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 #define _GNU_SOURCE
  24 #include <sys/types.h>
  25 #include <sys/socket.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 <lttng/ust-error.h>
  46 #include <lttng/ust-ctl.h>
  47 #include <urcu/tls-compat.h>
  48 #include <ust-comm.h>
  49 #include <usterr-signal-safe.h>
  50 #include <helper.h>
  51 #include "tracepoint-internal.h"
  52 #include "lttng-tracer-core.h"
  53 #include "compat.h"
  54 #include "../libringbuffer/tlsfixup.h"
  55 #include "lttng-ust-statedump.h"
  56 #include "clock.h"
  57 #include "../libringbuffer/getcpu.h"
  58 #include "getenv.h"
  59
  60 /*
  61  * Has lttng ust comm constructor been called ?
  62  */
  63 static int initialized;
  64
  65 /*
  66  * The ust_lock/ust_unlock lock is used as a communication thread mutex.
  67  * Held when handling a command, also held by fork() to deal with
  68  * removal of threads, and by exit path.
  69  *
  70  * The UST lock is the centralized mutex across UST tracing control and
  71  * probe registration.
  72  *
  73  * ust_exit_mutex must never nest in ust_mutex.
  74  *
  75  * ust_fork_mutex must never nest in ust_mutex.
  76  *
  77  * ust_mutex_nest is a per-thread nesting counter, allowing the perf
  78  * counter lazy initialization called by events within the statedump,
  79  * which traces while the ust_mutex is held.
  80  *
  81  * ust_lock nests within the dynamic loader lock (within glibc) because
  82  * it is taken within the library constructor.
  83  */
  84 static pthread_mutex_t ust_mutex = PTHREAD_MUTEX_INITIALIZER;
  85
  86 /* Allow nesting the ust_mutex within the same thread. */
  87 static DEFINE_URCU_TLS(int, ust_mutex_nest);
  88
  89 /*
  90  * ust_exit_mutex protects thread_active variable wrt thread exit. It
  91  * cannot be done by ust_mutex because pthread_cancel(), which takes an
  92  * internal libc lock, cannot nest within ust_mutex.
  93  *
  94  * It never nests within a ust_mutex.
  95  */
  96 static pthread_mutex_t ust_exit_mutex = PTHREAD_MUTEX_INITIALIZER;
  97
  98 /*
  99  * ust_fork_mutex protects base address statedump tracing against forks. It
 100  * prevents the dynamic loader lock to be taken (by base address statedump
 101  * tracing) while a fork is happening, thus preventing deadlock issues with
 102  * the dynamic loader lock.
 103  */
 104 static pthread_mutex_t ust_fork_mutex = PTHREAD_MUTEX_INITIALIZER;
 105
 106 /* Should the ust comm thread quit ? */
 107 static int lttng_ust_comm_should_quit;
 108
 109 /*
 110  * Return 0 on success, -1 if should quit.
 111  * The lock is taken in both cases.
 112  * Signal-safe.
 113  */
 114 int ust_lock(void)
 115 {
 116         sigset_t sig_all_blocked, orig_mask;
 117         int ret, oldstate;
 118
 119         ret = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &oldstate);
 120         if (ret) {
 121                 ERR("pthread_setcancelstate: %s", strerror(ret));
 122         }
 123         if (oldstate != PTHREAD_CANCEL_ENABLE) {
 124                 ERR("pthread_setcancelstate: unexpected oldstate");
 125         }
 126         sigfillset(&sig_all_blocked);
 127         ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
 128         if (ret) {
 129                 ERR("pthread_sigmask: %s", strerror(ret));
 130         }
 131         if (!URCU_TLS(ust_mutex_nest)++)
 132                 pthread_mutex_lock(&ust_mutex);
 133         ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
 134         if (ret) {
 135                 ERR("pthread_sigmask: %s", strerror(ret));
 136         }
 137         if (lttng_ust_comm_should_quit) {
 138                 return -1;
 139         } else {
 140                 return 0;
 141         }
 142 }
 143
 144 /*
 145  * ust_lock_nocheck() can be used in constructors/destructors, because
 146  * they are already nested within the dynamic loader lock, and therefore
 147  * have exclusive access against execution of liblttng-ust destructor.
 148  * Signal-safe.
 149  */
 150 void ust_lock_nocheck(void)
 151 {
 152         sigset_t sig_all_blocked, orig_mask;
 153         int ret, oldstate;
 154
 155         ret = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &oldstate);
 156         if (ret) {
 157                 ERR("pthread_setcancelstate: %s", strerror(ret));
 158         }
 159         if (oldstate != PTHREAD_CANCEL_ENABLE) {
 160                 ERR("pthread_setcancelstate: unexpected oldstate");
 161         }
 162         sigfillset(&sig_all_blocked);
 163         ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
 164         if (ret) {
 165                 ERR("pthread_sigmask: %s", strerror(ret));
 166         }
 167         if (!URCU_TLS(ust_mutex_nest)++)
 168                 pthread_mutex_lock(&ust_mutex);
 169         ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
 170         if (ret) {
 171                 ERR("pthread_sigmask: %s", strerror(ret));
 172         }
 173 }
 174
 175 /*
 176  * Signal-safe.
 177  */
 178 void ust_unlock(void)
 179 {
 180         sigset_t sig_all_blocked, orig_mask;
 181         int ret, oldstate;
 182
 183         sigfillset(&sig_all_blocked);
 184         ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
 185         if (ret) {
 186                 ERR("pthread_sigmask: %s", strerror(ret));
 187         }
 188         if (!--URCU_TLS(ust_mutex_nest))
 189                 pthread_mutex_unlock(&ust_mutex);
 190         ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
 191         if (ret) {
 192                 ERR("pthread_sigmask: %s", strerror(ret));
 193         }
 194         ret = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldstate);
 195         if (ret) {
 196                 ERR("pthread_setcancelstate: %s", strerror(ret));
 197         }
 198         if (oldstate != PTHREAD_CANCEL_DISABLE) {
 199                 ERR("pthread_setcancelstate: unexpected oldstate");
 200         }
 201 }
 202
 203 /*
 204  * Wait for either of these before continuing to the main
 205  * program:
 206  * - the register_done message from sessiond daemon
 207  *   (will let the sessiond daemon enable sessions before main
 208  *   starts.)
 209  * - sessiond daemon is not reachable.
 210  * - timeout (ensuring applications are resilient to session
 211  *   daemon problems).
 212  */
 213 static sem_t constructor_wait;
 214 /*
 215  * Doing this for both the global and local sessiond.
 216  */
 217 static int sem_count = { 2 };
 218
 219 /*
 220  * Counting nesting within lttng-ust. Used to ensure that calling fork()
 221  * from liblttng-ust does not execute the pre/post fork handlers.
 222  */
 223 static DEFINE_URCU_TLS(int, lttng_ust_nest_count);
 224
 225 /*
 226  * Info about socket and associated listener thread.
 227  */
 228 struct sock_info {
 229         const char *name;
 230         pthread_t ust_listener; /* listener thread */
 231         int root_handle;
 232         int constructor_sem_posted;
 233         int allowed;
 234         int global;
 235         int thread_active;
 236
 237         char sock_path[PATH_MAX];
 238         int socket;
 239         int notify_socket;
 240
 241         char wait_shm_path[PATH_MAX];
 242         char *wait_shm_mmap;
 243         /* Keep track of lazy state dump not performed yet. */
 244         int statedump_pending;
 245 };
 246
 247 /* Socket from app (connect) to session daemon (listen) for communication */
 248 struct sock_info global_apps = {
 249         .name = "global",
 250         .global = 1,
 251
 252         .root_handle = -1,
 253         .allowed = 1,
 254         .thread_active = 0,
 255
 256         .sock_path = LTTNG_DEFAULT_RUNDIR "/" LTTNG_UST_SOCK_FILENAME,
 257         .socket = -1,
 258         .notify_socket = -1,
 259
 260         .wait_shm_path = "/" LTTNG_UST_WAIT_FILENAME,
 261
 262         .statedump_pending = 0,
 263 };
 264
 265 /* TODO: allow global_apps_sock_path override */
 266
 267 struct sock_info local_apps = {
 268         .name = "local",
 269         .global = 0,
 270         .root_handle = -1,
 271         .allowed = 0,   /* Check setuid bit first */
 272         .thread_active = 0,
 273
 274         .socket = -1,
 275         .notify_socket = -1,
 276
 277         .statedump_pending = 0,
 278 };
 279
 280 static int wait_poll_fallback;
 281
 282 static const char *cmd_name_mapping[] = {
 283         [ LTTNG_UST_RELEASE ] = "Release",
 284         [ LTTNG_UST_SESSION ] = "Create Session",
 285         [ LTTNG_UST_TRACER_VERSION ] = "Get Tracer Version",
 286
 287         [ LTTNG_UST_TRACEPOINT_LIST ] = "Create Tracepoint List",
 288         [ LTTNG_UST_WAIT_QUIESCENT ] = "Wait for Quiescent State",
 289         [ LTTNG_UST_REGISTER_DONE ] = "Registration Done",
 290         [ LTTNG_UST_TRACEPOINT_FIELD_LIST ] = "Create Tracepoint Field List",
 291
 292         /* Session FD commands */
 293         [ LTTNG_UST_CHANNEL ] = "Create Channel",
 294         [ LTTNG_UST_SESSION_START ] = "Start Session",
 295         [ LTTNG_UST_SESSION_STOP ] = "Stop Session",
 296
 297         /* Channel FD commands */
 298         [ LTTNG_UST_STREAM ] = "Create Stream",
 299         [ LTTNG_UST_EVENT ] = "Create Event",
 300
 301         /* Event and Channel FD commands */
 302         [ LTTNG_UST_CONTEXT ] = "Create Context",
 303         [ LTTNG_UST_FLUSH_BUFFER ] = "Flush Buffer",
 304
 305         /* Event, Channel and Session commands */
 306         [ LTTNG_UST_ENABLE ] = "Enable",
 307         [ LTTNG_UST_DISABLE ] = "Disable",
 308
 309         /* Tracepoint list commands */
 310         [ LTTNG_UST_TRACEPOINT_LIST_GET ] = "List Next Tracepoint",
 311         [ LTTNG_UST_TRACEPOINT_FIELD_LIST_GET ] = "List Next Tracepoint Field",
 312
 313         /* Event FD commands */
 314         [ LTTNG_UST_FILTER ] = "Create Filter",
 315         [ LTTNG_UST_EXCLUSION ] = "Add exclusions to event",
 316 };
 317
 318 static const char *str_timeout;
 319 static int got_timeout_env;
 320
 321 extern void lttng_ring_buffer_client_overwrite_init(void);
 322 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
 323 extern void lttng_ring_buffer_client_discard_init(void);
 324 extern void lttng_ring_buffer_client_discard_rt_init(void);
 325 extern void lttng_ring_buffer_metadata_client_init(void);
 326 extern void lttng_ring_buffer_client_overwrite_exit(void);
 327 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
 328 extern void lttng_ring_buffer_client_discard_exit(void);
 329 extern void lttng_ring_buffer_client_discard_rt_exit(void);
 330 extern void lttng_ring_buffer_metadata_client_exit(void);
 331
 332 ssize_t lttng_ust_read(int fd, void *buf, size_t len)
 333 {
 334         ssize_t ret;
 335         size_t copied = 0, to_copy = len;
 336
 337         do {
 338                 ret = read(fd, buf + copied, to_copy);
 339                 if (ret > 0) {
 340                         copied += ret;
 341                         to_copy -= ret;
 342                 }
 343         } while ((ret > 0 && to_copy > 0)
 344                 || (ret < 0 && errno == EINTR));
 345         if (ret > 0) {
 346                 ret = copied;
 347         }
 348         return ret;
 349 }
 350 /*
 351  * Returns the HOME directory path. Caller MUST NOT free(3) the returned
 352  * pointer.
 353  */
 354 static
 355 const char *get_lttng_home_dir(void)
 356 {
 357        const char *val;
 358
 359        val = (const char *) lttng_secure_getenv("LTTNG_HOME");
 360        if (val != NULL) {
 361                return val;
 362        }
 363        return (const char *) lttng_secure_getenv("HOME");
 364 }
 365
 366 /*
 367  * Force a read (imply TLS fixup for dlopen) of TLS variables.
 368  */
 369 static
 370 void lttng_fixup_nest_count_tls(void)
 371 {
 372         asm volatile ("" : : "m" (URCU_TLS(lttng_ust_nest_count)));
 373 }
 374
 375 static
 376 void lttng_fixup_ust_mutex_nest_tls(void)
 377 {
 378         asm volatile ("" : : "m" (URCU_TLS(ust_mutex_nest)));
 379 }
 380
 381 /*
 382  * Fixup urcu bp TLS.
 383  */
 384 static
 385 void lttng_fixup_urcu_bp_tls(void)
 386 {
 387         rcu_read_lock();
 388         rcu_read_unlock();
 389 }
 390
 391 void lttng_ust_fixup_tls(void)
 392 {
 393         lttng_fixup_urcu_bp_tls();
 394         lttng_fixup_ringbuffer_tls();
 395         lttng_fixup_vtid_tls();
 396         lttng_fixup_nest_count_tls();
 397         lttng_fixup_procname_tls();
 398         lttng_fixup_ust_mutex_nest_tls();
 399 }
 400
 401 int lttng_get_notify_socket(void *owner)
 402 {
 403         struct sock_info *info = owner;
 404
 405         return info->notify_socket;
 406 }
 407
 408 static
 409 void print_cmd(int cmd, int handle)
 410 {
 411         const char *cmd_name = "Unknown";
 412
 413         if (cmd >= 0 && cmd < LTTNG_ARRAY_SIZE(cmd_name_mapping)
 414                         && cmd_name_mapping[cmd]) {
 415                 cmd_name = cmd_name_mapping[cmd];
 416         }
 417         DBG("Message Received \"%s\" (%d), Handle \"%s\" (%d)",
 418                 cmd_name, cmd,
 419                 lttng_ust_obj_get_name(handle), handle);
 420 }
 421
 422 static
 423 int setup_local_apps(void)
 424 {
 425         const char *home_dir;
 426         uid_t uid;
 427
 428         uid = getuid();
 429         /*
 430          * Disallow per-user tracing for setuid binaries.
 431          */
 432         if (uid != geteuid()) {
 433                 assert(local_apps.allowed == 0);
 434                 return 0;
 435         }
 436         home_dir = get_lttng_home_dir();
 437         if (!home_dir) {
 438                 WARN("HOME environment variable not set. Disabling LTTng-UST per-user tracing.");
 439                 assert(local_apps.allowed == 0);
 440                 return -ENOENT;
 441         }
 442         local_apps.allowed = 1;
 443         snprintf(local_apps.sock_path, PATH_MAX, "%s/%s/%s",
 444                 home_dir,
 445                 LTTNG_DEFAULT_HOME_RUNDIR,
 446                 LTTNG_UST_SOCK_FILENAME);
 447         snprintf(local_apps.wait_shm_path, PATH_MAX, "/%s-%u",
 448                 LTTNG_UST_WAIT_FILENAME,
 449                 uid);
 450         return 0;
 451 }
 452
 453 /*
 454  * Get socket timeout, in ms.
 455  * -1: wait forever. 0: don't wait. >0: timeout, in ms.
 456  */
 457 static
 458 long get_timeout(void)
 459 {
 460         long constructor_delay_ms = LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS;
 461
 462         if (!got_timeout_env) {
 463                 str_timeout = getenv("LTTNG_UST_REGISTER_TIMEOUT");
 464                 got_timeout_env = 1;
 465         }
 466         if (str_timeout)
 467                 constructor_delay_ms = strtol(str_timeout, NULL, 10);
 468         /* All negative values are considered as "-1". */
 469         if (constructor_delay_ms < -1)
 470                 constructor_delay_ms = -1;
 471         return constructor_delay_ms;
 472 }
 473
 474 /* Timeout for notify socket send and recv. */
 475 static
 476 long get_notify_sock_timeout(void)
 477 {
 478         return get_timeout();
 479 }
 480
 481 /* Timeout for connecting to cmd and notify sockets. */
 482 static
 483 long get_connect_sock_timeout(void)
 484 {
 485         return get_timeout();
 486 }
 487
 488 /*
 489  * Return values: -1: wait forever. 0: don't wait. 1: timeout wait.
 490  */
 491 static
 492 int get_constructor_timeout(struct timespec *constructor_timeout)
 493 {
 494         long constructor_delay_ms;
 495         int ret;
 496
 497         constructor_delay_ms = get_timeout();
 498
 499         switch (constructor_delay_ms) {
 500         case -1:/* fall-through */
 501         case 0:
 502                 return constructor_delay_ms;
 503         default:
 504                 break;
 505         }
 506
 507         /*
 508          * If we are unable to find the current time, don't wait.
 509          */
 510         ret = clock_gettime(CLOCK_REALTIME, constructor_timeout);
 511         if (ret) {
 512                 /* Don't wait. */
 513                 return 0;
 514         }
 515         constructor_timeout->tv_sec += constructor_delay_ms / 1000UL;
 516         constructor_timeout->tv_nsec +=
 517                 (constructor_delay_ms % 1000UL) * 1000000UL;
 518         if (constructor_timeout->tv_nsec >= 1000000000UL) {
 519                 constructor_timeout->tv_sec++;
 520                 constructor_timeout->tv_nsec -= 1000000000UL;
 521         }
 522         /* Timeout wait (constructor_delay_ms). */
 523         return 1;
 524 }
 525
 526 static
 527 int register_to_sessiond(int socket, enum ustctl_socket_type type)
 528 {
 529         return ustcomm_send_reg_msg(socket,
 530                 type,
 531                 CAA_BITS_PER_LONG,
 532                 lttng_alignof(uint8_t) * CHAR_BIT,
 533                 lttng_alignof(uint16_t) * CHAR_BIT,
 534                 lttng_alignof(uint32_t) * CHAR_BIT,
 535                 lttng_alignof(uint64_t) * CHAR_BIT,
 536                 lttng_alignof(unsigned long) * CHAR_BIT);
 537 }
 538
 539 static
 540 int send_reply(int sock, struct ustcomm_ust_reply *lur)
 541 {
 542         ssize_t len;
 543
 544         len = ustcomm_send_unix_sock(sock, lur, sizeof(*lur));
 545         switch (len) {
 546         case sizeof(*lur):
 547                 DBG("message successfully sent");
 548                 return 0;
 549         default:
 550                 if (len == -ECONNRESET) {
 551                         DBG("remote end closed connection");
 552                         return 0;
 553                 }
 554                 if (len < 0)
 555                         return len;
 556                 DBG("incorrect message size: %zd", len);
 557                 return -EINVAL;
 558         }
 559 }
 560
 561 static
 562 int handle_register_done(struct sock_info *sock_info)
 563 {
 564         int ret;
 565
 566         if (sock_info->constructor_sem_posted)
 567                 return 0;
 568         sock_info->constructor_sem_posted = 1;
 569         if (uatomic_read(&sem_count) <= 0) {
 570                 return 0;
 571         }
 572         ret = uatomic_add_return(&sem_count, -1);
 573         if (ret == 0) {
 574                 ret = sem_post(&constructor_wait);
 575                 assert(!ret);
 576         }
 577         return 0;
 578 }
 579
 580 /*
 581  * Only execute pending statedump after the constructor semaphore has
 582  * been posted by each listener thread. This means statedump will only
 583  * be performed after the "registration done" command is received from
 584  * each session daemon the application is connected to.
 585  *
 586  * This ensures we don't run into deadlock issues with the dynamic
 587  * loader mutex, which is held while the constructor is called and
 588  * waiting on the constructor semaphore. All operations requiring this
 589  * dynamic loader lock need to be postponed using this mechanism.
 590  */
 591 static
 592 void handle_pending_statedump(struct sock_info *sock_info)
 593 {
 594         int ctor_passed = sock_info->constructor_sem_posted;
 595
 596         if (ctor_passed && sock_info->statedump_pending) {
 597                 sock_info->statedump_pending = 0;
 598                 pthread_mutex_lock(&ust_fork_mutex);
 599                 lttng_handle_pending_statedump(sock_info);
 600                 pthread_mutex_unlock(&ust_fork_mutex);
 601         }
 602 }
 603
 604 static
 605 int handle_message(struct sock_info *sock_info,
 606                 int sock, struct ustcomm_ust_msg *lum)
 607 {
 608         int ret = 0;
 609         const struct lttng_ust_objd_ops *ops;
 610         struct ustcomm_ust_reply lur;
 611         union ust_args args;
 612         char ctxstr[LTTNG_UST_SYM_NAME_LEN];    /* App context string. */
 613         ssize_t len;
 614
 615         memset(&lur, 0, sizeof(lur));
 616
 617         if (ust_lock()) {
 618                 ret = -LTTNG_UST_ERR_EXITING;
 619                 goto error;
 620         }
 621
 622         ops = objd_ops(lum->handle);
 623         if (!ops) {
 624                 ret = -ENOENT;
 625                 goto error;
 626         }
 627
 628         switch (lum->cmd) {
 629         case LTTNG_UST_REGISTER_DONE:
 630                 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
 631                         ret = handle_register_done(sock_info);
 632                 else
 633                         ret = -EINVAL;
 634                 break;
 635         case LTTNG_UST_RELEASE:
 636                 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
 637                         ret = -EPERM;
 638                 else
 639                         ret = lttng_ust_objd_unref(lum->handle, 1);
 640                 break;
 641         case LTTNG_UST_FILTER:
 642         {
 643                 /* Receive filter data */
 644                 struct lttng_ust_filter_bytecode_node *bytecode;
 645
 646                 if (lum->u.filter.data_size > FILTER_BYTECODE_MAX_LEN) {
 647                         ERR("Filter data size is too large: %u bytes",
 648                                 lum->u.filter.data_size);
 649                         ret = -EINVAL;
 650                         goto error;
 651                 }
 652
 653                 if (lum->u.filter.reloc_offset > lum->u.filter.data_size) {
 654                         ERR("Filter reloc offset %u is not within data",
 655                                 lum->u.filter.reloc_offset);
 656                         ret = -EINVAL;
 657                         goto error;
 658                 }
 659
 660                 bytecode = zmalloc(sizeof(*bytecode) + lum->u.filter.data_size);
 661                 if (!bytecode) {
 662                         ret = -ENOMEM;
 663                         goto error;
 664                 }
 665                 len = ustcomm_recv_unix_sock(sock, bytecode->bc.data,
 666                                 lum->u.filter.data_size);
 667                 switch (len) {
 668                 case 0: /* orderly shutdown */
 669                         ret = 0;
 670                         free(bytecode);
 671                         goto error;
 672                 default:
 673                         if (len == lum->u.filter.data_size) {
 674                                 DBG("filter data received");
 675                                 break;
 676                         } else if (len < 0) {
 677                                 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
 678                                 if (len == -ECONNRESET) {
 679                                         ERR("%s remote end closed connection", sock_info->name);
 680                                         ret = len;
 681                                         free(bytecode);
 682                                         goto error;
 683                                 }
 684                                 ret = len;
 685                                 free(bytecode);
 686                                 goto error;
 687                         } else {
 688                                 DBG("incorrect filter data message size: %zd", len);
 689                                 ret = -EINVAL;
 690                                 free(bytecode);
 691                                 goto error;
 692                         }
 693                 }
 694                 bytecode->bc.len = lum->u.filter.data_size;
 695                 bytecode->bc.reloc_offset = lum->u.filter.reloc_offset;
 696                 bytecode->bc.seqnum = lum->u.filter.seqnum;
 697                 if (ops->cmd) {
 698                         ret = ops->cmd(lum->handle, lum->cmd,
 699                                         (unsigned long) bytecode,
 700                                         &args, sock_info);
 701                         if (ret) {
 702                                 free(bytecode);
 703                         }
 704                         /* don't free bytecode if everything went fine. */
 705                 } else {
 706                         ret = -ENOSYS;
 707                         free(bytecode);
 708                 }
 709                 break;
 710         }
 711         case LTTNG_UST_EXCLUSION:
 712         {
 713                 /* Receive exclusion names */
 714                 struct lttng_ust_excluder_node *node;
 715                 unsigned int count;
 716
 717                 count = lum->u.exclusion.count;
 718                 if (count == 0) {
 719                         /* There are no names to read */
 720                         ret = 0;
 721                         goto error;
 722                 }
 723                 node = zmalloc(sizeof(*node) +
 724                                 count * LTTNG_UST_SYM_NAME_LEN);
 725                 if (!node) {
 726                         ret = -ENOMEM;
 727                         goto error;
 728                 }
 729                 node->excluder.count = count;
 730                 len = ustcomm_recv_unix_sock(sock, node->excluder.names,
 731                                 count * LTTNG_UST_SYM_NAME_LEN);
 732                 switch (len) {
 733                 case 0: /* orderly shutdown */
 734                         ret = 0;
 735                         free(node);
 736                         goto error;
 737                 default:
 738                         if (len == count * LTTNG_UST_SYM_NAME_LEN) {
 739                                 DBG("Exclusion data received");
 740                                 break;
 741                         } else if (len < 0) {
 742                                 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
 743                                 if (len == -ECONNRESET) {
 744                                         ERR("%s remote end closed connection", sock_info->name);
 745                                         ret = len;
 746                                         free(node);
 747                                         goto error;
 748                                 }
 749                                 ret = len;
 750                                 free(node);
 751                                 goto error;
 752                         } else {
 753                                 DBG("Incorrect exclusion data message size: %zd", len);
 754                                 ret = -EINVAL;
 755                                 free(node);
 756                                 goto error;
 757                         }
 758                 }
 759                 if (ops->cmd) {
 760                         ret = ops->cmd(lum->handle, lum->cmd,
 761                                         (unsigned long) node,
 762                                         &args, sock_info);
 763                         if (ret) {
 764                                 free(node);
 765                         }
 766                         /* Don't free exclusion data if everything went fine. */
 767                 } else {
 768                         ret = -ENOSYS;
 769                         free(node);
 770                 }
 771                 break;
 772         }
 773         case LTTNG_UST_CHANNEL:
 774         {
 775                 void *chan_data;
 776                 int wakeup_fd;
 777
 778                 len = ustcomm_recv_channel_from_sessiond(sock,
 779                                 &chan_data, lum->u.channel.len,
 780                                 &wakeup_fd);
 781                 switch (len) {
 782                 case 0: /* orderly shutdown */
 783                         ret = 0;
 784                         goto error;
 785                 default:
 786                         if (len == lum->u.channel.len) {
 787                                 DBG("channel data received");
 788                                 break;
 789                         } else if (len < 0) {
 790                                 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
 791                                 if (len == -ECONNRESET) {
 792                                         ERR("%s remote end closed connection", sock_info->name);
 793                                         ret = len;
 794                                         goto error;
 795                                 }
 796                                 ret = len;
 797                                 goto error;
 798                         } else {
 799                                 DBG("incorrect channel data message size: %zd", len);
 800                                 ret = -EINVAL;
 801                                 goto error;
 802                         }
 803                 }
 804                 args.channel.chan_data = chan_data;
 805                 args.channel.wakeup_fd = wakeup_fd;
 806                 if (ops->cmd)
 807                         ret = ops->cmd(lum->handle, lum->cmd,
 808                                         (unsigned long) &lum->u,
 809                                         &args, sock_info);
 810                 else
 811                         ret = -ENOSYS;
 812                 break;
 813         }
 814         case LTTNG_UST_STREAM:
 815         {
 816                 /* Receive shm_fd, wakeup_fd */
 817                 ret = ustcomm_recv_stream_from_sessiond(sock,
 818                         &lum->u.stream.len,
 819                         &args.stream.shm_fd,
 820                         &args.stream.wakeup_fd);
 821                 if (ret) {
 822                         goto error;
 823                 }
 824                 if (ops->cmd)
 825                         ret = ops->cmd(lum->handle, lum->cmd,
 826                                         (unsigned long) &lum->u,
 827                                         &args, sock_info);
 828                 else
 829                         ret = -ENOSYS;
 830                 break;
 831         }
 832         case LTTNG_UST_CONTEXT:
 833                 switch (lum->u.context.ctx) {
 834                 case LTTNG_UST_CONTEXT_APP_CONTEXT:
 835                 {
 836                         char *p;
 837                         size_t ctxlen, recvlen;
 838
 839                         ctxlen = strlen("$app.") + lum->u.context.u.app_ctx.provider_name_len - 1
 840                                         + strlen(":") + lum->u.context.u.app_ctx.ctx_name_len;
 841                         if (ctxlen >= LTTNG_UST_SYM_NAME_LEN) {
 842                                 ERR("Application context string length size is too large: %zu bytes",
 843                                         ctxlen);
 844                                 ret = -EINVAL;
 845                                 goto error;
 846                         }
 847                         strcpy(ctxstr, "$app.");
 848                         p = &ctxstr[strlen("$app.")];
 849                         recvlen = ctxlen - strlen("$app.");
 850                         len = ustcomm_recv_unix_sock(sock, p, recvlen);
 851                         switch (len) {
 852                         case 0: /* orderly shutdown */
 853                                 ret = 0;
 854                                 goto error;
 855                         default:
 856                                 if (len == recvlen) {
 857                                         DBG("app context data received");
 858                                         break;
 859                                 } else if (len < 0) {
 860                                         DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
 861                                         if (len == -ECONNRESET) {
 862                                                 ERR("%s remote end closed connection", sock_info->name);
 863                                                 ret = len;
 864                                                 goto error;
 865                                         }
 866                                         ret = len;
 867                                         goto error;
 868                                 } else {
 869                                         DBG("incorrect app context data message size: %zd", len);
 870                                         ret = -EINVAL;
 871                                         goto error;
 872                                 }
 873                         }
 874                         /* Put : between provider and ctxname. */
 875                         p[lum->u.context.u.app_ctx.provider_name_len - 1] = ':';
 876                         args.app_context.ctxname = ctxstr;
 877                         break;
 878                 }
 879                 default:
 880                         break;
 881                 }
 882                 if (ops->cmd) {
 883                         ret = ops->cmd(lum->handle, lum->cmd,
 884                                         (unsigned long) &lum->u,
 885                                         &args, sock_info);
 886                 } else {
 887                         ret = -ENOSYS;
 888                 }
 889                 break;
 890         default:
 891                 if (ops->cmd)
 892                         ret = ops->cmd(lum->handle, lum->cmd,
 893                                         (unsigned long) &lum->u,
 894                                         &args, sock_info);
 895                 else
 896                         ret = -ENOSYS;
 897                 break;
 898         }
 899
 900         lur.handle = lum->handle;
 901         lur.cmd = lum->cmd;
 902         lur.ret_val = ret;
 903         if (ret >= 0) {
 904                 lur.ret_code = LTTNG_UST_OK;
 905         } else {
 906                 /*
 907                  * Use -LTTNG_UST_ERR as wildcard for UST internal
 908                  * error that are not caused by the transport, except if
 909                  * we already have a more precise error message to
 910                  * report.
 911                  */
 912                 if (ret > -LTTNG_UST_ERR) {
 913                         /* Translate code to UST error. */
 914                         switch (ret) {
 915                         case -EEXIST:
 916                                 lur.ret_code = -LTTNG_UST_ERR_EXIST;
 917                                 break;
 918                         case -EINVAL:
 919                                 lur.ret_code = -LTTNG_UST_ERR_INVAL;
 920                                 break;
 921                         case -ENOENT:
 922                                 lur.ret_code = -LTTNG_UST_ERR_NOENT;
 923                                 break;
 924                         case -EPERM:
 925                                 lur.ret_code = -LTTNG_UST_ERR_PERM;
 926                                 break;
 927                         case -ENOSYS:
 928                                 lur.ret_code = -LTTNG_UST_ERR_NOSYS;
 929                                 break;
 930                         default:
 931                                 lur.ret_code = -LTTNG_UST_ERR;
 932                                 break;
 933                         }
 934                 } else {
 935                         lur.ret_code = ret;
 936                 }
 937         }
 938         if (ret >= 0) {
 939                 switch (lum->cmd) {
 940                 case LTTNG_UST_TRACER_VERSION:
 941                         lur.u.version = lum->u.version;
 942                         break;
 943                 case LTTNG_UST_TRACEPOINT_LIST_GET:
 944                         memcpy(&lur.u.tracepoint, &lum->u.tracepoint, sizeof(lur.u.tracepoint));
 945                         break;
 946                 }
 947         }
 948         DBG("Return value: %d", lur.ret_val);
 949         ret = send_reply(sock, &lur);
 950         if (ret < 0) {
 951                 DBG("error sending reply");
 952                 goto error;
 953         }
 954
 955         /*
 956          * LTTNG_UST_TRACEPOINT_FIELD_LIST_GET needs to send the field
 957          * after the reply.
 958          */
 959         if (lur.ret_code == LTTNG_UST_OK) {
 960                 switch (lum->cmd) {
 961                 case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET:
 962                         len = ustcomm_send_unix_sock(sock,
 963                                 &args.field_list.entry,
 964                                 sizeof(args.field_list.entry));
 965                         if (len < 0) {
 966                                 ret = len;
 967                                 goto error;
 968                         }
 969                         if (len != sizeof(args.field_list.entry)) {
 970                                 ret = -EINVAL;
 971                                 goto error;
 972                         }
 973                 }
 974         }
 975
 976 error:
 977         ust_unlock();
 978
 979         /*
 980          * Performed delayed statedump operations outside of the UST
 981          * lock. We need to take the dynamic loader lock before we take
 982          * the UST lock internally within handle_pending_statedump().
 983           */
 984         handle_pending_statedump(sock_info);
 985
 986         return ret;
 987 }
 988
 989 static
 990 void cleanup_sock_info(struct sock_info *sock_info, int exiting)
 991 {
 992         int ret;
 993
 994         if (sock_info->root_handle != -1) {
 995                 ret = lttng_ust_objd_unref(sock_info->root_handle, 1);
 996                 if (ret) {
 997                         ERR("Error unref root handle");
 998                 }
 999                 sock_info->root_handle = -1;
1000         }
1001         sock_info->constructor_sem_posted = 0;
1002
1003         /*
1004          * wait_shm_mmap, socket and notify socket are used by listener
1005          * threads outside of the ust lock, so we cannot tear them down
1006          * ourselves, because we cannot join on these threads. Leave
1007          * responsibility of cleaning up these resources to the OS
1008          * process exit.
1009          */
1010         if (exiting)
1011                 return;
1012
1013         if (sock_info->socket != -1) {
1014                 ret = ustcomm_close_unix_sock(sock_info->socket);
1015                 if (ret) {
1016                         ERR("Error closing ust cmd socket");
1017                 }
1018                 sock_info->socket = -1;
1019         }
1020         if (sock_info->notify_socket != -1) {
1021                 ret = ustcomm_close_unix_sock(sock_info->notify_socket);
1022                 if (ret) {
1023                         ERR("Error closing ust notify socket");
1024                 }
1025                 sock_info->notify_socket = -1;
1026         }
1027         if (sock_info->wait_shm_mmap) {
1028                 long page_size;
1029
1030                 page_size = sysconf(_SC_PAGE_SIZE);
1031                 if (page_size <= 0) {
1032                         if (!page_size) {
1033                                 errno = EINVAL;
1034                         }
1035                         PERROR("Error in sysconf(_SC_PAGE_SIZE)");
1036                 } else {
1037                         ret = munmap(sock_info->wait_shm_mmap, page_size);
1038                         if (ret) {
1039                                 ERR("Error unmapping wait shm");
1040                         }
1041                 }
1042                 sock_info->wait_shm_mmap = NULL;
1043         }
1044 }
1045
1046 /*
1047  * Using fork to set umask in the child process (not multi-thread safe).
1048  * We deal with the shm_open vs ftruncate race (happening when the
1049  * sessiond owns the shm and does not let everybody modify it, to ensure
1050  * safety against shm_unlink) by simply letting the mmap fail and
1051  * retrying after a few seconds.
1052  * For global shm, everybody has rw access to it until the sessiond
1053  * starts.
1054  */
1055 static
1056 int get_wait_shm(struct sock_info *sock_info, size_t mmap_size)
1057 {
1058         int wait_shm_fd, ret;
1059         pid_t pid;
1060
1061         /*
1062          * Try to open read-only.
1063          */
1064         wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
1065         if (wait_shm_fd >= 0) {
1066                 int32_t tmp_read;
1067                 ssize_t len;
1068                 size_t bytes_read = 0;
1069
1070                 /*
1071                  * Try to read the fd. If unable to do so, try opening
1072                  * it in write mode.
1073                  */
1074                 do {
1075                         len = read(wait_shm_fd,
1076                                 &((char *) &tmp_read)[bytes_read],
1077                                 sizeof(tmp_read) - bytes_read);
1078                         if (len > 0) {
1079                                 bytes_read += len;
1080                         }
1081                 } while ((len < 0 && errno == EINTR)
1082                         || (len > 0 && bytes_read < sizeof(tmp_read)));
1083                 if (bytes_read != sizeof(tmp_read)) {
1084                         ret = close(wait_shm_fd);
1085                         if (ret) {
1086                                 ERR("close wait_shm_fd");
1087                         }
1088                         goto open_write;
1089                 }
1090                 goto end;
1091         } else if (wait_shm_fd < 0 && errno != ENOENT) {
1092                 /*
1093                  * Real-only open did not work, and it's not because the
1094                  * entry was not present. It's a failure that prohibits
1095                  * using shm.
1096                  */
1097                 ERR("Error opening shm %s", sock_info->wait_shm_path);
1098                 goto end;
1099         }
1100
1101 open_write:
1102         /*
1103          * If the open failed because the file did not exist, or because
1104          * the file was not truncated yet, try creating it ourself.
1105          */
1106         URCU_TLS(lttng_ust_nest_count)++;
1107         pid = fork();
1108         URCU_TLS(lttng_ust_nest_count)--;
1109         if (pid > 0) {
1110                 int status;
1111
1112                 /*
1113                  * Parent: wait for child to return, in which case the
1114                  * shared memory map will have been created.
1115                  */
1116                 pid = wait(&status);
1117                 if (pid < 0 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
1118                         wait_shm_fd = -1;
1119                         goto end;
1120                 }
1121                 /*
1122                  * Try to open read-only again after creation.
1123                  */
1124                 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
1125                 if (wait_shm_fd < 0) {
1126                         /*
1127                          * Real-only open did not work. It's a failure
1128                          * that prohibits using shm.
1129                          */
1130                         ERR("Error opening shm %s", sock_info->wait_shm_path);
1131                         goto end;
1132                 }
1133                 goto end;
1134         } else if (pid == 0) {
1135                 int create_mode;
1136
1137                 /* Child */
1138                 create_mode = S_IRUSR | S_IWUSR | S_IRGRP;
1139                 if (sock_info->global)
1140                         create_mode |= S_IROTH | S_IWGRP | S_IWOTH;
1141                 /*
1142                  * We're alone in a child process, so we can modify the
1143                  * process-wide umask.
1144                  */
1145                 umask(~create_mode);
1146                 /*
1147                  * Try creating shm (or get rw access).
1148                  * We don't do an exclusive open, because we allow other
1149                  * processes to create+ftruncate it concurrently.
1150                  */
1151                 wait_shm_fd = shm_open(sock_info->wait_shm_path,
1152                                 O_RDWR | O_CREAT, create_mode);
1153                 if (wait_shm_fd >= 0) {
1154                         ret = ftruncate(wait_shm_fd, mmap_size);
1155                         if (ret) {
1156                                 PERROR("ftruncate");
1157                                 _exit(EXIT_FAILURE);
1158                         }
1159                         _exit(EXIT_SUCCESS);
1160                 }
1161                 /*
1162                  * For local shm, we need to have rw access to accept
1163                  * opening it: this means the local sessiond will be
1164                  * able to wake us up. For global shm, we open it even
1165                  * if rw access is not granted, because the root.root
1166                  * sessiond will be able to override all rights and wake
1167                  * us up.
1168                  */
1169                 if (!sock_info->global && errno != EACCES) {
1170                         ERR("Error opening shm %s", sock_info->wait_shm_path);
1171                         _exit(EXIT_FAILURE);
1172                 }
1173                 /*
1174                  * The shm exists, but we cannot open it RW. Report
1175                  * success.
1176                  */
1177                 _exit(EXIT_SUCCESS);
1178         } else {
1179                 return -1;
1180         }
1181 end:
1182         if (wait_shm_fd >= 0 && !sock_info->global) {
1183                 struct stat statbuf;
1184
1185                 /*
1186                  * Ensure that our user is the owner of the shm file for
1187                  * local shm. If we do not own the file, it means our
1188                  * sessiond will not have access to wake us up (there is
1189                  * probably a rogue process trying to fake our
1190                  * sessiond). Fallback to polling method in this case.
1191                  */
1192                 ret = fstat(wait_shm_fd, &statbuf);
1193                 if (ret) {
1194                         PERROR("fstat");
1195                         goto error_close;
1196                 }
1197                 if (statbuf.st_uid != getuid())
1198                         goto error_close;
1199         }
1200         return wait_shm_fd;
1201
1202 error_close:
1203         ret = close(wait_shm_fd);
1204         if (ret) {
1205                 PERROR("Error closing fd");
1206         }
1207         return -1;
1208 }
1209
1210 static
1211 char *get_map_shm(struct sock_info *sock_info)
1212 {
1213         long page_size;
1214         int wait_shm_fd, ret;
1215         char *wait_shm_mmap;
1216
1217         page_size = sysconf(_SC_PAGE_SIZE);
1218         if (page_size <= 0) {
1219                 if (!page_size) {
1220                         errno = EINVAL;
1221                 }
1222                 PERROR("Error in sysconf(_SC_PAGE_SIZE)");
1223                 goto error;
1224         }
1225
1226         wait_shm_fd = get_wait_shm(sock_info, page_size);
1227         if (wait_shm_fd < 0) {
1228                 goto error;
1229         }
1230         wait_shm_mmap = mmap(NULL, page_size, PROT_READ,
1231                   MAP_SHARED, wait_shm_fd, 0);
1232         /* close shm fd immediately after taking the mmap reference */
1233         ret = close(wait_shm_fd);
1234         if (ret) {
1235                 PERROR("Error closing fd");
1236         }
1237         if (wait_shm_mmap == MAP_FAILED) {
1238                 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
1239                 goto error;
1240         }
1241         return wait_shm_mmap;
1242
1243 error:
1244         return NULL;
1245 }
1246
1247 static
1248 void wait_for_sessiond(struct sock_info *sock_info)
1249 {
1250         if (ust_lock()) {
1251                 goto quit;
1252         }
1253         if (wait_poll_fallback) {
1254                 goto error;
1255         }
1256         if (!sock_info->wait_shm_mmap) {
1257                 sock_info->wait_shm_mmap = get_map_shm(sock_info);
1258                 if (!sock_info->wait_shm_mmap)
1259                         goto error;
1260         }
1261         ust_unlock();
1262
1263         DBG("Waiting for %s apps sessiond", sock_info->name);
1264         /* Wait for futex wakeup */
1265         if (uatomic_read((int32_t *) sock_info->wait_shm_mmap))
1266                 goto end_wait;
1267
1268         while (futex_async((int32_t *) sock_info->wait_shm_mmap,
1269                         FUTEX_WAIT, 0, NULL, NULL, 0)) {
1270                 switch (errno) {
1271                 case EWOULDBLOCK:
1272                         /* Value already changed. */
1273                         goto end_wait;
1274                 case EINTR:
1275                         /* Retry if interrupted by signal. */
1276                         break;  /* Get out of switch. */
1277                 case EFAULT:
1278                         wait_poll_fallback = 1;
1279                         DBG(
1280 "Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
1281 "do not support FUTEX_WAKE on read-only memory mappings correctly. "
1282 "Please upgrade your kernel "
1283 "(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
1284 "mainline). LTTng-UST will use polling mode fallback.");
1285                         if (ust_debug())
1286                                 PERROR("futex");
1287                         goto end_wait;
1288                 }
1289         }
1290 end_wait:
1291         return;
1292
1293 quit:
1294         ust_unlock();
1295         return;
1296
1297 error:
1298         ust_unlock();
1299         return;
1300 }
1301
1302 /*
1303  * This thread does not allocate any resource, except within
1304  * handle_message, within mutex protection. This mutex protects against
1305  * fork and exit.
1306  * The other moment it allocates resources is at socket connection, which
1307  * is also protected by the mutex.
1308  */
1309 static
1310 void *ust_listener_thread(void *arg)
1311 {
1312         struct sock_info *sock_info = arg;
1313         int sock, ret, prev_connect_failed = 0, has_waited = 0;
1314         long timeout;
1315
1316         lttng_ust_fixup_tls();
1317
1318         /* Restart trying to connect to the session daemon */
1319 restart:
1320         if (prev_connect_failed) {
1321                 /* Wait for sessiond availability with pipe */
1322                 wait_for_sessiond(sock_info);
1323                 if (has_waited) {
1324                         has_waited = 0;
1325                         /*
1326                          * Sleep for 5 seconds before retrying after a
1327                          * sequence of failure / wait / failure. This
1328                          * deals with a killed or broken session daemon.
1329                          */
1330                         sleep(5);
1331                 } else {
1332                         has_waited = 1;
1333                 }
1334                 prev_connect_failed = 0;
1335         }
1336
1337         if (sock_info->socket != -1) {
1338                 ret = ustcomm_close_unix_sock(sock_info->socket);
1339                 if (ret) {
1340                         ERR("Error closing %s ust cmd socket",
1341                                 sock_info->name);
1342                 }
1343                 sock_info->socket = -1;
1344         }
1345         if (sock_info->notify_socket != -1) {
1346                 ret = ustcomm_close_unix_sock(sock_info->notify_socket);
1347                 if (ret) {
1348                         ERR("Error closing %s ust notify socket",
1349                                 sock_info->name);
1350                 }
1351                 sock_info->notify_socket = -1;
1352         }
1353
1354         /*
1355          * Register. We need to perform both connect and sending
1356          * registration message before doing the next connect otherwise
1357          * we may reach unix socket connect queue max limits and block
1358          * on the 2nd connect while the session daemon is awaiting the
1359          * first connect registration message.
1360          */
1361         /* Connect cmd socket */
1362         ret = ustcomm_connect_unix_sock(sock_info->sock_path,
1363                 get_connect_sock_timeout());
1364         if (ret < 0) {
1365                 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
1366                 prev_connect_failed = 1;
1367
1368                 if (ust_lock()) {
1369                         goto quit;
1370                 }
1371
1372                 /*
1373                  * If we cannot find the sessiond daemon, don't delay
1374                  * constructor execution.
1375                  */
1376                 ret = handle_register_done(sock_info);
1377                 assert(!ret);
1378                 ust_unlock();
1379                 goto restart;
1380         }
1381         sock_info->socket = ret;
1382
1383         if (ust_lock()) {
1384                 goto quit;
1385         }
1386
1387         /*
1388          * Create only one root handle per listener thread for the whole
1389          * process lifetime, so we ensure we get ID which is statically
1390          * assigned to the root handle.
1391          */
1392         if (sock_info->root_handle == -1) {
1393                 ret = lttng_abi_create_root_handle();
1394                 if (ret < 0) {
1395                         ERR("Error creating root handle");
1396                         goto quit;
1397                 }
1398                 sock_info->root_handle = ret;
1399         }
1400
1401         ret = register_to_sessiond(sock_info->socket, USTCTL_SOCKET_CMD);
1402         if (ret < 0) {
1403                 ERR("Error registering to %s ust cmd socket",
1404                         sock_info->name);
1405                 prev_connect_failed = 1;
1406                 /*
1407                  * If we cannot register to the sessiond daemon, don't
1408                  * delay constructor execution.
1409                  */
1410                 ret = handle_register_done(sock_info);
1411                 assert(!ret);
1412                 ust_unlock();
1413                 goto restart;
1414         }
1415
1416         ust_unlock();
1417
1418         /* Connect notify socket */
1419         ret = ustcomm_connect_unix_sock(sock_info->sock_path,
1420                 get_connect_sock_timeout());
1421         if (ret < 0) {
1422                 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
1423                 prev_connect_failed = 1;
1424
1425                 if (ust_lock()) {
1426                         goto quit;
1427                 }
1428
1429                 /*
1430                  * If we cannot find the sessiond daemon, don't delay
1431                  * constructor execution.
1432                  */
1433                 ret = handle_register_done(sock_info);
1434                 assert(!ret);
1435                 ust_unlock();
1436                 goto restart;
1437         }
1438         sock_info->notify_socket = ret;
1439
1440         timeout = get_notify_sock_timeout();
1441         if (timeout >= 0) {
1442                 /*
1443                  * Give at least 10ms to sessiond to reply to
1444                  * notifications.
1445                  */
1446                 if (timeout < 10)
1447                         timeout = 10;
1448                 ret = ustcomm_setsockopt_rcv_timeout(sock_info->notify_socket,
1449                                 timeout);
1450                 if (ret < 0) {
1451                         WARN("Error setting socket receive timeout");
1452                 }
1453                 ret = ustcomm_setsockopt_snd_timeout(sock_info->notify_socket,
1454                                 timeout);
1455                 if (ret < 0) {
1456                         WARN("Error setting socket send timeout");
1457                 }
1458         } else if (timeout < -1) {
1459                 WARN("Unsupported timeout value %ld", timeout);
1460         }
1461
1462         if (ust_lock()) {
1463                 goto quit;
1464         }
1465
1466         ret = register_to_sessiond(sock_info->notify_socket,
1467                         USTCTL_SOCKET_NOTIFY);
1468         if (ret < 0) {
1469                 ERR("Error registering to %s ust notify socket",
1470                         sock_info->name);
1471                 prev_connect_failed = 1;
1472                 /*
1473                  * If we cannot register to the sessiond daemon, don't
1474                  * delay constructor execution.
1475                  */
1476                 ret = handle_register_done(sock_info);
1477                 assert(!ret);
1478                 ust_unlock();
1479                 goto restart;
1480         }
1481         sock = sock_info->socket;
1482
1483         ust_unlock();
1484
1485         for (;;) {
1486                 ssize_t len;
1487                 struct ustcomm_ust_msg lum;
1488
1489                 len = ustcomm_recv_unix_sock(sock, &lum, sizeof(lum));
1490                 switch (len) {
1491                 case 0: /* orderly shutdown */
1492                         DBG("%s lttng-sessiond has performed an orderly shutdown", sock_info->name);
1493                         if (ust_lock()) {
1494                                 goto quit;
1495                         }
1496                         /*
1497                          * Either sessiond has shutdown or refused us by closing the socket.
1498                          * In either case, we don't want to delay construction execution,
1499                          * and we need to wait before retry.
1500                          */
1501                         prev_connect_failed = 1;
1502                         /*
1503                          * If we cannot register to the sessiond daemon, don't
1504                          * delay constructor execution.
1505                          */
1506                         ret = handle_register_done(sock_info);
1507                         assert(!ret);
1508                         ust_unlock();
1509                         goto end;
1510                 case sizeof(lum):
1511                         print_cmd(lum.cmd, lum.handle);
1512                         ret = handle_message(sock_info, sock, &lum);
1513                         if (ret) {
1514                                 ERR("Error handling message for %s socket",
1515                                         sock_info->name);
1516                                 /*
1517                                  * Close socket if protocol error is
1518                                  * detected.
1519                                  */
1520                                 goto end;
1521                         }
1522                         continue;
1523                 default:
1524                         if (len < 0) {
1525                                 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
1526                         } else {
1527                                 DBG("incorrect message size (%s socket): %zd", sock_info->name, len);
1528                         }
1529                         if (len == -ECONNRESET) {
1530                                 DBG("%s remote end closed connection", sock_info->name);
1531                                 goto end;
1532                         }
1533                         goto end;
1534                 }
1535
1536         }
1537 end:
1538         if (ust_lock()) {
1539                 goto quit;
1540         }
1541         /* Cleanup socket handles before trying to reconnect */
1542         lttng_ust_objd_table_owner_cleanup(sock_info);
1543         ust_unlock();
1544         goto restart;   /* try to reconnect */
1545
1546 quit:
1547         ust_unlock();
1548
1549         pthread_mutex_lock(&ust_exit_mutex);
1550         sock_info->thread_active = 0;
1551         pthread_mutex_unlock(&ust_exit_mutex);
1552         return NULL;
1553 }
1554
1555 /*
1556  * Weak symbol to call when the ust malloc wrapper is not loaded.
1557  */
1558 __attribute__((weak))
1559 void lttng_ust_malloc_wrapper_init(void)
1560 {
1561 }
1562
1563 /*
1564  * sessiond monitoring thread: monitor presence of global and per-user
1565  * sessiond by polling the application common named pipe.
1566  */
1567 void __attribute__((constructor)) lttng_ust_init(void)
1568 {
1569         struct timespec constructor_timeout;
1570         sigset_t sig_all_blocked, orig_parent_mask;
1571         pthread_attr_t thread_attr;
1572         int timeout_mode;
1573         int ret;
1574
1575         if (uatomic_xchg(&initialized, 1) == 1)
1576                 return;
1577
1578         /*
1579          * Fixup interdependency between TLS fixup mutex (which happens
1580          * to be the dynamic linker mutex) and ust_lock, taken within
1581          * the ust lock.
1582          */
1583         lttng_ust_fixup_tls();
1584
1585         /*
1586          * We want precise control over the order in which we construct
1587          * our sub-libraries vs starting to receive commands from
1588          * sessiond (otherwise leading to errors when trying to create
1589          * sessiond before the init functions are completed).
1590          */
1591         init_usterr();
1592         init_tracepoint();
1593         lttng_ust_clock_init();
1594         lttng_ust_getcpu_init();
1595         lttng_ust_statedump_init();
1596         lttng_ring_buffer_metadata_client_init();
1597         lttng_ring_buffer_client_overwrite_init();
1598         lttng_ring_buffer_client_overwrite_rt_init();
1599         lttng_ring_buffer_client_discard_init();
1600         lttng_ring_buffer_client_discard_rt_init();
1601         lttng_perf_counter_init();
1602         /*
1603          * Invoke ust malloc wrapper init before starting other threads.
1604          */
1605         lttng_ust_malloc_wrapper_init();
1606
1607         timeout_mode = get_constructor_timeout(&constructor_timeout);
1608
1609         ret = sem_init(&constructor_wait, 0, 0);
1610         if (ret) {
1611                 PERROR("sem_init");
1612         }
1613
1614         ret = setup_local_apps();
1615         if (ret) {
1616                 DBG("local apps setup returned %d", ret);
1617         }
1618
1619         /* A new thread created by pthread_create inherits the signal mask
1620          * from the parent. To avoid any signal being received by the
1621          * listener thread, we block all signals temporarily in the parent,
1622          * while we create the listener thread.
1623          */
1624         sigfillset(&sig_all_blocked);
1625         ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_parent_mask);
1626         if (ret) {
1627                 ERR("pthread_sigmask: %s", strerror(ret));
1628         }
1629
1630         ret = pthread_attr_init(&thread_attr);
1631         if (ret) {
1632                 ERR("pthread_attr_init: %s", strerror(ret));
1633         }
1634         ret = pthread_attr_setdetachstate(&thread_attr, PTHREAD_CREATE_DETACHED);
1635         if (ret) {
1636                 ERR("pthread_attr_setdetachstate: %s", strerror(ret));
1637         }
1638
1639         pthread_mutex_lock(&ust_exit_mutex);
1640         ret = pthread_create(&global_apps.ust_listener, &thread_attr,
1641                         ust_listener_thread, &global_apps);
1642         if (ret) {
1643                 ERR("pthread_create global: %s", strerror(ret));
1644         }
1645         global_apps.thread_active = 1;
1646         pthread_mutex_unlock(&ust_exit_mutex);
1647
1648         if (local_apps.allowed) {
1649                 pthread_mutex_lock(&ust_exit_mutex);
1650                 ret = pthread_create(&local_apps.ust_listener, &thread_attr,
1651                                 ust_listener_thread, &local_apps);
1652                 if (ret) {
1653                         ERR("pthread_create local: %s", strerror(ret));
1654                 }
1655                 local_apps.thread_active = 1;
1656                 pthread_mutex_unlock(&ust_exit_mutex);
1657         } else {
1658                 handle_register_done(&local_apps);
1659         }
1660         ret = pthread_attr_destroy(&thread_attr);
1661         if (ret) {
1662                 ERR("pthread_attr_destroy: %s", strerror(ret));
1663         }
1664
1665         /* Restore original signal mask in parent */
1666         ret = pthread_sigmask(SIG_SETMASK, &orig_parent_mask, NULL);
1667         if (ret) {
1668                 ERR("pthread_sigmask: %s", strerror(ret));
1669         }
1670
1671         switch (timeout_mode) {
1672         case 1: /* timeout wait */
1673                 do {
1674                         ret = sem_timedwait(&constructor_wait,
1675                                         &constructor_timeout);
1676                 } while (ret < 0 && errno == EINTR);
1677                 if (ret < 0) {
1678                         switch (errno) {
1679                         case ETIMEDOUT:
1680                                 ERR("Timed out waiting for lttng-sessiond");
1681                                 break;
1682                         case EINVAL:
1683                                 PERROR("sem_timedwait");
1684                                 break;
1685                         default:
1686                                 ERR("Unexpected error \"%s\" returned by sem_timedwait",
1687                                         strerror(errno));
1688                         }
1689                 }
1690                 break;
1691         case -1:/* wait forever */
1692                 do {
1693                         ret = sem_wait(&constructor_wait);
1694                 } while (ret < 0 && errno == EINTR);
1695                 if (ret < 0) {
1696                         switch (errno) {
1697                         case EINVAL:
1698                                 PERROR("sem_wait");
1699                                 break;
1700                         default:
1701                                 ERR("Unexpected error \"%s\" returned by sem_wait",
1702                                         strerror(errno));
1703                         }
1704                 }
1705                 break;
1706         case 0: /* no timeout */
1707                 break;
1708         }
1709 }
1710
1711 static
1712 void lttng_ust_cleanup(int exiting)
1713 {
1714         cleanup_sock_info(&global_apps, exiting);
1715         cleanup_sock_info(&local_apps, exiting);
1716         local_apps.allowed = 0;
1717         /*
1718          * The teardown in this function all affect data structures
1719          * accessed under the UST lock by the listener thread. This
1720          * lock, along with the lttng_ust_comm_should_quit flag, ensure
1721          * that none of these threads are accessing this data at this
1722          * point.
1723          */
1724         lttng_ust_abi_exit();
1725         lttng_ust_events_exit();
1726         lttng_perf_counter_exit();
1727         lttng_ring_buffer_client_discard_rt_exit();
1728         lttng_ring_buffer_client_discard_exit();
1729         lttng_ring_buffer_client_overwrite_rt_exit();
1730         lttng_ring_buffer_client_overwrite_exit();
1731         lttng_ring_buffer_metadata_client_exit();
1732         lttng_ust_statedump_destroy();
1733         exit_tracepoint();
1734         if (!exiting) {
1735                 /* Reinitialize values for fork */
1736                 sem_count = 2;
1737                 lttng_ust_comm_should_quit = 0;
1738                 initialized = 0;
1739         }
1740 }
1741
1742 void __attribute__((destructor)) lttng_ust_exit(void)
1743 {
1744         int ret;
1745
1746         /*
1747          * Using pthread_cancel here because:
1748          * A) we don't want to hang application teardown.
1749          * B) the thread is not allocating any resource.
1750          */
1751
1752         /*
1753          * Require the communication thread to quit. Synchronize with
1754          * mutexes to ensure it is not in a mutex critical section when
1755          * pthread_cancel is later called.
1756          */
1757         ust_lock_nocheck();
1758         lttng_ust_comm_should_quit = 1;
1759         ust_unlock();
1760
1761         pthread_mutex_lock(&ust_exit_mutex);
1762         /* cancel threads */
1763         if (global_apps.thread_active) {
1764                 ret = pthread_cancel(global_apps.ust_listener);
1765                 if (ret) {
1766                         ERR("Error cancelling global ust listener thread: %s",
1767                                 strerror(ret));
1768                 } else {
1769                         global_apps.thread_active = 0;
1770                 }
1771         }
1772         if (local_apps.thread_active) {
1773                 ret = pthread_cancel(local_apps.ust_listener);
1774                 if (ret) {
1775                         ERR("Error cancelling local ust listener thread: %s",
1776                                 strerror(ret));
1777                 } else {
1778                         local_apps.thread_active = 0;
1779                 }
1780         }
1781         pthread_mutex_unlock(&ust_exit_mutex);
1782
1783         /*
1784          * Do NOT join threads: use of sys_futex makes it impossible to
1785          * join the threads without using async-cancel, but async-cancel
1786          * is delivered by a signal, which could hit the target thread
1787          * anywhere in its code path, including while the ust_lock() is
1788          * held, causing a deadlock for the other thread. Let the OS
1789          * cleanup the threads if there are stalled in a syscall.
1790          */
1791         lttng_ust_cleanup(1);
1792 }
1793
1794 /*
1795  * We exclude the worker threads across fork and clone (except
1796  * CLONE_VM), because these system calls only keep the forking thread
1797  * running in the child.  Therefore, we don't want to call fork or clone
1798  * in the middle of an tracepoint or ust tracing state modification.
1799  * Holding this mutex protects these structures across fork and clone.
1800  */
1801 void ust_before_fork(sigset_t *save_sigset)
1802 {
1803         /*
1804          * Disable signals. This is to avoid that the child intervenes
1805          * before it is properly setup for tracing. It is safer to
1806          * disable all signals, because then we know we are not breaking
1807          * anything by restoring the original mask.
1808          */
1809         sigset_t all_sigs;
1810         int ret;
1811
1812         /* Fixup lttng-ust TLS. */
1813         lttng_ust_fixup_tls();
1814
1815         if (URCU_TLS(lttng_ust_nest_count))
1816                 return;
1817         /* Disable signals */
1818         sigfillset(&all_sigs);
1819         ret = sigprocmask(SIG_BLOCK, &all_sigs, save_sigset);
1820         if (ret == -1) {
1821                 PERROR("sigprocmask");
1822         }
1823
1824         pthread_mutex_lock(&ust_fork_mutex);
1825
1826         ust_lock_nocheck();
1827         rcu_bp_before_fork();
1828 }
1829
1830 static void ust_after_fork_common(sigset_t *restore_sigset)
1831 {
1832         int ret;
1833
1834         DBG("process %d", getpid());
1835         ust_unlock();
1836
1837         pthread_mutex_unlock(&ust_fork_mutex);
1838
1839         /* Restore signals */
1840         ret = sigprocmask(SIG_SETMASK, restore_sigset, NULL);
1841         if (ret == -1) {
1842                 PERROR("sigprocmask");
1843         }
1844 }
1845
1846 void ust_after_fork_parent(sigset_t *restore_sigset)
1847 {
1848         if (URCU_TLS(lttng_ust_nest_count))
1849                 return;
1850         DBG("process %d", getpid());
1851         rcu_bp_after_fork_parent();
1852         /* Release mutexes and reenable signals */
1853         ust_after_fork_common(restore_sigset);
1854 }
1855
1856 /*
1857  * After fork, in the child, we need to cleanup all the leftover state,
1858  * except the worker thread which already magically disappeared thanks
1859  * to the weird Linux fork semantics. After tyding up, we call
1860  * lttng_ust_init() again to start over as a new PID.
1861  *
1862  * This is meant for forks() that have tracing in the child between the
1863  * fork and following exec call (if there is any).
1864  */
1865 void ust_after_fork_child(sigset_t *restore_sigset)
1866 {
1867         if (URCU_TLS(lttng_ust_nest_count))
1868                 return;
1869         lttng_context_vtid_reset();
1870         DBG("process %d", getpid());
1871         /* Release urcu mutexes */
1872         rcu_bp_after_fork_child();
1873         lttng_ust_cleanup(0);
1874         /* Release mutexes and reenable signals */
1875         ust_after_fork_common(restore_sigset);
1876         lttng_ust_init();
1877 }
1878
1879 void lttng_ust_sockinfo_session_enabled(void *owner)
1880 {
1881         struct sock_info *sock_info = owner;
1882         sock_info->statedump_pending = 1;
1883 }