tests/unit/test_ust_data.c

   1 /*
   2  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #include <assert.h>
   9 #include <stdio.h>
  10 #include <stdlib.h>
  11 #include <string.h>
  12 #include <unistd.h>
  13 #include <time.h>
  14 #include <urcu.h>
  15
  16 #include <lttng/lttng.h>
  17 #include <bin/lttng-sessiond/lttng-ust-abi.h>
  18 #include <common/defaults.h>
  19 #include <common/compat/errno.h>
  20 #include <bin/lttng-sessiond/trace-ust.h>
  21 #include <bin/lttng-sessiond/ust-app.h>
  22 #include <bin/lttng-sessiond/notification-thread.h>
  23
  24 #include <lttng/ust-sigbus.h>
  25
  26 #include <tap/tap.h>
  27
  28 /* This path will NEVER be created in this test */
  29 #define PATH1 "/tmp/.test-junk-lttng"
  30
  31 #define RANDOM_STRING_LEN       11
  32
  33 /* Number of TAP tests in this file */
  34 #define NUM_TESTS 16
  35
  36 DEFINE_LTTNG_UST_SIGBUS_STATE();
  37
  38 static const char alphanum[] =
  39         "0123456789"
  40         "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  41         "abcdefghijklmnopqrstuvwxyz";
  42 static char random_string[RANDOM_STRING_LEN];
  43
  44 /*
  45  * Return random string of 10 characters.
  46  * Not thread-safe.
  47  */
  48 static char *get_random_string(void)
  49 {
  50         int i;
  51
  52         for (i = 0; i < RANDOM_STRING_LEN - 1; i++) {
  53                 random_string[i] = alphanum[rand() % (sizeof(alphanum) - 1)];
  54         }
  55
  56         random_string[RANDOM_STRING_LEN - 1] = '\0';
  57
  58         return random_string;
  59 }
  60
  61 static void test_create_one_ust_session(void)
  62 {
  63         struct ltt_ust_session *usess =
  64                 trace_ust_create_session(42);
  65
  66         ok(usess != NULL, "Create UST session");
  67
  68         if (!usess) {
  69                 skip(1, "UST session is null");
  70                 return;
  71         }
  72
  73         ok(usess->id == 42 &&
  74            usess->active == 0 &&
  75            usess->domain_global.channels != NULL &&
  76            usess->uid == 0 &&
  77            usess->gid == 0,
  78            "Validate UST session");
  79
  80         trace_ust_destroy_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         enum lttng_error_code ret;
 148         struct ltt_ust_event *event;
 149         struct lttng_event ev;
 150         char *name;
 151         char *random_name;
 152         struct lttng_event_exclusion *exclusion = NULL;
 153         struct lttng_event_exclusion *exclusion_copy = NULL;
 154         const int exclusion_count = 2;
 155
 156         memset(&ev, 0, sizeof(ev));
 157
 158         /* make a wildcarded event name */
 159         name = get_random_string();
 160         name[strlen(name) - 1] = '*';
 161         ok(lttng_strncpy(ev.name, name, LTTNG_SYMBOL_NAME_LEN) == 0,
 162                 "Validate string length");
 163
 164         ev.type = LTTNG_EVENT_TRACEPOINT;
 165         ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
 166
 167         /* set up an exclusion set */
 168         exclusion = zmalloc(sizeof(*exclusion) +
 169                 LTTNG_SYMBOL_NAME_LEN * exclusion_count);
 170         ok(exclusion != NULL, "Create UST exclusion");
 171         if (!exclusion) {
 172                 skip(4, "zmalloc failed");
 173                 goto end;
 174         }
 175
 176         exclusion->count = exclusion_count;
 177         random_name = get_random_string();
 178         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0), random_name,
 179                 LTTNG_SYMBOL_NAME_LEN);
 180         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1), random_name,
 181                 LTTNG_SYMBOL_NAME_LEN);
 182
 183         ret = trace_ust_create_event(&ev, NULL, NULL, exclusion, false, &event);
 184         exclusion = NULL;
 185
 186         ok(ret != LTTNG_OK, "Create UST event with identical exclusion names fails");
 187
 188         exclusion = zmalloc(sizeof(*exclusion) +
 189                 LTTNG_SYMBOL_NAME_LEN * exclusion_count);
 190         ok(exclusion != NULL, "Create UST exclusion");
 191         if (!exclusion) {
 192                 skip(2, "zmalloc failed");
 193                 goto end;
 194         }
 195
 196         exclusion_copy = zmalloc(sizeof(*exclusion) +
 197                 LTTNG_SYMBOL_NAME_LEN * exclusion_count);
 198         if (!exclusion_copy) {
 199                 skip(2, "zmalloc failed");
 200                 goto end;
 201         }
 202
 203         /*
 204          * We are giving ownership of the exclusion struct to the
 205          * trace_ust_create_event() function. Make a copy of the exclusion struct
 206          * so we can compare it later.
 207          */
 208
 209         exclusion->count = exclusion_count;
 210         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0),
 211                 get_random_string(), LTTNG_SYMBOL_NAME_LEN);
 212         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1),
 213                 get_random_string(), LTTNG_SYMBOL_NAME_LEN);
 214
 215         exclusion_copy->count = exclusion_count;
 216         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion_copy, 0),
 217                 LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 0), LTTNG_SYMBOL_NAME_LEN);
 218         strncpy(LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion_copy, 1),
 219                 LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, 1), LTTNG_SYMBOL_NAME_LEN);
 220
 221         ret = trace_ust_create_event(&ev, NULL, NULL, exclusion, false, &event);
 222         exclusion = NULL;
 223         ok(ret == LTTNG_OK, "Create UST event with different exclusion names");
 224
 225         if (!event) {
 226                 skip(1, "UST event with exclusion is null");
 227                 goto end;
 228         }
 229
 230         ok(event->enabled == 0 &&
 231                 event->attr.instrumentation == LTTNG_UST_ABI_TRACEPOINT &&
 232                 strcmp(event->attr.name, ev.name) == 0 &&
 233                 event->exclusion != NULL &&
 234                 event->exclusion->count == exclusion_count &&
 235                 !memcmp(event->exclusion->names, exclusion_copy->names,
 236                         LTTNG_SYMBOL_NAME_LEN * exclusion_count) &&
 237                 event->attr.name[LTTNG_UST_ABI_SYM_NAME_LEN - 1] == '\0',
 238                 "Validate UST event and exclusion");
 239
 240         trace_ust_destroy_event(event);
 241 end:
 242         free(exclusion);
 243         free(exclusion_copy);
 244         return;
 245 }
 246
 247
 248 static void test_create_ust_context(void)
 249 {
 250         struct lttng_event_context ectx;
 251         struct ltt_ust_context *uctx;
 252
 253         ectx.ctx = LTTNG_EVENT_CONTEXT_VTID;
 254
 255         uctx = trace_ust_create_context(&ectx);
 256         ok(uctx != NULL, "Create UST context");
 257
 258         if (uctx) {
 259                 ok((int) uctx->ctx.ctx == LTTNG_UST_ABI_CONTEXT_VTID,
 260                    "Validate UST context");
 261         } else {
 262                 skip(1, "Skipping UST context validation as creation failed");
 263         }
 264         free(uctx);
 265 }
 266
 267 int main(int argc, char **argv)
 268 {
 269         plan_tests(NUM_TESTS);
 270
 271         diag("UST data structures unit test");
 272
 273         rcu_register_thread();
 274
 275         test_create_one_ust_session();
 276         test_create_ust_channel();
 277         test_create_ust_event();
 278         test_create_ust_context();
 279         test_create_ust_event_exclusion();
 280
 281         rcu_unregister_thread();
 282
 283         return exit_status();
 284 }