tests/unit/test_ust_data.cpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <string.h>
  11 #include <unistd.h>
  12 #include <time.h>
  13 #include <urcu.h>
  14
  15 #include <lttng/lttng.h>
  16 #include <bin/lttng-sessiond/lttng-ust-abi.hpp>
  17 #include <common/defaults.hpp>
  18 #include <common/compat/errno.hpp>
  19 #include <bin/lttng-sessiond/trace-ust.hpp>
  20 #include <bin/lttng-sessiond/ust-app.hpp>
  21 #include <bin/lttng-sessiond/notification-thread.hpp>
  22
  23 #include <lttng/ust-sigbus.h>
  24
  25 #include <tap/tap.h>
  26
  27 /* This path will NEVER be created in this test */
  28 #define PATH1 "/tmp/.test-junk-lttng"
  29
  30 #define RANDOM_STRING_LEN       11
  31
  32 /* Number of TAP tests in this file */
  33 #define NUM_TESTS 16
  34
  35 LTTNG_EXPORT DEFINE_LTTNG_UST_SIGBUS_STATE();
  36
  37 static const char alphanum[] =
  38         "0123456789"
  39         "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  40         "abcdefghijklmnopqrstuvwxyz";
  41 static char random_string[RANDOM_STRING_LEN];
  42
  43 /*
  44  * Return random string of 10 characters.
  45  * Not thread-safe.
  46  */
  47 static char *get_random_string(void)
  48 {
  49         int i;
  50
  51         for (i = 0; i < RANDOM_STRING_LEN - 1; i++) {
  52                 random_string[i] = alphanum[rand() % (sizeof(alphanum) - 1)];
  53         }
  54
  55         random_string[RANDOM_STRING_LEN - 1] = '\0';
  56
  57         return random_string;
  58 }
  59
  60 static void test_create_one_ust_session(void)
  61 {
  62         struct ltt_ust_session *usess =
  63                 trace_ust_create_session(42);
  64
  65         ok(usess != NULL, "Create UST session");
  66
  67         if (!usess) {
  68                 skip(1, "UST session is null");
  69                 return;
  70         }
  71
  72         ok(usess->id == 42 &&
  73            usess->active == 0 &&
  74            usess->domain_global.channels != NULL &&
  75            usess->uid == 0 &&
  76            usess->gid == 0,
  77            "Validate UST session");
  78
  79         trace_ust_destroy_session(usess);
  80         trace_ust_free_session(usess);
  81 }
  82
  83 static void test_create_ust_channel(void)
  84 {
  85         struct ltt_ust_channel *uchan;
  86         struct lttng_channel attr;
  87         struct lttng_channel_extended extended;
  88
  89         memset(&attr, 0, sizeof(attr));
  90         memset(&extended, 0, sizeof(extended));
  91         attr.attr.extended.ptr = &extended;
  92
  93         ok(lttng_strncpy(attr.name, "channel0", sizeof(attr.name)) == 0,
  94                 "Validate channel name length");
  95         uchan = trace_ust_create_channel(&attr, LTTNG_DOMAIN_UST);
  96         ok(uchan != NULL, "Create UST channel");
  97
  98         if (!uchan) {
  99                 skip(1, "UST channel is null");
 100                 return;
 101         }
 102
 103         ok(uchan->enabled == 0 &&
 104            strncmp(uchan->name, "channel0", 8) == 0 &&
 105            uchan->name[LTTNG_UST_ABI_SYM_NAME_LEN - 1] == '\0' &&
 106            uchan->ctx != NULL &&
 107            uchan->events != NULL &&
 108            uchan->attr.overwrite  == attr.attr.overwrite,
 109            "Validate UST channel");
 110
 111         trace_ust_destroy_channel(uchan);
 112 }
 113
 114 static void test_create_ust_event(void)
 115 {
 116         struct ltt_ust_event *event;
 117         struct lttng_event ev;
 118         enum lttng_error_code ret;
 119
 120         memset(&ev, 0, sizeof(ev));
 121         ok(lttng_strncpy(ev.name, get_random_string(),
 122                         LTTNG_SYMBOL_NAME_LEN) == 0,
 123                 "Validate string length");
 124         ev.type = LTTNG_EVENT_TRACEPOINT;
 125         ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
 126
 127         ret = trace_ust_create_event(&ev, NULL, NULL, NULL, false, &event);
 128
 129         ok(ret == LTTNG_OK, "Create UST event");
 130
 131         if (!event) {
 132                 skip(1, "UST event is null");
 133                 return;
 134         }
 135
 136         ok(event->enabled == 0 &&
 137            event->attr.instrumentation == LTTNG_UST_ABI_TRACEPOINT &&
 138            strcmp(event->attr.name, ev.name) == 0 &&
 139            event->attr.name[LTTNG_UST_ABI_SYM_NAME_LEN - 1] == '\0',
 140            "Validate UST event");
 141
 142         trace_ust_destroy_event(event);
 143 }
 144
 145 static void test_create_ust_event_exclusion(void)
 146 {
 147         int copy_ret;
 148         enum lttng_error_code ret;
 149         struct ltt_ust_event *event;
 150         struct lttng_event ev;
 151         char *name;
 152         char *random_name;
 153         struct lttng_event_exclusion *exclusion = NULL;
 154         struct lttng_event_exclusion *exclusion_copy = NULL;
 155         const int exclusion_count = 2;
 156
 157         memset(&ev, 0, sizeof(ev));
 158
 159         /* make a wildcarded event name */
 160         name = get_random_string();
 161         name[strlen(name) - 1] = '*';
 162         ok(lttng_strncpy(ev.name, name, LTTNG_SYMBOL_NAME_LEN) == 0,
 163                 "Validate string length");
 164
 165         ev.type = LTTNG_EVENT_TRACEPOINT;
 166         ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
 167
 168         /* set up an exclusion set */
 169         exclusion = zmalloc<lttng_event_exclusion>(sizeof(*exclusion) +
 170                 LTTNG_SYMBOL_NAME_LEN * exclusion_count);
 171         ok(exclusion != NULL, "Create UST exclusion");
 172         if (!exclusion) {
 173                 skip(4, "zmalloc failed");
 174                 goto end;
 175         }
 176
 177         exclusion->count = exclusion_count;
 178         random_name = get_random_string();
 179         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0), random_name,
 180                 LTTNG_SYMBOL_NAME_LEN - 1);
 181         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1), random_name,
 182                 LTTNG_SYMBOL_NAME_LEN - 1);
 183
 184         ret = trace_ust_create_event(&ev, NULL, NULL, exclusion, false, &event);
 185         exclusion = NULL;
 186
 187         ok(ret != LTTNG_OK, "Create UST event with identical exclusion names fails");
 188
 189         exclusion = zmalloc<lttng_event_exclusion>(sizeof(*exclusion) +
 190                 LTTNG_SYMBOL_NAME_LEN * exclusion_count);
 191         ok(exclusion != NULL, "Create UST exclusion");
 192         if (!exclusion) {
 193                 skip(2, "zmalloc failed");
 194                 goto end;
 195         }
 196
 197         exclusion_copy = zmalloc<lttng_event_exclusion>(sizeof(*exclusion) +
 198                 LTTNG_SYMBOL_NAME_LEN * exclusion_count);
 199         if (!exclusion_copy) {
 200                 skip(2, "zmalloc failed");
 201                 goto end;
 202         }
 203
 204         /*
 205          * We are giving ownership of the exclusion struct to the
 206          * trace_ust_create_event() function. Make a copy of the exclusion struct
 207          * so we can compare it later.
 208          */
 209
 210         exclusion->count = exclusion_count;
 211         copy_ret = lttng_strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0),
 212                         get_random_string(),
 213                         sizeof(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0)));
 214         LTTNG_ASSERT(copy_ret == 0);
 215         copy_ret = lttng_strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1),
 216                         get_random_string(),
 217                         sizeof(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1)));
 218         LTTNG_ASSERT(copy_ret == 0);
 219
 220         exclusion_copy->count = exclusion_count;
 221         copy_ret = lttng_strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion_copy, 0),
 222                         LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0),
 223                         sizeof(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion_copy, 0)));
 224         LTTNG_ASSERT(copy_ret == 0);
 225         copy_ret = lttng_strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion_copy, 1),
 226                         LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1),
 227                         sizeof(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion_copy, 1)));
 228         LTTNG_ASSERT(copy_ret == 0);
 229
 230         ret = trace_ust_create_event(&ev, NULL, NULL, exclusion, false, &event);
 231         exclusion = NULL;
 232         ok(ret == LTTNG_OK, "Create UST event with different exclusion names");
 233
 234         if (!event) {
 235                 skip(1, "UST event with exclusion is null");
 236                 goto end;
 237         }
 238
 239         ok(event->enabled == 0 &&
 240                 event->attr.instrumentation == LTTNG_UST_ABI_TRACEPOINT &&
 241                 strcmp(event->attr.name, ev.name) == 0 &&
 242                 event->exclusion != NULL &&
 243                 event->exclusion->count == exclusion_count &&
 244                 !memcmp(event->exclusion->names, exclusion_copy->names,
 245                         LTTNG_SYMBOL_NAME_LEN * exclusion_count) &&
 246                 event->attr.name[LTTNG_UST_ABI_SYM_NAME_LEN - 1] == '\0',
 247                 "Validate UST event and exclusion");
 248
 249         trace_ust_destroy_event(event);
 250 end:
 251         free(exclusion);
 252         free(exclusion_copy);
 253         return;
 254 }
 255
 256
 257 static void test_create_ust_context(void)
 258 {
 259         struct lttng_event_context ectx;
 260         struct ltt_ust_context *uctx;
 261
 262         ectx.ctx = LTTNG_EVENT_CONTEXT_VTID;
 263
 264         uctx = trace_ust_create_context(&ectx);
 265         ok(uctx != NULL, "Create UST context");
 266
 267         if (uctx) {
 268                 ok((int) uctx->ctx.ctx == LTTNG_UST_ABI_CONTEXT_VTID,
 269                    "Validate UST context");
 270         } else {
 271                 skip(1, "Skipping UST context validation as creation failed");
 272         }
 273         free(uctx);
 274 }
 275
 276 int main(void)
 277 {
 278         plan_tests(NUM_TESTS);
 279
 280         diag("UST data structures unit test");
 281
 282         rcu_register_thread();
 283
 284         test_create_one_ust_session();
 285         test_create_ust_channel();
 286         test_create_ust_event();
 287         test_create_ust_context();
 288         test_create_ust_event_exclusion();
 289
 290         rcu_unregister_thread();
 291
 292         return exit_status();
 293 }