libust/lttng-ust-comm.c

   1 /*
   2  * lttng-ust-comm.c
   3  *
   4  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
   5  * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; only
  10  * version 2.1 of the License.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #define _LGPL_SOURCE
  23 #include <sys/types.h>
  24 #include <sys/socket.h>
  25 #include <sys/prctl.h>
  26 #include <sys/mman.h>
  27 #include <sys/stat.h>
  28 #include <sys/types.h>
  29 #include <sys/wait.h>
  30 #include <fcntl.h>
  31 #include <unistd.h>
  32 #include <errno.h>
  33 #include <pthread.h>
  34 #include <semaphore.h>
  35 #include <time.h>
  36 #include <assert.h>
  37 #include <signal.h>
  38 #include <urcu/uatomic.h>
  39 #include <urcu/futex.h>
  40
  41 #include <lttng-ust-comm.h>
  42 #include <ust/usterr-signal-safe.h>
  43 #include <ust/lttng-ust-abi.h>
  44 #include <ust/tracepoint.h>
  45 #include <ust/tracepoint-internal.h>
  46 #include <ust/ust.h>
  47 #include "ltt-tracer-core.h"
  48
  49 /*
  50  * Has lttng ust comm constructor been called ?
  51  */
  52 static int initialized;
  53
  54 /*
  55  * The ust_lock/ust_unlock lock is used as a communication thread mutex.
  56  * Held when handling a command, also held by fork() to deal with
  57  * removal of threads, and by exit path.
  58  */
  59
  60 /* Should the ust comm thread quit ? */
  61 static int lttng_ust_comm_should_quit;
  62
  63 /*
  64  * Wait for either of these before continuing to the main
  65  * program:
  66  * - the register_done message from sessiond daemon
  67  *   (will let the sessiond daemon enable sessions before main
  68  *   starts.)
  69  * - sessiond daemon is not reachable.
  70  * - timeout (ensuring applications are resilient to session
  71  *   daemon problems).
  72  */
  73 static sem_t constructor_wait;
  74 /*
  75  * Doing this for both the global and local sessiond.
  76  */
  77 static int sem_count = { 2 };
  78
  79 /*
  80  * Info about socket and associated listener thread.
  81  */
  82 struct sock_info {
  83         const char *name;
  84         pthread_t ust_listener; /* listener thread */
  85         int root_handle;
  86         int constructor_sem_posted;
  87         int allowed;
  88         int global;
  89
  90         char sock_path[PATH_MAX];
  91         int socket;
  92
  93         char wait_shm_path[PATH_MAX];
  94         char *wait_shm_mmap;
  95 };
  96
  97 /* Socket from app (connect) to session daemon (listen) for communication */
  98 struct sock_info global_apps = {
  99         .name = "global",
 100         .global = 1,
 101
 102         .root_handle = -1,
 103         .allowed = 1,
 104
 105         .sock_path = DEFAULT_GLOBAL_APPS_UNIX_SOCK,
 106         .socket = -1,
 107
 108         .wait_shm_path = DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH,
 109 };
 110
 111 /* TODO: allow global_apps_sock_path override */
 112
 113 struct sock_info local_apps = {
 114         .name = "local",
 115         .global = 0,
 116         .root_handle = -1,
 117         .allowed = 0,   /* Check setuid bit first */
 118
 119         .socket = -1,
 120 };
 121
 122 static int wait_poll_fallback;
 123
 124 extern void ltt_ring_buffer_client_overwrite_init(void);
 125 extern void ltt_ring_buffer_client_discard_init(void);
 126 extern void ltt_ring_buffer_metadata_client_init(void);
 127 extern void ltt_ring_buffer_client_overwrite_exit(void);
 128 extern void ltt_ring_buffer_client_discard_exit(void);
 129 extern void ltt_ring_buffer_metadata_client_exit(void);
 130
 131 static
 132 int setup_local_apps(void)
 133 {
 134         const char *home_dir;
 135         uid_t uid;
 136
 137         uid = getuid();
 138         /*
 139          * Disallow per-user tracing for setuid binaries.
 140          */
 141         if (uid != geteuid()) {
 142                 local_apps.allowed = 0;
 143                 return 0;
 144         } else {
 145                 local_apps.allowed = 1;
 146         }
 147         home_dir = (const char *) getenv("HOME");
 148         if (!home_dir)
 149                 return -ENOENT;
 150         snprintf(local_apps.sock_path, PATH_MAX,
 151                  DEFAULT_HOME_APPS_UNIX_SOCK, home_dir);
 152         snprintf(local_apps.wait_shm_path, PATH_MAX,
 153                  DEFAULT_HOME_APPS_WAIT_SHM_PATH, uid);
 154         return 0;
 155 }
 156
 157 static
 158 int register_app_to_sessiond(int socket)
 159 {
 160         ssize_t ret;
 161         int prctl_ret;
 162         struct {
 163                 uint32_t major;
 164                 uint32_t minor;
 165                 pid_t pid;
 166                 pid_t ppid;
 167                 uid_t uid;
 168                 gid_t gid;
 169                 char name[16];  /* process name */
 170         } reg_msg;
 171
 172         reg_msg.major = LTTNG_UST_COMM_VERSION_MAJOR;
 173         reg_msg.minor = LTTNG_UST_COMM_VERSION_MINOR;
 174         reg_msg.pid = getpid();
 175         reg_msg.ppid = getppid();
 176         reg_msg.uid = getuid();
 177         reg_msg.gid = getgid();
 178         prctl_ret = prctl(PR_GET_NAME, (unsigned long) reg_msg.name, 0, 0, 0);
 179         if (prctl_ret) {
 180                 ERR("Error executing prctl");
 181                 return -errno;
 182         }
 183
 184         ret = lttcomm_send_unix_sock(socket, &reg_msg, sizeof(reg_msg));
 185         if (ret >= 0 && ret != sizeof(reg_msg))
 186                 return -EIO;
 187         return ret;
 188 }
 189
 190 static
 191 int send_reply(int sock, struct lttcomm_ust_reply *lur)
 192 {
 193         ssize_t len;
 194
 195         len = lttcomm_send_unix_sock(sock, lur, sizeof(*lur));
 196         switch (len) {
 197         case sizeof(*lur):
 198                 DBG("message successfully sent");
 199                 return 0;
 200         case -1:
 201                 if (errno == ECONNRESET) {
 202                         printf("remote end closed connection\n");
 203                         return 0;
 204                 }
 205                 return -1;
 206         default:
 207                 printf("incorrect message size: %zd\n", len);
 208                 return -1;
 209         }
 210 }
 211
 212 static
 213 int handle_register_done(struct sock_info *sock_info)
 214 {
 215         int ret;
 216
 217         if (sock_info->constructor_sem_posted)
 218                 return 0;
 219         sock_info->constructor_sem_posted = 1;
 220         ret = uatomic_add_return(&sem_count, -1);
 221         if (ret == 0) {
 222                 ret = sem_post(&constructor_wait);
 223                 assert(!ret);
 224         }
 225         return 0;
 226 }
 227
 228 static
 229 int handle_message(struct sock_info *sock_info,
 230                 int sock, struct lttcomm_ust_msg *lum)
 231 {
 232         int ret = 0;
 233         const struct objd_ops *ops;
 234         struct lttcomm_ust_reply lur;
 235
 236         ust_lock();
 237
 238         memset(&lur, 0, sizeof(lur));
 239
 240         if (lttng_ust_comm_should_quit) {
 241                 ret = -EPERM;
 242                 goto end;
 243         }
 244
 245         ops = objd_ops(lum->handle);
 246         if (!ops) {
 247                 ret = -ENOENT;
 248                 goto end;
 249         }
 250
 251         switch (lum->cmd) {
 252         case LTTNG_UST_REGISTER_DONE:
 253                 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
 254                         ret = handle_register_done(sock_info);
 255                 else
 256                         ret = -EINVAL;
 257                 break;
 258         case LTTNG_UST_RELEASE:
 259                 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
 260                         ret = -EPERM;
 261                 else
 262                         ret = objd_unref(lum->handle);
 263                 break;
 264         default:
 265                 if (ops->cmd)
 266                         ret = ops->cmd(lum->handle, lum->cmd,
 267                                         (unsigned long) &lum->u);
 268                 else
 269                         ret = -ENOSYS;
 270                 break;
 271         }
 272
 273 end:
 274         lur.handle = lum->handle;
 275         lur.cmd = lum->cmd;
 276         lur.ret_val = ret;
 277         if (ret >= 0) {
 278                 lur.ret_code = LTTCOMM_OK;
 279         } else {
 280                 lur.ret_code = LTTCOMM_SESSION_FAIL;
 281         }
 282         ret = send_reply(sock, &lur);
 283
 284         ust_unlock();
 285         return ret;
 286 }
 287
 288 static
 289 void cleanup_sock_info(struct sock_info *sock_info)
 290 {
 291         int ret;
 292
 293         if (sock_info->socket != -1) {
 294                 ret = close(sock_info->socket);
 295                 if (ret) {
 296                         ERR("Error closing apps socket");
 297                 }
 298                 sock_info->socket = -1;
 299         }
 300         if (sock_info->root_handle != -1) {
 301                 ret = objd_unref(sock_info->root_handle);
 302                 if (ret) {
 303                         ERR("Error unref root handle");
 304                 }
 305                 sock_info->root_handle = -1;
 306         }
 307         sock_info->constructor_sem_posted = 0;
 308         if (sock_info->wait_shm_mmap) {
 309                 ret = munmap(sock_info->wait_shm_mmap, sysconf(_SC_PAGE_SIZE));
 310                 if (ret) {
 311                         ERR("Error unmapping wait shm");
 312                 }
 313                 sock_info->wait_shm_mmap = NULL;
 314         }
 315 }
 316
 317 /*
 318  * Using fork to set umask in the child process (not multi-thread safe).
 319  * We deal with the shm_open vs ftruncate race (happening when the
 320  * sessiond owns the shm and does not let everybody modify it, to ensure
 321  * safety against shm_unlink) by simply letting the mmap fail and
 322  * retrying after a few seconds.
 323  * For global shm, everybody has rw access to it until the sessiond
 324  * starts.
 325  */
 326 static
 327 int get_wait_shm(struct sock_info *sock_info, size_t mmap_size)
 328 {
 329         int wait_shm_fd, ret;
 330         pid_t pid;
 331
 332         /*
 333          * Try to open read-only.
 334          */
 335         wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
 336         if (wait_shm_fd >= 0) {
 337                 goto end;
 338         } else if (wait_shm_fd < 0 && errno != ENOENT) {
 339                 /*
 340                  * Real-only open did not work, and it's not because the
 341                  * entry was not present. It's a failure that prohibits
 342                  * using shm.
 343                  */
 344                 ERR("Error opening shm %s", sock_info->wait_shm_path);
 345                 goto end;
 346         }
 347         /*
 348          * If the open failed because the file did not exist, try
 349          * creating it ourself.
 350          */
 351         pid = fork();
 352         if (pid > 0) {
 353                 int status;
 354
 355                 /*
 356                  * Parent: wait for child to return, in which case the
 357                  * shared memory map will have been created.
 358                  */
 359                 pid = wait(&status);
 360                 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
 361                         wait_shm_fd = -1;
 362                         goto end;
 363                 }
 364                 /*
 365                  * Try to open read-only again after creation.
 366                  */
 367                 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
 368                 if (wait_shm_fd < 0) {
 369                         /*
 370                          * Real-only open did not work. It's a failure
 371                          * that prohibits using shm.
 372                          */
 373                         ERR("Error opening shm %s", sock_info->wait_shm_path);
 374                         goto end;
 375                 }
 376                 goto end;
 377         } else if (pid == 0) {
 378                 int create_mode;
 379
 380                 /* Child */
 381                 create_mode = S_IRUSR | S_IWUSR | S_IRGRP;
 382                 if (sock_info->global)
 383                         create_mode |= S_IROTH | S_IWGRP | S_IWOTH;
 384                 /*
 385                  * We're alone in a child process, so we can modify the
 386                  * process-wide umask.
 387                  */
 388                 umask(~create_mode);
 389                 /*
 390                  * Try creating shm (or get rw access).
 391                  * We don't do an exclusive open, because we allow other
 392                  * processes to create+ftruncate it concurrently.
 393                  */
 394                 wait_shm_fd = shm_open(sock_info->wait_shm_path,
 395                                 O_RDWR | O_CREAT, create_mode);
 396                 if (wait_shm_fd >= 0) {
 397                         ret = ftruncate(wait_shm_fd, mmap_size);
 398                         if (ret) {
 399                                 PERROR("ftruncate");
 400                                 exit(EXIT_FAILURE);
 401                         }
 402                         exit(EXIT_SUCCESS);
 403                 }
 404                 /*
 405                  * For local shm, we need to have rw access to accept
 406                  * opening it: this means the local sessiond will be
 407                  * able to wake us up. For global shm, we open it even
 408                  * if rw access is not granted, because the root.root
 409                  * sessiond will be able to override all rights and wake
 410                  * us up.
 411                  */
 412                 if (!sock_info->global && errno != EACCES) {
 413                         ERR("Error opening shm %s", sock_info->wait_shm_path);
 414                         exit(EXIT_FAILURE);
 415                 }
 416                 /*
 417                  * The shm exists, but we cannot open it RW. Report
 418                  * success.
 419                  */
 420                 exit(EXIT_SUCCESS);
 421         } else {
 422                 return -1;
 423         }
 424 end:
 425         if (wait_shm_fd >= 0 && !sock_info->global) {
 426                 struct stat statbuf;
 427
 428                 /*
 429                  * Ensure that our user is the owner of the shm file for
 430                  * local shm. If we do not own the file, it means our
 431                  * sessiond will not have access to wake us up (there is
 432                  * probably a rogue process trying to fake our
 433                  * sessiond). Fallback to polling method in this case.
 434                  */
 435                 ret = fstat(wait_shm_fd, &statbuf);
 436                 if (ret) {
 437                         PERROR("fstat");
 438                         goto error_close;
 439                 }
 440                 if (statbuf.st_uid != getuid())
 441                         goto error_close;
 442         }
 443         return wait_shm_fd;
 444
 445 error_close:
 446         ret = close(wait_shm_fd);
 447         if (ret) {
 448                 PERROR("Error closing fd");
 449         }
 450         return -1;
 451 }
 452
 453 static
 454 char *get_map_shm(struct sock_info *sock_info)
 455 {
 456         size_t mmap_size = sysconf(_SC_PAGE_SIZE);
 457         int wait_shm_fd, ret;
 458         char *wait_shm_mmap;
 459
 460         wait_shm_fd = get_wait_shm(sock_info, mmap_size);
 461         if (wait_shm_fd < 0) {
 462                 goto error;
 463         }
 464         wait_shm_mmap = mmap(NULL, mmap_size, PROT_READ,
 465                   MAP_SHARED, wait_shm_fd, 0);
 466         /* close shm fd immediately after taking the mmap reference */
 467         ret = close(wait_shm_fd);
 468         if (ret) {
 469                 PERROR("Error closing fd");
 470         }
 471         if (wait_shm_mmap == MAP_FAILED) {
 472                 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
 473                 goto error;
 474         }
 475         return wait_shm_mmap;
 476
 477 error:
 478         return NULL;
 479 }
 480
 481 static
 482 void wait_for_sessiond(struct sock_info *sock_info)
 483 {
 484         int ret;
 485
 486         ust_lock();
 487         if (lttng_ust_comm_should_quit) {
 488                 goto quit;
 489         }
 490         if (wait_poll_fallback) {
 491                 goto error;
 492         }
 493         if (!sock_info->wait_shm_mmap) {
 494                 sock_info->wait_shm_mmap = get_map_shm(sock_info);
 495                 if (!sock_info->wait_shm_mmap)
 496                         goto error;
 497         }
 498         ust_unlock();
 499
 500         DBG("Waiting for %s apps sessiond", sock_info->name);
 501         /* Wait for futex wakeup */
 502         if (uatomic_read((int32_t *) sock_info->wait_shm_mmap) == 0) {
 503                 ret = futex_async((int32_t *) sock_info->wait_shm_mmap,
 504                         FUTEX_WAIT, 0, NULL, NULL, 0);
 505                 if (ret < 0) {
 506                         if (errno == EFAULT) {
 507                                 wait_poll_fallback = 1;
 508                                 ERR(
 509 "Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
 510 "do not support FUTEX_WAKE on read-only memory mappings correctly. "
 511 "Please upgrade your kernel "
 512 "(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
 513 "mainline). LTTng-UST will use polling mode fallback.");
 514                         }
 515                         PERROR("futex");
 516                         sleep(5);
 517                 }
 518         }
 519         return;
 520
 521 quit:
 522         ust_unlock();
 523         return;
 524
 525 error:
 526         ust_unlock();
 527         /* Error handling: fallback on a 5 seconds sleep. */
 528         sleep(5);
 529         return;
 530 }
 531
 532 /*
 533  * This thread does not allocate any resource, except within
 534  * handle_message, within mutex protection. This mutex protects against
 535  * fork and exit.
 536  * The other moment it allocates resources is at socket connexion, which
 537  * is also protected by the mutex.
 538  */
 539 static
 540 void *ust_listener_thread(void *arg)
 541 {
 542         struct sock_info *sock_info = arg;
 543         int sock, ret;
 544
 545         /* Restart trying to connect to the session daemon */
 546 restart:
 547         ust_lock();
 548
 549         if (lttng_ust_comm_should_quit) {
 550                 ust_unlock();
 551                 goto quit;
 552         }
 553
 554         if (sock_info->socket != -1) {
 555                 ret = close(sock_info->socket);
 556                 if (ret) {
 557                         ERR("Error closing %s apps socket", sock_info->name);
 558                 }
 559                 sock_info->socket = -1;
 560         }
 561
 562         /* Register */
 563         ret = lttcomm_connect_unix_sock(sock_info->sock_path);
 564         if (ret < 0) {
 565                 ERR("Error connecting to %s apps socket", sock_info->name);
 566                 /*
 567                  * If we cannot find the sessiond daemon, don't delay
 568                  * constructor execution.
 569                  */
 570                 ret = handle_register_done(sock_info);
 571                 assert(!ret);
 572                 ust_unlock();
 573
 574                 /* Wait for sessiond availability with pipe */
 575                 wait_for_sessiond(sock_info);
 576                 goto restart;
 577         }
 578
 579         sock_info->socket = sock = ret;
 580
 581         /*
 582          * Create only one root handle per listener thread for the whole
 583          * process lifetime.
 584          */
 585         if (sock_info->root_handle == -1) {
 586                 ret = lttng_abi_create_root_handle();
 587                 if (ret) {
 588                         ERR("Error creating root handle");
 589                         ust_unlock();
 590                         goto quit;
 591                 }
 592                 sock_info->root_handle = ret;
 593         }
 594
 595         ret = register_app_to_sessiond(sock);
 596         if (ret < 0) {
 597                 ERR("Error registering to %s apps socket", sock_info->name);
 598                 /*
 599                  * If we cannot register to the sessiond daemon, don't
 600                  * delay constructor execution.
 601                  */
 602                 ret = handle_register_done(sock_info);
 603                 assert(!ret);
 604                 ust_unlock();
 605                 wait_for_sessiond(sock_info);
 606                 goto restart;
 607         }
 608         ust_unlock();
 609
 610         for (;;) {
 611                 ssize_t len;
 612                 struct lttcomm_ust_msg lum;
 613
 614                 len = lttcomm_recv_unix_sock(sock, &lum, sizeof(lum));
 615                 switch (len) {
 616                 case 0: /* orderly shutdown */
 617                         DBG("%s ltt-sessiond has performed an orderly shutdown\n", sock_info->name);
 618                         goto end;
 619                 case sizeof(lum):
 620                         DBG("message received\n");
 621                         ret = handle_message(sock_info, sock, &lum);
 622                         if (ret < 0) {
 623                                 ERR("Error handling message for %s socket", sock_info->name);
 624                         }
 625                         continue;
 626                 case -1:
 627                         if (errno == ECONNRESET) {
 628                                 ERR("%s remote end closed connection\n", sock_info->name);
 629                                 goto end;
 630                         }
 631                         goto end;
 632                 default:
 633                         ERR("incorrect message size (%s socket): %zd\n", sock_info->name, len);
 634                         continue;
 635                 }
 636
 637         }
 638 end:
 639         goto restart;   /* try to reconnect */
 640 quit:
 641         return NULL;
 642 }
 643
 644 /*
 645  * Return values: -1: don't wait. 0: wait forever. 1: timeout wait.
 646  */
 647 static
 648 int get_timeout(struct timespec *constructor_timeout)
 649 {
 650         long constructor_delay_ms = LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS;
 651         char *str_delay;
 652         int ret;
 653
 654         str_delay = getenv("UST_REGISTER_TIMEOUT");
 655         if (str_delay) {
 656                 constructor_delay_ms = strtol(str_delay, NULL, 10);
 657         }
 658
 659         switch (constructor_delay_ms) {
 660         case -1:/* fall-through */
 661         case 0:
 662                 return constructor_delay_ms;
 663         default:
 664                 break;
 665         }
 666
 667         /*
 668          * If we are unable to find the current time, don't wait.
 669          */
 670         ret = clock_gettime(CLOCK_REALTIME, constructor_timeout);
 671         if (ret) {
 672                 return -1;
 673         }
 674         constructor_timeout->tv_sec += constructor_delay_ms / 1000UL;
 675         constructor_timeout->tv_nsec +=
 676                 (constructor_delay_ms % 1000UL) * 1000000UL;
 677         if (constructor_timeout->tv_nsec >= 1000000000UL) {
 678                 constructor_timeout->tv_sec++;
 679                 constructor_timeout->tv_nsec -= 1000000000UL;
 680         }
 681         return 1;
 682 }
 683
 684 /*
 685  * sessiond monitoring thread: monitor presence of global and per-user
 686  * sessiond by polling the application common named pipe.
 687  */
 688 /* TODO */
 689
 690 void __attribute__((constructor)) lttng_ust_init(void)
 691 {
 692         struct timespec constructor_timeout;
 693         int timeout_mode;
 694         int ret;
 695
 696         if (uatomic_xchg(&initialized, 1) == 1)
 697                 return;
 698
 699         /*
 700          * We want precise control over the order in which we construct
 701          * our sub-libraries vs starting to receive commands from
 702          * sessiond (otherwise leading to errors when trying to create
 703          * sessiond before the init functions are completed).
 704          */
 705         init_usterr();
 706         init_tracepoint();
 707         ltt_ring_buffer_metadata_client_init();
 708         ltt_ring_buffer_client_overwrite_init();
 709         ltt_ring_buffer_client_discard_init();
 710
 711         timeout_mode = get_timeout(&constructor_timeout);
 712
 713         ret = sem_init(&constructor_wait, 0, 0);
 714         assert(!ret);
 715
 716         ret = setup_local_apps();
 717         if (ret) {
 718                 ERR("Error setting up to local apps");
 719         }
 720         ret = pthread_create(&local_apps.ust_listener, NULL,
 721                         ust_listener_thread, &local_apps);
 722
 723         if (local_apps.allowed) {
 724                 ret = pthread_create(&global_apps.ust_listener, NULL,
 725                                 ust_listener_thread, &global_apps);
 726         } else {
 727                 handle_register_done(&local_apps);
 728         }
 729
 730         switch (timeout_mode) {
 731         case 1: /* timeout wait */
 732                 do {
 733                         ret = sem_timedwait(&constructor_wait,
 734                                         &constructor_timeout);
 735                 } while (ret < 0 && errno == EINTR);
 736                 if (ret < 0 && errno == ETIMEDOUT) {
 737                         ERR("Timed out waiting for ltt-sessiond");
 738                 } else {
 739                         assert(!ret);
 740                 }
 741                 break;
 742         case -1:/* wait forever */
 743                 do {
 744                         ret = sem_wait(&constructor_wait);
 745                 } while (ret < 0 && errno == EINTR);
 746                 assert(!ret);
 747                 break;
 748         case 0: /* no timeout */
 749                 break;
 750         }
 751 }
 752
 753 static
 754 void lttng_ust_cleanup(int exiting)
 755 {
 756         cleanup_sock_info(&global_apps);
 757         if (local_apps.allowed) {
 758                 cleanup_sock_info(&local_apps);
 759         }
 760         lttng_ust_abi_exit();
 761         ltt_events_exit();
 762         ltt_ring_buffer_client_discard_exit();
 763         ltt_ring_buffer_client_overwrite_exit();
 764         ltt_ring_buffer_metadata_client_exit();
 765         exit_tracepoint();
 766         if (!exiting) {
 767                 /* Reinitialize values for fork */
 768                 sem_count = 2;
 769                 lttng_ust_comm_should_quit = 0;
 770                 initialized = 0;
 771         }
 772 }
 773
 774 void __attribute__((destructor)) lttng_ust_exit(void)
 775 {
 776         int ret;
 777
 778         /*
 779          * Using pthread_cancel here because:
 780          * A) we don't want to hang application teardown.
 781          * B) the thread is not allocating any resource.
 782          */
 783
 784         /*
 785          * Require the communication thread to quit. Synchronize with
 786          * mutexes to ensure it is not in a mutex critical section when
 787          * pthread_cancel is later called.
 788          */
 789         ust_lock();
 790         lttng_ust_comm_should_quit = 1;
 791         ust_unlock();
 792
 793         ret = pthread_cancel(global_apps.ust_listener);
 794         if (ret) {
 795                 ERR("Error cancelling global ust listener thread");
 796         }
 797         if (local_apps.allowed) {
 798                 ret = pthread_cancel(local_apps.ust_listener);
 799                 if (ret) {
 800                         ERR("Error cancelling local ust listener thread");
 801                 }
 802         }
 803         lttng_ust_cleanup(1);
 804 }
 805
 806 /*
 807  * We exclude the worker threads across fork and clone (except
 808  * CLONE_VM), because these system calls only keep the forking thread
 809  * running in the child.  Therefore, we don't want to call fork or clone
 810  * in the middle of an tracepoint or ust tracing state modification.
 811  * Holding this mutex protects these structures across fork and clone.
 812  */
 813 void ust_before_fork(ust_fork_info_t *fork_info)
 814 {
 815         /*
 816          * Disable signals. This is to avoid that the child intervenes
 817          * before it is properly setup for tracing. It is safer to
 818          * disable all signals, because then we know we are not breaking
 819          * anything by restoring the original mask.
 820          */
 821         sigset_t all_sigs;
 822         int ret;
 823
 824         /* Disable signals */
 825         sigfillset(&all_sigs);
 826         ret = sigprocmask(SIG_BLOCK, &all_sigs, &fork_info->orig_sigs);
 827         if (ret == -1) {
 828                 PERROR("sigprocmask");
 829         }
 830         ust_lock();
 831         rcu_bp_before_fork();
 832 }
 833
 834 static void ust_after_fork_common(ust_fork_info_t *fork_info)
 835 {
 836         int ret;
 837
 838         DBG("process %d", getpid());
 839         ust_unlock();
 840         /* Restore signals */
 841         ret = sigprocmask(SIG_SETMASK, &fork_info->orig_sigs, NULL);
 842         if (ret == -1) {
 843                 PERROR("sigprocmask");
 844         }
 845 }
 846
 847 void ust_after_fork_parent(ust_fork_info_t *fork_info)
 848 {
 849         DBG("process %d", getpid());
 850         rcu_bp_after_fork_parent();
 851         /* Release mutexes and reenable signals */
 852         ust_after_fork_common(fork_info);
 853 }
 854
 855 /*
 856  * After fork, in the child, we need to cleanup all the leftover state,
 857  * except the worker thread which already magically disappeared thanks
 858  * to the weird Linux fork semantics. After tyding up, we call
 859  * lttng_ust_init() again to start over as a new PID.
 860  *
 861  * This is meant for forks() that have tracing in the child between the
 862  * fork and following exec call (if there is any).
 863  */
 864 void ust_after_fork_child(ust_fork_info_t *fork_info)
 865 {
 866         DBG("process %d", getpid());
 867         /* Release urcu mutexes */
 868         rcu_bp_after_fork_child();
 869         lttng_ust_cleanup(0);
 870         /* Release mutexes and reenable signals */
 871         ust_after_fork_common(fork_info);
 872         lttng_ust_init();
 873 }