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