SoW-2019-0007-2: Dynamic Snapshot: Triggers send partial event payload with notifications
[deliverable/lttng-ust.git] / liblttng-ust / lttng-ust-comm.c
CommitLineData
2691221a
MD
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
80e2814b 22#define _LGPL_SOURCE
5e1b7b8b 23#define _GNU_SOURCE
b4051ad8 24#include <stddef.h>
fb31eb73 25#include <stdint.h>
2691221a
MD
26#include <sys/types.h>
27#include <sys/socket.h>
7fc90dca
MD
28#include <sys/mman.h>
29#include <sys/stat.h>
58d4b2a2
MD
30#include <sys/types.h>
31#include <sys/wait.h>
b2292d85 32#include <dlfcn.h>
7fc90dca 33#include <fcntl.h>
2691221a
MD
34#include <unistd.h>
35#include <errno.h>
d9e99d10 36#include <pthread.h>
11ff9c7d
MD
37#include <semaphore.h>
38#include <time.h>
1ea11eab 39#include <assert.h>
e822f505 40#include <signal.h>
6f97f9c2 41#include <limits.h>
95259bd0 42#include <urcu/uatomic.h>
80e2814b 43#include <urcu/futex.h>
c117fb1b 44#include <urcu/compiler.h>
1ea11eab 45
4318ae1b 46#include <lttng/ust-events.h>
4318ae1b 47#include <lttng/ust-abi.h>
4318ae1b 48#include <lttng/ust.h>
7bc53e94 49#include <lttng/ust-error.h>
74d81a6c 50#include <lttng/ust-ctl.h>
8c90a710 51#include <urcu/tls-compat.h>
44c72f10 52#include <ust-comm.h>
6548fca4 53#include <ust-fd.h>
44c72f10 54#include <usterr-signal-safe.h>
cd54f6d9 55#include <helper.h>
44c72f10 56#include "tracepoint-internal.h"
7dd08bec 57#include "lttng-tracer-core.h"
08114193 58#include "compat.h"
6f97f9c2 59#include "../libringbuffer/rb-init.h"
cf73e0fe 60#include "lttng-ust-statedump.h"
f9364363 61#include "clock.h"
5e1b7b8b 62#include "../libringbuffer/getcpu.h"
13efba44 63#include "getenv.h"
cb11f03a 64#include "ust-events-internal.h"
edaa1431 65
b2292d85 66/* Concatenate lttng ust shared library name with its major version number. */
6be9efc1 67#define LTTNG_UST_LIB_SO_NAME "liblttng-ust.so." __ust_stringify(CONFIG_LTTNG_UST_LIBRARY_VERSION_MAJOR)
b2292d85 68
edaa1431
MD
69/*
70 * Has lttng ust comm constructor been called ?
71 */
72static int initialized;
73
1ea11eab 74/*
17dfb34b
MD
75 * The ust_lock/ust_unlock lock is used as a communication thread mutex.
76 * Held when handling a command, also held by fork() to deal with
77 * removal of threads, and by exit path.
3327ac33
MD
78 *
79 * The UST lock is the centralized mutex across UST tracing control and
80 * probe registration.
81 *
82 * ust_exit_mutex must never nest in ust_mutex.
d58d1454 83 *
4770bd47
MD
84 * ust_fork_mutex must never nest in ust_mutex.
85 *
d58d1454
MD
86 * ust_mutex_nest is a per-thread nesting counter, allowing the perf
87 * counter lazy initialization called by events within the statedump,
88 * which traces while the ust_mutex is held.
4770bd47
MD
89 *
90 * ust_lock nests within the dynamic loader lock (within glibc) because
91 * it is taken within the library constructor.
c1be081a
MD
92 *
93 * The ust fd tracker lock nests within the ust_mutex.
3327ac33
MD
94 */
95static pthread_mutex_t ust_mutex = PTHREAD_MUTEX_INITIALIZER;
96
d58d1454 97/* Allow nesting the ust_mutex within the same thread. */
16adecf1 98static DEFINE_URCU_TLS(int, ust_mutex_nest);
d58d1454 99
3327ac33
MD
100/*
101 * ust_exit_mutex protects thread_active variable wrt thread exit. It
102 * cannot be done by ust_mutex because pthread_cancel(), which takes an
103 * internal libc lock, cannot nest within ust_mutex.
104 *
105 * It never nests within a ust_mutex.
1ea11eab 106 */
3327ac33 107static pthread_mutex_t ust_exit_mutex = PTHREAD_MUTEX_INITIALIZER;
1ea11eab 108
458d678c
PW
109/*
110 * ust_fork_mutex protects base address statedump tracing against forks. It
111 * prevents the dynamic loader lock to be taken (by base address statedump
112 * tracing) while a fork is happening, thus preventing deadlock issues with
113 * the dynamic loader lock.
114 */
115static pthread_mutex_t ust_fork_mutex = PTHREAD_MUTEX_INITIALIZER;
116
1ea11eab
MD
117/* Should the ust comm thread quit ? */
118static int lttng_ust_comm_should_quit;
119
07b57e5e
MD
120/*
121 * This variable can be tested by applications to check whether
122 * lttng-ust is loaded. They simply have to define their own
123 * "lttng_ust_loaded" weak symbol, and test it. It is set to 1 by the
124 * library constructor.
125 */
126int lttng_ust_loaded __attribute__((weak));
127
3327ac33 128/*
d58d1454 129 * Return 0 on success, -1 if should quit.
3327ac33 130 * The lock is taken in both cases.
d58d1454 131 * Signal-safe.
3327ac33
MD
132 */
133int ust_lock(void)
134{
d58d1454 135 sigset_t sig_all_blocked, orig_mask;
e446ad80 136 int ret, oldstate;
d58d1454 137
e446ad80
MD
138 ret = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &oldstate);
139 if (ret) {
140 ERR("pthread_setcancelstate: %s", strerror(ret));
141 }
142 if (oldstate != PTHREAD_CANCEL_ENABLE) {
143 ERR("pthread_setcancelstate: unexpected oldstate");
144 }
d58d1454
MD
145 sigfillset(&sig_all_blocked);
146 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
147 if (ret) {
148 ERR("pthread_sigmask: %s", strerror(ret));
149 }
150 if (!URCU_TLS(ust_mutex_nest)++)
151 pthread_mutex_lock(&ust_mutex);
152 ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
153 if (ret) {
154 ERR("pthread_sigmask: %s", strerror(ret));
155 }
3327ac33
MD
156 if (lttng_ust_comm_should_quit) {
157 return -1;
158 } else {
159 return 0;
160 }
161}
162
163/*
164 * ust_lock_nocheck() can be used in constructors/destructors, because
165 * they are already nested within the dynamic loader lock, and therefore
166 * have exclusive access against execution of liblttng-ust destructor.
d58d1454 167 * Signal-safe.
3327ac33
MD
168 */
169void ust_lock_nocheck(void)
170{
d58d1454 171 sigset_t sig_all_blocked, orig_mask;
e446ad80 172 int ret, oldstate;
d58d1454 173
e446ad80
MD
174 ret = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &oldstate);
175 if (ret) {
176 ERR("pthread_setcancelstate: %s", strerror(ret));
177 }
178 if (oldstate != PTHREAD_CANCEL_ENABLE) {
179 ERR("pthread_setcancelstate: unexpected oldstate");
180 }
d58d1454
MD
181 sigfillset(&sig_all_blocked);
182 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
183 if (ret) {
184 ERR("pthread_sigmask: %s", strerror(ret));
185 }
186 if (!URCU_TLS(ust_mutex_nest)++)
187 pthread_mutex_lock(&ust_mutex);
188 ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
189 if (ret) {
190 ERR("pthread_sigmask: %s", strerror(ret));
191 }
3327ac33
MD
192}
193
d58d1454
MD
194/*
195 * Signal-safe.
196 */
3327ac33
MD
197void ust_unlock(void)
198{
d58d1454 199 sigset_t sig_all_blocked, orig_mask;
e446ad80 200 int ret, oldstate;
d58d1454
MD
201
202 sigfillset(&sig_all_blocked);
203 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
204 if (ret) {
205 ERR("pthread_sigmask: %s", strerror(ret));
206 }
207 if (!--URCU_TLS(ust_mutex_nest))
208 pthread_mutex_unlock(&ust_mutex);
209 ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
210 if (ret) {
211 ERR("pthread_sigmask: %s", strerror(ret));
212 }
e446ad80
MD
213 ret = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldstate);
214 if (ret) {
215 ERR("pthread_setcancelstate: %s", strerror(ret));
216 }
217 if (oldstate != PTHREAD_CANCEL_DISABLE) {
218 ERR("pthread_setcancelstate: unexpected oldstate");
219 }
3327ac33
MD
220}
221
11ff9c7d
MD
222/*
223 * Wait for either of these before continuing to the main
224 * program:
225 * - the register_done message from sessiond daemon
226 * (will let the sessiond daemon enable sessions before main
227 * starts.)
228 * - sessiond daemon is not reachable.
229 * - timeout (ensuring applications are resilient to session
230 * daemon problems).
231 */
232static sem_t constructor_wait;
950aab0c
MD
233/*
234 * Doing this for both the global and local sessiond.
235 */
eb0e6022
GAPG
236enum {
237 sem_count_initial_value = 4,
238};
239
240static int sem_count = sem_count_initial_value;
11ff9c7d 241
e8508a49
MD
242/*
243 * Counting nesting within lttng-ust. Used to ensure that calling fork()
244 * from liblttng-ust does not execute the pre/post fork handlers.
245 */
8c90a710 246static DEFINE_URCU_TLS(int, lttng_ust_nest_count);
e8508a49 247
1ea11eab
MD
248/*
249 * Info about socket and associated listener thread.
250 */
251struct sock_info {
11ff9c7d 252 const char *name;
1ea11eab 253 pthread_t ust_listener; /* listener thread */
46050b1a 254 int root_handle;
eb0e6022 255 int registration_done;
8d20bf54 256 int allowed;
44e073f5 257 int global;
e33f3265 258 int thread_active;
7fc90dca
MD
259
260 char sock_path[PATH_MAX];
261 int socket;
32ce8569 262 int notify_socket;
7fc90dca
MD
263
264 char wait_shm_path[PATH_MAX];
265 char *wait_shm_mmap;
37dddb65
MD
266 /* Keep track of lazy state dump not performed yet. */
267 int statedump_pending;
eb0e6022 268 int initial_statedump_done;
94be38e8
JR
269 /* Keep procname for statedump */
270 char procname[LTTNG_UST_PROCNAME_LEN];
1ea11eab 271};
2691221a
MD
272
273/* Socket from app (connect) to session daemon (listen) for communication */
1ea11eab 274struct sock_info global_apps = {
11ff9c7d 275 .name = "global",
44e073f5 276 .global = 1,
7fc90dca 277
46050b1a 278 .root_handle = -1,
eb0e6022 279 .registration_done = 0,
060577e3 280 .allowed = 0,
e33f3265 281 .thread_active = 0,
7fc90dca 282
32ce8569 283 .sock_path = LTTNG_DEFAULT_RUNDIR "/" LTTNG_UST_SOCK_FILENAME,
7fc90dca 284 .socket = -1,
32ce8569 285 .notify_socket = -1,
7fc90dca 286
32ce8569 287 .wait_shm_path = "/" LTTNG_UST_WAIT_FILENAME,
95c25348 288
37dddb65 289 .statedump_pending = 0,
eb0e6022 290 .initial_statedump_done = 0,
94be38e8 291 .procname[0] = '\0'
1ea11eab 292};
2691221a
MD
293
294/* TODO: allow global_apps_sock_path override */
295
1ea11eab 296struct sock_info local_apps = {
11ff9c7d 297 .name = "local",
44e073f5 298 .global = 0,
46050b1a 299 .root_handle = -1,
eb0e6022 300 .registration_done = 0,
8d20bf54 301 .allowed = 0, /* Check setuid bit first */
e33f3265 302 .thread_active = 0,
7fc90dca
MD
303
304 .socket = -1,
32ce8569 305 .notify_socket = -1,
95c25348 306
37dddb65 307 .statedump_pending = 0,
eb0e6022 308 .initial_statedump_done = 0,
94be38e8 309 .procname[0] = '\0'
1ea11eab 310};
2691221a 311
37ed587a
MD
312static int wait_poll_fallback;
313
74d81a6c
MD
314static const char *cmd_name_mapping[] = {
315 [ LTTNG_UST_RELEASE ] = "Release",
316 [ LTTNG_UST_SESSION ] = "Create Session",
317 [ LTTNG_UST_TRACER_VERSION ] = "Get Tracer Version",
318
319 [ LTTNG_UST_TRACEPOINT_LIST ] = "Create Tracepoint List",
320 [ LTTNG_UST_WAIT_QUIESCENT ] = "Wait for Quiescent State",
321 [ LTTNG_UST_REGISTER_DONE ] = "Registration Done",
322 [ LTTNG_UST_TRACEPOINT_FIELD_LIST ] = "Create Tracepoint Field List",
323
cb11f03a
FD
324 [ LTTNG_UST_TRIGGER_GROUP_CREATE ] = "Create trigger group",
325 [ LTTNG_UST_TRIGGER_CREATE ] = "Create trigger",
326
74d81a6c
MD
327 /* Session FD commands */
328 [ LTTNG_UST_CHANNEL ] = "Create Channel",
329 [ LTTNG_UST_SESSION_START ] = "Start Session",
330 [ LTTNG_UST_SESSION_STOP ] = "Stop Session",
331
332 /* Channel FD commands */
333 [ LTTNG_UST_STREAM ] = "Create Stream",
334 [ LTTNG_UST_EVENT ] = "Create Event",
335
336 /* Event and Channel FD commands */
337 [ LTTNG_UST_CONTEXT ] = "Create Context",
338 [ LTTNG_UST_FLUSH_BUFFER ] = "Flush Buffer",
339
340 /* Event, Channel and Session commands */
341 [ LTTNG_UST_ENABLE ] = "Enable",
342 [ LTTNG_UST_DISABLE ] = "Disable",
343
344 /* Tracepoint list commands */
345 [ LTTNG_UST_TRACEPOINT_LIST_GET ] = "List Next Tracepoint",
346 [ LTTNG_UST_TRACEPOINT_FIELD_LIST_GET ] = "List Next Tracepoint Field",
347
348 /* Event FD commands */
349 [ LTTNG_UST_FILTER ] = "Create Filter",
75582b3a 350 [ LTTNG_UST_EXCLUSION ] = "Add exclusions to event",
74d81a6c
MD
351};
352
ff517991
MD
353static const char *str_timeout;
354static int got_timeout_env;
355
7dd08bec 356extern void lttng_ring_buffer_client_overwrite_init(void);
34a91bdb 357extern void lttng_ring_buffer_client_overwrite_rt_init(void);
7dd08bec 358extern void lttng_ring_buffer_client_discard_init(void);
34a91bdb 359extern void lttng_ring_buffer_client_discard_rt_init(void);
7dd08bec
MD
360extern void lttng_ring_buffer_metadata_client_init(void);
361extern void lttng_ring_buffer_client_overwrite_exit(void);
34a91bdb 362extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
7dd08bec 363extern void lttng_ring_buffer_client_discard_exit(void);
34a91bdb 364extern void lttng_ring_buffer_client_discard_rt_exit(void);
7dd08bec 365extern void lttng_ring_buffer_metadata_client_exit(void);
edaa1431 366
060577e3
JR
367static char *get_map_shm(struct sock_info *sock_info);
368
405be658
MD
369ssize_t lttng_ust_read(int fd, void *buf, size_t len)
370{
371 ssize_t ret;
372 size_t copied = 0, to_copy = len;
373
374 do {
375 ret = read(fd, buf + copied, to_copy);
376 if (ret > 0) {
377 copied += ret;
378 to_copy -= ret;
379 }
380 } while ((ret > 0 && to_copy > 0)
381 || (ret < 0 && errno == EINTR));
382 if (ret > 0) {
383 ret = copied;
384 }
385 return ret;
386}
3c6f6263
AM
387/*
388 * Returns the HOME directory path. Caller MUST NOT free(3) the returned
389 * pointer.
390 */
391static
392const char *get_lttng_home_dir(void)
393{
394 const char *val;
395
6f626d28 396 val = (const char *) lttng_getenv("LTTNG_HOME");
3c6f6263
AM
397 if (val != NULL) {
398 return val;
399 }
6f626d28 400 return (const char *) lttng_getenv("HOME");
3c6f6263
AM
401}
402
a903623f
MD
403/*
404 * Force a read (imply TLS fixup for dlopen) of TLS variables.
405 */
406static
407void lttng_fixup_nest_count_tls(void)
408{
8c90a710 409 asm volatile ("" : : "m" (URCU_TLS(lttng_ust_nest_count)));
a903623f
MD
410}
411
d58d1454
MD
412static
413void lttng_fixup_ust_mutex_nest_tls(void)
414{
415 asm volatile ("" : : "m" (URCU_TLS(ust_mutex_nest)));
416}
417
1556a549
MD
418/*
419 * Fixup urcu bp TLS.
420 */
421static
422void lttng_fixup_urcu_bp_tls(void)
423{
424 rcu_read_lock();
425 rcu_read_unlock();
426}
427
c362addf
MD
428void lttng_ust_fixup_tls(void)
429{
430 lttng_fixup_urcu_bp_tls();
431 lttng_fixup_ringbuffer_tls();
432 lttng_fixup_vtid_tls();
433 lttng_fixup_nest_count_tls();
434 lttng_fixup_procname_tls();
435 lttng_fixup_ust_mutex_nest_tls();
20142124 436 lttng_ust_fixup_perf_counter_tls();
6548fca4 437 lttng_ust_fixup_fd_tracker_tls();
735bef47
MJ
438 lttng_fixup_cgroup_ns_tls();
439 lttng_fixup_ipc_ns_tls();
440 lttng_fixup_net_ns_tls();
441 lttng_fixup_uts_ns_tls();
c362addf
MD
442}
443
32ce8569
MD
444int lttng_get_notify_socket(void *owner)
445{
446 struct sock_info *info = owner;
447
448 return info->notify_socket;
449}
450
94be38e8
JR
451
452LTTNG_HIDDEN
453char* lttng_ust_sockinfo_get_procname(void *owner)
454{
455 struct sock_info *info = owner;
456
457 return info->procname;
458}
459
74d81a6c
MD
460static
461void print_cmd(int cmd, int handle)
462{
463 const char *cmd_name = "Unknown";
464
fd67a004
MD
465 if (cmd >= 0 && cmd < LTTNG_ARRAY_SIZE(cmd_name_mapping)
466 && cmd_name_mapping[cmd]) {
74d81a6c
MD
467 cmd_name = cmd_name_mapping[cmd];
468 }
fd67a004
MD
469 DBG("Message Received \"%s\" (%d), Handle \"%s\" (%d)",
470 cmd_name, cmd,
74d81a6c
MD
471 lttng_ust_obj_get_name(handle), handle);
472}
473
060577e3
JR
474static
475int setup_global_apps(void)
476{
477 int ret = 0;
478 assert(!global_apps.wait_shm_mmap);
479
480 global_apps.wait_shm_mmap = get_map_shm(&global_apps);
481 if (!global_apps.wait_shm_mmap) {
482 WARN("Unable to get map shm for global apps. Disabling LTTng-UST global tracing.");
483 global_apps.allowed = 0;
484 ret = -EIO;
485 goto error;
486 }
487
488 global_apps.allowed = 1;
94be38e8 489 lttng_ust_getprocname(global_apps.procname);
060577e3
JR
490error:
491 return ret;
492}
2691221a 493static
8d20bf54 494int setup_local_apps(void)
2691221a 495{
060577e3 496 int ret = 0;
2691221a 497 const char *home_dir;
7fc90dca 498 uid_t uid;
2691221a 499
060577e3
JR
500 assert(!local_apps.wait_shm_mmap);
501
7fc90dca 502 uid = getuid();
8d20bf54
MD
503 /*
504 * Disallow per-user tracing for setuid binaries.
505 */
7fc90dca 506 if (uid != geteuid()) {
9ec6895c 507 assert(local_apps.allowed == 0);
060577e3
JR
508 ret = 0;
509 goto end;
8d20bf54 510 }
3c6f6263 511 home_dir = get_lttng_home_dir();
9ec6895c
MD
512 if (!home_dir) {
513 WARN("HOME environment variable not set. Disabling LTTng-UST per-user tracing.");
514 assert(local_apps.allowed == 0);
060577e3
JR
515 ret = -ENOENT;
516 goto end;
9ec6895c
MD
517 }
518 local_apps.allowed = 1;
32ce8569
MD
519 snprintf(local_apps.sock_path, PATH_MAX, "%s/%s/%s",
520 home_dir,
521 LTTNG_DEFAULT_HOME_RUNDIR,
522 LTTNG_UST_SOCK_FILENAME);
523 snprintf(local_apps.wait_shm_path, PATH_MAX, "/%s-%u",
524 LTTNG_UST_WAIT_FILENAME,
525 uid);
060577e3
JR
526
527 local_apps.wait_shm_mmap = get_map_shm(&local_apps);
528 if (!local_apps.wait_shm_mmap) {
529 WARN("Unable to get map shm for local apps. Disabling LTTng-UST per-user tracing.");
530 local_apps.allowed = 0;
531 ret = -EIO;
532 goto end;
533 }
94be38e8
JR
534
535 lttng_ust_getprocname(local_apps.procname);
060577e3
JR
536end:
537 return ret;
2691221a
MD
538}
539
ff517991 540/*
451d66b2 541 * Get socket timeout, in ms.
28515902 542 * -1: wait forever. 0: don't wait. >0: timeout, in ms.
ff517991
MD
543 */
544static
545long get_timeout(void)
546{
547 long constructor_delay_ms = LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS;
548
549 if (!got_timeout_env) {
6f626d28 550 str_timeout = lttng_getenv("LTTNG_UST_REGISTER_TIMEOUT");
ff517991
MD
551 got_timeout_env = 1;
552 }
553 if (str_timeout)
554 constructor_delay_ms = strtol(str_timeout, NULL, 10);
5cf81d53
MD
555 /* All negative values are considered as "-1". */
556 if (constructor_delay_ms < -1)
557 constructor_delay_ms = -1;
ff517991
MD
558 return constructor_delay_ms;
559}
560
451d66b2 561/* Timeout for notify socket send and recv. */
ff517991
MD
562static
563long get_notify_sock_timeout(void)
564{
565 return get_timeout();
566}
567
451d66b2
MD
568/* Timeout for connecting to cmd and notify sockets. */
569static
570long get_connect_sock_timeout(void)
571{
572 return get_timeout();
573}
574
ff517991 575/*
28515902 576 * Return values: -1: wait forever. 0: don't wait. 1: timeout wait.
ff517991
MD
577 */
578static
579int get_constructor_timeout(struct timespec *constructor_timeout)
580{
581 long constructor_delay_ms;
582 int ret;
583
584 constructor_delay_ms = get_timeout();
585
586 switch (constructor_delay_ms) {
587 case -1:/* fall-through */
588 case 0:
589 return constructor_delay_ms;
590 default:
591 break;
592 }
593
594 /*
595 * If we are unable to find the current time, don't wait.
596 */
597 ret = clock_gettime(CLOCK_REALTIME, constructor_timeout);
598 if (ret) {
28515902
JG
599 /* Don't wait. */
600 return 0;
ff517991
MD
601 }
602 constructor_timeout->tv_sec += constructor_delay_ms / 1000UL;
603 constructor_timeout->tv_nsec +=
604 (constructor_delay_ms % 1000UL) * 1000000UL;
605 if (constructor_timeout->tv_nsec >= 1000000000UL) {
606 constructor_timeout->tv_sec++;
607 constructor_timeout->tv_nsec -= 1000000000UL;
608 }
28515902 609 /* Timeout wait (constructor_delay_ms). */
ff517991
MD
610 return 1;
611}
612
6f97f9c2 613static
b2c5f61a 614void get_allow_blocking(void)
6f97f9c2 615{
b2c5f61a
MD
616 const char *str_allow_blocking =
617 lttng_getenv("LTTNG_UST_ALLOW_BLOCKING");
618
619 if (str_allow_blocking) {
620 DBG("%s environment variable is set",
621 "LTTNG_UST_ALLOW_BLOCKING");
622 lttng_ust_ringbuffer_set_allow_blocking();
6f97f9c2
MD
623 }
624}
625
2691221a 626static
32ce8569 627int register_to_sessiond(int socket, enum ustctl_socket_type type)
2691221a 628{
32ce8569
MD
629 return ustcomm_send_reg_msg(socket,
630 type,
631 CAA_BITS_PER_LONG,
632 lttng_alignof(uint8_t) * CHAR_BIT,
633 lttng_alignof(uint16_t) * CHAR_BIT,
634 lttng_alignof(uint32_t) * CHAR_BIT,
635 lttng_alignof(uint64_t) * CHAR_BIT,
636 lttng_alignof(unsigned long) * CHAR_BIT);
2691221a
MD
637}
638
d9e99d10 639static
57773204 640int send_reply(int sock, struct ustcomm_ust_reply *lur)
d9e99d10 641{
9eb62b9c 642 ssize_t len;
d3a492d1 643
57773204 644 len = ustcomm_send_unix_sock(sock, lur, sizeof(*lur));
d3a492d1 645 switch (len) {
a4be8962 646 case sizeof(*lur):
d3a492d1
MD
647 DBG("message successfully sent");
648 return 0;
7bc53e94
MD
649 default:
650 if (len == -ECONNRESET) {
651 DBG("remote end closed connection");
d3a492d1
MD
652 return 0;
653 }
7bc53e94
MD
654 if (len < 0)
655 return len;
656 DBG("incorrect message size: %zd", len);
657 return -EINVAL;
d3a492d1
MD
658 }
659}
660
661static
eb0e6022 662void decrement_sem_count(unsigned int count)
11ff9c7d
MD
663{
664 int ret;
665
eb0e6022
GAPG
666 assert(uatomic_read(&sem_count) >= count);
667
56cd7e2f 668 if (uatomic_read(&sem_count) <= 0) {
eb0e6022 669 return;
56cd7e2f 670 }
eb0e6022
GAPG
671
672 ret = uatomic_add_return(&sem_count, -count);
95259bd0
MD
673 if (ret == 0) {
674 ret = sem_post(&constructor_wait);
675 assert(!ret);
676 }
eb0e6022
GAPG
677}
678
679static
680int handle_register_done(struct sock_info *sock_info)
681{
682 if (sock_info->registration_done)
683 return 0;
684 sock_info->registration_done = 1;
685
686 decrement_sem_count(1);
04682184
MD
687 if (!sock_info->statedump_pending) {
688 sock_info->initial_statedump_done = 1;
689 decrement_sem_count(1);
690 }
eb0e6022
GAPG
691
692 return 0;
693}
694
695static
696int handle_register_failed(struct sock_info *sock_info)
697{
698 if (sock_info->registration_done)
699 return 0;
700 sock_info->registration_done = 1;
701 sock_info->initial_statedump_done = 1;
702
703 decrement_sem_count(2);
704
11ff9c7d
MD
705 return 0;
706}
707
37dddb65
MD
708/*
709 * Only execute pending statedump after the constructor semaphore has
eb0e6022
GAPG
710 * been posted by the current listener thread. This means statedump will
711 * only be performed after the "registration done" command is received
712 * from this thread's session daemon.
37dddb65
MD
713 *
714 * This ensures we don't run into deadlock issues with the dynamic
715 * loader mutex, which is held while the constructor is called and
716 * waiting on the constructor semaphore. All operations requiring this
717 * dynamic loader lock need to be postponed using this mechanism.
eb0e6022
GAPG
718 *
719 * In a scenario with two session daemons connected to the application,
720 * it is possible that the first listener thread which receives the
721 * registration done command issues its statedump while the dynamic
722 * loader lock is still held by the application constructor waiting on
723 * the semaphore. It will however be allowed to proceed when the
724 * second session daemon sends the registration done command to the
725 * second listener thread. This situation therefore does not produce
726 * a deadlock.
37dddb65
MD
727 */
728static
729void handle_pending_statedump(struct sock_info *sock_info)
730{
eb0e6022 731 if (sock_info->registration_done && sock_info->statedump_pending) {
37dddb65 732 sock_info->statedump_pending = 0;
2932a87f 733 pthread_mutex_lock(&ust_fork_mutex);
37dddb65 734 lttng_handle_pending_statedump(sock_info);
458d678c 735 pthread_mutex_unlock(&ust_fork_mutex);
eb0e6022
GAPG
736
737 if (!sock_info->initial_statedump_done) {
738 sock_info->initial_statedump_done = 1;
739 decrement_sem_count(1);
740 }
37dddb65
MD
741 }
742}
743
cb11f03a
FD
744static inline
745const char *bytecode_type_str(uint32_t cmd)
746{
747 switch (cmd) {
748 case LTTNG_UST_CAPTURE:
749 return "capture";
750 case LTTNG_UST_FILTER:
751 return "filter";
752 default:
753 abort();
754 }
755}
756
757static
758int handle_bytecode_recv(struct sock_info *sock_info,
759 int sock, struct ustcomm_ust_msg *lum)
760{
761 struct lttng_ust_bytecode_node *bytecode;
762 enum lttng_ust_bytecode_node_type type;
763 const struct lttng_ust_objd_ops *ops;
764 uint32_t data_size, data_size_max, reloc_offset;
765 uint64_t seqnum;
766 ssize_t len;
767 int ret = 0;
768
769 switch (lum->cmd) {
770 case LTTNG_UST_FILTER:
771 type = LTTNG_UST_BYTECODE_NODE_TYPE_FILTER;
772 data_size = lum->u.filter.data_size;
773 data_size_max = FILTER_BYTECODE_MAX_LEN;
774 reloc_offset = lum->u.filter.reloc_offset;
775 seqnum = lum->u.filter.seqnum;
776 break;
777 case LTTNG_UST_CAPTURE:
778 type = LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE;
779 data_size = lum->u.capture.data_size;
780 data_size_max = CAPTURE_BYTECODE_MAX_LEN;
781 reloc_offset = lum->u.capture.reloc_offset;
782 seqnum = lum->u.capture.seqnum;
783 break;
784 default:
785 abort();
786 }
787
788 if (data_size > data_size_max) {
789 ERR("Bytecode %s data size is too large: %u bytes",
790 bytecode_type_str(lum->cmd), data_size);
791 ret = -EINVAL;
792 goto end;
793 }
794
795 if (reloc_offset > data_size) {
796 ERR("Bytecode %s reloc offset %u is not within data",
797 bytecode_type_str(lum->cmd), reloc_offset);
798 ret = -EINVAL;
799 goto end;
800 }
801
802 /* Allocate the structure AND the `data[]` field. */
803 bytecode = zmalloc(sizeof(*bytecode) + data_size);
804 if (!bytecode) {
805 ret = -ENOMEM;
806 goto end;
807 }
808
809 bytecode->bc.len = data_size;
810 bytecode->bc.reloc_offset = reloc_offset;
811 bytecode->bc.seqnum = seqnum;
812 bytecode->type = type;
813
814 len = ustcomm_recv_unix_sock(sock, bytecode->bc.data, bytecode->bc.len);
815 switch (len) {
816 case 0: /* orderly shutdown */
817 ret = 0;
818 goto error_free_bytecode;
819 default:
820 if (len == bytecode->bc.len) {
821 DBG("Bytecode %s data received",
822 bytecode_type_str(lum->cmd));
823 break;
824 } else if (len < 0) {
825 DBG("Receive failed from lttng-sessiond with errno %d",
826 (int) -len);
827 if (len == -ECONNRESET) {
828 ERR("%s remote end closed connection",
829 sock_info->name);
830 ret = len;
831 goto error_free_bytecode;
832 }
833 ret = len;
834 goto error_free_bytecode;
835 } else {
836 DBG("Incorrect %s bytecode data message size: %zd",
837 bytecode_type_str(lum->cmd), len);
838 ret = -EINVAL;
839 goto error_free_bytecode;
840 }
841 }
842
843 ops = objd_ops(lum->handle);
844 if (!ops) {
845 ret = -ENOENT;
846 goto error_free_bytecode;
847 }
848
849 if (ops->cmd) {
850 ret = ops->cmd(lum->handle, lum->cmd,
851 (unsigned long) bytecode,
852 NULL, sock_info);
853 if (ret)
854 goto error_free_bytecode;
855 /* don't free bytecode if everything went fine. */
856 } else {
857 ret = -ENOSYS;
858 goto error_free_bytecode;
859 }
860
861 goto end;
862
863error_free_bytecode:
864 free(bytecode);
865end:
866 return ret;
867}
868
11ff9c7d
MD
869static
870int handle_message(struct sock_info *sock_info,
57773204 871 int sock, struct ustcomm_ust_msg *lum)
d3a492d1 872{
1ea11eab 873 int ret = 0;
b61ce3b2 874 const struct lttng_ust_objd_ops *ops;
57773204 875 struct ustcomm_ust_reply lur;
ef9ff354 876 union ust_args args;
8e696cfa 877 char ctxstr[LTTNG_UST_SYM_NAME_LEN]; /* App context string. */
40003310 878 ssize_t len;
1ea11eab 879
46050b1a
MD
880 memset(&lur, 0, sizeof(lur));
881
3327ac33 882 if (ust_lock()) {
74d81a6c 883 ret = -LTTNG_UST_ERR_EXITING;
0dafcd63 884 goto error;
1ea11eab 885 }
9eb62b9c 886
46050b1a
MD
887 ops = objd_ops(lum->handle);
888 if (!ops) {
889 ret = -ENOENT;
0dafcd63 890 goto error;
1ea11eab 891 }
46050b1a
MD
892
893 switch (lum->cmd) {
11ff9c7d
MD
894 case LTTNG_UST_REGISTER_DONE:
895 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
edaa1431 896 ret = handle_register_done(sock_info);
11ff9c7d
MD
897 else
898 ret = -EINVAL;
899 break;
46050b1a
MD
900 case LTTNG_UST_RELEASE:
901 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
902 ret = -EPERM;
903 else
1849ef7c 904 ret = lttng_ust_objd_unref(lum->handle, 1);
d9e99d10 905 break;
cb11f03a 906 case LTTNG_UST_CAPTURE:
2d78951a 907 case LTTNG_UST_FILTER:
cb11f03a
FD
908 ret = handle_bytecode_recv(sock_info, sock, lum);
909 if (ret)
2734ca65 910 goto error;
2d78951a 911 break;
86e36163
JI
912 case LTTNG_UST_EXCLUSION:
913 {
914 /* Receive exclusion names */
915 struct lttng_ust_excluder_node *node;
916 unsigned int count;
917
918 count = lum->u.exclusion.count;
919 if (count == 0) {
920 /* There are no names to read */
921 ret = 0;
922 goto error;
923 }
924 node = zmalloc(sizeof(*node) +
925 count * LTTNG_UST_SYM_NAME_LEN);
926 if (!node) {
927 ret = -ENOMEM;
928 goto error;
929 }
930 node->excluder.count = count;
931 len = ustcomm_recv_unix_sock(sock, node->excluder.names,
932 count * LTTNG_UST_SYM_NAME_LEN);
933 switch (len) {
934 case 0: /* orderly shutdown */
935 ret = 0;
936 free(node);
937 goto error;
938 default:
939 if (len == count * LTTNG_UST_SYM_NAME_LEN) {
940 DBG("Exclusion data received");
941 break;
942 } else if (len < 0) {
943 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
944 if (len == -ECONNRESET) {
945 ERR("%s remote end closed connection", sock_info->name);
946 ret = len;
947 free(node);
948 goto error;
949 }
950 ret = len;
951 free(node);
0dafcd63 952 goto error;
86e36163
JI
953 } else {
954 DBG("Incorrect exclusion data message size: %zd", len);
955 ret = -EINVAL;
956 free(node);
0dafcd63 957 goto error;
86e36163
JI
958 }
959 }
960 if (ops->cmd) {
961 ret = ops->cmd(lum->handle, lum->cmd,
962 (unsigned long) node,
963 &args, sock_info);
964 if (ret) {
965 free(node);
966 }
967 /* Don't free exclusion data if everything went fine. */
968 } else {
969 ret = -ENOSYS;
970 free(node);
971 }
972 break;
973 }
cb11f03a
FD
974 case LTTNG_UST_TRIGGER_GROUP_CREATE:
975 {
976 int trigger_notif_fd;
977
978 len = ustcomm_recv_trigger_notif_fd_from_sessiond(sock,
979 &trigger_notif_fd);
980 switch (len) {
981 case 0: /* orderly shutdown */
982 ret = 0;
983 goto error;
984 case 1:
985 break;
986 default:
987 if (len < 0) {
988 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
989 if (len == -ECONNRESET) {
990 ERR("%s remote end closed connection", sock_info->name);
991 ret = len;
992 goto error;
993 }
994 ret = len;
995 goto error;
996 } else {
997 DBG("incorrect trigger fd message size: %zd", len);
998 ret = -EINVAL;
999 goto error;
1000 }
1001 }
1002 args.trigger_handle.trigger_notif_fd = trigger_notif_fd;
1003 if (ops->cmd)
1004 ret = ops->cmd(lum->handle, lum->cmd,
1005 (unsigned long) &lum->u,
1006 &args, sock_info);
1007 else
1008 ret = -ENOSYS;
1009 break;
1010 }
74d81a6c
MD
1011 case LTTNG_UST_CHANNEL:
1012 {
1013 void *chan_data;
ff0f5728 1014 int wakeup_fd;
74d81a6c
MD
1015
1016 len = ustcomm_recv_channel_from_sessiond(sock,
ff0f5728
MD
1017 &chan_data, lum->u.channel.len,
1018 &wakeup_fd);
74d81a6c
MD
1019 switch (len) {
1020 case 0: /* orderly shutdown */
1021 ret = 0;
1022 goto error;
1023 default:
1024 if (len == lum->u.channel.len) {
1025 DBG("channel data received");
1026 break;
1027 } else if (len < 0) {
1028 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
1029 if (len == -ECONNRESET) {
1030 ERR("%s remote end closed connection", sock_info->name);
1031 ret = len;
1032 goto error;
1033 }
1034 ret = len;
0dafcd63 1035 goto error;
74d81a6c
MD
1036 } else {
1037 DBG("incorrect channel data message size: %zd", len);
1038 ret = -EINVAL;
0dafcd63 1039 goto error;
74d81a6c
MD
1040 }
1041 }
1042 args.channel.chan_data = chan_data;
ff0f5728 1043 args.channel.wakeup_fd = wakeup_fd;
74d81a6c
MD
1044 if (ops->cmd)
1045 ret = ops->cmd(lum->handle, lum->cmd,
1046 (unsigned long) &lum->u,
1047 &args, sock_info);
1048 else
1049 ret = -ENOSYS;
1050 break;
1051 }
1052 case LTTNG_UST_STREAM:
1053 {
1054 /* Receive shm_fd, wakeup_fd */
1055 ret = ustcomm_recv_stream_from_sessiond(sock,
61e520fb 1056 NULL,
74d81a6c
MD
1057 &args.stream.shm_fd,
1058 &args.stream.wakeup_fd);
1059 if (ret) {
0dafcd63 1060 goto error;
74d81a6c 1061 }
973eac63 1062
74d81a6c
MD
1063 if (ops->cmd)
1064 ret = ops->cmd(lum->handle, lum->cmd,
1065 (unsigned long) &lum->u,
1066 &args, sock_info);
1067 else
1068 ret = -ENOSYS;
1069 break;
1070 }
8e696cfa
MD
1071 case LTTNG_UST_CONTEXT:
1072 switch (lum->u.context.ctx) {
1073 case LTTNG_UST_CONTEXT_APP_CONTEXT:
1074 {
1075 char *p;
1076 size_t ctxlen, recvlen;
1077
1078 ctxlen = strlen("$app.") + lum->u.context.u.app_ctx.provider_name_len - 1
1079 + strlen(":") + lum->u.context.u.app_ctx.ctx_name_len;
1080 if (ctxlen >= LTTNG_UST_SYM_NAME_LEN) {
1081 ERR("Application context string length size is too large: %zu bytes",
1082 ctxlen);
1083 ret = -EINVAL;
1084 goto error;
1085 }
1086 strcpy(ctxstr, "$app.");
1087 p = &ctxstr[strlen("$app.")];
1088 recvlen = ctxlen - strlen("$app.");
1089 len = ustcomm_recv_unix_sock(sock, p, recvlen);
1090 switch (len) {
1091 case 0: /* orderly shutdown */
1092 ret = 0;
1093 goto error;
1094 default:
1095 if (len == recvlen) {
1096 DBG("app context data received");
1097 break;
1098 } else if (len < 0) {
1099 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
1100 if (len == -ECONNRESET) {
1101 ERR("%s remote end closed connection", sock_info->name);
1102 ret = len;
1103 goto error;
1104 }
1105 ret = len;
1106 goto error;
1107 } else {
1108 DBG("incorrect app context data message size: %zd", len);
1109 ret = -EINVAL;
1110 goto error;
1111 }
1112 }
1113 /* Put : between provider and ctxname. */
1114 p[lum->u.context.u.app_ctx.provider_name_len - 1] = ':';
1115 args.app_context.ctxname = ctxstr;
1116 break;
1117 }
1118 default:
1119 break;
1120 }
1121 if (ops->cmd) {
1122 ret = ops->cmd(lum->handle, lum->cmd,
1123 (unsigned long) &lum->u,
1124 &args, sock_info);
1125 } else {
1126 ret = -ENOSYS;
1127 }
1128 break;
d9e99d10 1129 default:
46050b1a
MD
1130 if (ops->cmd)
1131 ret = ops->cmd(lum->handle, lum->cmd,
ef9ff354 1132 (unsigned long) &lum->u,
f59ed768 1133 &args, sock_info);
46050b1a
MD
1134 else
1135 ret = -ENOSYS;
1136 break;
d9e99d10 1137 }
46050b1a 1138
46050b1a
MD
1139 lur.handle = lum->handle;
1140 lur.cmd = lum->cmd;
1141 lur.ret_val = ret;
1142 if (ret >= 0) {
7bc53e94 1143 lur.ret_code = LTTNG_UST_OK;
46050b1a 1144 } else {
7bc53e94
MD
1145 /*
1146 * Use -LTTNG_UST_ERR as wildcard for UST internal
1147 * error that are not caused by the transport, except if
1148 * we already have a more precise error message to
1149 * report.
1150 */
64b2564e
DG
1151 if (ret > -LTTNG_UST_ERR) {
1152 /* Translate code to UST error. */
1153 switch (ret) {
1154 case -EEXIST:
1155 lur.ret_code = -LTTNG_UST_ERR_EXIST;
1156 break;
1157 case -EINVAL:
1158 lur.ret_code = -LTTNG_UST_ERR_INVAL;
1159 break;
1160 case -ENOENT:
1161 lur.ret_code = -LTTNG_UST_ERR_NOENT;
1162 break;
1163 case -EPERM:
1164 lur.ret_code = -LTTNG_UST_ERR_PERM;
1165 break;
1166 case -ENOSYS:
1167 lur.ret_code = -LTTNG_UST_ERR_NOSYS;
1168 break;
1169 default:
1170 lur.ret_code = -LTTNG_UST_ERR;
1171 break;
1172 }
1173 } else {
7bc53e94 1174 lur.ret_code = ret;
64b2564e 1175 }
46050b1a 1176 }
e6ea14c5
MD
1177 if (ret >= 0) {
1178 switch (lum->cmd) {
e6ea14c5
MD
1179 case LTTNG_UST_TRACER_VERSION:
1180 lur.u.version = lum->u.version;
1181 break;
1182 case LTTNG_UST_TRACEPOINT_LIST_GET:
1183 memcpy(&lur.u.tracepoint, &lum->u.tracepoint, sizeof(lur.u.tracepoint));
1184 break;
1185 }
381c0f1e 1186 }
74d81a6c 1187 DBG("Return value: %d", lur.ret_val);
4c62d8d1
MD
1188
1189 ust_unlock();
1190
1191 /*
1192 * Performed delayed statedump operations outside of the UST
1193 * lock. We need to take the dynamic loader lock before we take
1194 * the UST lock internally within handle_pending_statedump().
1195 */
1196 handle_pending_statedump(sock_info);
1197
1198 if (ust_lock()) {
1199 ret = -LTTNG_UST_ERR_EXITING;
1200 goto error;
1201 }
1202
46050b1a 1203 ret = send_reply(sock, &lur);
193183fb 1204 if (ret < 0) {
7bc53e94 1205 DBG("error sending reply");
193183fb
MD
1206 goto error;
1207 }
46050b1a 1208
40003310
MD
1209 /*
1210 * LTTNG_UST_TRACEPOINT_FIELD_LIST_GET needs to send the field
1211 * after the reply.
1212 */
7bc53e94 1213 if (lur.ret_code == LTTNG_UST_OK) {
40003310
MD
1214 switch (lum->cmd) {
1215 case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET:
1216 len = ustcomm_send_unix_sock(sock,
1217 &args.field_list.entry,
1218 sizeof(args.field_list.entry));
7bc53e94
MD
1219 if (len < 0) {
1220 ret = len;
1221 goto error;
1222 }
40003310 1223 if (len != sizeof(args.field_list.entry)) {
7bc53e94 1224 ret = -EINVAL;
40003310
MD
1225 goto error;
1226 }
1227 }
1228 }
ef9ff354 1229
381c0f1e 1230error:
17dfb34b 1231 ust_unlock();
d9e99d10 1232
37dddb65 1233 return ret;
246be17e
PW
1234}
1235
46050b1a 1236static
efe0de09 1237void cleanup_sock_info(struct sock_info *sock_info, int exiting)
46050b1a
MD
1238{
1239 int ret;
1240
5b14aab3
MD
1241 if (sock_info->root_handle != -1) {
1242 ret = lttng_ust_objd_unref(sock_info->root_handle, 1);
1243 if (ret) {
1244 ERR("Error unref root handle");
1245 }
1246 sock_info->root_handle = -1;
1247 }
eb0e6022
GAPG
1248 sock_info->registration_done = 0;
1249 sock_info->initial_statedump_done = 0;
5b14aab3
MD
1250
1251 /*
1252 * wait_shm_mmap, socket and notify socket are used by listener
1253 * threads outside of the ust lock, so we cannot tear them down
1254 * ourselves, because we cannot join on these threads. Leave
1255 * responsibility of cleaning up these resources to the OS
1256 * process exit.
1257 */
1258 if (exiting)
1259 return;
1260
46050b1a 1261 if (sock_info->socket != -1) {
e6973a89 1262 ret = ustcomm_close_unix_sock(sock_info->socket);
46050b1a 1263 if (ret) {
32ce8569 1264 ERR("Error closing ust cmd socket");
46050b1a
MD
1265 }
1266 sock_info->socket = -1;
1267 }
32ce8569
MD
1268 if (sock_info->notify_socket != -1) {
1269 ret = ustcomm_close_unix_sock(sock_info->notify_socket);
1270 if (ret) {
1271 ERR("Error closing ust notify socket");
1272 }
1273 sock_info->notify_socket = -1;
1274 }
5b14aab3 1275 if (sock_info->wait_shm_mmap) {
172d6b68
MD
1276 long page_size;
1277
1278 page_size = sysconf(_SC_PAGE_SIZE);
2657d1ba
MD
1279 if (page_size <= 0) {
1280 if (!page_size) {
1281 errno = EINVAL;
1282 }
1283 PERROR("Error in sysconf(_SC_PAGE_SIZE)");
1284 } else {
172d6b68
MD
1285 ret = munmap(sock_info->wait_shm_mmap, page_size);
1286 if (ret) {
1287 ERR("Error unmapping wait shm");
1288 }
7fc90dca
MD
1289 }
1290 sock_info->wait_shm_mmap = NULL;
1291 }
1292}
1293
58d4b2a2 1294/*
33bbeb90
MD
1295 * Using fork to set umask in the child process (not multi-thread safe).
1296 * We deal with the shm_open vs ftruncate race (happening when the
1297 * sessiond owns the shm and does not let everybody modify it, to ensure
1298 * safety against shm_unlink) by simply letting the mmap fail and
1299 * retrying after a few seconds.
1300 * For global shm, everybody has rw access to it until the sessiond
1301 * starts.
58d4b2a2 1302 */
7fc90dca 1303static
58d4b2a2 1304int get_wait_shm(struct sock_info *sock_info, size_t mmap_size)
7fc90dca 1305{
7fc90dca 1306 int wait_shm_fd, ret;
58d4b2a2 1307 pid_t pid;
44e073f5 1308
58d4b2a2 1309 /*
33bbeb90 1310 * Try to open read-only.
58d4b2a2 1311 */
33bbeb90 1312 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
58d4b2a2 1313 if (wait_shm_fd >= 0) {
7aa76730
MD
1314 int32_t tmp_read;
1315 ssize_t len;
1316 size_t bytes_read = 0;
1317
1318 /*
1319 * Try to read the fd. If unable to do so, try opening
1320 * it in write mode.
1321 */
1322 do {
1323 len = read(wait_shm_fd,
1324 &((char *) &tmp_read)[bytes_read],
1325 sizeof(tmp_read) - bytes_read);
1326 if (len > 0) {
1327 bytes_read += len;
1328 }
1329 } while ((len < 0 && errno == EINTR)
1330 || (len > 0 && bytes_read < sizeof(tmp_read)));
1331 if (bytes_read != sizeof(tmp_read)) {
1332 ret = close(wait_shm_fd);
1333 if (ret) {
1334 ERR("close wait_shm_fd");
1335 }
1336 goto open_write;
1337 }
58d4b2a2
MD
1338 goto end;
1339 } else if (wait_shm_fd < 0 && errno != ENOENT) {
1340 /*
33bbeb90
MD
1341 * Real-only open did not work, and it's not because the
1342 * entry was not present. It's a failure that prohibits
1343 * using shm.
58d4b2a2 1344 */
7fc90dca 1345 ERR("Error opening shm %s", sock_info->wait_shm_path);
58d4b2a2 1346 goto end;
7fc90dca 1347 }
7aa76730
MD
1348
1349open_write:
7fc90dca 1350 /*
7aa76730
MD
1351 * If the open failed because the file did not exist, or because
1352 * the file was not truncated yet, try creating it ourself.
7fc90dca 1353 */
8c90a710 1354 URCU_TLS(lttng_ust_nest_count)++;
58d4b2a2 1355 pid = fork();
8c90a710 1356 URCU_TLS(lttng_ust_nest_count)--;
58d4b2a2
MD
1357 if (pid > 0) {
1358 int status;
1359
1360 /*
1361 * Parent: wait for child to return, in which case the
1362 * shared memory map will have been created.
1363 */
1364 pid = wait(&status);
b7d3cb32 1365 if (pid < 0 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
58d4b2a2
MD
1366 wait_shm_fd = -1;
1367 goto end;
7fc90dca 1368 }
58d4b2a2
MD
1369 /*
1370 * Try to open read-only again after creation.
1371 */
33bbeb90 1372 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
58d4b2a2
MD
1373 if (wait_shm_fd < 0) {
1374 /*
1375 * Real-only open did not work. It's a failure
1376 * that prohibits using shm.
1377 */
1378 ERR("Error opening shm %s", sock_info->wait_shm_path);
1379 goto end;
1380 }
1381 goto end;
1382 } else if (pid == 0) {
1383 int create_mode;
1384
1385 /* Child */
33bbeb90 1386 create_mode = S_IRUSR | S_IWUSR | S_IRGRP;
58d4b2a2 1387 if (sock_info->global)
33bbeb90 1388 create_mode |= S_IROTH | S_IWGRP | S_IWOTH;
58d4b2a2
MD
1389 /*
1390 * We're alone in a child process, so we can modify the
1391 * process-wide umask.
1392 */
33bbeb90 1393 umask(~create_mode);
58d4b2a2 1394 /*
33bbeb90
MD
1395 * Try creating shm (or get rw access).
1396 * We don't do an exclusive open, because we allow other
1397 * processes to create+ftruncate it concurrently.
58d4b2a2
MD
1398 */
1399 wait_shm_fd = shm_open(sock_info->wait_shm_path,
1400 O_RDWR | O_CREAT, create_mode);
1401 if (wait_shm_fd >= 0) {
1402 ret = ftruncate(wait_shm_fd, mmap_size);
1403 if (ret) {
1404 PERROR("ftruncate");
b0c1425d 1405 _exit(EXIT_FAILURE);
58d4b2a2 1406 }
b0c1425d 1407 _exit(EXIT_SUCCESS);
58d4b2a2 1408 }
33bbeb90
MD
1409 /*
1410 * For local shm, we need to have rw access to accept
1411 * opening it: this means the local sessiond will be
1412 * able to wake us up. For global shm, we open it even
1413 * if rw access is not granted, because the root.root
1414 * sessiond will be able to override all rights and wake
1415 * us up.
1416 */
1417 if (!sock_info->global && errno != EACCES) {
58d4b2a2 1418 ERR("Error opening shm %s", sock_info->wait_shm_path);
5d3bc5ed 1419 _exit(EXIT_FAILURE);
58d4b2a2
MD
1420 }
1421 /*
33bbeb90
MD
1422 * The shm exists, but we cannot open it RW. Report
1423 * success.
58d4b2a2 1424 */
5d3bc5ed 1425 _exit(EXIT_SUCCESS);
58d4b2a2
MD
1426 } else {
1427 return -1;
7fc90dca 1428 }
58d4b2a2 1429end:
33bbeb90
MD
1430 if (wait_shm_fd >= 0 && !sock_info->global) {
1431 struct stat statbuf;
1432
1433 /*
1434 * Ensure that our user is the owner of the shm file for
1435 * local shm. If we do not own the file, it means our
1436 * sessiond will not have access to wake us up (there is
1437 * probably a rogue process trying to fake our
1438 * sessiond). Fallback to polling method in this case.
1439 */
1440 ret = fstat(wait_shm_fd, &statbuf);
1441 if (ret) {
1442 PERROR("fstat");
1443 goto error_close;
1444 }
1445 if (statbuf.st_uid != getuid())
1446 goto error_close;
1447 }
58d4b2a2 1448 return wait_shm_fd;
33bbeb90
MD
1449
1450error_close:
1451 ret = close(wait_shm_fd);
1452 if (ret) {
1453 PERROR("Error closing fd");
1454 }
1455 return -1;
58d4b2a2
MD
1456}
1457
1458static
1459char *get_map_shm(struct sock_info *sock_info)
1460{
172d6b68 1461 long page_size;
58d4b2a2
MD
1462 int wait_shm_fd, ret;
1463 char *wait_shm_mmap;
1464
172d6b68 1465 page_size = sysconf(_SC_PAGE_SIZE);
2657d1ba
MD
1466 if (page_size <= 0) {
1467 if (!page_size) {
1468 errno = EINVAL;
1469 }
1470 PERROR("Error in sysconf(_SC_PAGE_SIZE)");
172d6b68
MD
1471 goto error;
1472 }
1473
6548fca4 1474 lttng_ust_lock_fd_tracker();
172d6b68 1475 wait_shm_fd = get_wait_shm(sock_info, page_size);
58d4b2a2 1476 if (wait_shm_fd < 0) {
6548fca4 1477 lttng_ust_unlock_fd_tracker();
58d4b2a2 1478 goto error;
44e073f5 1479 }
f5c453e9
JR
1480
1481 ret = lttng_ust_add_fd_to_tracker(wait_shm_fd);
1482 if (ret < 0) {
1483 ret = close(wait_shm_fd);
1484 if (!ret) {
1485 PERROR("Error closing fd");
1486 }
1487 lttng_ust_unlock_fd_tracker();
1488 goto error;
1489 }
1490
1491 wait_shm_fd = ret;
6548fca4
MD
1492 lttng_ust_unlock_fd_tracker();
1493
172d6b68 1494 wait_shm_mmap = mmap(NULL, page_size, PROT_READ,
7fc90dca 1495 MAP_SHARED, wait_shm_fd, 0);
6548fca4 1496
7fc90dca 1497 /* close shm fd immediately after taking the mmap reference */
6548fca4 1498 lttng_ust_lock_fd_tracker();
7fc90dca 1499 ret = close(wait_shm_fd);
6548fca4
MD
1500 if (!ret) {
1501 lttng_ust_delete_fd_from_tracker(wait_shm_fd);
1502 } else {
33bbeb90
MD
1503 PERROR("Error closing fd");
1504 }
6548fca4
MD
1505 lttng_ust_unlock_fd_tracker();
1506
33bbeb90
MD
1507 if (wait_shm_mmap == MAP_FAILED) {
1508 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
1509 goto error;
7fc90dca
MD
1510 }
1511 return wait_shm_mmap;
1512
1513error:
1514 return NULL;
1515}
1516
1517static
1518void wait_for_sessiond(struct sock_info *sock_info)
1519{
060577e3 1520 /* Use ust_lock to check if we should quit. */
3327ac33 1521 if (ust_lock()) {
7fc90dca
MD
1522 goto quit;
1523 }
37ed587a
MD
1524 if (wait_poll_fallback) {
1525 goto error;
1526 }
7fc90dca
MD
1527 ust_unlock();
1528
060577e3
JR
1529 assert(sock_info->wait_shm_mmap);
1530
7fc90dca 1531 DBG("Waiting for %s apps sessiond", sock_info->name);
80e2814b 1532 /* Wait for futex wakeup */
ee7fcec8
MD
1533 if (uatomic_read((int32_t *) sock_info->wait_shm_mmap))
1534 goto end_wait;
1535
1536 while (futex_async((int32_t *) sock_info->wait_shm_mmap,
1537 FUTEX_WAIT, 0, NULL, NULL, 0)) {
1538 switch (errno) {
1539 case EWOULDBLOCK:
1540 /* Value already changed. */
1541 goto end_wait;
1542 case EINTR:
1543 /* Retry if interrupted by signal. */
1544 break; /* Get out of switch. */
1545 case EFAULT:
1546 wait_poll_fallback = 1;
1547 DBG(
37ed587a
MD
1548"Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
1549"do not support FUTEX_WAKE on read-only memory mappings correctly. "
1550"Please upgrade your kernel "
1551"(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
1552"mainline). LTTng-UST will use polling mode fallback.");
ee7fcec8
MD
1553 if (ust_debug())
1554 PERROR("futex");
1555 goto end_wait;
80e2814b
MD
1556 }
1557 }
ee7fcec8 1558end_wait:
7fc90dca
MD
1559 return;
1560
1561quit:
1562 ust_unlock();
1563 return;
1564
1565error:
1566 ust_unlock();
7fc90dca 1567 return;
46050b1a
MD
1568}
1569
1ea11eab
MD
1570/*
1571 * This thread does not allocate any resource, except within
1572 * handle_message, within mutex protection. This mutex protects against
1573 * fork and exit.
98bf993f 1574 * The other moment it allocates resources is at socket connection, which
1ea11eab
MD
1575 * is also protected by the mutex.
1576 */
d9e99d10
MD
1577static
1578void *ust_listener_thread(void *arg)
1579{
1ea11eab 1580 struct sock_info *sock_info = arg;
f5c453e9 1581 int sock, ret, prev_connect_failed = 0, has_waited = 0, fd;
ff517991 1582 long timeout;
d9e99d10 1583
c362addf 1584 lttng_ust_fixup_tls();
01f0e40c
RB
1585 /*
1586 * If available, add '-ust' to the end of this thread's
1587 * process name
1588 */
1589 ret = lttng_ust_setustprocname();
1590 if (ret) {
1591 ERR("Unable to set UST process name");
1592 }
1593
9eb62b9c
MD
1594 /* Restart trying to connect to the session daemon */
1595restart:
c0eedf81
MD
1596 if (prev_connect_failed) {
1597 /* Wait for sessiond availability with pipe */
1598 wait_for_sessiond(sock_info);
1599 if (has_waited) {
1600 has_waited = 0;
1601 /*
1602 * Sleep for 5 seconds before retrying after a
1603 * sequence of failure / wait / failure. This
1604 * deals with a killed or broken session daemon.
1605 */
1606 sleep(5);
eacc4aa4
MD
1607 } else {
1608 has_waited = 1;
c0eedf81 1609 }
c0eedf81
MD
1610 prev_connect_failed = 0;
1611 }
9eb62b9c 1612
101dace0
JR
1613 if (ust_lock()) {
1614 goto quit;
1615 }
1616
1ea11eab 1617 if (sock_info->socket != -1) {
6548fca4 1618 /* FD tracker is updated by ustcomm_close_unix_sock() */
e6973a89 1619 ret = ustcomm_close_unix_sock(sock_info->socket);
1ea11eab 1620 if (ret) {
32ce8569
MD
1621 ERR("Error closing %s ust cmd socket",
1622 sock_info->name);
1ea11eab
MD
1623 }
1624 sock_info->socket = -1;
1625 }
32ce8569 1626 if (sock_info->notify_socket != -1) {
6548fca4 1627 /* FD tracker is updated by ustcomm_close_unix_sock() */
32ce8569
MD
1628 ret = ustcomm_close_unix_sock(sock_info->notify_socket);
1629 if (ret) {
1630 ERR("Error closing %s ust notify socket",
1631 sock_info->name);
1632 }
1633 sock_info->notify_socket = -1;
1634 }
46050b1a 1635
6548fca4 1636
321f2351
MD
1637 /*
1638 * Register. We need to perform both connect and sending
1639 * registration message before doing the next connect otherwise
1640 * we may reach unix socket connect queue max limits and block
1641 * on the 2nd connect while the session daemon is awaiting the
1642 * first connect registration message.
1643 */
1644 /* Connect cmd socket */
6548fca4 1645 lttng_ust_lock_fd_tracker();
451d66b2
MD
1646 ret = ustcomm_connect_unix_sock(sock_info->sock_path,
1647 get_connect_sock_timeout());
321f2351 1648 if (ret < 0) {
6548fca4 1649 lttng_ust_unlock_fd_tracker();
321f2351
MD
1650 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
1651 prev_connect_failed = 1;
5b14aab3 1652
e3426ddc 1653 /*
321f2351
MD
1654 * If we cannot find the sessiond daemon, don't delay
1655 * constructor execution.
e3426ddc 1656 */
eb0e6022 1657 ret = handle_register_failed(sock_info);
321f2351
MD
1658 assert(!ret);
1659 ust_unlock();
1660 goto restart;
27fe9f21 1661 }
f5c453e9
JR
1662 fd = ret;
1663 ret = lttng_ust_add_fd_to_tracker(fd);
1664 if (ret < 0) {
1665 ret = close(fd);
1666 if (ret) {
1667 PERROR("close on sock_info->socket");
1668 }
1669 ret = -1;
1670 lttng_ust_unlock_fd_tracker();
1671 ust_unlock();
1672 goto quit;
1673 }
1674
321f2351 1675 sock_info->socket = ret;
f5c453e9 1676 lttng_ust_unlock_fd_tracker();
27fe9f21 1677
6548fca4
MD
1678 ust_unlock();
1679 /*
1680 * Unlock/relock ust lock because connect is blocking (with
1681 * timeout). Don't delay constructors on the ust lock for too
1682 * long.
1683 */
3327ac33 1684 if (ust_lock()) {
5b14aab3
MD
1685 goto quit;
1686 }
1687
46050b1a
MD
1688 /*
1689 * Create only one root handle per listener thread for the whole
f59ed768
MD
1690 * process lifetime, so we ensure we get ID which is statically
1691 * assigned to the root handle.
46050b1a
MD
1692 */
1693 if (sock_info->root_handle == -1) {
1694 ret = lttng_abi_create_root_handle();
a51070bb 1695 if (ret < 0) {
46050b1a 1696 ERR("Error creating root handle");
46050b1a
MD
1697 goto quit;
1698 }
1699 sock_info->root_handle = ret;
9eb62b9c 1700 }
1ea11eab 1701
32ce8569 1702 ret = register_to_sessiond(sock_info->socket, USTCTL_SOCKET_CMD);
9eb62b9c 1703 if (ret < 0) {
32ce8569
MD
1704 ERR("Error registering to %s ust cmd socket",
1705 sock_info->name);
c0eedf81 1706 prev_connect_failed = 1;
11ff9c7d
MD
1707 /*
1708 * If we cannot register to the sessiond daemon, don't
1709 * delay constructor execution.
1710 */
eb0e6022 1711 ret = handle_register_failed(sock_info);
11ff9c7d 1712 assert(!ret);
17dfb34b 1713 ust_unlock();
9eb62b9c
MD
1714 goto restart;
1715 }
321f2351
MD
1716
1717 ust_unlock();
6548fca4
MD
1718 /*
1719 * Unlock/relock ust lock because connect is blocking (with
1720 * timeout). Don't delay constructors on the ust lock for too
1721 * long.
1722 */
1723 if (ust_lock()) {
1724 goto quit;
1725 }
321f2351
MD
1726
1727 /* Connect notify socket */
6548fca4 1728 lttng_ust_lock_fd_tracker();
451d66b2
MD
1729 ret = ustcomm_connect_unix_sock(sock_info->sock_path,
1730 get_connect_sock_timeout());
321f2351 1731 if (ret < 0) {
6548fca4 1732 lttng_ust_unlock_fd_tracker();
321f2351
MD
1733 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
1734 prev_connect_failed = 1;
1735
321f2351
MD
1736 /*
1737 * If we cannot find the sessiond daemon, don't delay
1738 * constructor execution.
1739 */
eb0e6022 1740 ret = handle_register_failed(sock_info);
321f2351
MD
1741 assert(!ret);
1742 ust_unlock();
1743 goto restart;
1744 }
f5c453e9
JR
1745
1746 fd = ret;
1747 ret = lttng_ust_add_fd_to_tracker(fd);
1748 if (ret < 0) {
1749 ret = close(fd);
1750 if (ret) {
1751 PERROR("close on sock_info->notify_socket");
1752 }
1753 ret = -1;
1754 lttng_ust_unlock_fd_tracker();
1755 ust_unlock();
1756 goto quit;
1757 }
1758
321f2351 1759 sock_info->notify_socket = ret;
f5c453e9 1760 lttng_ust_unlock_fd_tracker();
321f2351 1761
6548fca4
MD
1762 ust_unlock();
1763 /*
1764 * Unlock/relock ust lock because connect is blocking (with
1765 * timeout). Don't delay constructors on the ust lock for too
1766 * long.
1767 */
1768 if (ust_lock()) {
1769 goto quit;
1770 }
1771
321f2351
MD
1772 timeout = get_notify_sock_timeout();
1773 if (timeout >= 0) {
1774 /*
1775 * Give at least 10ms to sessiond to reply to
1776 * notifications.
1777 */
1778 if (timeout < 10)
1779 timeout = 10;
1780 ret = ustcomm_setsockopt_rcv_timeout(sock_info->notify_socket,
1781 timeout);
1782 if (ret < 0) {
1783 WARN("Error setting socket receive timeout");
1784 }
1785 ret = ustcomm_setsockopt_snd_timeout(sock_info->notify_socket,
1786 timeout);
1787 if (ret < 0) {
1788 WARN("Error setting socket send timeout");
1789 }
1790 } else if (timeout < -1) {
1791 WARN("Unsupported timeout value %ld", timeout);
1792 }
1793
32ce8569
MD
1794 ret = register_to_sessiond(sock_info->notify_socket,
1795 USTCTL_SOCKET_NOTIFY);
1796 if (ret < 0) {
1797 ERR("Error registering to %s ust notify socket",
1798 sock_info->name);
1799 prev_connect_failed = 1;
1800 /*
1801 * If we cannot register to the sessiond daemon, don't
1802 * delay constructor execution.
1803 */
eb0e6022 1804 ret = handle_register_failed(sock_info);
32ce8569
MD
1805 assert(!ret);
1806 ust_unlock();
1807 goto restart;
1808 }
1809 sock = sock_info->socket;
1810
17dfb34b 1811 ust_unlock();
46050b1a 1812
d9e99d10
MD
1813 for (;;) {
1814 ssize_t len;
57773204 1815 struct ustcomm_ust_msg lum;
d9e99d10 1816
57773204 1817 len = ustcomm_recv_unix_sock(sock, &lum, sizeof(lum));
d9e99d10
MD
1818 switch (len) {
1819 case 0: /* orderly shutdown */
7dd08bec 1820 DBG("%s lttng-sessiond has performed an orderly shutdown", sock_info->name);
3327ac33 1821 if (ust_lock()) {
d5e1fea6
MD
1822 goto quit;
1823 }
8236ba10
MD
1824 /*
1825 * Either sessiond has shutdown or refused us by closing the socket.
1826 * In either case, we don't want to delay construction execution,
1827 * and we need to wait before retry.
1828 */
1829 prev_connect_failed = 1;
1830 /*
1831 * If we cannot register to the sessiond daemon, don't
1832 * delay constructor execution.
1833 */
eb0e6022 1834 ret = handle_register_failed(sock_info);
8236ba10
MD
1835 assert(!ret);
1836 ust_unlock();
d9e99d10 1837 goto end;
e7723462 1838 case sizeof(lum):
74d81a6c 1839 print_cmd(lum.cmd, lum.handle);
11ff9c7d 1840 ret = handle_message(sock_info, sock, &lum);
7bc53e94 1841 if (ret) {
0dafcd63
MD
1842 ERR("Error handling message for %s socket",
1843 sock_info->name);
1844 /*
1845 * Close socket if protocol error is
1846 * detected.
1847 */
1848 goto end;
d9e99d10
MD
1849 }
1850 continue;
7bc53e94
MD
1851 default:
1852 if (len < 0) {
1853 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
1854 } else {
1855 DBG("incorrect message size (%s socket): %zd", sock_info->name, len);
1856 }
1857 if (len == -ECONNRESET) {
1858 DBG("%s remote end closed connection", sock_info->name);
d9e99d10
MD
1859 goto end;
1860 }
1861 goto end;
d9e99d10
MD
1862 }
1863
1864 }
1865end:
3327ac33 1866 if (ust_lock()) {
d5e1fea6
MD
1867 goto quit;
1868 }
f59ed768
MD
1869 /* Cleanup socket handles before trying to reconnect */
1870 lttng_ust_objd_table_owner_cleanup(sock_info);
1871 ust_unlock();
9eb62b9c 1872 goto restart; /* try to reconnect */
e33f3265 1873
1ea11eab 1874quit:
e33f3265 1875 ust_unlock();
3327ac33
MD
1876
1877 pthread_mutex_lock(&ust_exit_mutex);
1878 sock_info->thread_active = 0;
1879 pthread_mutex_unlock(&ust_exit_mutex);
d9e99d10
MD
1880 return NULL;
1881}
1882
2594a5b4
MD
1883/*
1884 * Weak symbol to call when the ust malloc wrapper is not loaded.
1885 */
1886__attribute__((weak))
1887void lttng_ust_malloc_wrapper_init(void)
1888{
1889}
1890
2691221a
MD
1891/*
1892 * sessiond monitoring thread: monitor presence of global and per-user
1893 * sessiond by polling the application common named pipe.
1894 */
edaa1431 1895void __attribute__((constructor)) lttng_ust_init(void)
2691221a 1896{
11ff9c7d 1897 struct timespec constructor_timeout;
ae6a58bf 1898 sigset_t sig_all_blocked, orig_parent_mask;
1879f67f 1899 pthread_attr_t thread_attr;
cf12a773 1900 int timeout_mode;
2691221a 1901 int ret;
b2292d85 1902 void *handle;
2691221a 1903
edaa1431
MD
1904 if (uatomic_xchg(&initialized, 1) == 1)
1905 return;
1906
eddd8d5d
MD
1907 /*
1908 * Fixup interdependency between TLS fixup mutex (which happens
1909 * to be the dynamic linker mutex) and ust_lock, taken within
1910 * the ust lock.
1911 */
c362addf 1912 lttng_ust_fixup_tls();
eddd8d5d 1913
07b57e5e
MD
1914 lttng_ust_loaded = 1;
1915
b2292d85
FD
1916 /*
1917 * We need to ensure that the liblttng-ust library is not unloaded to avoid
1918 * the unloading of code used by the ust_listener_threads as we can not
1919 * reliably know when they exited. To do that, manually load
1920 * liblttng-ust.so to increment the dynamic loader's internal refcount for
1921 * this library so it never becomes zero, thus never gets unloaded from the
1922 * address space of the process. Since we are already running in the
1923 * constructor of the LTTNG_UST_LIB_SO_NAME library, calling dlopen will
1924 * simply increment the refcount and no additionnal work is needed by the
1925 * dynamic loader as the shared library is already loaded in the address
1926 * space. As a safe guard, we use the RTLD_NODELETE flag to prevent
1927 * unloading of the UST library if its refcount becomes zero (which should
1928 * never happen). Do the return value check but discard the handle at the
1929 * end of the function as it's not needed.
1930 */
1931 handle = dlopen(LTTNG_UST_LIB_SO_NAME, RTLD_LAZY | RTLD_NODELETE);
1932 if (!handle) {
1933 ERR("dlopen of liblttng-ust shared library (%s).", LTTNG_UST_LIB_SO_NAME);
1934 }
1935
edaa1431
MD
1936 /*
1937 * We want precise control over the order in which we construct
1938 * our sub-libraries vs starting to receive commands from
1939 * sessiond (otherwise leading to errors when trying to create
1940 * sessiond before the init functions are completed).
1941 */
2691221a 1942 init_usterr();
6f626d28 1943 lttng_ust_getenv_init(); /* Needs init_usterr() to be completed. */
edaa1431 1944 init_tracepoint();
6548fca4 1945 lttng_ust_init_fd_tracker();
f9364363 1946 lttng_ust_clock_init();
5e1b7b8b 1947 lttng_ust_getcpu_init();
cf73e0fe 1948 lttng_ust_statedump_init();
7dd08bec
MD
1949 lttng_ring_buffer_metadata_client_init();
1950 lttng_ring_buffer_client_overwrite_init();
34a91bdb 1951 lttng_ring_buffer_client_overwrite_rt_init();
7dd08bec 1952 lttng_ring_buffer_client_discard_init();
34a91bdb 1953 lttng_ring_buffer_client_discard_rt_init();
d58d1454 1954 lttng_perf_counter_init();
2594a5b4
MD
1955 /*
1956 * Invoke ust malloc wrapper init before starting other threads.
1957 */
1958 lttng_ust_malloc_wrapper_init();
2691221a 1959
ff517991 1960 timeout_mode = get_constructor_timeout(&constructor_timeout);
11ff9c7d 1961
b2c5f61a 1962 get_allow_blocking();
6f97f9c2 1963
95259bd0 1964 ret = sem_init(&constructor_wait, 0, 0);
8aadb54a
MD
1965 if (ret) {
1966 PERROR("sem_init");
1967 }
11ff9c7d 1968
060577e3
JR
1969 ret = setup_global_apps();
1970 if (ret) {
1971 assert(global_apps.allowed == 0);
1972 DBG("global apps setup returned %d", ret);
1973 }
1974
8d20bf54 1975 ret = setup_local_apps();
2691221a 1976 if (ret) {
060577e3 1977 assert(local_apps.allowed == 0);
9ec6895c 1978 DBG("local apps setup returned %d", ret);
2691221a 1979 }
ae6a58bf
WP
1980
1981 /* A new thread created by pthread_create inherits the signal mask
1982 * from the parent. To avoid any signal being received by the
1983 * listener thread, we block all signals temporarily in the parent,
1984 * while we create the listener thread.
1985 */
1986 sigfillset(&sig_all_blocked);
1987 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_parent_mask);
1988 if (ret) {
d94d802c 1989 ERR("pthread_sigmask: %s", strerror(ret));
ae6a58bf
WP
1990 }
1991
1879f67f
MG
1992 ret = pthread_attr_init(&thread_attr);
1993 if (ret) {
1994 ERR("pthread_attr_init: %s", strerror(ret));
1995 }
1996 ret = pthread_attr_setdetachstate(&thread_attr, PTHREAD_CREATE_DETACHED);
1997 if (ret) {
1998 ERR("pthread_attr_setdetachstate: %s", strerror(ret));
1999 }
2000
060577e3
JR
2001 if (global_apps.allowed) {
2002 pthread_mutex_lock(&ust_exit_mutex);
2003 ret = pthread_create(&global_apps.ust_listener, &thread_attr,
2004 ust_listener_thread, &global_apps);
2005 if (ret) {
2006 ERR("pthread_create global: %s", strerror(ret));
2007 }
2008 global_apps.thread_active = 1;
2009 pthread_mutex_unlock(&ust_exit_mutex);
2010 } else {
2011 handle_register_done(&global_apps);
d94d802c 2012 }
e33f3265 2013
8d20bf54 2014 if (local_apps.allowed) {
c0bbbd5a 2015 pthread_mutex_lock(&ust_exit_mutex);
1879f67f 2016 ret = pthread_create(&local_apps.ust_listener, &thread_attr,
dde70ea0 2017 ust_listener_thread, &local_apps);
d94d802c
MD
2018 if (ret) {
2019 ERR("pthread_create local: %s", strerror(ret));
2020 }
e33f3265 2021 local_apps.thread_active = 1;
c0bbbd5a 2022 pthread_mutex_unlock(&ust_exit_mutex);
8d20bf54
MD
2023 } else {
2024 handle_register_done(&local_apps);
2025 }
1879f67f
MG
2026 ret = pthread_attr_destroy(&thread_attr);
2027 if (ret) {
2028 ERR("pthread_attr_destroy: %s", strerror(ret));
2029 }
8d20bf54 2030
ae6a58bf
WP
2031 /* Restore original signal mask in parent */
2032 ret = pthread_sigmask(SIG_SETMASK, &orig_parent_mask, NULL);
2033 if (ret) {
d94d802c 2034 ERR("pthread_sigmask: %s", strerror(ret));
ae6a58bf
WP
2035 }
2036
cf12a773
MD
2037 switch (timeout_mode) {
2038 case 1: /* timeout wait */
95259bd0
MD
2039 do {
2040 ret = sem_timedwait(&constructor_wait,
2041 &constructor_timeout);
2042 } while (ret < 0 && errno == EINTR);
8aadb54a
MD
2043 if (ret < 0) {
2044 switch (errno) {
2045 case ETIMEDOUT:
2046 ERR("Timed out waiting for lttng-sessiond");
2047 break;
2048 case EINVAL:
2049 PERROR("sem_timedwait");
2050 break;
2051 default:
2052 ERR("Unexpected error \"%s\" returned by sem_timedwait",
2053 strerror(errno));
2054 }
cf12a773
MD
2055 }
2056 break;
7b766b16 2057 case -1:/* wait forever */
95259bd0
MD
2058 do {
2059 ret = sem_wait(&constructor_wait);
2060 } while (ret < 0 && errno == EINTR);
8aadb54a
MD
2061 if (ret < 0) {
2062 switch (errno) {
2063 case EINVAL:
2064 PERROR("sem_wait");
2065 break;
2066 default:
2067 ERR("Unexpected error \"%s\" returned by sem_wait",
2068 strerror(errno));
2069 }
2070 }
cf12a773 2071 break;
7b766b16 2072 case 0: /* no timeout */
cf12a773 2073 break;
11ff9c7d 2074 }
2691221a
MD
2075}
2076
17dfb34b
MD
2077static
2078void lttng_ust_cleanup(int exiting)
2079{
efe0de09 2080 cleanup_sock_info(&global_apps, exiting);
932cfadb 2081 cleanup_sock_info(&local_apps, exiting);
74f98bc9 2082 local_apps.allowed = 0;
060577e3 2083 global_apps.allowed = 0;
efe0de09
MD
2084 /*
2085 * The teardown in this function all affect data structures
2086 * accessed under the UST lock by the listener thread. This
2087 * lock, along with the lttng_ust_comm_should_quit flag, ensure
2088 * that none of these threads are accessing this data at this
2089 * point.
2090 */
17dfb34b 2091 lttng_ust_abi_exit();
003fedf4 2092 lttng_ust_events_exit();
d58d1454 2093 lttng_perf_counter_exit();
34a91bdb 2094 lttng_ring_buffer_client_discard_rt_exit();
7dd08bec 2095 lttng_ring_buffer_client_discard_exit();
34a91bdb 2096 lttng_ring_buffer_client_overwrite_rt_exit();
7dd08bec
MD
2097 lttng_ring_buffer_client_overwrite_exit();
2098 lttng_ring_buffer_metadata_client_exit();
cf73e0fe 2099 lttng_ust_statedump_destroy();
17dfb34b
MD
2100 exit_tracepoint();
2101 if (!exiting) {
2102 /* Reinitialize values for fork */
eb0e6022 2103 sem_count = sem_count_initial_value;
17dfb34b
MD
2104 lttng_ust_comm_should_quit = 0;
2105 initialized = 0;
2106 }
2107}
2108
edaa1431 2109void __attribute__((destructor)) lttng_ust_exit(void)
2691221a
MD
2110{
2111 int ret;
2112
9eb62b9c
MD
2113 /*
2114 * Using pthread_cancel here because:
2115 * A) we don't want to hang application teardown.
2116 * B) the thread is not allocating any resource.
2117 */
1ea11eab
MD
2118
2119 /*
2120 * Require the communication thread to quit. Synchronize with
2121 * mutexes to ensure it is not in a mutex critical section when
2122 * pthread_cancel is later called.
2123 */
3327ac33 2124 ust_lock_nocheck();
1ea11eab 2125 lttng_ust_comm_should_quit = 1;
3327ac33 2126 ust_unlock();
1ea11eab 2127
3327ac33 2128 pthread_mutex_lock(&ust_exit_mutex);
f5f94532 2129 /* cancel threads */
e33f3265
MD
2130 if (global_apps.thread_active) {
2131 ret = pthread_cancel(global_apps.ust_listener);
2132 if (ret) {
2133 ERR("Error cancelling global ust listener thread: %s",
2134 strerror(ret));
2135 } else {
2136 global_apps.thread_active = 0;
2137 }
2691221a 2138 }
e33f3265 2139 if (local_apps.thread_active) {
8d20bf54
MD
2140 ret = pthread_cancel(local_apps.ust_listener);
2141 if (ret) {
d94d802c
MD
2142 ERR("Error cancelling local ust listener thread: %s",
2143 strerror(ret));
e33f3265
MD
2144 } else {
2145 local_apps.thread_active = 0;
8d20bf54 2146 }
8d20bf54 2147 }
3327ac33 2148 pthread_mutex_unlock(&ust_exit_mutex);
e33f3265 2149
efe0de09
MD
2150 /*
2151 * Do NOT join threads: use of sys_futex makes it impossible to
2152 * join the threads without using async-cancel, but async-cancel
2153 * is delivered by a signal, which could hit the target thread
2154 * anywhere in its code path, including while the ust_lock() is
2155 * held, causing a deadlock for the other thread. Let the OS
2156 * cleanup the threads if there are stalled in a syscall.
2157 */
17dfb34b 2158 lttng_ust_cleanup(1);
2691221a 2159}
e822f505 2160
735bef47
MJ
2161static
2162void ust_context_ns_reset(void)
2163{
2164 lttng_context_pid_ns_reset();
2165 lttng_context_cgroup_ns_reset();
2166 lttng_context_ipc_ns_reset();
2167 lttng_context_mnt_ns_reset();
2168 lttng_context_net_ns_reset();
2169 lttng_context_user_ns_reset();
2170 lttng_context_uts_ns_reset();
2171}
2172
fca2f191
MJ
2173static
2174void ust_context_vuids_reset(void)
2175{
2176 lttng_context_vuid_reset();
2177 lttng_context_veuid_reset();
2178 lttng_context_vsuid_reset();
2179}
2180
2181static
2182void ust_context_vgids_reset(void)
2183{
2184 lttng_context_vgid_reset();
2185 lttng_context_vegid_reset();
2186 lttng_context_vsgid_reset();
2187}
2188
e822f505
MD
2189/*
2190 * We exclude the worker threads across fork and clone (except
2191 * CLONE_VM), because these system calls only keep the forking thread
2192 * running in the child. Therefore, we don't want to call fork or clone
2193 * in the middle of an tracepoint or ust tracing state modification.
2194 * Holding this mutex protects these structures across fork and clone.
2195 */
b728d87e 2196void ust_before_fork(sigset_t *save_sigset)
e822f505
MD
2197{
2198 /*
2199 * Disable signals. This is to avoid that the child intervenes
2200 * before it is properly setup for tracing. It is safer to
2201 * disable all signals, because then we know we are not breaking
2202 * anything by restoring the original mask.
2203 */
2204 sigset_t all_sigs;
2205 int ret;
2206
c362addf
MD
2207 /* Fixup lttng-ust TLS. */
2208 lttng_ust_fixup_tls();
2209
8c90a710 2210 if (URCU_TLS(lttng_ust_nest_count))
e8508a49 2211 return;
e822f505
MD
2212 /* Disable signals */
2213 sigfillset(&all_sigs);
b728d87e 2214 ret = sigprocmask(SIG_BLOCK, &all_sigs, save_sigset);
e822f505
MD
2215 if (ret == -1) {
2216 PERROR("sigprocmask");
2217 }
458d678c
PW
2218
2219 pthread_mutex_lock(&ust_fork_mutex);
2220
3327ac33 2221 ust_lock_nocheck();
d6ddec3f 2222 urcu_bp_before_fork();
c1be081a 2223 lttng_ust_lock_fd_tracker();
20142124 2224 lttng_perf_lock();
e822f505
MD
2225}
2226
b728d87e 2227static void ust_after_fork_common(sigset_t *restore_sigset)
e822f505
MD
2228{
2229 int ret;
2230
17dfb34b 2231 DBG("process %d", getpid());
20142124 2232 lttng_perf_unlock();
c1be081a 2233 lttng_ust_unlock_fd_tracker();
17dfb34b 2234 ust_unlock();
458d678c
PW
2235
2236 pthread_mutex_unlock(&ust_fork_mutex);
2237
e822f505 2238 /* Restore signals */
23c8854a 2239 ret = sigprocmask(SIG_SETMASK, restore_sigset, NULL);
e822f505
MD
2240 if (ret == -1) {
2241 PERROR("sigprocmask");
2242 }
2243}
2244
b728d87e 2245void ust_after_fork_parent(sigset_t *restore_sigset)
e822f505 2246{
8c90a710 2247 if (URCU_TLS(lttng_ust_nest_count))
e8508a49 2248 return;
17dfb34b 2249 DBG("process %d", getpid());
d6ddec3f 2250 urcu_bp_after_fork_parent();
e822f505 2251 /* Release mutexes and reenable signals */
b728d87e 2252 ust_after_fork_common(restore_sigset);
e822f505
MD
2253}
2254
17dfb34b
MD
2255/*
2256 * After fork, in the child, we need to cleanup all the leftover state,
2257 * except the worker thread which already magically disappeared thanks
2258 * to the weird Linux fork semantics. After tyding up, we call
2259 * lttng_ust_init() again to start over as a new PID.
2260 *
2261 * This is meant for forks() that have tracing in the child between the
2262 * fork and following exec call (if there is any).
2263 */
b728d87e 2264void ust_after_fork_child(sigset_t *restore_sigset)
e822f505 2265{
8c90a710 2266 if (URCU_TLS(lttng_ust_nest_count))
e8508a49 2267 return;
06b16a0b 2268 lttng_context_vpid_reset();
8478887d 2269 lttng_context_vtid_reset();
46228a6f 2270 lttng_context_procname_reset();
735bef47 2271 ust_context_ns_reset();
fca2f191
MJ
2272 ust_context_vuids_reset();
2273 ust_context_vgids_reset();
17dfb34b 2274 DBG("process %d", getpid());
e822f505 2275 /* Release urcu mutexes */
d6ddec3f 2276 urcu_bp_after_fork_child();
17dfb34b 2277 lttng_ust_cleanup(0);
e822f505 2278 /* Release mutexes and reenable signals */
b728d87e 2279 ust_after_fork_common(restore_sigset);
318dfea9 2280 lttng_ust_init();
e822f505 2281}
95c25348 2282
735bef47
MJ
2283void ust_after_setns(void)
2284{
2285 ust_context_ns_reset();
fca2f191
MJ
2286 ust_context_vuids_reset();
2287 ust_context_vgids_reset();
735bef47
MJ
2288}
2289
2290void ust_after_unshare(void)
2291{
2292 ust_context_ns_reset();
fca2f191
MJ
2293 ust_context_vuids_reset();
2294 ust_context_vgids_reset();
2295}
2296
2297void ust_after_setuid(void)
2298{
2299 ust_context_vuids_reset();
2300}
2301
2302void ust_after_seteuid(void)
2303{
2304 ust_context_vuids_reset();
2305}
2306
2307void ust_after_setreuid(void)
2308{
2309 ust_context_vuids_reset();
2310}
2311
2312void ust_after_setresuid(void)
2313{
2314 ust_context_vuids_reset();
2315}
2316
2317void ust_after_setgid(void)
2318{
2319 ust_context_vgids_reset();
2320}
2321
2322void ust_after_setegid(void)
2323{
2324 ust_context_vgids_reset();
2325}
2326
2327void ust_after_setregid(void)
2328{
2329 ust_context_vgids_reset();
2330}
2331
2332void ust_after_setresgid(void)
2333{
2334 ust_context_vgids_reset();
735bef47
MJ
2335}
2336
246be17e 2337void lttng_ust_sockinfo_session_enabled(void *owner)
95c25348
PW
2338{
2339 struct sock_info *sock_info = owner;
37dddb65 2340 sock_info->statedump_pending = 1;
95c25348 2341}
This page took 0.174663 seconds and 5 git commands to generate.