liblttng-ust/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 #include <urcu/compiler.h>
  41
  42 #include <lttng/ust-events.h>
  43 #include <lttng/ust-abi.h>
  44 #include <lttng/ust.h>
  45 #include <ust-comm.h>
  46 #include <usterr-signal-safe.h>
  47 #include "tracepoint-internal.h"
  48 #include "ltt-tracer-core.h"
  49
  50 /*
  51  * Has lttng ust comm constructor been called ?
  52  */
  53 static int initialized;
  54
  55 /*
  56  * The ust_lock/ust_unlock lock is used as a communication thread mutex.
  57  * Held when handling a command, also held by fork() to deal with
  58  * removal of threads, and by exit path.
  59  */
  60
  61 /* Should the ust comm thread quit ? */
  62 static int lttng_ust_comm_should_quit;
  63
  64 /*
  65  * Wait for either of these before continuing to the main
  66  * program:
  67  * - the register_done message from sessiond daemon
  68  *   (will let the sessiond daemon enable sessions before main
  69  *   starts.)
  70  * - sessiond daemon is not reachable.
  71  * - timeout (ensuring applications are resilient to session
  72  *   daemon problems).
  73  */
  74 static sem_t constructor_wait;
  75 /*
  76  * Doing this for both the global and local sessiond.
  77  */
  78 static int sem_count = { 2 };
  79
  80 /*
  81  * Info about socket and associated listener thread.
  82  */
  83 struct sock_info {
  84         const char *name;
  85         pthread_t ust_listener; /* listener thread */
  86         int root_handle;
  87         int constructor_sem_posted;
  88         int allowed;
  89         int global;
  90
  91         char sock_path[PATH_MAX];
  92         int socket;
  93
  94         char wait_shm_path[PATH_MAX];
  95         char *wait_shm_mmap;
  96 };
  97
  98 /* Socket from app (connect) to session daemon (listen) for communication */
  99 struct sock_info global_apps = {
 100         .name = "global",
 101         .global = 1,
 102
 103         .root_handle = -1,
 104         .allowed = 1,
 105
 106         .sock_path = DEFAULT_GLOBAL_APPS_UNIX_SOCK,
 107         .socket = -1,
 108
 109         .wait_shm_path = DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH,
 110 };
 111
 112 /* TODO: allow global_apps_sock_path override */
 113
 114 struct sock_info local_apps = {
 115         .name = "local",
 116         .global = 0,
 117         .root_handle = -1,
 118         .allowed = 0,   /* Check setuid bit first */
 119
 120         .socket = -1,
 121 };
 122
 123 static int wait_poll_fallback;
 124
 125 extern void ltt_ring_buffer_client_overwrite_init(void);
 126 extern void ltt_ring_buffer_client_discard_init(void);
 127 extern void ltt_ring_buffer_metadata_client_init(void);
 128 extern void ltt_ring_buffer_client_overwrite_exit(void);
 129 extern void ltt_ring_buffer_client_discard_exit(void);
 130 extern void ltt_ring_buffer_metadata_client_exit(void);
 131
 132 static
 133 int setup_local_apps(void)
 134 {
 135         const char *home_dir;
 136         uid_t uid;
 137
 138         uid = getuid();
 139         /*
 140          * Disallow per-user tracing for setuid binaries.
 141          */
 142         if (uid != geteuid()) {
 143                 local_apps.allowed = 0;
 144                 return 0;
 145         } else {
 146                 local_apps.allowed = 1;
 147         }
 148         home_dir = (const char *) getenv("HOME");
 149         if (!home_dir)
 150                 return -ENOENT;
 151         snprintf(local_apps.sock_path, PATH_MAX,
 152                  DEFAULT_HOME_APPS_UNIX_SOCK, home_dir);
 153         snprintf(local_apps.wait_shm_path, PATH_MAX,
 154                  DEFAULT_HOME_APPS_WAIT_SHM_PATH, uid);
 155         return 0;
 156 }
 157
 158 static
 159 int register_app_to_sessiond(int socket)
 160 {
 161         ssize_t ret;
 162         int prctl_ret;
 163         struct {
 164                 uint32_t major;
 165                 uint32_t minor;
 166                 pid_t pid;
 167                 pid_t ppid;
 168                 uid_t uid;
 169                 gid_t gid;
 170                 uint32_t bits_per_long;
 171                 char name[16];  /* process name */
 172         } reg_msg;
 173
 174         reg_msg.major = LTTNG_UST_COMM_VERSION_MAJOR;
 175         reg_msg.minor = LTTNG_UST_COMM_VERSION_MINOR;
 176         reg_msg.pid = getpid();
 177         reg_msg.ppid = getppid();
 178         reg_msg.uid = getuid();
 179         reg_msg.gid = getgid();
 180         reg_msg.bits_per_long = CAA_BITS_PER_LONG;
 181         prctl_ret = prctl(PR_GET_NAME, (unsigned long) reg_msg.name, 0, 0, 0);
 182         if (prctl_ret) {
 183                 ERR("Error executing prctl");
 184                 return -errno;
 185         }
 186
 187         ret = ustcomm_send_unix_sock(socket, &reg_msg, sizeof(reg_msg));
 188         if (ret >= 0 && ret != sizeof(reg_msg))
 189                 return -EIO;
 190         return ret;
 191 }
 192
 193 static
 194 int send_reply(int sock, struct ustcomm_ust_reply *lur)
 195 {
 196         ssize_t len;
 197
 198         len = ustcomm_send_unix_sock(sock, lur, sizeof(*lur));
 199         switch (len) {
 200         case sizeof(*lur):
 201                 DBG("message successfully sent");
 202                 return 0;
 203         case -1:
 204                 if (errno == ECONNRESET) {
 205                         printf("remote end closed connection\n");
 206                         return 0;
 207                 }
 208                 return -1;
 209         default:
 210                 printf("incorrect message size: %zd\n", len);
 211                 return -1;
 212         }
 213 }
 214
 215 static
 216 int handle_register_done(struct sock_info *sock_info)
 217 {
 218         int ret;
 219
 220         if (sock_info->constructor_sem_posted)
 221                 return 0;
 222         sock_info->constructor_sem_posted = 1;
 223         if (uatomic_read(&sem_count) <= 0) {
 224                 return 0;
 225         }
 226         ret = uatomic_add_return(&sem_count, -1);
 227         if (ret == 0) {
 228                 ret = sem_post(&constructor_wait);
 229                 assert(!ret);
 230         }
 231         return 0;
 232 }
 233
 234 static
 235 int handle_message(struct sock_info *sock_info,
 236                 int sock, struct ustcomm_ust_msg *lum)
 237 {
 238         int ret = 0;
 239         const struct lttng_ust_objd_ops *ops;
 240         struct ustcomm_ust_reply lur;
 241         int shm_fd, wait_fd;
 242         union ust_args args;
 243
 244         ust_lock();
 245
 246         memset(&lur, 0, sizeof(lur));
 247
 248         if (lttng_ust_comm_should_quit) {
 249                 ret = -EPERM;
 250                 goto end;
 251         }
 252
 253         ops = objd_ops(lum->handle);
 254         if (!ops) {
 255                 ret = -ENOENT;
 256                 goto end;
 257         }
 258
 259         switch (lum->cmd) {
 260         case LTTNG_UST_REGISTER_DONE:
 261                 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
 262                         ret = handle_register_done(sock_info);
 263                 else
 264                         ret = -EINVAL;
 265                 break;
 266         case LTTNG_UST_RELEASE:
 267                 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
 268                         ret = -EPERM;
 269                 else
 270                         ret = lttng_ust_objd_unref(lum->handle);
 271                 break;
 272         default:
 273                 if (ops->cmd)
 274                         ret = ops->cmd(lum->handle, lum->cmd,
 275                                         (unsigned long) &lum->u,
 276                                         &args);
 277                 else
 278                         ret = -ENOSYS;
 279                 break;
 280         }
 281
 282 end:
 283         lur.handle = lum->handle;
 284         lur.cmd = lum->cmd;
 285         lur.ret_val = ret;
 286         if (ret >= 0) {
 287                 lur.ret_code = USTCOMM_OK;
 288         } else {
 289                 //lur.ret_code = USTCOMM_SESSION_FAIL;
 290                 lur.ret_code = ret;
 291         }
 292         switch (lum->cmd) {
 293         case LTTNG_UST_STREAM:
 294                 /*
 295                  * Special-case reply to send stream info.
 296                  * Use lum.u output.
 297                  */
 298                 lur.u.stream.memory_map_size = *args.stream.memory_map_size;
 299                 shm_fd = *args.stream.shm_fd;
 300                 wait_fd = *args.stream.wait_fd;
 301                 break;
 302         case LTTNG_UST_METADATA:
 303         case LTTNG_UST_CHANNEL:
 304                 lur.u.channel.memory_map_size = *args.channel.memory_map_size;
 305                 shm_fd = *args.channel.shm_fd;
 306                 wait_fd = *args.channel.wait_fd;
 307                 break;
 308         case LTTNG_UST_TRACER_VERSION:
 309                 lur.u.version = lum->u.version;
 310                 break;
 311         case LTTNG_UST_TRACEPOINT_LIST_GET:
 312                 memcpy(&lur.u.tracepoint, &lum->u.tracepoint, sizeof(lur.u.tracepoint));
 313                 break;
 314         }
 315         ret = send_reply(sock, &lur);
 316         if (ret < 0) {
 317                 perror("error sending reply");
 318                 goto error;
 319         }
 320
 321         if ((lum->cmd == LTTNG_UST_STREAM
 322              || lum->cmd == LTTNG_UST_CHANNEL
 323              || lum->cmd == LTTNG_UST_METADATA)
 324                         && lur.ret_code == USTCOMM_OK) {
 325                 /* we also need to send the file descriptors. */
 326                 ret = ustcomm_send_fds_unix_sock(sock,
 327                         &shm_fd, &shm_fd,
 328                         1, sizeof(int));
 329                 if (ret < 0) {
 330                         perror("send shm_fd");
 331                         goto error;
 332                 }
 333                 ret = ustcomm_send_fds_unix_sock(sock,
 334                         &wait_fd, &wait_fd,
 335                         1, sizeof(int));
 336                 if (ret < 0) {
 337                         perror("send wait_fd");
 338                         goto error;
 339                 }
 340         }
 341         /*
 342          * We still have the memory map reference, and the fds have been
 343          * sent to the sessiond. We can therefore close those fds. Note
 344          * that we keep the write side of the wait_fd open, but close
 345          * the read side.
 346          */
 347         if (lur.ret_code == USTCOMM_OK) {
 348                 switch (lum->cmd) {
 349                 case LTTNG_UST_STREAM:
 350                         if (shm_fd >= 0) {
 351                                 ret = close(shm_fd);
 352                                 if (ret) {
 353                                         PERROR("Error closing stream shm_fd");
 354                                 }
 355                                 *args.stream.shm_fd = -1;
 356                         }
 357                         if (wait_fd >= 0) {
 358                                 ret = close(wait_fd);
 359                                 if (ret) {
 360                                         PERROR("Error closing stream wait_fd");
 361                                 }
 362                                 *args.stream.wait_fd = -1;
 363                         }
 364                         break;
 365                 case LTTNG_UST_METADATA:
 366                 case LTTNG_UST_CHANNEL:
 367                         if (shm_fd >= 0) {
 368                                 ret = close(shm_fd);
 369                                 if (ret) {
 370                                         PERROR("Error closing channel shm_fd");
 371                                 }
 372                                 *args.channel.shm_fd = -1;
 373                         }
 374                         if (wait_fd >= 0) {
 375                                 ret = close(wait_fd);
 376                                 if (ret) {
 377                                         PERROR("Error closing channel wait_fd");
 378                                 }
 379                                 *args.channel.wait_fd = -1;
 380                         }
 381                         break;
 382                 }
 383         }
 384
 385 error:
 386         ust_unlock();
 387         return ret;
 388 }
 389
 390 static
 391 void cleanup_sock_info(struct sock_info *sock_info, int exiting)
 392 {
 393         int ret;
 394
 395         if (sock_info->socket != -1) {
 396                 ret = close(sock_info->socket);
 397                 if (ret) {
 398                         ERR("Error closing apps socket");
 399                 }
 400                 sock_info->socket = -1;
 401         }
 402         if (sock_info->root_handle != -1) {
 403                 ret = lttng_ust_objd_unref(sock_info->root_handle);
 404                 if (ret) {
 405                         ERR("Error unref root handle");
 406                 }
 407                 sock_info->root_handle = -1;
 408         }
 409         sock_info->constructor_sem_posted = 0;
 410         /*
 411          * wait_shm_mmap is used by listener threads outside of the
 412          * ust lock, so we cannot tear it down ourselves, because we
 413          * cannot join on these threads. Leave this task to the OS
 414          * process exit.
 415          */
 416         if (!exiting && sock_info->wait_shm_mmap) {
 417                 ret = munmap(sock_info->wait_shm_mmap, sysconf(_SC_PAGE_SIZE));
 418                 if (ret) {
 419                         ERR("Error unmapping wait shm");
 420                 }
 421                 sock_info->wait_shm_mmap = NULL;
 422         }
 423 }
 424
 425 /*
 426  * Using fork to set umask in the child process (not multi-thread safe).
 427  * We deal with the shm_open vs ftruncate race (happening when the
 428  * sessiond owns the shm and does not let everybody modify it, to ensure
 429  * safety against shm_unlink) by simply letting the mmap fail and
 430  * retrying after a few seconds.
 431  * For global shm, everybody has rw access to it until the sessiond
 432  * starts.
 433  */
 434 static
 435 int get_wait_shm(struct sock_info *sock_info, size_t mmap_size)
 436 {
 437         int wait_shm_fd, ret;
 438         pid_t pid;
 439
 440         /*
 441          * Try to open read-only.
 442          */
 443         wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
 444         if (wait_shm_fd >= 0) {
 445                 goto end;
 446         } else if (wait_shm_fd < 0 && errno != ENOENT) {
 447                 /*
 448                  * Real-only open did not work, and it's not because the
 449                  * entry was not present. It's a failure that prohibits
 450                  * using shm.
 451                  */
 452                 ERR("Error opening shm %s", sock_info->wait_shm_path);
 453                 goto end;
 454         }
 455         /*
 456          * If the open failed because the file did not exist, try
 457          * creating it ourself.
 458          */
 459         pid = fork();
 460         if (pid > 0) {
 461                 int status;
 462
 463                 /*
 464                  * Parent: wait for child to return, in which case the
 465                  * shared memory map will have been created.
 466                  */
 467                 pid = wait(&status);
 468                 if (pid < 0 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
 469                         wait_shm_fd = -1;
 470                         goto end;
 471                 }
 472                 /*
 473                  * Try to open read-only again after creation.
 474                  */
 475                 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
 476                 if (wait_shm_fd < 0) {
 477                         /*
 478                          * Real-only open did not work. It's a failure
 479                          * that prohibits using shm.
 480                          */
 481                         ERR("Error opening shm %s", sock_info->wait_shm_path);
 482                         goto end;
 483                 }
 484                 goto end;
 485         } else if (pid == 0) {
 486                 int create_mode;
 487
 488                 /* Child */
 489                 create_mode = S_IRUSR | S_IWUSR | S_IRGRP;
 490                 if (sock_info->global)
 491                         create_mode |= S_IROTH | S_IWGRP | S_IWOTH;
 492                 /*
 493                  * We're alone in a child process, so we can modify the
 494                  * process-wide umask.
 495                  */
 496                 umask(~create_mode);
 497                 /*
 498                  * Try creating shm (or get rw access).
 499                  * We don't do an exclusive open, because we allow other
 500                  * processes to create+ftruncate it concurrently.
 501                  */
 502                 wait_shm_fd = shm_open(sock_info->wait_shm_path,
 503                                 O_RDWR | O_CREAT, create_mode);
 504                 if (wait_shm_fd >= 0) {
 505                         ret = ftruncate(wait_shm_fd, mmap_size);
 506                         if (ret) {
 507                                 PERROR("ftruncate");
 508                                 exit(EXIT_FAILURE);
 509                         }
 510                         exit(EXIT_SUCCESS);
 511                 }
 512                 /*
 513                  * For local shm, we need to have rw access to accept
 514                  * opening it: this means the local sessiond will be
 515                  * able to wake us up. For global shm, we open it even
 516                  * if rw access is not granted, because the root.root
 517                  * sessiond will be able to override all rights and wake
 518                  * us up.
 519                  */
 520                 if (!sock_info->global && errno != EACCES) {
 521                         ERR("Error opening shm %s", sock_info->wait_shm_path);
 522                         exit(EXIT_FAILURE);
 523                 }
 524                 /*
 525                  * The shm exists, but we cannot open it RW. Report
 526                  * success.
 527                  */
 528                 exit(EXIT_SUCCESS);
 529         } else {
 530                 return -1;
 531         }
 532 end:
 533         if (wait_shm_fd >= 0 && !sock_info->global) {
 534                 struct stat statbuf;
 535
 536                 /*
 537                  * Ensure that our user is the owner of the shm file for
 538                  * local shm. If we do not own the file, it means our
 539                  * sessiond will not have access to wake us up (there is
 540                  * probably a rogue process trying to fake our
 541                  * sessiond). Fallback to polling method in this case.
 542                  */
 543                 ret = fstat(wait_shm_fd, &statbuf);
 544                 if (ret) {
 545                         PERROR("fstat");
 546                         goto error_close;
 547                 }
 548                 if (statbuf.st_uid != getuid())
 549                         goto error_close;
 550         }
 551         return wait_shm_fd;
 552
 553 error_close:
 554         ret = close(wait_shm_fd);
 555         if (ret) {
 556                 PERROR("Error closing fd");
 557         }
 558         return -1;
 559 }
 560
 561 static
 562 char *get_map_shm(struct sock_info *sock_info)
 563 {
 564         size_t mmap_size = sysconf(_SC_PAGE_SIZE);
 565         int wait_shm_fd, ret;
 566         char *wait_shm_mmap;
 567
 568         wait_shm_fd = get_wait_shm(sock_info, mmap_size);
 569         if (wait_shm_fd < 0) {
 570                 goto error;
 571         }
 572         wait_shm_mmap = mmap(NULL, mmap_size, PROT_READ,
 573                   MAP_SHARED, wait_shm_fd, 0);
 574         /* close shm fd immediately after taking the mmap reference */
 575         ret = close(wait_shm_fd);
 576         if (ret) {
 577                 PERROR("Error closing fd");
 578         }
 579         if (wait_shm_mmap == MAP_FAILED) {
 580                 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
 581                 goto error;
 582         }
 583         return wait_shm_mmap;
 584
 585 error:
 586         return NULL;
 587 }
 588
 589 static
 590 void wait_for_sessiond(struct sock_info *sock_info)
 591 {
 592         int ret;
 593
 594         ust_lock();
 595         if (lttng_ust_comm_should_quit) {
 596                 goto quit;
 597         }
 598         if (wait_poll_fallback) {
 599                 goto error;
 600         }
 601         if (!sock_info->wait_shm_mmap) {
 602                 sock_info->wait_shm_mmap = get_map_shm(sock_info);
 603                 if (!sock_info->wait_shm_mmap)
 604                         goto error;
 605         }
 606         ust_unlock();
 607
 608         DBG("Waiting for %s apps sessiond", sock_info->name);
 609         /* Wait for futex wakeup */
 610         if (uatomic_read((int32_t *) sock_info->wait_shm_mmap) == 0) {
 611                 ret = futex_async((int32_t *) sock_info->wait_shm_mmap,
 612                         FUTEX_WAIT, 0, NULL, NULL, 0);
 613                 if (ret < 0) {
 614                         if (errno == EFAULT) {
 615                                 wait_poll_fallback = 1;
 616                                 DBG(
 617 "Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
 618 "do not support FUTEX_WAKE on read-only memory mappings correctly. "
 619 "Please upgrade your kernel "
 620 "(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
 621 "mainline). LTTng-UST will use polling mode fallback.");
 622                                 if (ust_debug())
 623                                         PERROR("futex");
 624                         }
 625                 }
 626         }
 627         return;
 628
 629 quit:
 630         ust_unlock();
 631         return;
 632
 633 error:
 634         ust_unlock();
 635         return;
 636 }
 637
 638 /*
 639  * This thread does not allocate any resource, except within
 640  * handle_message, within mutex protection. This mutex protects against
 641  * fork and exit.
 642  * The other moment it allocates resources is at socket connexion, which
 643  * is also protected by the mutex.
 644  */
 645 static
 646 void *ust_listener_thread(void *arg)
 647 {
 648         struct sock_info *sock_info = arg;
 649         int sock, ret, prev_connect_failed = 0, has_waited = 0;
 650
 651         /* Restart trying to connect to the session daemon */
 652 restart:
 653         if (prev_connect_failed) {
 654                 /* Wait for sessiond availability with pipe */
 655                 wait_for_sessiond(sock_info);
 656                 if (has_waited) {
 657                         has_waited = 0;
 658                         /*
 659                          * Sleep for 5 seconds before retrying after a
 660                          * sequence of failure / wait / failure. This
 661                          * deals with a killed or broken session daemon.
 662                          */
 663                         sleep(5);
 664                 }
 665                 has_waited = 1;
 666                 prev_connect_failed = 0;
 667         }
 668         ust_lock();
 669
 670         if (lttng_ust_comm_should_quit) {
 671                 ust_unlock();
 672                 goto quit;
 673         }
 674
 675         if (sock_info->socket != -1) {
 676                 ret = close(sock_info->socket);
 677                 if (ret) {
 678                         ERR("Error closing %s apps socket", sock_info->name);
 679                 }
 680                 sock_info->socket = -1;
 681         }
 682
 683         /* Register */
 684         ret = ustcomm_connect_unix_sock(sock_info->sock_path);
 685         if (ret < 0) {
 686                 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
 687                 prev_connect_failed = 1;
 688                 /*
 689                  * If we cannot find the sessiond daemon, don't delay
 690                  * constructor execution.
 691                  */
 692                 ret = handle_register_done(sock_info);
 693                 assert(!ret);
 694                 ust_unlock();
 695                 goto restart;
 696         }
 697
 698         sock_info->socket = sock = ret;
 699
 700         /*
 701          * Create only one root handle per listener thread for the whole
 702          * process lifetime.
 703          */
 704         if (sock_info->root_handle == -1) {
 705                 ret = lttng_abi_create_root_handle();
 706                 if (ret < 0) {
 707                         ERR("Error creating root handle");
 708                         ust_unlock();
 709                         goto quit;
 710                 }
 711                 sock_info->root_handle = ret;
 712         }
 713
 714         ret = register_app_to_sessiond(sock);
 715         if (ret < 0) {
 716                 ERR("Error registering to %s apps socket", sock_info->name);
 717                 prev_connect_failed = 1;
 718                 /*
 719                  * If we cannot register to the sessiond daemon, don't
 720                  * delay constructor execution.
 721                  */
 722                 ret = handle_register_done(sock_info);
 723                 assert(!ret);
 724                 ust_unlock();
 725                 goto restart;
 726         }
 727         ust_unlock();
 728
 729         for (;;) {
 730                 ssize_t len;
 731                 struct ustcomm_ust_msg lum;
 732
 733                 len = ustcomm_recv_unix_sock(sock, &lum, sizeof(lum));
 734                 switch (len) {
 735                 case 0: /* orderly shutdown */
 736                         DBG("%s ltt-sessiond has performed an orderly shutdown\n", sock_info->name);
 737                         ust_lock();
 738                         /*
 739                          * Either sessiond has shutdown or refused us by closing the socket.
 740                          * In either case, we don't want to delay construction execution,
 741                          * and we need to wait before retry.
 742                          */
 743                         prev_connect_failed = 1;
 744                         /*
 745                          * If we cannot register to the sessiond daemon, don't
 746                          * delay constructor execution.
 747                          */
 748                         ret = handle_register_done(sock_info);
 749                         assert(!ret);
 750                         ust_unlock();
 751                         goto end;
 752                 case sizeof(lum):
 753                         DBG("message received\n");
 754                         ret = handle_message(sock_info, sock, &lum);
 755                         if (ret < 0) {
 756                                 ERR("Error handling message for %s socket", sock_info->name);
 757                         }
 758                         continue;
 759                 case -1:
 760                         DBG("Receive failed from lttng-sessiond with errno %d", errno);
 761                         if (errno == ECONNRESET) {
 762                                 ERR("%s remote end closed connection\n", sock_info->name);
 763                                 goto end;
 764                         }
 765                         goto end;
 766                 default:
 767                         ERR("incorrect message size (%s socket): %zd\n", sock_info->name, len);
 768                         continue;
 769                 }
 770
 771         }
 772 end:
 773         goto restart;   /* try to reconnect */
 774 quit:
 775         return NULL;
 776 }
 777
 778 /*
 779  * Return values: -1: don't wait. 0: wait forever. 1: timeout wait.
 780  */
 781 static
 782 int get_timeout(struct timespec *constructor_timeout)
 783 {
 784         long constructor_delay_ms = LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS;
 785         char *str_delay;
 786         int ret;
 787
 788         str_delay = getenv("LTTNG_UST_REGISTER_TIMEOUT");
 789         if (str_delay) {
 790                 constructor_delay_ms = strtol(str_delay, NULL, 10);
 791         }
 792
 793         switch (constructor_delay_ms) {
 794         case -1:/* fall-through */
 795         case 0:
 796                 return constructor_delay_ms;
 797         default:
 798                 break;
 799         }
 800
 801         /*
 802          * If we are unable to find the current time, don't wait.
 803          */
 804         ret = clock_gettime(CLOCK_REALTIME, constructor_timeout);
 805         if (ret) {
 806                 return -1;
 807         }
 808         constructor_timeout->tv_sec += constructor_delay_ms / 1000UL;
 809         constructor_timeout->tv_nsec +=
 810                 (constructor_delay_ms % 1000UL) * 1000000UL;
 811         if (constructor_timeout->tv_nsec >= 1000000000UL) {
 812                 constructor_timeout->tv_sec++;
 813                 constructor_timeout->tv_nsec -= 1000000000UL;
 814         }
 815         return 1;
 816 }
 817
 818 /*
 819  * sessiond monitoring thread: monitor presence of global and per-user
 820  * sessiond by polling the application common named pipe.
 821  */
 822 /* TODO */
 823
 824 void __attribute__((constructor)) lttng_ust_init(void)
 825 {
 826         struct timespec constructor_timeout;
 827         int timeout_mode;
 828         int ret;
 829
 830         if (uatomic_xchg(&initialized, 1) == 1)
 831                 return;
 832
 833         /*
 834          * We want precise control over the order in which we construct
 835          * our sub-libraries vs starting to receive commands from
 836          * sessiond (otherwise leading to errors when trying to create
 837          * sessiond before the init functions are completed).
 838          */
 839         init_usterr();
 840         init_tracepoint();
 841         ltt_ring_buffer_metadata_client_init();
 842         ltt_ring_buffer_client_overwrite_init();
 843         ltt_ring_buffer_client_discard_init();
 844
 845         timeout_mode = get_timeout(&constructor_timeout);
 846
 847         ret = sem_init(&constructor_wait, 0, 0);
 848         assert(!ret);
 849
 850         ret = setup_local_apps();
 851         if (ret) {
 852                 ERR("Error setting up to local apps");
 853         }
 854         ret = pthread_create(&local_apps.ust_listener, NULL,
 855                         ust_listener_thread, &local_apps);
 856
 857         if (local_apps.allowed) {
 858                 ret = pthread_create(&global_apps.ust_listener, NULL,
 859                                 ust_listener_thread, &global_apps);
 860         } else {
 861                 handle_register_done(&local_apps);
 862         }
 863
 864         switch (timeout_mode) {
 865         case 1: /* timeout wait */
 866                 do {
 867                         ret = sem_timedwait(&constructor_wait,
 868                                         &constructor_timeout);
 869                 } while (ret < 0 && errno == EINTR);
 870                 if (ret < 0 && errno == ETIMEDOUT) {
 871                         ERR("Timed out waiting for ltt-sessiond");
 872                 } else {
 873                         assert(!ret);
 874                 }
 875                 break;
 876         case -1:/* wait forever */
 877                 do {
 878                         ret = sem_wait(&constructor_wait);
 879                 } while (ret < 0 && errno == EINTR);
 880                 assert(!ret);
 881                 break;
 882         case 0: /* no timeout */
 883                 break;
 884         }
 885 }
 886
 887 static
 888 void lttng_ust_cleanup(int exiting)
 889 {
 890         cleanup_sock_info(&global_apps, exiting);
 891         if (local_apps.allowed) {
 892                 cleanup_sock_info(&local_apps, exiting);
 893         }
 894         /*
 895          * The teardown in this function all affect data structures
 896          * accessed under the UST lock by the listener thread. This
 897          * lock, along with the lttng_ust_comm_should_quit flag, ensure
 898          * that none of these threads are accessing this data at this
 899          * point.
 900          */
 901         lttng_ust_abi_exit();
 902         lttng_ust_events_exit();
 903         ltt_ring_buffer_client_discard_exit();
 904         ltt_ring_buffer_client_overwrite_exit();
 905         ltt_ring_buffer_metadata_client_exit();
 906         exit_tracepoint();
 907         if (!exiting) {
 908                 /* Reinitialize values for fork */
 909                 sem_count = 2;
 910                 lttng_ust_comm_should_quit = 0;
 911                 initialized = 0;
 912         }
 913 }
 914
 915 void __attribute__((destructor)) lttng_ust_exit(void)
 916 {
 917         int ret;
 918
 919         /*
 920          * Using pthread_cancel here because:
 921          * A) we don't want to hang application teardown.
 922          * B) the thread is not allocating any resource.
 923          */
 924
 925         /*
 926          * Require the communication thread to quit. Synchronize with
 927          * mutexes to ensure it is not in a mutex critical section when
 928          * pthread_cancel is later called.
 929          */
 930         ust_lock();
 931         lttng_ust_comm_should_quit = 1;
 932         ust_unlock();
 933
 934         /* cancel threads */
 935         ret = pthread_cancel(global_apps.ust_listener);
 936         if (ret) {
 937                 ERR("Error cancelling global ust listener thread");
 938         }
 939         if (local_apps.allowed) {
 940                 ret = pthread_cancel(local_apps.ust_listener);
 941                 if (ret) {
 942                         ERR("Error cancelling local ust listener thread");
 943                 }
 944         }
 945         /*
 946          * Do NOT join threads: use of sys_futex makes it impossible to
 947          * join the threads without using async-cancel, but async-cancel
 948          * is delivered by a signal, which could hit the target thread
 949          * anywhere in its code path, including while the ust_lock() is
 950          * held, causing a deadlock for the other thread. Let the OS
 951          * cleanup the threads if there are stalled in a syscall.
 952          */
 953         lttng_ust_cleanup(1);
 954 }
 955
 956 /*
 957  * We exclude the worker threads across fork and clone (except
 958  * CLONE_VM), because these system calls only keep the forking thread
 959  * running in the child.  Therefore, we don't want to call fork or clone
 960  * in the middle of an tracepoint or ust tracing state modification.
 961  * Holding this mutex protects these structures across fork and clone.
 962  */
 963 void ust_before_fork(sigset_t *save_sigset)
 964 {
 965         /*
 966          * Disable signals. This is to avoid that the child intervenes
 967          * before it is properly setup for tracing. It is safer to
 968          * disable all signals, because then we know we are not breaking
 969          * anything by restoring the original mask.
 970          */
 971         sigset_t all_sigs;
 972         int ret;
 973
 974         /* Disable signals */
 975         sigfillset(&all_sigs);
 976         ret = sigprocmask(SIG_BLOCK, &all_sigs, save_sigset);
 977         if (ret == -1) {
 978                 PERROR("sigprocmask");
 979         }
 980         ust_lock();
 981         rcu_bp_before_fork();
 982 }
 983
 984 static void ust_after_fork_common(sigset_t *restore_sigset)
 985 {
 986         int ret;
 987
 988         DBG("process %d", getpid());
 989         ust_unlock();
 990         /* Restore signals */
 991         ret = sigprocmask(SIG_SETMASK, restore_sigset, NULL);
 992         if (ret == -1) {
 993                 PERROR("sigprocmask");
 994         }
 995 }
 996
 997 void ust_after_fork_parent(sigset_t *restore_sigset)
 998 {
 999         DBG("process %d", getpid());
1000         rcu_bp_after_fork_parent();
1001         /* Release mutexes and reenable signals */
1002         ust_after_fork_common(restore_sigset);
1003 }
1004
1005 /*
1006  * After fork, in the child, we need to cleanup all the leftover state,
1007  * except the worker thread which already magically disappeared thanks
1008  * to the weird Linux fork semantics. After tyding up, we call
1009  * lttng_ust_init() again to start over as a new PID.
1010  *
1011  * This is meant for forks() that have tracing in the child between the
1012  * fork and following exec call (if there is any).
1013  */
1014 void ust_after_fork_child(sigset_t *restore_sigset)
1015 {
1016         DBG("process %d", getpid());
1017         /* Release urcu mutexes */
1018         rcu_bp_after_fork_child();
1019         lttng_ust_cleanup(0);
1020         lttng_context_vtid_reset();
1021         /* Release mutexes and reenable signals */
1022         ust_after_fork_common(restore_sigset);
1023         lttng_ust_init();
1024 }