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
23 #include <sys/types.h>
24 #include <sys/socket.h>
27 #include <sys/types.h>
33 #include <semaphore.h>
37 #include <urcu/uatomic.h>
38 #include <urcu/futex.h>
39 #include <urcu/compiler.h>
41 #include <lttng/ust-events.h>
42 #include <lttng/ust-abi.h>
43 #include <lttng/ust.h>
44 #include <lttng/ust-error.h>
45 #include <lttng/ust-ctl.h>
46 #include <urcu/tls-compat.h>
48 #include <usterr-signal-safe.h>
50 #include "tracepoint-internal.h"
51 #include "lttng-tracer-core.h"
53 #include "../libringbuffer/tlsfixup.h"
54 #include "lttng-ust-baddr.h"
57 * Has lttng ust comm constructor been called ?
59 static int initialized
;
62 * The ust_lock/ust_unlock lock is used as a communication thread mutex.
63 * Held when handling a command, also held by fork() to deal with
64 * removal of threads, and by exit path.
66 * The UST lock is the centralized mutex across UST tracing control and
69 * ust_exit_mutex must never nest in ust_mutex.
71 * ust_fork_mutex must never nest in ust_mutex.
73 * ust_mutex_nest is a per-thread nesting counter, allowing the perf
74 * counter lazy initialization called by events within the statedump,
75 * which traces while the ust_mutex is held.
77 * ust_lock nests within the dynamic loader lock (within glibc) because
78 * it is taken within the library constructor.
80 static pthread_mutex_t ust_mutex
= PTHREAD_MUTEX_INITIALIZER
;
82 /* Allow nesting the ust_mutex within the same thread. */
83 static DEFINE_URCU_TLS(int, ust_mutex_nest
);
86 * ust_exit_mutex protects thread_active variable wrt thread exit. It
87 * cannot be done by ust_mutex because pthread_cancel(), which takes an
88 * internal libc lock, cannot nest within ust_mutex.
90 * It never nests within a ust_mutex.
92 static pthread_mutex_t ust_exit_mutex
= PTHREAD_MUTEX_INITIALIZER
;
95 * ust_fork_mutex protects base address statedump tracing against forks. It
96 * prevents the dynamic loader lock to be taken (by base address statedump
97 * tracing) while a fork is happening, thus preventing deadlock issues with
98 * the dynamic loader lock.
100 static pthread_mutex_t ust_fork_mutex
= PTHREAD_MUTEX_INITIALIZER
;
102 /* Should the ust comm thread quit ? */
103 static int lttng_ust_comm_should_quit
;
106 * Return 0 on success, -1 if should quit.
107 * The lock is taken in both cases.
112 sigset_t sig_all_blocked
, orig_mask
;
115 sigfillset(&sig_all_blocked
);
116 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_mask
);
118 ERR("pthread_sigmask: %s", strerror(ret
));
120 if (!URCU_TLS(ust_mutex_nest
)++)
121 pthread_mutex_lock(&ust_mutex
);
122 ret
= pthread_sigmask(SIG_SETMASK
, &orig_mask
, NULL
);
124 ERR("pthread_sigmask: %s", strerror(ret
));
126 if (lttng_ust_comm_should_quit
) {
134 * ust_lock_nocheck() can be used in constructors/destructors, because
135 * they are already nested within the dynamic loader lock, and therefore
136 * have exclusive access against execution of liblttng-ust destructor.
139 void ust_lock_nocheck(void)
141 sigset_t sig_all_blocked
, orig_mask
;
144 sigfillset(&sig_all_blocked
);
145 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_mask
);
147 ERR("pthread_sigmask: %s", strerror(ret
));
149 if (!URCU_TLS(ust_mutex_nest
)++)
150 pthread_mutex_lock(&ust_mutex
);
151 ret
= pthread_sigmask(SIG_SETMASK
, &orig_mask
, NULL
);
153 ERR("pthread_sigmask: %s", strerror(ret
));
160 void ust_unlock(void)
162 sigset_t sig_all_blocked
, orig_mask
;
165 sigfillset(&sig_all_blocked
);
166 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_mask
);
168 ERR("pthread_sigmask: %s", strerror(ret
));
170 if (!--URCU_TLS(ust_mutex_nest
))
171 pthread_mutex_unlock(&ust_mutex
);
172 ret
= pthread_sigmask(SIG_SETMASK
, &orig_mask
, NULL
);
174 ERR("pthread_sigmask: %s", strerror(ret
));
179 * Wait for either of these before continuing to the main
181 * - the register_done message from sessiond daemon
182 * (will let the sessiond daemon enable sessions before main
184 * - sessiond daemon is not reachable.
185 * - timeout (ensuring applications are resilient to session
188 static sem_t constructor_wait
;
190 * Doing this for both the global and local sessiond.
192 static int sem_count
= { 2 };
195 * Counting nesting within lttng-ust. Used to ensure that calling fork()
196 * from liblttng-ust does not execute the pre/post fork handlers.
198 static DEFINE_URCU_TLS(int, lttng_ust_nest_count
);
201 * Info about socket and associated listener thread.
205 pthread_t ust_listener
; /* listener thread */
207 int constructor_sem_posted
;
212 char sock_path
[PATH_MAX
];
216 char wait_shm_path
[PATH_MAX
];
218 /* Keep track of lazy state dump not performed yet. */
219 int statedump_pending
;
222 /* Socket from app (connect) to session daemon (listen) for communication */
223 struct sock_info global_apps
= {
231 .sock_path
= LTTNG_DEFAULT_RUNDIR
"/" LTTNG_UST_SOCK_FILENAME
,
235 .wait_shm_path
= "/" LTTNG_UST_WAIT_FILENAME
,
237 .statedump_pending
= 0,
240 /* TODO: allow global_apps_sock_path override */
242 struct sock_info local_apps
= {
246 .allowed
= 0, /* Check setuid bit first */
252 .statedump_pending
= 0,
255 static int wait_poll_fallback
;
257 static const char *cmd_name_mapping
[] = {
258 [ LTTNG_UST_RELEASE
] = "Release",
259 [ LTTNG_UST_SESSION
] = "Create Session",
260 [ LTTNG_UST_TRACER_VERSION
] = "Get Tracer Version",
262 [ LTTNG_UST_TRACEPOINT_LIST
] = "Create Tracepoint List",
263 [ LTTNG_UST_WAIT_QUIESCENT
] = "Wait for Quiescent State",
264 [ LTTNG_UST_REGISTER_DONE
] = "Registration Done",
265 [ LTTNG_UST_TRACEPOINT_FIELD_LIST
] = "Create Tracepoint Field List",
267 /* Session FD commands */
268 [ LTTNG_UST_CHANNEL
] = "Create Channel",
269 [ LTTNG_UST_SESSION_START
] = "Start Session",
270 [ LTTNG_UST_SESSION_STOP
] = "Stop Session",
272 /* Channel FD commands */
273 [ LTTNG_UST_STREAM
] = "Create Stream",
274 [ LTTNG_UST_EVENT
] = "Create Event",
276 /* Event and Channel FD commands */
277 [ LTTNG_UST_CONTEXT
] = "Create Context",
278 [ LTTNG_UST_FLUSH_BUFFER
] = "Flush Buffer",
280 /* Event, Channel and Session commands */
281 [ LTTNG_UST_ENABLE
] = "Enable",
282 [ LTTNG_UST_DISABLE
] = "Disable",
284 /* Tracepoint list commands */
285 [ LTTNG_UST_TRACEPOINT_LIST_GET
] = "List Next Tracepoint",
286 [ LTTNG_UST_TRACEPOINT_FIELD_LIST_GET
] = "List Next Tracepoint Field",
288 /* Event FD commands */
289 [ LTTNG_UST_FILTER
] = "Create Filter",
290 [ LTTNG_UST_EXCLUSION
] = "Add exclusions to event",
293 static const char *str_timeout
;
294 static int got_timeout_env
;
296 extern void lttng_ring_buffer_client_overwrite_init(void);
297 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
298 extern void lttng_ring_buffer_client_discard_init(void);
299 extern void lttng_ring_buffer_client_discard_rt_init(void);
300 extern void lttng_ring_buffer_metadata_client_init(void);
301 extern void lttng_ring_buffer_client_overwrite_exit(void);
302 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
303 extern void lttng_ring_buffer_client_discard_exit(void);
304 extern void lttng_ring_buffer_client_discard_rt_exit(void);
305 extern void lttng_ring_buffer_metadata_client_exit(void);
308 * Returns the HOME directory path. Caller MUST NOT free(3) the returned
312 const char *get_lttng_home_dir(void)
316 val
= (const char *) getenv("LTTNG_HOME");
320 return (const char *) getenv("HOME");
324 * Force a read (imply TLS fixup for dlopen) of TLS variables.
327 void lttng_fixup_nest_count_tls(void)
329 asm volatile ("" : : "m" (URCU_TLS(lttng_ust_nest_count
)));
333 void lttng_fixup_ust_mutex_nest_tls(void)
335 asm volatile ("" : : "m" (URCU_TLS(ust_mutex_nest
)));
342 void lttng_fixup_urcu_bp_tls(void)
348 int lttng_get_notify_socket(void *owner
)
350 struct sock_info
*info
= owner
;
352 return info
->notify_socket
;
356 void print_cmd(int cmd
, int handle
)
358 const char *cmd_name
= "Unknown";
360 if (cmd
>= 0 && cmd
< LTTNG_ARRAY_SIZE(cmd_name_mapping
)
361 && cmd_name_mapping
[cmd
]) {
362 cmd_name
= cmd_name_mapping
[cmd
];
364 DBG("Message Received \"%s\" (%d), Handle \"%s\" (%d)",
366 lttng_ust_obj_get_name(handle
), handle
);
370 int setup_local_apps(void)
372 const char *home_dir
;
377 * Disallow per-user tracing for setuid binaries.
379 if (uid
!= geteuid()) {
380 assert(local_apps
.allowed
== 0);
383 home_dir
= get_lttng_home_dir();
385 WARN("HOME environment variable not set. Disabling LTTng-UST per-user tracing.");
386 assert(local_apps
.allowed
== 0);
389 local_apps
.allowed
= 1;
390 snprintf(local_apps
.sock_path
, PATH_MAX
, "%s/%s/%s",
392 LTTNG_DEFAULT_HOME_RUNDIR
,
393 LTTNG_UST_SOCK_FILENAME
);
394 snprintf(local_apps
.wait_shm_path
, PATH_MAX
, "/%s-%u",
395 LTTNG_UST_WAIT_FILENAME
,
401 * Get notify_sock timeout, in ms.
402 * -1: wait forever. 0: don't wait. >0: timeout, in ms.
405 long get_timeout(void)
407 long constructor_delay_ms
= LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
;
409 if (!got_timeout_env
) {
410 str_timeout
= getenv("LTTNG_UST_REGISTER_TIMEOUT");
414 constructor_delay_ms
= strtol(str_timeout
, NULL
, 10);
415 return constructor_delay_ms
;
419 long get_notify_sock_timeout(void)
421 return get_timeout();
425 * Return values: -1: wait forever. 0: don't wait. 1: timeout wait.
428 int get_constructor_timeout(struct timespec
*constructor_timeout
)
430 long constructor_delay_ms
;
433 constructor_delay_ms
= get_timeout();
435 switch (constructor_delay_ms
) {
436 case -1:/* fall-through */
438 return constructor_delay_ms
;
444 * If we are unable to find the current time, don't wait.
446 ret
= clock_gettime(CLOCK_REALTIME
, constructor_timeout
);
451 constructor_timeout
->tv_sec
+= constructor_delay_ms
/ 1000UL;
452 constructor_timeout
->tv_nsec
+=
453 (constructor_delay_ms
% 1000UL) * 1000000UL;
454 if (constructor_timeout
->tv_nsec
>= 1000000000UL) {
455 constructor_timeout
->tv_sec
++;
456 constructor_timeout
->tv_nsec
-= 1000000000UL;
458 /* Timeout wait (constructor_delay_ms). */
463 int register_to_sessiond(int socket
, enum ustctl_socket_type type
)
465 return ustcomm_send_reg_msg(socket
,
468 lttng_alignof(uint8_t) * CHAR_BIT
,
469 lttng_alignof(uint16_t) * CHAR_BIT
,
470 lttng_alignof(uint32_t) * CHAR_BIT
,
471 lttng_alignof(uint64_t) * CHAR_BIT
,
472 lttng_alignof(unsigned long) * CHAR_BIT
);
476 int send_reply(int sock
, struct ustcomm_ust_reply
*lur
)
480 len
= ustcomm_send_unix_sock(sock
, lur
, sizeof(*lur
));
483 DBG("message successfully sent");
486 if (len
== -ECONNRESET
) {
487 DBG("remote end closed connection");
492 DBG("incorrect message size: %zd", len
);
498 int handle_register_done(struct sock_info
*sock_info
)
502 if (sock_info
->constructor_sem_posted
)
504 sock_info
->constructor_sem_posted
= 1;
505 if (uatomic_read(&sem_count
) <= 0) {
508 ret
= uatomic_add_return(&sem_count
, -1);
510 ret
= sem_post(&constructor_wait
);
517 * Only execute pending statedump after the constructor semaphore has
518 * been posted by each listener thread. This means statedump will only
519 * be performed after the "registration done" command is received from
520 * each session daemon the application is connected to.
522 * This ensures we don't run into deadlock issues with the dynamic
523 * loader mutex, which is held while the constructor is called and
524 * waiting on the constructor semaphore. All operations requiring this
525 * dynamic loader lock need to be postponed using this mechanism.
528 void handle_pending_statedump(struct sock_info
*sock_info
)
530 int ctor_passed
= sock_info
->constructor_sem_posted
;
532 if (ctor_passed
&& sock_info
->statedump_pending
) {
533 sock_info
->statedump_pending
= 0;
534 pthread_mutex_lock(&ust_fork_mutex
);
535 lttng_handle_pending_statedump(sock_info
);
536 pthread_mutex_unlock(&ust_fork_mutex
);
541 int handle_message(struct sock_info
*sock_info
,
542 int sock
, struct ustcomm_ust_msg
*lum
)
545 const struct lttng_ust_objd_ops
*ops
;
546 struct ustcomm_ust_reply lur
;
550 memset(&lur
, 0, sizeof(lur
));
553 ret
= -LTTNG_UST_ERR_EXITING
;
557 ops
= objd_ops(lum
->handle
);
564 case LTTNG_UST_REGISTER_DONE
:
565 if (lum
->handle
== LTTNG_UST_ROOT_HANDLE
)
566 ret
= handle_register_done(sock_info
);
570 case LTTNG_UST_RELEASE
:
571 if (lum
->handle
== LTTNG_UST_ROOT_HANDLE
)
574 ret
= lttng_ust_objd_unref(lum
->handle
, 1);
576 case LTTNG_UST_FILTER
:
578 /* Receive filter data */
579 struct lttng_ust_filter_bytecode_node
*bytecode
;
581 if (lum
->u
.filter
.data_size
> FILTER_BYTECODE_MAX_LEN
) {
582 ERR("Filter data size is too large: %u bytes",
583 lum
->u
.filter
.data_size
);
588 if (lum
->u
.filter
.reloc_offset
> lum
->u
.filter
.data_size
) {
589 ERR("Filter reloc offset %u is not within data",
590 lum
->u
.filter
.reloc_offset
);
595 bytecode
= zmalloc(sizeof(*bytecode
) + lum
->u
.filter
.data_size
);
600 len
= ustcomm_recv_unix_sock(sock
, bytecode
->bc
.data
,
601 lum
->u
.filter
.data_size
);
603 case 0: /* orderly shutdown */
608 if (len
== lum
->u
.filter
.data_size
) {
609 DBG("filter data received");
611 } else if (len
< 0) {
612 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
613 if (len
== -ECONNRESET
) {
614 ERR("%s remote end closed connection", sock_info
->name
);
623 DBG("incorrect filter data message size: %zd", len
);
629 bytecode
->bc
.len
= lum
->u
.filter
.data_size
;
630 bytecode
->bc
.reloc_offset
= lum
->u
.filter
.reloc_offset
;
631 bytecode
->bc
.seqnum
= lum
->u
.filter
.seqnum
;
633 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
634 (unsigned long) bytecode
,
639 /* don't free bytecode if everything went fine. */
646 case LTTNG_UST_EXCLUSION
:
648 /* Receive exclusion names */
649 struct lttng_ust_excluder_node
*node
;
652 count
= lum
->u
.exclusion
.count
;
654 /* There are no names to read */
658 node
= zmalloc(sizeof(*node
) +
659 count
* LTTNG_UST_SYM_NAME_LEN
);
664 node
->excluder
.count
= count
;
665 len
= ustcomm_recv_unix_sock(sock
, node
->excluder
.names
,
666 count
* LTTNG_UST_SYM_NAME_LEN
);
668 case 0: /* orderly shutdown */
673 if (len
== count
* LTTNG_UST_SYM_NAME_LEN
) {
674 DBG("Exclusion data received");
676 } else if (len
< 0) {
677 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
678 if (len
== -ECONNRESET
) {
679 ERR("%s remote end closed connection", sock_info
->name
);
688 DBG("Incorrect exclusion data message size: %zd", len
);
695 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
696 (unsigned long) node
,
701 /* Don't free exclusion data if everything went fine. */
708 case LTTNG_UST_CHANNEL
:
713 len
= ustcomm_recv_channel_from_sessiond(sock
,
714 &chan_data
, lum
->u
.channel
.len
,
717 case 0: /* orderly shutdown */
721 if (len
== lum
->u
.channel
.len
) {
722 DBG("channel data received");
724 } else if (len
< 0) {
725 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
726 if (len
== -ECONNRESET
) {
727 ERR("%s remote end closed connection", sock_info
->name
);
734 DBG("incorrect channel data message size: %zd", len
);
739 args
.channel
.chan_data
= chan_data
;
740 args
.channel
.wakeup_fd
= wakeup_fd
;
742 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
743 (unsigned long) &lum
->u
,
749 case LTTNG_UST_STREAM
:
751 /* Receive shm_fd, wakeup_fd */
752 ret
= ustcomm_recv_stream_from_sessiond(sock
,
755 &args
.stream
.wakeup_fd
);
760 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
761 (unsigned long) &lum
->u
,
769 ret
= ops
->cmd(lum
->handle
, lum
->cmd
,
770 (unsigned long) &lum
->u
,
778 lur
.handle
= lum
->handle
;
782 lur
.ret_code
= LTTNG_UST_OK
;
785 * Use -LTTNG_UST_ERR as wildcard for UST internal
786 * error that are not caused by the transport, except if
787 * we already have a more precise error message to
790 if (ret
> -LTTNG_UST_ERR
) {
791 /* Translate code to UST error. */
794 lur
.ret_code
= -LTTNG_UST_ERR_EXIST
;
797 lur
.ret_code
= -LTTNG_UST_ERR_INVAL
;
800 lur
.ret_code
= -LTTNG_UST_ERR_NOENT
;
803 lur
.ret_code
= -LTTNG_UST_ERR_PERM
;
806 lur
.ret_code
= -LTTNG_UST_ERR_NOSYS
;
809 lur
.ret_code
= -LTTNG_UST_ERR
;
818 case LTTNG_UST_TRACER_VERSION
:
819 lur
.u
.version
= lum
->u
.version
;
821 case LTTNG_UST_TRACEPOINT_LIST_GET
:
822 memcpy(&lur
.u
.tracepoint
, &lum
->u
.tracepoint
, sizeof(lur
.u
.tracepoint
));
826 DBG("Return value: %d", lur
.ret_val
);
827 ret
= send_reply(sock
, &lur
);
829 DBG("error sending reply");
834 * LTTNG_UST_TRACEPOINT_FIELD_LIST_GET needs to send the field
837 if (lur
.ret_code
== LTTNG_UST_OK
) {
839 case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET
:
840 len
= ustcomm_send_unix_sock(sock
,
841 &args
.field_list
.entry
,
842 sizeof(args
.field_list
.entry
));
847 if (len
!= sizeof(args
.field_list
.entry
)) {
858 * Performed delayed statedump operations outside of the UST
859 * lock. We need to take the dynamic loader lock before we take
860 * the UST lock internally within handle_pending_statedump().
862 handle_pending_statedump(sock_info
);
868 void cleanup_sock_info(struct sock_info
*sock_info
, int exiting
)
872 if (sock_info
->root_handle
!= -1) {
873 ret
= lttng_ust_objd_unref(sock_info
->root_handle
, 1);
875 ERR("Error unref root handle");
877 sock_info
->root_handle
= -1;
879 sock_info
->constructor_sem_posted
= 0;
882 * wait_shm_mmap, socket and notify socket are used by listener
883 * threads outside of the ust lock, so we cannot tear them down
884 * ourselves, because we cannot join on these threads. Leave
885 * responsibility of cleaning up these resources to the OS
891 if (sock_info
->socket
!= -1) {
892 ret
= ustcomm_close_unix_sock(sock_info
->socket
);
894 ERR("Error closing ust cmd socket");
896 sock_info
->socket
= -1;
898 if (sock_info
->notify_socket
!= -1) {
899 ret
= ustcomm_close_unix_sock(sock_info
->notify_socket
);
901 ERR("Error closing ust notify socket");
903 sock_info
->notify_socket
= -1;
905 if (sock_info
->wait_shm_mmap
) {
908 page_size
= sysconf(_SC_PAGE_SIZE
);
910 ret
= munmap(sock_info
->wait_shm_mmap
, page_size
);
912 ERR("Error unmapping wait shm");
915 sock_info
->wait_shm_mmap
= NULL
;
920 * Using fork to set umask in the child process (not multi-thread safe).
921 * We deal with the shm_open vs ftruncate race (happening when the
922 * sessiond owns the shm and does not let everybody modify it, to ensure
923 * safety against shm_unlink) by simply letting the mmap fail and
924 * retrying after a few seconds.
925 * For global shm, everybody has rw access to it until the sessiond
929 int get_wait_shm(struct sock_info
*sock_info
, size_t mmap_size
)
931 int wait_shm_fd
, ret
;
935 * Try to open read-only.
937 wait_shm_fd
= shm_open(sock_info
->wait_shm_path
, O_RDONLY
, 0);
938 if (wait_shm_fd
>= 0) {
941 size_t bytes_read
= 0;
944 * Try to read the fd. If unable to do so, try opening
948 len
= read(wait_shm_fd
,
949 &((char *) &tmp_read
)[bytes_read
],
950 sizeof(tmp_read
) - bytes_read
);
954 } while ((len
< 0 && errno
== EINTR
)
955 || (len
> 0 && bytes_read
< sizeof(tmp_read
)));
956 if (bytes_read
!= sizeof(tmp_read
)) {
957 ret
= close(wait_shm_fd
);
959 ERR("close wait_shm_fd");
964 } else if (wait_shm_fd
< 0 && errno
!= ENOENT
) {
966 * Real-only open did not work, and it's not because the
967 * entry was not present. It's a failure that prohibits
970 ERR("Error opening shm %s", sock_info
->wait_shm_path
);
976 * If the open failed because the file did not exist, or because
977 * the file was not truncated yet, try creating it ourself.
979 URCU_TLS(lttng_ust_nest_count
)++;
981 URCU_TLS(lttng_ust_nest_count
)--;
986 * Parent: wait for child to return, in which case the
987 * shared memory map will have been created.
990 if (pid
< 0 || !WIFEXITED(status
) || WEXITSTATUS(status
) != 0) {
995 * Try to open read-only again after creation.
997 wait_shm_fd
= shm_open(sock_info
->wait_shm_path
, O_RDONLY
, 0);
998 if (wait_shm_fd
< 0) {
1000 * Real-only open did not work. It's a failure
1001 * that prohibits using shm.
1003 ERR("Error opening shm %s", sock_info
->wait_shm_path
);
1007 } else if (pid
== 0) {
1011 create_mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
;
1012 if (sock_info
->global
)
1013 create_mode
|= S_IROTH
| S_IWGRP
| S_IWOTH
;
1015 * We're alone in a child process, so we can modify the
1016 * process-wide umask.
1018 umask(~create_mode
);
1020 * Try creating shm (or get rw access).
1021 * We don't do an exclusive open, because we allow other
1022 * processes to create+ftruncate it concurrently.
1024 wait_shm_fd
= shm_open(sock_info
->wait_shm_path
,
1025 O_RDWR
| O_CREAT
, create_mode
);
1026 if (wait_shm_fd
>= 0) {
1027 ret
= ftruncate(wait_shm_fd
, mmap_size
);
1029 PERROR("ftruncate");
1030 _exit(EXIT_FAILURE
);
1032 _exit(EXIT_SUCCESS
);
1035 * For local shm, we need to have rw access to accept
1036 * opening it: this means the local sessiond will be
1037 * able to wake us up. For global shm, we open it even
1038 * if rw access is not granted, because the root.root
1039 * sessiond will be able to override all rights and wake
1042 if (!sock_info
->global
&& errno
!= EACCES
) {
1043 ERR("Error opening shm %s", sock_info
->wait_shm_path
);
1044 _exit(EXIT_FAILURE
);
1047 * The shm exists, but we cannot open it RW. Report
1050 _exit(EXIT_SUCCESS
);
1055 if (wait_shm_fd
>= 0 && !sock_info
->global
) {
1056 struct stat statbuf
;
1059 * Ensure that our user is the owner of the shm file for
1060 * local shm. If we do not own the file, it means our
1061 * sessiond will not have access to wake us up (there is
1062 * probably a rogue process trying to fake our
1063 * sessiond). Fallback to polling method in this case.
1065 ret
= fstat(wait_shm_fd
, &statbuf
);
1070 if (statbuf
.st_uid
!= getuid())
1076 ret
= close(wait_shm_fd
);
1078 PERROR("Error closing fd");
1084 char *get_map_shm(struct sock_info
*sock_info
)
1087 int wait_shm_fd
, ret
;
1088 char *wait_shm_mmap
;
1090 page_size
= sysconf(_SC_PAGE_SIZE
);
1091 if (page_size
< 0) {
1095 wait_shm_fd
= get_wait_shm(sock_info
, page_size
);
1096 if (wait_shm_fd
< 0) {
1099 wait_shm_mmap
= mmap(NULL
, page_size
, PROT_READ
,
1100 MAP_SHARED
, wait_shm_fd
, 0);
1101 /* close shm fd immediately after taking the mmap reference */
1102 ret
= close(wait_shm_fd
);
1104 PERROR("Error closing fd");
1106 if (wait_shm_mmap
== MAP_FAILED
) {
1107 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
1110 return wait_shm_mmap
;
1117 void wait_for_sessiond(struct sock_info
*sock_info
)
1124 if (wait_poll_fallback
) {
1127 if (!sock_info
->wait_shm_mmap
) {
1128 sock_info
->wait_shm_mmap
= get_map_shm(sock_info
);
1129 if (!sock_info
->wait_shm_mmap
)
1134 DBG("Waiting for %s apps sessiond", sock_info
->name
);
1135 /* Wait for futex wakeup */
1136 if (uatomic_read((int32_t *) sock_info
->wait_shm_mmap
) == 0) {
1137 ret
= futex_async((int32_t *) sock_info
->wait_shm_mmap
,
1138 FUTEX_WAIT
, 0, NULL
, NULL
, 0);
1140 if (errno
== EFAULT
) {
1141 wait_poll_fallback
= 1;
1143 "Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
1144 "do not support FUTEX_WAKE on read-only memory mappings correctly. "
1145 "Please upgrade your kernel "
1146 "(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
1147 "mainline). LTTng-UST will use polling mode fallback.");
1165 * This thread does not allocate any resource, except within
1166 * handle_message, within mutex protection. This mutex protects against
1168 * The other moment it allocates resources is at socket connection, which
1169 * is also protected by the mutex.
1172 void *ust_listener_thread(void *arg
)
1174 struct sock_info
*sock_info
= arg
;
1175 int sock
, ret
, prev_connect_failed
= 0, has_waited
= 0;
1178 /* Restart trying to connect to the session daemon */
1180 if (prev_connect_failed
) {
1181 /* Wait for sessiond availability with pipe */
1182 wait_for_sessiond(sock_info
);
1186 * Sleep for 5 seconds before retrying after a
1187 * sequence of failure / wait / failure. This
1188 * deals with a killed or broken session daemon.
1193 prev_connect_failed
= 0;
1196 if (sock_info
->socket
!= -1) {
1197 ret
= ustcomm_close_unix_sock(sock_info
->socket
);
1199 ERR("Error closing %s ust cmd socket",
1202 sock_info
->socket
= -1;
1204 if (sock_info
->notify_socket
!= -1) {
1205 ret
= ustcomm_close_unix_sock(sock_info
->notify_socket
);
1207 ERR("Error closing %s ust notify socket",
1210 sock_info
->notify_socket
= -1;
1214 * Register. We need to perform both connect and sending
1215 * registration message before doing the next connect otherwise
1216 * we may reach unix socket connect queue max limits and block
1217 * on the 2nd connect while the session daemon is awaiting the
1218 * first connect registration message.
1220 /* Connect cmd socket */
1221 ret
= ustcomm_connect_unix_sock(sock_info
->sock_path
);
1223 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info
->name
);
1224 prev_connect_failed
= 1;
1231 * If we cannot find the sessiond daemon, don't delay
1232 * constructor execution.
1234 ret
= handle_register_done(sock_info
);
1239 sock_info
->socket
= ret
;
1246 * Create only one root handle per listener thread for the whole
1247 * process lifetime, so we ensure we get ID which is statically
1248 * assigned to the root handle.
1250 if (sock_info
->root_handle
== -1) {
1251 ret
= lttng_abi_create_root_handle();
1253 ERR("Error creating root handle");
1256 sock_info
->root_handle
= ret
;
1259 ret
= register_to_sessiond(sock_info
->socket
, USTCTL_SOCKET_CMD
);
1261 ERR("Error registering to %s ust cmd socket",
1263 prev_connect_failed
= 1;
1265 * If we cannot register to the sessiond daemon, don't
1266 * delay constructor execution.
1268 ret
= handle_register_done(sock_info
);
1276 /* Connect notify socket */
1277 ret
= ustcomm_connect_unix_sock(sock_info
->sock_path
);
1279 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info
->name
);
1280 prev_connect_failed
= 1;
1287 * If we cannot find the sessiond daemon, don't delay
1288 * constructor execution.
1290 ret
= handle_register_done(sock_info
);
1295 sock_info
->notify_socket
= ret
;
1297 timeout
= get_notify_sock_timeout();
1300 * Give at least 10ms to sessiond to reply to
1305 ret
= ustcomm_setsockopt_rcv_timeout(sock_info
->notify_socket
,
1308 WARN("Error setting socket receive timeout");
1310 ret
= ustcomm_setsockopt_snd_timeout(sock_info
->notify_socket
,
1313 WARN("Error setting socket send timeout");
1315 } else if (timeout
< -1) {
1316 WARN("Unsupported timeout value %ld", timeout
);
1323 ret
= register_to_sessiond(sock_info
->notify_socket
,
1324 USTCTL_SOCKET_NOTIFY
);
1326 ERR("Error registering to %s ust notify socket",
1328 prev_connect_failed
= 1;
1330 * If we cannot register to the sessiond daemon, don't
1331 * delay constructor execution.
1333 ret
= handle_register_done(sock_info
);
1338 sock
= sock_info
->socket
;
1344 struct ustcomm_ust_msg lum
;
1346 len
= ustcomm_recv_unix_sock(sock
, &lum
, sizeof(lum
));
1348 case 0: /* orderly shutdown */
1349 DBG("%s lttng-sessiond has performed an orderly shutdown", sock_info
->name
);
1354 * Either sessiond has shutdown or refused us by closing the socket.
1355 * In either case, we don't want to delay construction execution,
1356 * and we need to wait before retry.
1358 prev_connect_failed
= 1;
1360 * If we cannot register to the sessiond daemon, don't
1361 * delay constructor execution.
1363 ret
= handle_register_done(sock_info
);
1368 print_cmd(lum
.cmd
, lum
.handle
);
1369 ret
= handle_message(sock_info
, sock
, &lum
);
1371 ERR("Error handling message for %s socket", sock_info
->name
);
1376 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len
);
1378 DBG("incorrect message size (%s socket): %zd", sock_info
->name
, len
);
1380 if (len
== -ECONNRESET
) {
1381 DBG("%s remote end closed connection", sock_info
->name
);
1392 /* Cleanup socket handles before trying to reconnect */
1393 lttng_ust_objd_table_owner_cleanup(sock_info
);
1395 goto restart
; /* try to reconnect */
1400 pthread_mutex_lock(&ust_exit_mutex
);
1401 sock_info
->thread_active
= 0;
1402 pthread_mutex_unlock(&ust_exit_mutex
);
1407 * Weak symbol to call when the ust malloc wrapper is not loaded.
1409 __attribute__((weak
))
1410 void lttng_ust_malloc_wrapper_init(void)
1415 * sessiond monitoring thread: monitor presence of global and per-user
1416 * sessiond by polling the application common named pipe.
1418 void __attribute__((constructor
)) lttng_ust_init(void)
1420 struct timespec constructor_timeout
;
1421 sigset_t sig_all_blocked
, orig_parent_mask
;
1422 pthread_attr_t thread_attr
;
1426 if (uatomic_xchg(&initialized
, 1) == 1)
1430 * Fixup interdependency between TLS fixup mutex (which happens
1431 * to be the dynamic linker mutex) and ust_lock, taken within
1434 lttng_fixup_urcu_bp_tls();
1435 lttng_fixup_ringbuffer_tls();
1436 lttng_fixup_vtid_tls();
1437 lttng_fixup_nest_count_tls();
1438 lttng_fixup_procname_tls();
1439 lttng_fixup_ust_mutex_nest_tls();
1442 * We want precise control over the order in which we construct
1443 * our sub-libraries vs starting to receive commands from
1444 * sessiond (otherwise leading to errors when trying to create
1445 * sessiond before the init functions are completed).
1449 lttng_ust_baddr_statedump_init();
1450 lttng_ring_buffer_metadata_client_init();
1451 lttng_ring_buffer_client_overwrite_init();
1452 lttng_ring_buffer_client_overwrite_rt_init();
1453 lttng_ring_buffer_client_discard_init();
1454 lttng_ring_buffer_client_discard_rt_init();
1455 lttng_perf_counter_init();
1456 lttng_context_init();
1458 * Invoke ust malloc wrapper init before starting other threads.
1460 lttng_ust_malloc_wrapper_init();
1462 timeout_mode
= get_constructor_timeout(&constructor_timeout
);
1464 ret
= sem_init(&constructor_wait
, 0, 0);
1467 ret
= setup_local_apps();
1469 DBG("local apps setup returned %d", ret
);
1472 /* A new thread created by pthread_create inherits the signal mask
1473 * from the parent. To avoid any signal being received by the
1474 * listener thread, we block all signals temporarily in the parent,
1475 * while we create the listener thread.
1477 sigfillset(&sig_all_blocked
);
1478 ret
= pthread_sigmask(SIG_SETMASK
, &sig_all_blocked
, &orig_parent_mask
);
1480 ERR("pthread_sigmask: %s", strerror(ret
));
1483 ret
= pthread_attr_init(&thread_attr
);
1485 ERR("pthread_attr_init: %s", strerror(ret
));
1487 ret
= pthread_attr_setdetachstate(&thread_attr
, PTHREAD_CREATE_DETACHED
);
1489 ERR("pthread_attr_setdetachstate: %s", strerror(ret
));
1492 pthread_mutex_lock(&ust_exit_mutex
);
1493 ret
= pthread_create(&global_apps
.ust_listener
, &thread_attr
,
1494 ust_listener_thread
, &global_apps
);
1496 ERR("pthread_create global: %s", strerror(ret
));
1498 global_apps
.thread_active
= 1;
1499 pthread_mutex_unlock(&ust_exit_mutex
);
1501 if (local_apps
.allowed
) {
1502 pthread_mutex_lock(&ust_exit_mutex
);
1503 ret
= pthread_create(&local_apps
.ust_listener
, &thread_attr
,
1504 ust_listener_thread
, &local_apps
);
1506 ERR("pthread_create local: %s", strerror(ret
));
1508 local_apps
.thread_active
= 1;
1509 pthread_mutex_unlock(&ust_exit_mutex
);
1511 handle_register_done(&local_apps
);
1513 ret
= pthread_attr_destroy(&thread_attr
);
1515 ERR("pthread_attr_destroy: %s", strerror(ret
));
1518 /* Restore original signal mask in parent */
1519 ret
= pthread_sigmask(SIG_SETMASK
, &orig_parent_mask
, NULL
);
1521 ERR("pthread_sigmask: %s", strerror(ret
));
1524 switch (timeout_mode
) {
1525 case 1: /* timeout wait */
1527 ret
= sem_timedwait(&constructor_wait
,
1528 &constructor_timeout
);
1529 } while (ret
< 0 && errno
== EINTR
);
1530 if (ret
< 0 && errno
== ETIMEDOUT
) {
1531 ERR("Timed out waiting for lttng-sessiond");
1536 case -1:/* wait forever */
1538 ret
= sem_wait(&constructor_wait
);
1539 } while (ret
< 0 && errno
== EINTR
);
1542 case 0: /* no timeout */
1548 void lttng_ust_cleanup(int exiting
)
1550 cleanup_sock_info(&global_apps
, exiting
);
1551 if (local_apps
.allowed
) {
1552 cleanup_sock_info(&local_apps
, exiting
);
1555 * The teardown in this function all affect data structures
1556 * accessed under the UST lock by the listener thread. This
1557 * lock, along with the lttng_ust_comm_should_quit flag, ensure
1558 * that none of these threads are accessing this data at this
1561 lttng_ust_abi_exit();
1562 lttng_ust_events_exit();
1563 lttng_context_exit();
1564 lttng_perf_counter_exit();
1565 lttng_ring_buffer_client_discard_rt_exit();
1566 lttng_ring_buffer_client_discard_exit();
1567 lttng_ring_buffer_client_overwrite_rt_exit();
1568 lttng_ring_buffer_client_overwrite_exit();
1569 lttng_ring_buffer_metadata_client_exit();
1570 lttng_ust_baddr_statedump_destroy();
1573 /* Reinitialize values for fork */
1575 lttng_ust_comm_should_quit
= 0;
1580 void __attribute__((destructor
)) lttng_ust_exit(void)
1585 * Using pthread_cancel here because:
1586 * A) we don't want to hang application teardown.
1587 * B) the thread is not allocating any resource.
1591 * Require the communication thread to quit. Synchronize with
1592 * mutexes to ensure it is not in a mutex critical section when
1593 * pthread_cancel is later called.
1596 lttng_ust_comm_should_quit
= 1;
1599 pthread_mutex_lock(&ust_exit_mutex
);
1600 /* cancel threads */
1601 if (global_apps
.thread_active
) {
1602 ret
= pthread_cancel(global_apps
.ust_listener
);
1604 ERR("Error cancelling global ust listener thread: %s",
1607 global_apps
.thread_active
= 0;
1610 if (local_apps
.thread_active
) {
1611 ret
= pthread_cancel(local_apps
.ust_listener
);
1613 ERR("Error cancelling local ust listener thread: %s",
1616 local_apps
.thread_active
= 0;
1619 pthread_mutex_unlock(&ust_exit_mutex
);
1622 * Do NOT join threads: use of sys_futex makes it impossible to
1623 * join the threads without using async-cancel, but async-cancel
1624 * is delivered by a signal, which could hit the target thread
1625 * anywhere in its code path, including while the ust_lock() is
1626 * held, causing a deadlock for the other thread. Let the OS
1627 * cleanup the threads if there are stalled in a syscall.
1629 lttng_ust_cleanup(1);
1633 * We exclude the worker threads across fork and clone (except
1634 * CLONE_VM), because these system calls only keep the forking thread
1635 * running in the child. Therefore, we don't want to call fork or clone
1636 * in the middle of an tracepoint or ust tracing state modification.
1637 * Holding this mutex protects these structures across fork and clone.
1639 void ust_before_fork(sigset_t
*save_sigset
)
1642 * Disable signals. This is to avoid that the child intervenes
1643 * before it is properly setup for tracing. It is safer to
1644 * disable all signals, because then we know we are not breaking
1645 * anything by restoring the original mask.
1650 if (URCU_TLS(lttng_ust_nest_count
))
1652 /* Disable signals */
1653 sigfillset(&all_sigs
);
1654 ret
= sigprocmask(SIG_BLOCK
, &all_sigs
, save_sigset
);
1656 PERROR("sigprocmask");
1659 pthread_mutex_lock(&ust_fork_mutex
);
1662 rcu_bp_before_fork();
1665 static void ust_after_fork_common(sigset_t
*restore_sigset
)
1669 DBG("process %d", getpid());
1672 pthread_mutex_unlock(&ust_fork_mutex
);
1674 /* Restore signals */
1675 ret
= sigprocmask(SIG_SETMASK
, restore_sigset
, NULL
);
1677 PERROR("sigprocmask");
1681 void ust_after_fork_parent(sigset_t
*restore_sigset
)
1683 if (URCU_TLS(lttng_ust_nest_count
))
1685 DBG("process %d", getpid());
1686 rcu_bp_after_fork_parent();
1687 /* Release mutexes and reenable signals */
1688 ust_after_fork_common(restore_sigset
);
1692 * After fork, in the child, we need to cleanup all the leftover state,
1693 * except the worker thread which already magically disappeared thanks
1694 * to the weird Linux fork semantics. After tyding up, we call
1695 * lttng_ust_init() again to start over as a new PID.
1697 * This is meant for forks() that have tracing in the child between the
1698 * fork and following exec call (if there is any).
1700 void ust_after_fork_child(sigset_t
*restore_sigset
)
1702 if (URCU_TLS(lttng_ust_nest_count
))
1704 DBG("process %d", getpid());
1705 /* Release urcu mutexes */
1706 rcu_bp_after_fork_child();
1707 lttng_ust_cleanup(0);
1708 lttng_context_vtid_reset();
1709 /* Release mutexes and reenable signals */
1710 ust_after_fork_common(restore_sigset
);
1714 void lttng_ust_sockinfo_session_enabled(void *owner
)
1716 struct sock_info
*sock_info
= owner
;
1717 sock_info
->statedump_pending
= 1;