tests/unit/test_session.c

   1 /*
   2  * Copyright (c)  2011 David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * as published by the Free Software Foundation; only version 2
   7  * of the License.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25 #include <time.h>
  26 #include <sys/types.h>
  27 #include <urcu.h>
  28
  29 #include <tap/tap.h>
  30
  31 #include <bin/lttng-sessiond/session.h>
  32 #include <bin/lttng-sessiond/ust-app.h>
  33 #include <bin/lttng-sessiond/ht-cleanup.h>
  34 #include <bin/lttng-sessiond/health-sessiond.h>
  35 #include <bin/lttng-sessiond/thread.h>
  36 #include <common/sessiond-comm/sessiond-comm.h>
  37 #include <common/common.h>
  38
  39 #define SESSION1 "test1"
  40
  41 #define MAX_SESSIONS 10000
  42 #define RANDOM_STRING_LEN       11
  43
  44 /* Number of TAP tests in this file */
  45 #define NUM_TESTS 11
  46
  47 struct health_app *health_sessiond;
  48 static struct ltt_session_list *session_list;
  49
  50 /* For error.h */
  51 int lttng_opt_quiet = 1;
  52 int lttng_opt_verbose = 0;
  53 int lttng_opt_mi;
  54
  55 int ust_consumerd32_fd;
  56 int ust_consumerd64_fd;
  57
  58 static const char alphanum[] =
  59         "0123456789"
  60         "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  61         "abcdefghijklmnopqrstuvwxyz";
  62 static char random_string[RANDOM_STRING_LEN];
  63
  64 /*
  65  * Return random string of 10 characters.
  66  * Not thread-safe.
  67  */
  68 static char *get_random_string(void)
  69 {
  70         int i;
  71
  72         for (i = 0; i < RANDOM_STRING_LEN - 1; i++) {
  73                 random_string[i] = alphanum[rand() % (sizeof(alphanum) - 1)];
  74         }
  75
  76         random_string[RANDOM_STRING_LEN - 1] = '\0';
  77
  78         return random_string;
  79 }
  80
  81 /*
  82  * Return 0 if session name is found, else -1
  83  */
  84 static int find_session_name(char *name)
  85 {
  86         struct ltt_session *iter;
  87
  88         cds_list_for_each_entry(iter, &session_list->head, list) {
  89                 if (strcmp(iter->name, name) == 0) {
  90                         return 0;
  91                 }
  92         }
  93
  94         return -1;
  95 }
  96
  97 static int session_list_count(void)
  98 {
  99         int count = 0;
 100         struct ltt_session *iter;
 101
 102         cds_list_for_each_entry(iter, &session_list->head, list) {
 103                 count++;
 104         }
 105         return count;
 106 }
 107
 108 /*
 109  * Empty session list manually.
 110  */
 111 static void empty_session_list(void)
 112 {
 113         struct ltt_session *iter, *tmp;
 114
 115         session_lock_list();
 116         cds_list_for_each_entry_safe(iter, tmp, &session_list->head, list) {
 117                 session_destroy(iter);
 118         }
 119         session_unlock_list();
 120
 121         /* Session list must be 0 */
 122         assert(!session_list_count());
 123 }
 124
 125 /*
 126  * Test creation of 1 session
 127  */
 128 static int create_one_session(char *name)
 129 {
 130         int ret;
 131         enum lttng_error_code ret_code;
 132         struct ltt_session *session = NULL;
 133
 134         session_lock_list();
 135         ret_code = session_create(name, geteuid(), getegid(), &session);
 136         session_put(session);
 137         if (ret_code == LTTNG_OK) {
 138                 /* Validate */
 139                 ret = find_session_name(name);
 140                 if (ret < 0) {
 141                         /* Session not found by name */
 142                         printf("session not found after creation\n");
 143                         ret = -1;
 144                 } else {
 145                         /* Success */
 146                         ret = 0;
 147                 }
 148         } else {
 149                 if (ret_code == LTTNG_ERR_EXIST_SESS) {
 150                         printf("(session already exists) ");
 151                 }
 152                 ret = -1;
 153         }
 154
 155         session_unlock_list();
 156         return ret;
 157 }
 158
 159 /*
 160  * Test deletion of 1 session
 161  */
 162 static int destroy_one_session(struct ltt_session *session)
 163 {
 164         int ret;
 165         char session_name[NAME_MAX];
 166
 167         strncpy(session_name, session->name, sizeof(session_name));
 168         session_name[sizeof(session_name) - 1] = '\0';
 169
 170         session_destroy(session);
 171         session_put(session);
 172
 173         ret = find_session_name(session_name);
 174         if (ret < 0) {
 175                 /* Success, -1 means that the sesion is NOT found */
 176                 ret = 0;
 177         } else {
 178                 /* Fail */
 179                 ret = -1;
 180         }
 181         return ret;
 182 }
 183
 184 /*
 185  * This test is supposed to fail at the second create call. If so, return 0 for
 186  * test success, else -1.
 187  */
 188 static int two_session_same_name(void)
 189 {
 190         int ret;
 191         struct ltt_session *sess;
 192
 193         ret = create_one_session(SESSION1);
 194         if (ret < 0) {
 195                 /* Fail */
 196                 ret = -1;
 197                 goto end;
 198         }
 199
 200         session_lock_list();
 201         sess = session_find_by_name(SESSION1);
 202         if (sess) {
 203                 /* Success */
 204                 session_put(sess);
 205                 session_unlock_list();
 206                 ret = 0;
 207                 goto end_unlock;
 208         } else {
 209                 /* Fail */
 210                 ret = -1;
 211                 goto end_unlock;
 212         }
 213 end_unlock:
 214         session_unlock_list();
 215 end:
 216         return ret;
 217 }
 218
 219 static void test_session_list(void)
 220 {
 221         session_list = session_get_list();
 222         ok(session_list != NULL, "Session list: not NULL");
 223 }
 224
 225 static void test_create_one_session(void)
 226 {
 227         ok(create_one_session(SESSION1) == 0,
 228            "Create session: %s",
 229            SESSION1);
 230 }
 231
 232 static void test_validate_session(void)
 233 {
 234         struct ltt_session *tmp;
 235
 236         session_lock_list();
 237         tmp = session_find_by_name(SESSION1);
 238
 239         ok(tmp != NULL,
 240            "Validating session: session found");
 241
 242         if (tmp) {
 243                 ok(tmp->kernel_session == NULL &&
 244                    strlen(tmp->name),
 245                    "Validating session: basic sanity check");
 246         } else {
 247                 skip(1, "Skipping session validation check as session was not found");
 248                 goto end;
 249         }
 250
 251         session_lock(tmp);
 252         session_unlock(tmp);
 253         session_put(tmp);
 254 end:
 255         session_unlock_list();
 256 }
 257
 258 static void test_destroy_session(void)
 259 {
 260         struct ltt_session *tmp;
 261
 262         session_lock_list();
 263         tmp = session_find_by_name(SESSION1);
 264
 265         ok(tmp != NULL,
 266            "Destroying session: session found");
 267
 268         if (tmp) {
 269                 ok(destroy_one_session(tmp) == 0,
 270                    "Destroying session: %s destroyed",
 271                    SESSION1);
 272         } else {
 273                 skip(1, "Skipping session destruction as it was not found");
 274         }
 275         session_unlock_list();
 276 }
 277
 278 static void test_duplicate_session(void)
 279 {
 280         ok(two_session_same_name() == 0,
 281            "Duplicate session creation");
 282 }
 283
 284 static void test_session_name_generation(void)
 285 {
 286         struct ltt_session *session = NULL;
 287         enum lttng_error_code ret_code;
 288         const char *expected_session_name_prefix = DEFAULT_SESSION_NAME;
 289
 290         session_lock_list();
 291         ret_code = session_create(NULL, geteuid(), getegid(), &session);
 292         ok(ret_code == LTTNG_OK,
 293                 "Create session with a NULL name (auto-generate a name)");
 294         if (!session) {
 295                 skip(1, "Skipping session name generation tests as session_create() failed.");
 296                 goto end;
 297         }
 298         diag("Automatically-generated session name: %s", *session->name ?
 299                 session->name : "ERROR");
 300         ok(*session->name && !strncmp(expected_session_name_prefix, session->name,
 301                         sizeof(DEFAULT_SESSION_NAME) - 1),
 302                         "Auto-generated session name starts with %s",
 303                         DEFAULT_SESSION_NAME);
 304 end:
 305         session_put(session);
 306         session_unlock_list();
 307 }
 308
 309 static void test_large_session_number(void)
 310 {
 311         int ret, i, failed = 0;
 312         struct ltt_session *iter, *tmp;
 313
 314         for (i = 0; i < MAX_SESSIONS; i++) {
 315                 char *tmp_name = get_random_string();
 316                 ret = create_one_session(tmp_name);
 317                 if (ret < 0) {
 318                         diag("session %d (name: %s) creation failed", i, tmp_name);
 319                         ++failed;
 320                 }
 321         }
 322
 323         ok(failed == 0,
 324            "Large sessions number: created %u sessions",
 325            MAX_SESSIONS);
 326
 327         failed = 0;
 328
 329         session_lock_list();
 330         for (i = 0; i < MAX_SESSIONS; i++) {
 331                 cds_list_for_each_entry_safe(iter, tmp, &session_list->head, list) {
 332                         assert(session_get(iter));
 333                         ret = destroy_one_session(iter);
 334                         if (ret < 0) {
 335                                 diag("session %d destroy failed", i);
 336                                 ++failed;
 337                         }
 338                 }
 339         }
 340         session_unlock_list();
 341
 342         ok(failed == 0 && session_list_count() == 0,
 343            "Large sessions number: destroyed %u sessions",
 344            MAX_SESSIONS);
 345 }
 346
 347 int main(int argc, char **argv)
 348 {
 349         struct lttng_thread *ht_cleanup_thread;
 350
 351         plan_tests(NUM_TESTS);
 352
 353         health_sessiond = health_app_create(NR_HEALTH_SESSIOND_TYPES);
 354         ht_cleanup_thread = launch_ht_cleanup_thread();
 355         assert(ht_cleanup_thread);
 356         lttng_thread_put(ht_cleanup_thread);
 357
 358         diag("Sessions unit tests");
 359
 360         rcu_register_thread();
 361
 362         test_session_list();
 363
 364         test_create_one_session();
 365
 366         test_validate_session();
 367
 368         test_destroy_session();
 369
 370         test_duplicate_session();
 371
 372         empty_session_list();
 373
 374         test_session_name_generation();
 375
 376         test_large_session_number();
 377
 378         rcu_unregister_thread();
 379         lttng_thread_list_shutdown_orphans();
 380
 381         return exit_status();
 382 }