4 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
5 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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
24 #include <sys/types.h>
25 #include <sys/socket.h>
28 #include <sys/types.h>
35 #include <semaphore.h>
40 #include <urcu/uatomic.h>
41 #include <urcu/futex.h>
42 #include <urcu/compiler.h>
44 #include <lttng/ust-events.h>
45 #include <lttng/ust-abi.h>
46 #include <lttng/ust.h>
47 #include <lttng/ust-error.h>
48 #include <lttng/ust-ctl.h>
49 #include <urcu/tls-compat.h>
52 #include <usterr-signal-safe.h>
54 #include "tracepoint-internal.h"
55 #include "lttng-tracer-core.h"
57 #include "../libringbuffer/rb-init.h"
58 #include "lttng-ust-statedump.h"
60 #include "../libringbuffer/getcpu.h"
63 /* Concatenate lttng ust shared library name with its major version number. */
64 #define LTTNG_UST_LIB_SO_NAME "liblttng-ust.so." __ust_stringify(CONFIG_LTTNG_UST_LIBRARY_VERSION_MAJOR)
67 * Has lttng ust comm constructor been called ?
69 static int initialized
;
72 * The ust_lock/ust_unlock lock is used as a communication thread mutex.
73 * Held when handling a command, also held by fork() to deal with
74 * removal of threads, and by exit path.
76 * The UST lock is the centralized mutex across UST tracing control and
79 * ust_exit_mutex must never nest in ust_mutex.
81 * ust_fork_mutex must never nest in ust_mutex.
83 * ust_mutex_nest is a per-thread nesting counter, allowing the perf
84 * counter lazy initialization called by events within the statedump,
85 * which traces while the ust_mutex is held.
87 * ust_lock nests within the dynamic loader lock (within glibc) because
88 * it is taken within the library constructor.
90 * The ust fd tracker lock nests within the ust_mutex.
92 static pthread_mutex_t ust_mutex
= PTHREAD_MUTEX_INITIALIZER
;
94 /* Allow nesting the ust_mutex within the same thread. */
95 static DEFINE_URCU_TLS(int, ust_mutex_nest
);
98 * ust_exit_mutex protects thread_active variable wrt thread exit. It
99 * cannot be done by ust_mutex because pthread_cancel(), which takes an
100 * internal libc lock, cannot nest within ust_mutex.
102 * It never nests within a ust_mutex.
104 static pthread_mutex_t ust_exit_mutex
= PTHREAD_MUTEX_INITIALIZER
;
107 * ust_fork_mutex protects base address statedump tracing against forks. It
108 * prevents the dynamic loader lock to be taken (by base address statedump
109 * tracing) while a fork is happening, thus preventing deadlock issues with
110 * the dynamic loader lock.
112 static pthread_mutex_t ust_fork_mutex
= PTHREAD_MUTEX_INITIALIZER
;
114 /* Should the ust comm thread quit ? */
115 static int lttng_ust_comm_should_quit
;
118 * This variable can be tested by applications to check whether
119 * lttng-ust is loaded. They simply have to define their own
120 * "lttng_ust_loaded" weak symbol, and test it. It is set to 1 by the
121 * library constructor.
123 int lttng_ust_loaded
__attribute__((weak
));
126 * Return 0 on success, -1 if should quit.
127 * The lock is taken in both cases.
132 sigset_t sig_all_blocked
, orig_mask
;
135 ret
= pthread_setcancelstate(PTHREAD_CANCEL_DISABLE
, &oldstate
);
137 ERR("pthread_setcancelstate: %s", strerror(ret
));
139 if (oldstate
!= PTHREAD_CANCEL_ENABLE
) {
140 ERR("pthread_setcancelstate: unexpected oldstate");
142 sigfillset(&sig_all_blocked
);
143 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_mask
);
145 ERR("pthread_sigmask: %s", strerror(ret
));
147 if (!URCU_TLS(ust_mutex_nest
)++)
148 pthread_mutex_lock(&ust_mutex
);
149 ret
= pthread_sigmask(SIG_SETMASK
, &orig_mask
, NULL
);
151 ERR("pthread_sigmask: %s", strerror(ret
));
153 if (lttng_ust_comm_should_quit
) {
161 * ust_lock_nocheck() can be used in constructors/destructors, because
162 * they are already nested within the dynamic loader lock, and therefore
163 * have exclusive access against execution of liblttng-ust destructor.
166 void ust_lock_nocheck(void)
168 sigset_t sig_all_blocked
, orig_mask
;
171 ret
= pthread_setcancelstate(PTHREAD_CANCEL_DISABLE
, &oldstate
);
173 ERR("pthread_setcancelstate: %s", strerror(ret
));
175 if (oldstate
!= PTHREAD_CANCEL_ENABLE
) {
176 ERR("pthread_setcancelstate: unexpected oldstate");
178 sigfillset(&sig_all_blocked
);
179 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_mask
);
181 ERR("pthread_sigmask: %s", strerror(ret
));
183 if (!URCU_TLS(ust_mutex_nest
)++)
184 pthread_mutex_lock(&ust_mutex
);
185 ret
= pthread_sigmask(SIG_SETMASK
, &orig_mask
, NULL
);
187 ERR("pthread_sigmask: %s", strerror(ret
));
194 void ust_unlock(void)
196 sigset_t sig_all_blocked
, orig_mask
;
199 sigfillset(&sig_all_blocked
);
200 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_mask
);
202 ERR("pthread_sigmask: %s", strerror(ret
));
204 if (!--URCU_TLS(ust_mutex_nest
))
205 pthread_mutex_unlock(&ust_mutex
);
206 ret
= pthread_sigmask(SIG_SETMASK
, &orig_mask
, NULL
);
208 ERR("pthread_sigmask: %s", strerror(ret
));
210 ret
= pthread_setcancelstate(PTHREAD_CANCEL_ENABLE
, &oldstate
);
212 ERR("pthread_setcancelstate: %s", strerror(ret
));
214 if (oldstate
!= PTHREAD_CANCEL_DISABLE
) {
215 ERR("pthread_setcancelstate: unexpected oldstate");
220 * Wait for either of these before continuing to the main
222 * - the register_done message from sessiond daemon
223 * (will let the sessiond daemon enable sessions before main
225 * - sessiond daemon is not reachable.
226 * - timeout (ensuring applications are resilient to session
229 static sem_t constructor_wait
;
231 * Doing this for both the global and local sessiond.
234 sem_count_initial_value
= 4,
237 static int sem_count
= sem_count_initial_value
;
240 * Counting nesting within lttng-ust. Used to ensure that calling fork()
241 * from liblttng-ust does not execute the pre/post fork handlers.
243 static DEFINE_URCU_TLS(int, lttng_ust_nest_count
);
246 * Info about socket and associated listener thread.
250 pthread_t ust_listener
; /* listener thread */
252 int registration_done
;
257 char sock_path
[PATH_MAX
];
261 char wait_shm_path
[PATH_MAX
];
263 /* Keep track of lazy state dump not performed yet. */
264 int statedump_pending
;
265 int initial_statedump_done
;
268 /* Socket from app (connect) to session daemon (listen) for communication */
269 struct sock_info global_apps
= {
274 .registration_done
= 0,
278 .sock_path
= LTTNG_DEFAULT_RUNDIR
"/" LTTNG_UST_SOCK_FILENAME
,
282 .wait_shm_path
= "/" LTTNG_UST_WAIT_FILENAME
,
284 .statedump_pending
= 0,
285 .initial_statedump_done
= 0,
288 /* TODO: allow global_apps_sock_path override */
290 struct sock_info local_apps
= {
294 .registration_done
= 0,
295 .allowed
= 0, /* Check setuid bit first */
301 .statedump_pending
= 0,
302 .initial_statedump_done
= 0,
305 static int wait_poll_fallback
;
307 static const char *cmd_name_mapping
[] = {
308 [ LTTNG_UST_RELEASE
] = "Release",
309 [ LTTNG_UST_SESSION
] = "Create Session",
310 [ LTTNG_UST_TRACER_VERSION
] = "Get Tracer Version",
312 [ LTTNG_UST_TRACEPOINT_LIST
] = "Create Tracepoint List",
313 [ LTTNG_UST_WAIT_QUIESCENT
] = "Wait for Quiescent State",
314 [ LTTNG_UST_REGISTER_DONE
] = "Registration Done",
315 [ LTTNG_UST_TRACEPOINT_FIELD_LIST
] = "Create Tracepoint Field List",
317 /* Session FD commands */
318 [ LTTNG_UST_CHANNEL
] = "Create Channel",
319 [ LTTNG_UST_SESSION_START
] = "Start Session",
320 [ LTTNG_UST_SESSION_STOP
] = "Stop Session",
322 /* Channel FD commands */
323 [ LTTNG_UST_STREAM
] = "Create Stream",
324 [ LTTNG_UST_EVENT
] = "Create Event",
326 /* Event and Channel FD commands */
327 [ LTTNG_UST_CONTEXT
] = "Create Context",
328 [ LTTNG_UST_FLUSH_BUFFER
] = "Flush Buffer",
330 /* Event, Channel and Session commands */
331 [ LTTNG_UST_ENABLE
] = "Enable",
332 [ LTTNG_UST_DISABLE
] = "Disable",
334 /* Tracepoint list commands */
335 [ LTTNG_UST_TRACEPOINT_LIST_GET
] = "List Next Tracepoint",
336 [ LTTNG_UST_TRACEPOINT_FIELD_LIST_GET
] = "List Next Tracepoint Field",
338 /* Event FD commands */
339 [ LTTNG_UST_FILTER
] = "Create Filter",
340 [ LTTNG_UST_EXCLUSION
] = "Add exclusions to event",
343 static const char *str_timeout
;
344 static int got_timeout_env
;
346 extern void lttng_ring_buffer_client_overwrite_init(void);
347 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
348 extern void lttng_ring_buffer_client_discard_init(void);
349 extern void lttng_ring_buffer_client_discard_rt_init(void);
350 extern void lttng_ring_buffer_metadata_client_init(void);
351 extern void lttng_ring_buffer_client_overwrite_exit(void);
352 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
353 extern void lttng_ring_buffer_client_discard_exit(void);
354 extern void lttng_ring_buffer_client_discard_rt_exit(void);
355 extern void lttng_ring_buffer_metadata_client_exit(void);
357 static char *get_map_shm(struct sock_info
*sock_info
);
359 ssize_t
lttng_ust_read(int fd
, void *buf
, size_t len
)
362 size_t copied
= 0, to_copy
= len
;
365 ret
= read(fd
, buf
+ copied
, to_copy
);
370 } while ((ret
> 0 && to_copy
> 0)
371 || (ret
< 0 && errno
== EINTR
));
378 * Returns the HOME directory path. Caller MUST NOT free(3) the returned
382 const char *get_lttng_home_dir(void)
386 val
= (const char *) lttng_getenv("LTTNG_HOME");
390 return (const char *) lttng_getenv("HOME");
394 * Force a read (imply TLS fixup for dlopen) of TLS variables.
397 void lttng_fixup_nest_count_tls(void)
399 asm volatile ("" : : "m" (URCU_TLS(lttng_ust_nest_count
)));
403 void lttng_fixup_ust_mutex_nest_tls(void)
405 asm volatile ("" : : "m" (URCU_TLS(ust_mutex_nest
)));
412 void lttng_fixup_urcu_bp_tls(void)
418 void lttng_ust_fixup_tls(void)
420 lttng_fixup_urcu_bp_tls();
421 lttng_fixup_ringbuffer_tls();
422 lttng_fixup_vtid_tls();
423 lttng_fixup_nest_count_tls();
424 lttng_fixup_procname_tls();
425 lttng_fixup_ust_mutex_nest_tls();
426 lttng_ust_fixup_perf_counter_tls();
427 lttng_ust_fixup_fd_tracker_tls();
428 lttng_fixup_cgroup_ns_tls();
429 lttng_fixup_ipc_ns_tls();
430 lttng_fixup_net_ns_tls();
431 lttng_fixup_uts_ns_tls();
434 int lttng_get_notify_socket(void *owner
)
436 struct sock_info
*info
= owner
;
438 return info
->notify_socket
;
442 void print_cmd(int cmd
, int handle
)
444 const char *cmd_name
= "Unknown";
446 if (cmd
>= 0 && cmd
< LTTNG_ARRAY_SIZE(cmd_name_mapping
)
447 && cmd_name_mapping
[cmd
]) {
448 cmd_name
= cmd_name_mapping
[cmd
];
450 DBG("Message Received \"%s\" (%d), Handle \"%s\" (%d)",
452 lttng_ust_obj_get_name(handle
), handle
);
456 int setup_global_apps(void)
459 assert(!global_apps
.wait_shm_mmap
);
461 global_apps
.wait_shm_mmap
= get_map_shm(&global_apps
);
462 if (!global_apps
.wait_shm_mmap
) {
463 WARN("Unable to get map shm for global apps. Disabling LTTng-UST global tracing.");
464 global_apps
.allowed
= 0;
469 global_apps
.allowed
= 1;
474 int setup_local_apps(void)
477 const char *home_dir
;
480 assert(!local_apps
.wait_shm_mmap
);
484 * Disallow per-user tracing for setuid binaries.
486 if (uid
!= geteuid()) {
487 assert(local_apps
.allowed
== 0);
491 home_dir
= get_lttng_home_dir();
493 WARN("HOME environment variable not set. Disabling LTTng-UST per-user tracing.");
494 assert(local_apps
.allowed
== 0);
498 local_apps
.allowed
= 1;
499 snprintf(local_apps
.sock_path
, PATH_MAX
, "%s/%s/%s",
501 LTTNG_DEFAULT_HOME_RUNDIR
,
502 LTTNG_UST_SOCK_FILENAME
);
503 snprintf(local_apps
.wait_shm_path
, PATH_MAX
, "/%s-%u",
504 LTTNG_UST_WAIT_FILENAME
,
507 local_apps
.wait_shm_mmap
= get_map_shm(&local_apps
);
508 if (!local_apps
.wait_shm_mmap
) {
509 WARN("Unable to get map shm for local apps. Disabling LTTng-UST per-user tracing.");
510 local_apps
.allowed
= 0;
519 * Get socket timeout, in ms.
520 * -1: wait forever. 0: don't wait. >0: timeout, in ms.
523 long get_timeout(void)
525 long constructor_delay_ms
= LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
;
527 if (!got_timeout_env
) {
528 str_timeout
= lttng_getenv("LTTNG_UST_REGISTER_TIMEOUT");
532 constructor_delay_ms
= strtol(str_timeout
, NULL
, 10);
533 /* All negative values are considered as "-1". */
534 if (constructor_delay_ms
< -1)
535 constructor_delay_ms
= -1;
536 return constructor_delay_ms
;
539 /* Timeout for notify socket send and recv. */
541 long get_notify_sock_timeout(void)
543 return get_timeout();
546 /* Timeout for connecting to cmd and notify sockets. */
548 long get_connect_sock_timeout(void)
550 return get_timeout();
554 * Return values: -1: wait forever. 0: don't wait. 1: timeout wait.
557 int get_constructor_timeout(struct timespec
*constructor_timeout
)
559 long constructor_delay_ms
;
562 constructor_delay_ms
= get_timeout();
564 switch (constructor_delay_ms
) {
565 case -1:/* fall-through */
567 return constructor_delay_ms
;
573 * If we are unable to find the current time, don't wait.
575 ret
= clock_gettime(CLOCK_REALTIME
, constructor_timeout
);
580 constructor_timeout
->tv_sec
+= constructor_delay_ms
/ 1000UL;
581 constructor_timeout
->tv_nsec
+=
582 (constructor_delay_ms
% 1000UL) * 1000000UL;
583 if (constructor_timeout
->tv_nsec
>= 1000000000UL) {
584 constructor_timeout
->tv_sec
++;
585 constructor_timeout
->tv_nsec
-= 1000000000UL;
587 /* Timeout wait (constructor_delay_ms). */
592 void get_allow_blocking(void)
594 const char *str_allow_blocking
=
595 lttng_getenv("LTTNG_UST_ALLOW_BLOCKING");
597 if (str_allow_blocking
) {
598 DBG("%s environment variable is set",
599 "LTTNG_UST_ALLOW_BLOCKING");
600 lttng_ust_ringbuffer_set_allow_blocking();
605 int register_to_sessiond(int socket
, enum ustctl_socket_type type
)
607 return ustcomm_send_reg_msg(socket
,
610 lttng_alignof(uint8_t) * CHAR_BIT
,
611 lttng_alignof(uint16_t) * CHAR_BIT
,
612 lttng_alignof(uint32_t) * CHAR_BIT
,
613 lttng_alignof(uint64_t) * CHAR_BIT
,
614 lttng_alignof(unsigned long) * CHAR_BIT
);
618 int send_reply(int sock
, struct ustcomm_ust_reply
*lur
)
622 len
= ustcomm_send_unix_sock(sock
, lur
, sizeof(*lur
));
625 DBG("message successfully sent");
628 if (len
== -ECONNRESET
) {
629 DBG("remote end closed connection");
634 DBG("incorrect message size: %zd", len
);
640 void decrement_sem_count(unsigned int count
)
644 assert(uatomic_read(&sem_count
) >= count
);
646 if (uatomic_read(&sem_count
) <= 0) {
650 ret
= uatomic_add_return(&sem_count
, -count
);
652 ret
= sem_post(&constructor_wait
);
658 int handle_register_done(struct sock_info
*sock_info
)
660 if (sock_info
->registration_done
)
662 sock_info
->registration_done
= 1;
664 decrement_sem_count(1);
665 if (!sock_info
->statedump_pending
) {
666 sock_info
->initial_statedump_done
= 1;
667 decrement_sem_count(1);
674 int handle_register_failed(struct sock_info
*sock_info
)
676 if (sock_info
->registration_done
)
678 sock_info
->registration_done
= 1;
679 sock_info
->initial_statedump_done
= 1;
681 decrement_sem_count(2);
687 * Only execute pending statedump after the constructor semaphore has
688 * been posted by the current listener thread. This means statedump will
689 * only be performed after the "registration done" command is received
690 * from this thread's session daemon.
692 * This ensures we don't run into deadlock issues with the dynamic
693 * loader mutex, which is held while the constructor is called and
694 * waiting on the constructor semaphore. All operations requiring this
695 * dynamic loader lock need to be postponed using this mechanism.
697 * In a scenario with two session daemons connected to the application,
698 * it is possible that the first listener thread which receives the
699 * registration done command issues its statedump while the dynamic
700 * loader lock is still held by the application constructor waiting on
701 * the semaphore. It will however be allowed to proceed when the
702 * second session daemon sends the registration done command to the
703 * second listener thread. This situation therefore does not produce
707 void handle_pending_statedump(struct sock_info
*sock_info
)
709 if (sock_info
->registration_done
&& sock_info
->statedump_pending
) {
710 sock_info
->statedump_pending
= 0;
711 pthread_mutex_lock(&ust_fork_mutex
);
712 lttng_handle_pending_statedump(sock_info
);
713 pthread_mutex_unlock(&ust_fork_mutex
);
715 if (!sock_info
->initial_statedump_done
) {
716 sock_info
->initial_statedump_done
= 1;
717 decrement_sem_count(1);
723 int handle_message(struct sock_info
*sock_info
,
724 int sock
, struct ustcomm_ust_msg
*lum
)
727 const struct lttng_ust_objd_ops
*ops
;
728 struct ustcomm_ust_reply lur
;
730 char ctxstr
[LTTNG_UST_SYM_NAME_LEN
]; /* App context string. */
733 memset(&lur
, 0, sizeof(lur
));
736 ret
= -LTTNG_UST_ERR_EXITING
;
740 ops
= objd_ops(lum
->handle
);
747 case LTTNG_UST_REGISTER_DONE
:
748 if (lum
->handle
== LTTNG_UST_ROOT_HANDLE
)
749 ret
= handle_register_done(sock_info
);
753 case LTTNG_UST_RELEASE
:
754 if (lum
->handle
== LTTNG_UST_ROOT_HANDLE
)
757 ret
= lttng_ust_objd_unref(lum
->handle
, 1);
759 case LTTNG_UST_FILTER
:
761 /* Receive filter data */
762 struct lttng_ust_filter_bytecode_node
*bytecode
;
764 if (lum
->u
.filter
.data_size
> FILTER_BYTECODE_MAX_LEN
) {
765 ERR("Filter data size is too large: %u bytes",
766 lum
->u
.filter
.data_size
);
771 if (lum
->u
.filter
.reloc_offset
> lum
->u
.filter
.data_size
) {
772 ERR("Filter reloc offset %u is not within data",
773 lum
->u
.filter
.reloc_offset
);
778 bytecode
= zmalloc(sizeof(*bytecode
) + lum
->u
.filter
.data_size
);
783 len
= ustcomm_recv_unix_sock(sock
, bytecode
->bc
.data
,
784 lum
->u
.filter
.data_size
);
786 case 0: /* orderly shutdown */
791 if (len
== lum
->u
.filter
.data_size
) {
792 DBG("filter data received");
794 } else if (len
< 0) {
795 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
796 if (len
== -ECONNRESET
) {
797 ERR("%s remote end closed connection", sock_info
->name
);
806 DBG("incorrect filter data message size: %zd", len
);
812 bytecode
->bc
.len
= lum
->u
.filter
.data_size
;
813 bytecode
->bc
.reloc_offset
= lum
->u
.filter
.reloc_offset
;
814 bytecode
->bc
.seqnum
= lum
->u
.filter
.seqnum
;
816 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
817 (unsigned long) bytecode
,
822 /* don't free bytecode if everything went fine. */
829 case LTTNG_UST_EXCLUSION
:
831 /* Receive exclusion names */
832 struct lttng_ust_excluder_node
*node
;
835 count
= lum
->u
.exclusion
.count
;
837 /* There are no names to read */
841 node
= zmalloc(sizeof(*node
) +
842 count
* LTTNG_UST_SYM_NAME_LEN
);
847 node
->excluder
.count
= count
;
848 len
= ustcomm_recv_unix_sock(sock
, node
->excluder
.names
,
849 count
* LTTNG_UST_SYM_NAME_LEN
);
851 case 0: /* orderly shutdown */
856 if (len
== count
* LTTNG_UST_SYM_NAME_LEN
) {
857 DBG("Exclusion data received");
859 } else if (len
< 0) {
860 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
861 if (len
== -ECONNRESET
) {
862 ERR("%s remote end closed connection", sock_info
->name
);
871 DBG("Incorrect exclusion data message size: %zd", len
);
878 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
879 (unsigned long) node
,
884 /* Don't free exclusion data if everything went fine. */
891 case LTTNG_UST_CHANNEL
:
896 len
= ustcomm_recv_channel_from_sessiond(sock
,
897 &chan_data
, lum
->u
.channel
.len
,
900 case 0: /* orderly shutdown */
904 if (len
== lum
->u
.channel
.len
) {
905 DBG("channel data received");
907 } else if (len
< 0) {
908 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
909 if (len
== -ECONNRESET
) {
910 ERR("%s remote end closed connection", sock_info
->name
);
917 DBG("incorrect channel data message size: %zd", len
);
922 args
.channel
.chan_data
= chan_data
;
923 args
.channel
.wakeup_fd
= wakeup_fd
;
925 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
926 (unsigned long) &lum
->u
,
932 case LTTNG_UST_STREAM
:
934 /* Receive shm_fd, wakeup_fd */
935 ret
= ustcomm_recv_stream_from_sessiond(sock
,
938 &args
.stream
.wakeup_fd
);
944 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
945 (unsigned long) &lum
->u
,
951 case LTTNG_UST_CONTEXT
:
952 switch (lum
->u
.context
.ctx
) {
953 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
956 size_t ctxlen
, recvlen
;
958 ctxlen
= strlen("$app.") + lum
->u
.context
.u
.app_ctx
.provider_name_len
- 1
959 + strlen(":") + lum
->u
.context
.u
.app_ctx
.ctx_name_len
;
960 if (ctxlen
>= LTTNG_UST_SYM_NAME_LEN
) {
961 ERR("Application context string length size is too large: %zu bytes",
966 strcpy(ctxstr
, "$app.");
967 p
= &ctxstr
[strlen("$app.")];
968 recvlen
= ctxlen
- strlen("$app.");
969 len
= ustcomm_recv_unix_sock(sock
, p
, recvlen
);
971 case 0: /* orderly shutdown */
975 if (len
== recvlen
) {
976 DBG("app context data received");
978 } else if (len
< 0) {
979 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
980 if (len
== -ECONNRESET
) {
981 ERR("%s remote end closed connection", sock_info
->name
);
988 DBG("incorrect app context data message size: %zd", len
);
993 /* Put : between provider and ctxname. */
994 p
[lum
->u
.context
.u
.app_ctx
.provider_name_len
- 1] = ':';
995 args
.app_context
.ctxname
= ctxstr
;
1002 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
1003 (unsigned long) &lum
->u
,
1011 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
1012 (unsigned long) &lum
->u
,
1019 lur
.handle
= lum
->handle
;
1023 lur
.ret_code
= LTTNG_UST_OK
;
1026 * Use -LTTNG_UST_ERR as wildcard for UST internal
1027 * error that are not caused by the transport, except if
1028 * we already have a more precise error message to
1031 if (ret
> -LTTNG_UST_ERR
) {
1032 /* Translate code to UST error. */
1035 lur
.ret_code
= -LTTNG_UST_ERR_EXIST
;
1038 lur
.ret_code
= -LTTNG_UST_ERR_INVAL
;
1041 lur
.ret_code
= -LTTNG_UST_ERR_NOENT
;
1044 lur
.ret_code
= -LTTNG_UST_ERR_PERM
;
1047 lur
.ret_code
= -LTTNG_UST_ERR_NOSYS
;
1050 lur
.ret_code
= -LTTNG_UST_ERR
;
1059 case LTTNG_UST_TRACER_VERSION
:
1060 lur
.u
.version
= lum
->u
.version
;
1062 case LTTNG_UST_TRACEPOINT_LIST_GET
:
1063 memcpy(&lur
.u
.tracepoint
, &lum
->u
.tracepoint
, sizeof(lur
.u
.tracepoint
));
1067 DBG("Return value: %d", lur
.ret_val
);
1072 * Performed delayed statedump operations outside of the UST
1073 * lock. We need to take the dynamic loader lock before we take
1074 * the UST lock internally within handle_pending_statedump().
1076 handle_pending_statedump(sock_info
);
1079 ret
= -LTTNG_UST_ERR_EXITING
;
1083 ret
= send_reply(sock
, &lur
);
1085 DBG("error sending reply");
1090 * LTTNG_UST_TRACEPOINT_FIELD_LIST_GET needs to send the field
1093 if (lur
.ret_code
== LTTNG_UST_OK
) {
1095 case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET
:
1096 len
= ustcomm_send_unix_sock(sock
,
1097 &args
.field_list
.entry
,
1098 sizeof(args
.field_list
.entry
));
1103 if (len
!= sizeof(args
.field_list
.entry
)) {
1117 void cleanup_sock_info(struct sock_info
*sock_info
, int exiting
)
1121 if (sock_info
->root_handle
!= -1) {
1122 ret
= lttng_ust_objd_unref(sock_info
->root_handle
, 1);
1124 ERR("Error unref root handle");
1126 sock_info
->root_handle
= -1;
1128 sock_info
->registration_done
= 0;
1129 sock_info
->initial_statedump_done
= 0;
1132 * wait_shm_mmap, socket and notify socket are used by listener
1133 * threads outside of the ust lock, so we cannot tear them down
1134 * ourselves, because we cannot join on these threads. Leave
1135 * responsibility of cleaning up these resources to the OS
1141 if (sock_info
->socket
!= -1) {
1142 ret
= ustcomm_close_unix_sock(sock_info
->socket
);
1144 ERR("Error closing ust cmd socket");
1146 sock_info
->socket
= -1;
1148 if (sock_info
->notify_socket
!= -1) {
1149 ret
= ustcomm_close_unix_sock(sock_info
->notify_socket
);
1151 ERR("Error closing ust notify socket");
1153 sock_info
->notify_socket
= -1;
1155 if (sock_info
->wait_shm_mmap
) {
1158 page_size
= sysconf(_SC_PAGE_SIZE
);
1159 if (page_size
<= 0) {
1163 PERROR("Error in sysconf(_SC_PAGE_SIZE)");
1165 ret
= munmap(sock_info
->wait_shm_mmap
, page_size
);
1167 ERR("Error unmapping wait shm");
1170 sock_info
->wait_shm_mmap
= NULL
;
1175 * Using fork to set umask in the child process (not multi-thread safe).
1176 * We deal with the shm_open vs ftruncate race (happening when the
1177 * sessiond owns the shm and does not let everybody modify it, to ensure
1178 * safety against shm_unlink) by simply letting the mmap fail and
1179 * retrying after a few seconds.
1180 * For global shm, everybody has rw access to it until the sessiond
1184 int get_wait_shm(struct sock_info
*sock_info
, size_t mmap_size
)
1186 int wait_shm_fd
, ret
;
1190 * Try to open read-only.
1192 wait_shm_fd
= shm_open(sock_info
->wait_shm_path
, O_RDONLY
, 0);
1193 if (wait_shm_fd
>= 0) {
1196 size_t bytes_read
= 0;
1199 * Try to read the fd. If unable to do so, try opening
1203 len
= read(wait_shm_fd
,
1204 &((char *) &tmp_read
)[bytes_read
],
1205 sizeof(tmp_read
) - bytes_read
);
1209 } while ((len
< 0 && errno
== EINTR
)
1210 || (len
> 0 && bytes_read
< sizeof(tmp_read
)));
1211 if (bytes_read
!= sizeof(tmp_read
)) {
1212 ret
= close(wait_shm_fd
);
1214 ERR("close wait_shm_fd");
1219 } else if (wait_shm_fd
< 0 && errno
!= ENOENT
) {
1221 * Real-only open did not work, and it's not because the
1222 * entry was not present. It's a failure that prohibits
1225 ERR("Error opening shm %s", sock_info
->wait_shm_path
);
1231 * If the open failed because the file did not exist, or because
1232 * the file was not truncated yet, try creating it ourself.
1234 URCU_TLS(lttng_ust_nest_count
)++;
1236 URCU_TLS(lttng_ust_nest_count
)--;
1241 * Parent: wait for child to return, in which case the
1242 * shared memory map will have been created.
1244 pid
= wait(&status
);
1245 if (pid
< 0 || !WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
1250 * Try to open read-only again after creation.
1252 wait_shm_fd
= shm_open(sock_info
->wait_shm_path
, O_RDONLY
, 0);
1253 if (wait_shm_fd
< 0) {
1255 * Real-only open did not work. It's a failure
1256 * that prohibits using shm.
1258 ERR("Error opening shm %s", sock_info
->wait_shm_path
);
1262 } else if (pid
== 0) {
1266 create_mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
;
1267 if (sock_info
->global
)
1268 create_mode
|= S_IROTH
| S_IWGRP
| S_IWOTH
;
1270 * We're alone in a child process, so we can modify the
1271 * process-wide umask.
1273 umask(~create_mode
);
1275 * Try creating shm (or get rw access).
1276 * We don't do an exclusive open, because we allow other
1277 * processes to create+ftruncate it concurrently.
1279 wait_shm_fd
= shm_open(sock_info
->wait_shm_path
,
1280 O_RDWR
| O_CREAT
, create_mode
);
1281 if (wait_shm_fd
>= 0) {
1282 ret
= ftruncate(wait_shm_fd
, mmap_size
);
1284 PERROR("ftruncate");
1285 _exit(EXIT_FAILURE
);
1287 _exit(EXIT_SUCCESS
);
1290 * For local shm, we need to have rw access to accept
1291 * opening it: this means the local sessiond will be
1292 * able to wake us up. For global shm, we open it even
1293 * if rw access is not granted, because the root.root
1294 * sessiond will be able to override all rights and wake
1297 if (!sock_info
->global
&& errno
!= EACCES
) {
1298 ERR("Error opening shm %s", sock_info
->wait_shm_path
);
1299 _exit(EXIT_FAILURE
);
1302 * The shm exists, but we cannot open it RW. Report
1305 _exit(EXIT_SUCCESS
);
1310 if (wait_shm_fd
>= 0 && !sock_info
->global
) {
1311 struct stat statbuf
;
1314 * Ensure that our user is the owner of the shm file for
1315 * local shm. If we do not own the file, it means our
1316 * sessiond will not have access to wake us up (there is
1317 * probably a rogue process trying to fake our
1318 * sessiond). Fallback to polling method in this case.
1320 ret
= fstat(wait_shm_fd
, &statbuf
);
1325 if (statbuf
.st_uid
!= getuid())
1331 ret
= close(wait_shm_fd
);
1333 PERROR("Error closing fd");
1339 char *get_map_shm(struct sock_info
*sock_info
)
1342 int wait_shm_fd
, ret
;
1343 char *wait_shm_mmap
;
1345 page_size
= sysconf(_SC_PAGE_SIZE
);
1346 if (page_size
<= 0) {
1350 PERROR("Error in sysconf(_SC_PAGE_SIZE)");
1354 lttng_ust_lock_fd_tracker();
1355 wait_shm_fd
= get_wait_shm(sock_info
, page_size
);
1356 if (wait_shm_fd
< 0) {
1357 lttng_ust_unlock_fd_tracker();
1361 ret
= lttng_ust_add_fd_to_tracker(wait_shm_fd
);
1363 ret
= close(wait_shm_fd
);
1365 PERROR("Error closing fd");
1367 lttng_ust_unlock_fd_tracker();
1372 lttng_ust_unlock_fd_tracker();
1374 wait_shm_mmap
= mmap(NULL
, page_size
, PROT_READ
,
1375 MAP_SHARED
, wait_shm_fd
, 0);
1377 /* close shm fd immediately after taking the mmap reference */
1378 lttng_ust_lock_fd_tracker();
1379 ret
= close(wait_shm_fd
);
1381 lttng_ust_delete_fd_from_tracker(wait_shm_fd
);
1383 PERROR("Error closing fd");
1385 lttng_ust_unlock_fd_tracker();
1387 if (wait_shm_mmap
== MAP_FAILED
) {
1388 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
1391 return wait_shm_mmap
;
1398 void wait_for_sessiond(struct sock_info
*sock_info
)
1400 /* Use ust_lock to check if we should quit. */
1404 if (wait_poll_fallback
) {
1409 assert(sock_info
->wait_shm_mmap
);
1411 DBG("Waiting for %s apps sessiond", sock_info
->name
);
1412 /* Wait for futex wakeup */
1413 if (uatomic_read((int32_t *) sock_info
->wait_shm_mmap
))
1416 while (futex_async((int32_t *) sock_info
->wait_shm_mmap
,
1417 FUTEX_WAIT
, 0, NULL
, NULL
, 0)) {
1420 /* Value already changed. */
1423 /* Retry if interrupted by signal. */
1424 break; /* Get out of switch. */
1426 wait_poll_fallback
= 1;
1428 "Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
1429 "do not support FUTEX_WAKE on read-only memory mappings correctly. "
1430 "Please upgrade your kernel "
1431 "(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
1432 "mainline). LTTng-UST will use polling mode fallback.");
1451 * This thread does not allocate any resource, except within
1452 * handle_message, within mutex protection. This mutex protects against
1454 * The other moment it allocates resources is at socket connection, which
1455 * is also protected by the mutex.
1458 void *ust_listener_thread(void *arg
)
1460 struct sock_info
*sock_info
= arg
;
1461 int sock
, ret
, prev_connect_failed
= 0, has_waited
= 0, fd
;
1464 lttng_ust_fixup_tls();
1466 * If available, add '-ust' to the end of this thread's
1469 ret
= lttng_ust_setustprocname();
1471 ERR("Unable to set UST process name");
1474 /* Restart trying to connect to the session daemon */
1476 if (prev_connect_failed
) {
1477 /* Wait for sessiond availability with pipe */
1478 wait_for_sessiond(sock_info
);
1482 * Sleep for 5 seconds before retrying after a
1483 * sequence of failure / wait / failure. This
1484 * deals with a killed or broken session daemon.
1490 prev_connect_failed
= 0;
1497 if (sock_info
->socket
!= -1) {
1498 /* FD tracker is updated by ustcomm_close_unix_sock() */
1499 ret
= ustcomm_close_unix_sock(sock_info
->socket
);
1501 ERR("Error closing %s ust cmd socket",
1504 sock_info
->socket
= -1;
1506 if (sock_info
->notify_socket
!= -1) {
1507 /* FD tracker is updated by ustcomm_close_unix_sock() */
1508 ret
= ustcomm_close_unix_sock(sock_info
->notify_socket
);
1510 ERR("Error closing %s ust notify socket",
1513 sock_info
->notify_socket
= -1;
1518 * Register. We need to perform both connect and sending
1519 * registration message before doing the next connect otherwise
1520 * we may reach unix socket connect queue max limits and block
1521 * on the 2nd connect while the session daemon is awaiting the
1522 * first connect registration message.
1524 /* Connect cmd socket */
1525 lttng_ust_lock_fd_tracker();
1526 ret
= ustcomm_connect_unix_sock(sock_info
->sock_path
,
1527 get_connect_sock_timeout());
1529 lttng_ust_unlock_fd_tracker();
1530 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info
->name
);
1531 prev_connect_failed
= 1;
1534 * If we cannot find the sessiond daemon, don't delay
1535 * constructor execution.
1537 ret
= handle_register_failed(sock_info
);
1543 ret
= lttng_ust_add_fd_to_tracker(fd
);
1547 PERROR("close on sock_info->socket");
1550 lttng_ust_unlock_fd_tracker();
1555 sock_info
->socket
= ret
;
1556 lttng_ust_unlock_fd_tracker();
1560 * Unlock/relock ust lock because connect is blocking (with
1561 * timeout). Don't delay constructors on the ust lock for too
1569 * Create only one root handle per listener thread for the whole
1570 * process lifetime, so we ensure we get ID which is statically
1571 * assigned to the root handle.
1573 if (sock_info
->root_handle
== -1) {
1574 ret
= lttng_abi_create_root_handle();
1576 ERR("Error creating root handle");
1579 sock_info
->root_handle
= ret
;
1582 ret
= register_to_sessiond(sock_info
->socket
, USTCTL_SOCKET_CMD
);
1584 ERR("Error registering to %s ust cmd socket",
1586 prev_connect_failed
= 1;
1588 * If we cannot register to the sessiond daemon, don't
1589 * delay constructor execution.
1591 ret
= handle_register_failed(sock_info
);
1599 * Unlock/relock ust lock because connect is blocking (with
1600 * timeout). Don't delay constructors on the ust lock for too
1607 /* Connect notify socket */
1608 lttng_ust_lock_fd_tracker();
1609 ret
= ustcomm_connect_unix_sock(sock_info
->sock_path
,
1610 get_connect_sock_timeout());
1612 lttng_ust_unlock_fd_tracker();
1613 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info
->name
);
1614 prev_connect_failed
= 1;
1617 * If we cannot find the sessiond daemon, don't delay
1618 * constructor execution.
1620 ret
= handle_register_failed(sock_info
);
1627 ret
= lttng_ust_add_fd_to_tracker(fd
);
1631 PERROR("close on sock_info->notify_socket");
1634 lttng_ust_unlock_fd_tracker();
1639 sock_info
->notify_socket
= ret
;
1640 lttng_ust_unlock_fd_tracker();
1644 * Unlock/relock ust lock because connect is blocking (with
1645 * timeout). Don't delay constructors on the ust lock for too
1652 timeout
= get_notify_sock_timeout();
1655 * Give at least 10ms to sessiond to reply to
1660 ret
= ustcomm_setsockopt_rcv_timeout(sock_info
->notify_socket
,
1663 WARN("Error setting socket receive timeout");
1665 ret
= ustcomm_setsockopt_snd_timeout(sock_info
->notify_socket
,
1668 WARN("Error setting socket send timeout");
1670 } else if (timeout
< -1) {
1671 WARN("Unsupported timeout value %ld", timeout
);
1674 ret
= register_to_sessiond(sock_info
->notify_socket
,
1675 USTCTL_SOCKET_NOTIFY
);
1677 ERR("Error registering to %s ust notify socket",
1679 prev_connect_failed
= 1;
1681 * If we cannot register to the sessiond daemon, don't
1682 * delay constructor execution.
1684 ret
= handle_register_failed(sock_info
);
1689 sock
= sock_info
->socket
;
1695 struct ustcomm_ust_msg lum
;
1697 len
= ustcomm_recv_unix_sock(sock
, &lum
, sizeof(lum
));
1699 case 0: /* orderly shutdown */
1700 DBG("%s lttng-sessiond has performed an orderly shutdown", sock_info
->name
);
1705 * Either sessiond has shutdown or refused us by closing the socket.
1706 * In either case, we don't want to delay construction execution,
1707 * and we need to wait before retry.
1709 prev_connect_failed
= 1;
1711 * If we cannot register to the sessiond daemon, don't
1712 * delay constructor execution.
1714 ret
= handle_register_failed(sock_info
);
1719 print_cmd(lum
.cmd
, lum
.handle
);
1720 ret
= handle_message(sock_info
, sock
, &lum
);
1722 ERR("Error handling message for %s socket",
1725 * Close socket if protocol error is
1733 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
1735 DBG("incorrect message size (%s socket): %zd", sock_info
->name
, len
);
1737 if (len
== -ECONNRESET
) {
1738 DBG("%s remote end closed connection", sock_info
->name
);
1749 /* Cleanup socket handles before trying to reconnect */
1750 lttng_ust_objd_table_owner_cleanup(sock_info
);
1752 goto restart
; /* try to reconnect */
1757 pthread_mutex_lock(&ust_exit_mutex
);
1758 sock_info
->thread_active
= 0;
1759 pthread_mutex_unlock(&ust_exit_mutex
);
1764 * Weak symbol to call when the ust malloc wrapper is not loaded.
1766 __attribute__((weak
))
1767 void lttng_ust_malloc_wrapper_init(void)
1772 * sessiond monitoring thread: monitor presence of global and per-user
1773 * sessiond by polling the application common named pipe.
1775 void __attribute__((constructor
)) lttng_ust_init(void)
1777 struct timespec constructor_timeout
;
1778 sigset_t sig_all_blocked
, orig_parent_mask
;
1779 pthread_attr_t thread_attr
;
1784 if (uatomic_xchg(&initialized
, 1) == 1)
1788 * Fixup interdependency between TLS fixup mutex (which happens
1789 * to be the dynamic linker mutex) and ust_lock, taken within
1792 lttng_ust_fixup_tls();
1794 lttng_ust_loaded
= 1;
1797 * We need to ensure that the liblttng-ust library is not unloaded to avoid
1798 * the unloading of code used by the ust_listener_threads as we can not
1799 * reliably know when they exited. To do that, manually load
1800 * liblttng-ust.so to increment the dynamic loader's internal refcount for
1801 * this library so it never becomes zero, thus never gets unloaded from the
1802 * address space of the process. Since we are already running in the
1803 * constructor of the LTTNG_UST_LIB_SO_NAME library, calling dlopen will
1804 * simply increment the refcount and no additionnal work is needed by the
1805 * dynamic loader as the shared library is already loaded in the address
1806 * space. As a safe guard, we use the RTLD_NODELETE flag to prevent
1807 * unloading of the UST library if its refcount becomes zero (which should
1808 * never happen). Do the return value check but discard the handle at the
1809 * end of the function as it's not needed.
1811 handle
= dlopen(LTTNG_UST_LIB_SO_NAME
, RTLD_LAZY
| RTLD_NODELETE
);
1813 ERR("dlopen of liblttng-ust shared library (%s).", LTTNG_UST_LIB_SO_NAME
);
1817 * We want precise control over the order in which we construct
1818 * our sub-libraries vs starting to receive commands from
1819 * sessiond (otherwise leading to errors when trying to create
1820 * sessiond before the init functions are completed).
1823 lttng_ust_getenv_init(); /* Needs init_usterr() to be completed. */
1825 lttng_ust_init_fd_tracker();
1826 lttng_ust_clock_init();
1827 lttng_ust_getcpu_init();
1828 lttng_ust_statedump_init();
1829 lttng_ring_buffer_metadata_client_init();
1830 lttng_ring_buffer_client_overwrite_init();
1831 lttng_ring_buffer_client_overwrite_rt_init();
1832 lttng_ring_buffer_client_discard_init();
1833 lttng_ring_buffer_client_discard_rt_init();
1834 lttng_perf_counter_init();
1836 * Invoke ust malloc wrapper init before starting other threads.
1838 lttng_ust_malloc_wrapper_init();
1840 timeout_mode
= get_constructor_timeout(&constructor_timeout
);
1842 get_allow_blocking();
1844 ret
= sem_init(&constructor_wait
, 0, 0);
1849 ret
= setup_global_apps();
1851 assert(global_apps
.allowed
== 0);
1852 DBG("global apps setup returned %d", ret
);
1855 ret
= setup_local_apps();
1857 assert(local_apps
.allowed
== 0);
1858 DBG("local apps setup returned %d", ret
);
1861 /* A new thread created by pthread_create inherits the signal mask
1862 * from the parent. To avoid any signal being received by the
1863 * listener thread, we block all signals temporarily in the parent,
1864 * while we create the listener thread.
1866 sigfillset(&sig_all_blocked
);
1867 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_parent_mask
);
1869 ERR("pthread_sigmask: %s", strerror(ret
));
1872 ret
= pthread_attr_init(&thread_attr
);
1874 ERR("pthread_attr_init: %s", strerror(ret
));
1876 ret
= pthread_attr_setdetachstate(&thread_attr
, PTHREAD_CREATE_DETACHED
);
1878 ERR("pthread_attr_setdetachstate: %s", strerror(ret
));
1881 if (global_apps
.allowed
) {
1882 pthread_mutex_lock(&ust_exit_mutex
);
1883 ret
= pthread_create(&global_apps
.ust_listener
, &thread_attr
,
1884 ust_listener_thread
, &global_apps
);
1886 ERR("pthread_create global: %s", strerror(ret
));
1888 global_apps
.thread_active
= 1;
1889 pthread_mutex_unlock(&ust_exit_mutex
);
1891 handle_register_done(&global_apps
);
1894 if (local_apps
.allowed
) {
1895 pthread_mutex_lock(&ust_exit_mutex
);
1896 ret
= pthread_create(&local_apps
.ust_listener
, &thread_attr
,
1897 ust_listener_thread
, &local_apps
);
1899 ERR("pthread_create local: %s", strerror(ret
));
1901 local_apps
.thread_active
= 1;
1902 pthread_mutex_unlock(&ust_exit_mutex
);
1904 handle_register_done(&local_apps
);
1906 ret
= pthread_attr_destroy(&thread_attr
);
1908 ERR("pthread_attr_destroy: %s", strerror(ret
));
1911 /* Restore original signal mask in parent */
1912 ret
= pthread_sigmask(SIG_SETMASK
, &orig_parent_mask
, NULL
);
1914 ERR("pthread_sigmask: %s", strerror(ret
));
1917 switch (timeout_mode
) {
1918 case 1: /* timeout wait */
1920 ret
= sem_timedwait(&constructor_wait
,
1921 &constructor_timeout
);
1922 } while (ret
< 0 && errno
== EINTR
);
1926 ERR("Timed out waiting for lttng-sessiond");
1929 PERROR("sem_timedwait");
1932 ERR("Unexpected error \"%s\" returned by sem_timedwait",
1937 case -1:/* wait forever */
1939 ret
= sem_wait(&constructor_wait
);
1940 } while (ret
< 0 && errno
== EINTR
);
1947 ERR("Unexpected error \"%s\" returned by sem_wait",
1952 case 0: /* no timeout */
1958 void lttng_ust_cleanup(int exiting
)
1960 cleanup_sock_info(&global_apps
, exiting
);
1961 cleanup_sock_info(&local_apps
, exiting
);
1962 local_apps
.allowed
= 0;
1963 global_apps
.allowed
= 0;
1965 * The teardown in this function all affect data structures
1966 * accessed under the UST lock by the listener thread. This
1967 * lock, along with the lttng_ust_comm_should_quit flag, ensure
1968 * that none of these threads are accessing this data at this
1971 lttng_ust_abi_exit();
1972 lttng_ust_events_exit();
1973 lttng_perf_counter_exit();
1974 lttng_ring_buffer_client_discard_rt_exit();
1975 lttng_ring_buffer_client_discard_exit();
1976 lttng_ring_buffer_client_overwrite_rt_exit();
1977 lttng_ring_buffer_client_overwrite_exit();
1978 lttng_ring_buffer_metadata_client_exit();
1979 lttng_ust_statedump_destroy();
1982 /* Reinitialize values for fork */
1983 sem_count
= sem_count_initial_value
;
1984 lttng_ust_comm_should_quit
= 0;
1989 void __attribute__((destructor
)) lttng_ust_exit(void)
1994 * Using pthread_cancel here because:
1995 * A) we don't want to hang application teardown.
1996 * B) the thread is not allocating any resource.
2000 * Require the communication thread to quit. Synchronize with
2001 * mutexes to ensure it is not in a mutex critical section when
2002 * pthread_cancel is later called.
2005 lttng_ust_comm_should_quit
= 1;
2008 pthread_mutex_lock(&ust_exit_mutex
);
2009 /* cancel threads */
2010 if (global_apps
.thread_active
) {
2011 ret
= pthread_cancel(global_apps
.ust_listener
);
2013 ERR("Error cancelling global ust listener thread: %s",
2016 global_apps
.thread_active
= 0;
2019 if (local_apps
.thread_active
) {
2020 ret
= pthread_cancel(local_apps
.ust_listener
);
2022 ERR("Error cancelling local ust listener thread: %s",
2025 local_apps
.thread_active
= 0;
2028 pthread_mutex_unlock(&ust_exit_mutex
);
2031 * Do NOT join threads: use of sys_futex makes it impossible to
2032 * join the threads without using async-cancel, but async-cancel
2033 * is delivered by a signal, which could hit the target thread
2034 * anywhere in its code path, including while the ust_lock() is
2035 * held, causing a deadlock for the other thread. Let the OS
2036 * cleanup the threads if there are stalled in a syscall.
2038 lttng_ust_cleanup(1);
2042 void ust_context_ns_reset(void)
2044 lttng_context_pid_ns_reset();
2045 lttng_context_cgroup_ns_reset();
2046 lttng_context_ipc_ns_reset();
2047 lttng_context_mnt_ns_reset();
2048 lttng_context_net_ns_reset();
2049 lttng_context_user_ns_reset();
2050 lttng_context_uts_ns_reset();
2054 void ust_context_vuids_reset(void)
2056 lttng_context_vuid_reset();
2057 lttng_context_veuid_reset();
2058 lttng_context_vsuid_reset();
2062 void ust_context_vgids_reset(void)
2064 lttng_context_vgid_reset();
2065 lttng_context_vegid_reset();
2066 lttng_context_vsgid_reset();
2070 * We exclude the worker threads across fork and clone (except
2071 * CLONE_VM), because these system calls only keep the forking thread
2072 * running in the child. Therefore, we don't want to call fork or clone
2073 * in the middle of an tracepoint or ust tracing state modification.
2074 * Holding this mutex protects these structures across fork and clone.
2076 void ust_before_fork(sigset_t
*save_sigset
)
2079 * Disable signals. This is to avoid that the child intervenes
2080 * before it is properly setup for tracing. It is safer to
2081 * disable all signals, because then we know we are not breaking
2082 * anything by restoring the original mask.
2087 /* Fixup lttng-ust TLS. */
2088 lttng_ust_fixup_tls();
2090 if (URCU_TLS(lttng_ust_nest_count
))
2092 /* Disable signals */
2093 sigfillset(&all_sigs
);
2094 ret
= sigprocmask(SIG_BLOCK
, &all_sigs
, save_sigset
);
2096 PERROR("sigprocmask");
2099 pthread_mutex_lock(&ust_fork_mutex
);
2102 urcu_bp_before_fork();
2103 lttng_ust_lock_fd_tracker();
2107 static void ust_after_fork_common(sigset_t
*restore_sigset
)
2111 DBG("process %d", getpid());
2112 lttng_perf_unlock();
2113 lttng_ust_unlock_fd_tracker();
2116 pthread_mutex_unlock(&ust_fork_mutex
);
2118 /* Restore signals */
2119 ret
= sigprocmask(SIG_SETMASK
, restore_sigset
, NULL
);
2121 PERROR("sigprocmask");
2125 void ust_after_fork_parent(sigset_t
*restore_sigset
)
2127 if (URCU_TLS(lttng_ust_nest_count
))
2129 DBG("process %d", getpid());
2130 urcu_bp_after_fork_parent();
2131 /* Release mutexes and reenable signals */
2132 ust_after_fork_common(restore_sigset
);
2136 * After fork, in the child, we need to cleanup all the leftover state,
2137 * except the worker thread which already magically disappeared thanks
2138 * to the weird Linux fork semantics. After tyding up, we call
2139 * lttng_ust_init() again to start over as a new PID.
2141 * This is meant for forks() that have tracing in the child between the
2142 * fork and following exec call (if there is any).
2144 void ust_after_fork_child(sigset_t
*restore_sigset
)
2146 if (URCU_TLS(lttng_ust_nest_count
))
2148 lttng_context_vpid_reset();
2149 lttng_context_vtid_reset();
2150 lttng_context_procname_reset();
2151 ust_context_ns_reset();
2152 ust_context_vuids_reset();
2153 ust_context_vgids_reset();
2154 DBG("process %d", getpid());
2155 /* Release urcu mutexes */
2156 urcu_bp_after_fork_child();
2157 lttng_ust_cleanup(0);
2158 /* Release mutexes and reenable signals */
2159 ust_after_fork_common(restore_sigset
);
2163 void ust_after_setns(void)
2165 ust_context_ns_reset();
2166 ust_context_vuids_reset();
2167 ust_context_vgids_reset();
2170 void ust_after_unshare(void)
2172 ust_context_ns_reset();
2173 ust_context_vuids_reset();
2174 ust_context_vgids_reset();
2177 void ust_after_setuid(void)
2179 ust_context_vuids_reset();
2182 void ust_after_seteuid(void)
2184 ust_context_vuids_reset();
2187 void ust_after_setreuid(void)
2189 ust_context_vuids_reset();
2192 void ust_after_setresuid(void)
2194 ust_context_vuids_reset();
2197 void ust_after_setgid(void)
2199 ust_context_vgids_reset();
2202 void ust_after_setegid(void)
2204 ust_context_vgids_reset();
2207 void ust_after_setregid(void)
2209 ust_context_vgids_reset();
2212 void ust_after_setresgid(void)
2214 ust_context_vgids_reset();
2217 void lttng_ust_sockinfo_session_enabled(void *owner
)
2219 struct sock_info
*sock_info
= owner
;
2220 sock_info
->statedump_pending
= 1;