2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
33 #include <sys/mount.h>
34 #include <sys/resource.h>
35 #include <sys/socket.h>
37 #include <sys/types.h>
39 #include <urcu/uatomic.h>
43 #include <common/common.h>
44 #include <common/compat/socket.h>
45 #include <common/compat/getenv.h>
46 #include <common/defaults.h>
47 #include <common/kernel-consumer/kernel-consumer.h>
48 #include <common/futex.h>
49 #include <common/relayd/relayd.h>
50 #include <common/utils.h>
51 #include <common/daemonize.h>
52 #include <common/config/config.h>
54 #include "lttng-sessiond.h"
55 #include "buffer-registry.h"
62 #include "kernel-consumer.h"
66 #include "ust-consumer.h"
69 #include "health-sessiond.h"
70 #include "testpoint.h"
71 #include "ust-thread.h"
72 #include "agent-thread.h"
74 #include "load-session-thread.h"
78 #define CONSUMERD_FILE "lttng-consumerd"
81 static const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
82 static int tracing_group_name_override
;
83 static char *opt_pidfile
;
84 static int opt_sig_parent
;
85 static int opt_verbose_consumer
;
86 static int opt_daemon
, opt_background
;
87 static int opt_no_kernel
;
88 static char *opt_load_session_path
;
89 static pid_t ppid
; /* Parent PID for --sig-parent option */
90 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
92 static int lockfile_fd
= -1;
94 /* Set to 1 when a SIGUSR1 signal is received. */
95 static int recv_child_signal
;
98 * Consumer daemon specific control data. Every value not initialized here is
99 * set to 0 by the static definition.
101 static struct consumer_data kconsumer_data
= {
102 .type
= LTTNG_CONSUMER_KERNEL
,
103 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
104 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
107 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
108 .lock
= PTHREAD_MUTEX_INITIALIZER
,
109 .cond
= PTHREAD_COND_INITIALIZER
,
110 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
112 static struct consumer_data ustconsumer64_data
= {
113 .type
= LTTNG_CONSUMER64_UST
,
114 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
115 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
118 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
119 .lock
= PTHREAD_MUTEX_INITIALIZER
,
120 .cond
= PTHREAD_COND_INITIALIZER
,
121 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
123 static struct consumer_data ustconsumer32_data
= {
124 .type
= LTTNG_CONSUMER32_UST
,
125 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
126 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
129 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
130 .lock
= PTHREAD_MUTEX_INITIALIZER
,
131 .cond
= PTHREAD_COND_INITIALIZER
,
132 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
135 /* Command line options */
136 static const struct option long_options
[] = {
137 { "client-sock", required_argument
, 0, 'c' },
138 { "apps-sock", required_argument
, 0, 'a' },
139 { "kconsumerd-cmd-sock", required_argument
, 0, '\0' },
140 { "kconsumerd-err-sock", required_argument
, 0, '\0' },
141 { "ustconsumerd32-cmd-sock", required_argument
, 0, '\0' },
142 { "ustconsumerd32-err-sock", required_argument
, 0, '\0' },
143 { "ustconsumerd64-cmd-sock", required_argument
, 0, '\0' },
144 { "ustconsumerd64-err-sock", required_argument
, 0, '\0' },
145 { "consumerd32-path", required_argument
, 0, '\0' },
146 { "consumerd32-libdir", required_argument
, 0, '\0' },
147 { "consumerd64-path", required_argument
, 0, '\0' },
148 { "consumerd64-libdir", required_argument
, 0, '\0' },
149 { "daemonize", no_argument
, 0, 'd' },
150 { "background", no_argument
, 0, 'b' },
151 { "sig-parent", no_argument
, 0, 'S' },
152 { "help", no_argument
, 0, 'h' },
153 { "group", required_argument
, 0, 'g' },
154 { "version", no_argument
, 0, 'V' },
155 { "quiet", no_argument
, 0, 'q' },
156 { "verbose", no_argument
, 0, 'v' },
157 { "verbose-consumer", no_argument
, 0, '\0' },
158 { "no-kernel", no_argument
, 0, '\0' },
159 { "pidfile", required_argument
, 0, 'p' },
160 { "agent-tcp-port", required_argument
, 0, '\0' },
161 { "config", required_argument
, 0, 'f' },
162 { "load", required_argument
, 0, 'l' },
163 { "kmod-probes", required_argument
, 0, '\0' },
164 { "extra-kmod-probes", required_argument
, 0, '\0' },
168 /* Command line options to ignore from configuration file */
169 static const char *config_ignore_options
[] = { "help", "version", "config" };
171 /* Shared between threads */
172 static int dispatch_thread_exit
;
174 /* Global application Unix socket path */
175 static char apps_unix_sock_path
[PATH_MAX
];
176 /* Global client Unix socket path */
177 static char client_unix_sock_path
[PATH_MAX
];
178 /* global wait shm path for UST */
179 static char wait_shm_path
[PATH_MAX
];
180 /* Global health check unix path */
181 static char health_unix_sock_path
[PATH_MAX
];
183 /* Sockets and FDs */
184 static int client_sock
= -1;
185 static int apps_sock
= -1;
186 int kernel_tracer_fd
= -1;
187 static int kernel_poll_pipe
[2] = { -1, -1 };
190 * Quit pipe for all threads. This permits a single cancellation point
191 * for all threads when receiving an event on the pipe.
193 static int thread_quit_pipe
[2] = { -1, -1 };
194 static int ht_cleanup_quit_pipe
[2] = { -1, -1 };
197 * This pipe is used to inform the thread managing application communication
198 * that a command is queued and ready to be processed.
200 static int apps_cmd_pipe
[2] = { -1, -1 };
202 int apps_cmd_notify_pipe
[2] = { -1, -1 };
204 /* Pthread, Mutexes and Semaphores */
205 static pthread_t apps_thread
;
206 static pthread_t apps_notify_thread
;
207 static pthread_t reg_apps_thread
;
208 static pthread_t client_thread
;
209 static pthread_t kernel_thread
;
210 static pthread_t dispatch_thread
;
211 static pthread_t health_thread
;
212 static pthread_t ht_cleanup_thread
;
213 static pthread_t agent_reg_thread
;
214 static pthread_t load_session_thread
;
217 * UST registration command queue. This queue is tied with a futex and uses a N
218 * wakers / 1 waiter implemented and detailed in futex.c/.h
220 * The thread_registration_apps and thread_dispatch_ust_registration uses this
221 * queue along with the wait/wake scheme. The thread_manage_apps receives down
222 * the line new application socket and monitors it for any I/O error or clean
223 * close that triggers an unregistration of the application.
225 static struct ust_cmd_queue ust_cmd_queue
;
228 * Pointer initialized before thread creation.
230 * This points to the tracing session list containing the session count and a
231 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
232 * MUST NOT be taken if you call a public function in session.c.
234 * The lock is nested inside the structure: session_list_ptr->lock. Please use
235 * session_lock_list and session_unlock_list for lock acquisition.
237 static struct ltt_session_list
*session_list_ptr
;
239 int ust_consumerd64_fd
= -1;
240 int ust_consumerd32_fd
= -1;
242 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
243 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
244 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
245 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
246 static int consumerd32_bin_override
;
247 static int consumerd64_bin_override
;
248 static int consumerd32_libdir_override
;
249 static int consumerd64_libdir_override
;
251 static const char *module_proc_lttng
= "/proc/lttng";
254 * Consumer daemon state which is changed when spawning it, killing it or in
255 * case of a fatal error.
257 enum consumerd_state
{
258 CONSUMER_STARTED
= 1,
259 CONSUMER_STOPPED
= 2,
264 * This consumer daemon state is used to validate if a client command will be
265 * able to reach the consumer. If not, the client is informed. For instance,
266 * doing a "lttng start" when the consumer state is set to ERROR will return an
267 * error to the client.
269 * The following example shows a possible race condition of this scheme:
271 * consumer thread error happens
273 * client cmd checks state -> still OK
274 * consumer thread exit, sets error
275 * client cmd try to talk to consumer
278 * However, since the consumer is a different daemon, we have no way of making
279 * sure the command will reach it safely even with this state flag. This is why
280 * we consider that up to the state validation during command processing, the
281 * command is safe. After that, we can not guarantee the correctness of the
282 * client request vis-a-vis the consumer.
284 static enum consumerd_state ust_consumerd_state
;
285 static enum consumerd_state kernel_consumerd_state
;
288 * Socket timeout for receiving and sending in seconds.
290 static int app_socket_timeout
;
292 /* Set in main() with the current page size. */
295 /* Application health monitoring */
296 struct health_app
*health_sessiond
;
298 /* Agent TCP port for registration. Used by the agent thread. */
299 unsigned int agent_tcp_port
= DEFAULT_AGENT_TCP_PORT
;
301 /* Am I root or not. */
302 int is_root
; /* Set to 1 if the daemon is running as root */
304 const char * const config_section_name
= "sessiond";
306 /* Load session thread information to operate. */
307 struct load_session_thread_data
*load_info
;
309 /* Global hash tables */
310 struct lttng_ht
*agent_apps_ht_by_sock
= NULL
;
313 * Whether sessiond is ready for commands/health check requests.
314 * NR_LTTNG_SESSIOND_READY must match the number of calls to
315 * sessiond_notify_ready().
317 #define NR_LTTNG_SESSIOND_READY 3
318 int lttng_sessiond_ready
= NR_LTTNG_SESSIOND_READY
;
320 /* Notify parents that we are ready for cmd and health check */
322 void sessiond_notify_ready(void)
324 if (uatomic_sub_return(<tng_sessiond_ready
, 1) == 0) {
326 * Notify parent pid that we are ready to accept command
327 * for client side. This ppid is the one from the
328 * external process that spawned us.
330 if (opt_sig_parent
) {
335 * Notify the parent of the fork() process that we are
338 if (opt_daemon
|| opt_background
) {
339 kill(child_ppid
, SIGUSR1
);
345 void setup_consumerd_path(void)
347 const char *bin
, *libdir
;
350 * Allow INSTALL_BIN_PATH to be used as a target path for the
351 * native architecture size consumer if CONFIG_CONSUMER*_PATH
352 * has not been defined.
354 #if (CAA_BITS_PER_LONG == 32)
355 if (!consumerd32_bin
[0]) {
356 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
358 if (!consumerd32_libdir
[0]) {
359 consumerd32_libdir
= INSTALL_LIB_PATH
;
361 #elif (CAA_BITS_PER_LONG == 64)
362 if (!consumerd64_bin
[0]) {
363 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
365 if (!consumerd64_libdir
[0]) {
366 consumerd64_libdir
= INSTALL_LIB_PATH
;
369 #error "Unknown bitness"
373 * runtime env. var. overrides the build default.
375 bin
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
377 consumerd32_bin
= bin
;
379 bin
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
381 consumerd64_bin
= bin
;
383 libdir
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
385 consumerd32_libdir
= libdir
;
387 libdir
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
389 consumerd64_libdir
= libdir
;
394 int __sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
,
401 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
407 ret
= lttng_poll_add(events
, a_pipe
[0], LPOLLIN
| LPOLLERR
);
419 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
421 int sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
)
423 return __sessiond_set_thread_pollset(events
, size
, thread_quit_pipe
);
427 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
429 int sessiond_set_ht_cleanup_thread_pollset(struct lttng_poll_event
*events
,
432 return __sessiond_set_thread_pollset(events
, size
,
433 ht_cleanup_quit_pipe
);
437 int __sessiond_check_thread_quit_pipe(int fd
, uint32_t events
, int a_pipe
)
439 if (fd
== a_pipe
&& (events
& LPOLLIN
)) {
446 * Check if the thread quit pipe was triggered.
448 * Return 1 if it was triggered else 0;
450 int sessiond_check_thread_quit_pipe(int fd
, uint32_t events
)
452 return __sessiond_check_thread_quit_pipe(fd
, events
,
453 thread_quit_pipe
[0]);
457 * Check if the ht_cleanup thread quit pipe was triggered.
459 * Return 1 if it was triggered else 0;
461 int sessiond_check_ht_cleanup_quit(int fd
, uint32_t events
)
463 return __sessiond_check_thread_quit_pipe(fd
, events
,
464 ht_cleanup_quit_pipe
[0]);
468 * Init thread quit pipe.
470 * Return -1 on error or 0 if all pipes are created.
472 static int __init_thread_quit_pipe(int *a_pipe
)
478 PERROR("thread quit pipe");
482 for (i
= 0; i
< 2; i
++) {
483 ret
= fcntl(a_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
494 static int init_thread_quit_pipe(void)
496 return __init_thread_quit_pipe(thread_quit_pipe
);
499 static int init_ht_cleanup_quit_pipe(void)
501 return __init_thread_quit_pipe(ht_cleanup_quit_pipe
);
505 * Stop all threads by closing the thread quit pipe.
507 static void stop_threads(void)
511 /* Stopping all threads */
512 DBG("Terminating all threads");
513 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
515 ERR("write error on thread quit pipe");
518 /* Dispatch thread */
519 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
520 futex_nto1_wake(&ust_cmd_queue
.futex
);
524 * Close every consumer sockets.
526 static void close_consumer_sockets(void)
530 if (kconsumer_data
.err_sock
>= 0) {
531 ret
= close(kconsumer_data
.err_sock
);
533 PERROR("kernel consumer err_sock close");
536 if (ustconsumer32_data
.err_sock
>= 0) {
537 ret
= close(ustconsumer32_data
.err_sock
);
539 PERROR("UST consumerd32 err_sock close");
542 if (ustconsumer64_data
.err_sock
>= 0) {
543 ret
= close(ustconsumer64_data
.err_sock
);
545 PERROR("UST consumerd64 err_sock close");
548 if (kconsumer_data
.cmd_sock
>= 0) {
549 ret
= close(kconsumer_data
.cmd_sock
);
551 PERROR("kernel consumer cmd_sock close");
554 if (ustconsumer32_data
.cmd_sock
>= 0) {
555 ret
= close(ustconsumer32_data
.cmd_sock
);
557 PERROR("UST consumerd32 cmd_sock close");
560 if (ustconsumer64_data
.cmd_sock
>= 0) {
561 ret
= close(ustconsumer64_data
.cmd_sock
);
563 PERROR("UST consumerd64 cmd_sock close");
569 * Generate the full lock file path using the rundir.
571 * Return the snprintf() return value thus a negative value is an error.
573 static int generate_lock_file_path(char *path
, size_t len
)
580 /* Build lockfile path from rundir. */
581 ret
= snprintf(path
, len
, "%s/" DEFAULT_LTTNG_SESSIOND_LOCKFILE
, rundir
);
583 PERROR("snprintf lockfile path");
590 * Cleanup the session daemon's data structures.
592 static void sessiond_cleanup(void)
595 struct ltt_session
*sess
, *stmp
;
598 DBG("Cleanup sessiond");
601 * Close the thread quit pipe. It has already done its job,
602 * since we are now called.
604 utils_close_pipe(thread_quit_pipe
);
607 * If opt_pidfile is undefined, the default file will be wiped when
608 * removing the rundir.
611 ret
= remove(opt_pidfile
);
613 PERROR("remove pidfile %s", opt_pidfile
);
617 DBG("Removing sessiond and consumerd content of directory %s", rundir
);
620 snprintf(path
, PATH_MAX
,
622 rundir
, DEFAULT_LTTNG_SESSIOND_PIDFILE
);
623 DBG("Removing %s", path
);
626 snprintf(path
, PATH_MAX
, "%s/%s", rundir
,
627 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
628 DBG("Removing %s", path
);
632 snprintf(path
, PATH_MAX
,
633 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
635 DBG("Removing %s", path
);
638 snprintf(path
, PATH_MAX
,
639 DEFAULT_KCONSUMERD_PATH
,
641 DBG("Removing directory %s", path
);
644 /* ust consumerd 32 */
645 snprintf(path
, PATH_MAX
,
646 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
648 DBG("Removing %s", path
);
651 snprintf(path
, PATH_MAX
,
652 DEFAULT_USTCONSUMERD32_PATH
,
654 DBG("Removing directory %s", path
);
657 /* ust consumerd 64 */
658 snprintf(path
, PATH_MAX
,
659 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
661 DBG("Removing %s", path
);
664 snprintf(path
, PATH_MAX
,
665 DEFAULT_USTCONSUMERD64_PATH
,
667 DBG("Removing directory %s", path
);
670 DBG("Cleaning up all sessions");
672 /* Destroy session list mutex */
673 if (session_list_ptr
!= NULL
) {
674 pthread_mutex_destroy(&session_list_ptr
->lock
);
676 /* Cleanup ALL session */
677 cds_list_for_each_entry_safe(sess
, stmp
,
678 &session_list_ptr
->head
, list
) {
679 cmd_destroy_session(sess
, kernel_poll_pipe
[1]);
683 DBG("Cleaning up all agent apps");
684 agent_app_ht_clean();
686 DBG("Closing all UST sockets");
687 ust_app_clean_list();
688 buffer_reg_destroy_registries();
690 if (is_root
&& !opt_no_kernel
) {
691 DBG2("Closing kernel fd");
692 if (kernel_tracer_fd
>= 0) {
693 ret
= close(kernel_tracer_fd
);
698 DBG("Unloading kernel modules");
699 modprobe_remove_lttng_all();
703 close_consumer_sockets();
706 load_session_destroy_data(load_info
);
711 * Cleanup lock file by deleting it and finaly closing it which will
712 * release the file system lock.
714 if (lockfile_fd
>= 0) {
715 char lockfile_path
[PATH_MAX
];
717 ret
= generate_lock_file_path(lockfile_path
,
718 sizeof(lockfile_path
));
720 ret
= remove(lockfile_path
);
722 PERROR("remove lock file");
724 ret
= close(lockfile_fd
);
726 PERROR("close lock file");
732 * We do NOT rmdir rundir because there are other processes
733 * using it, for instance lttng-relayd, which can start in
734 * parallel with this teardown.
741 * Cleanup the daemon's option data structures.
743 static void sessiond_cleanup_options(void)
745 DBG("Cleaning up options");
748 * If the override option is set, the pointer points to a *non* const
749 * thus freeing it even though the variable type is set to const.
751 if (tracing_group_name_override
) {
752 free((void *) tracing_group_name
);
754 if (consumerd32_bin_override
) {
755 free((void *) consumerd32_bin
);
757 if (consumerd64_bin_override
) {
758 free((void *) consumerd64_bin
);
760 if (consumerd32_libdir_override
) {
761 free((void *) consumerd32_libdir
);
763 if (consumerd64_libdir_override
) {
764 free((void *) consumerd64_libdir
);
768 free(opt_load_session_path
);
769 free(kmod_probes_list
);
770 free(kmod_extra_probes_list
);
773 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
774 "Matthew, BEET driven development works!%c[%dm",
775 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
780 * Send data on a unix socket using the liblttsessiondcomm API.
782 * Return lttcomm error code.
784 static int send_unix_sock(int sock
, void *buf
, size_t len
)
786 /* Check valid length */
791 return lttcomm_send_unix_sock(sock
, buf
, len
);
795 * Free memory of a command context structure.
797 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
799 DBG("Clean command context structure");
801 if ((*cmd_ctx
)->llm
) {
802 free((*cmd_ctx
)->llm
);
804 if ((*cmd_ctx
)->lsm
) {
805 free((*cmd_ctx
)->lsm
);
813 * Notify UST applications using the shm mmap futex.
815 static int notify_ust_apps(int active
)
819 DBG("Notifying applications of session daemon state: %d", active
);
821 /* See shm.c for this call implying mmap, shm and futex calls */
822 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
823 if (wait_shm_mmap
== NULL
) {
827 /* Wake waiting process */
828 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
830 /* Apps notified successfully */
838 * Setup the outgoing data buffer for the response (llm) by allocating the
839 * right amount of memory and copying the original information from the lsm
842 * Return total size of the buffer pointed by buf.
844 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
850 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
851 if (cmd_ctx
->llm
== NULL
) {
857 /* Copy common data */
858 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
859 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
861 cmd_ctx
->llm
->data_size
= size
;
862 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
871 * Update the kernel poll set of all channel fd available over all tracing
872 * session. Add the wakeup pipe at the end of the set.
874 static int update_kernel_poll(struct lttng_poll_event
*events
)
877 struct ltt_session
*session
;
878 struct ltt_kernel_channel
*channel
;
880 DBG("Updating kernel poll set");
883 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
884 session_lock(session
);
885 if (session
->kernel_session
== NULL
) {
886 session_unlock(session
);
890 cds_list_for_each_entry(channel
,
891 &session
->kernel_session
->channel_list
.head
, list
) {
892 /* Add channel fd to the kernel poll set */
893 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
895 session_unlock(session
);
898 DBG("Channel fd %d added to kernel set", channel
->fd
);
900 session_unlock(session
);
902 session_unlock_list();
907 session_unlock_list();
912 * Find the channel fd from 'fd' over all tracing session. When found, check
913 * for new channel stream and send those stream fds to the kernel consumer.
915 * Useful for CPU hotplug feature.
917 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
920 struct ltt_session
*session
;
921 struct ltt_kernel_session
*ksess
;
922 struct ltt_kernel_channel
*channel
;
924 DBG("Updating kernel streams for channel fd %d", fd
);
927 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
928 session_lock(session
);
929 if (session
->kernel_session
== NULL
) {
930 session_unlock(session
);
933 ksess
= session
->kernel_session
;
935 cds_list_for_each_entry(channel
,
936 &ksess
->channel_list
.head
, list
) {
937 struct lttng_ht_iter iter
;
938 struct consumer_socket
*socket
;
940 if (channel
->fd
!= fd
) {
943 DBG("Channel found, updating kernel streams");
944 ret
= kernel_open_channel_stream(channel
);
948 /* Update the stream global counter */
949 ksess
->stream_count_global
+= ret
;
952 * Have we already sent fds to the consumer? If yes, it
953 * means that tracing is started so it is safe to send
954 * our updated stream fds.
956 if (ksess
->consumer_fds_sent
!= 1
957 || ksess
->consumer
== NULL
) {
963 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
964 &iter
.iter
, socket
, node
.node
) {
965 pthread_mutex_lock(socket
->lock
);
966 ret
= kernel_consumer_send_channel_stream(socket
,
968 session
->output_traces
? 1 : 0);
969 pthread_mutex_unlock(socket
->lock
);
977 session_unlock(session
);
979 session_unlock_list();
983 session_unlock(session
);
984 session_unlock_list();
989 * For each tracing session, update newly registered apps. The session list
990 * lock MUST be acquired before calling this.
992 static void update_ust_app(int app_sock
)
994 struct ltt_session
*sess
, *stmp
;
996 /* Consumer is in an ERROR state. Stop any application update. */
997 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
998 /* Stop the update process since the consumer is dead. */
1002 /* For all tracing session(s) */
1003 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
1004 struct ust_app
*app
;
1007 if (!sess
->ust_session
) {
1008 goto unlock_session
;
1012 assert(app_sock
>= 0);
1013 app
= ust_app_find_by_sock(app_sock
);
1016 * Application can be unregistered before so
1017 * this is possible hence simply stopping the
1020 DBG3("UST app update failed to find app sock %d",
1024 ust_app_global_update(sess
->ust_session
, app
);
1028 session_unlock(sess
);
1033 * This thread manage event coming from the kernel.
1035 * Features supported in this thread:
1038 static void *thread_manage_kernel(void *data
)
1040 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
1041 uint32_t revents
, nb_fd
;
1043 struct lttng_poll_event events
;
1045 DBG("[thread] Thread manage kernel started");
1047 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_KERNEL
);
1050 * This first step of the while is to clean this structure which could free
1051 * non NULL pointers so initialize it before the loop.
1053 lttng_poll_init(&events
);
1055 if (testpoint(sessiond_thread_manage_kernel
)) {
1056 goto error_testpoint
;
1059 health_code_update();
1061 if (testpoint(sessiond_thread_manage_kernel_before_loop
)) {
1062 goto error_testpoint
;
1066 health_code_update();
1068 if (update_poll_flag
== 1) {
1069 /* Clean events object. We are about to populate it again. */
1070 lttng_poll_clean(&events
);
1072 ret
= sessiond_set_thread_pollset(&events
, 2);
1074 goto error_poll_create
;
1077 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
1082 /* This will add the available kernel channel if any. */
1083 ret
= update_kernel_poll(&events
);
1087 update_poll_flag
= 0;
1090 DBG("Thread kernel polling");
1092 /* Poll infinite value of time */
1094 health_poll_entry();
1095 ret
= lttng_poll_wait(&events
, -1);
1096 DBG("Thread kernel return from poll on %d fds",
1097 LTTNG_POLL_GETNB(&events
));
1101 * Restart interrupted system call.
1103 if (errno
== EINTR
) {
1107 } else if (ret
== 0) {
1108 /* Should not happen since timeout is infinite */
1109 ERR("Return value of poll is 0 with an infinite timeout.\n"
1110 "This should not have happened! Continuing...");
1116 for (i
= 0; i
< nb_fd
; i
++) {
1117 /* Fetch once the poll data */
1118 revents
= LTTNG_POLL_GETEV(&events
, i
);
1119 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1121 health_code_update();
1124 /* No activity for this FD (poll implementation). */
1128 /* Thread quit pipe has been closed. Killing thread. */
1129 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1135 /* Check for data on kernel pipe */
1136 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
1137 (void) lttng_read(kernel_poll_pipe
[0],
1140 * Ret value is useless here, if this pipe gets any actions an
1141 * update is required anyway.
1143 update_poll_flag
= 1;
1147 * New CPU detected by the kernel. Adding kernel stream to
1148 * kernel session and updating the kernel consumer
1150 if (revents
& LPOLLIN
) {
1151 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
1157 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
1158 * and unregister kernel stream at this point.
1167 lttng_poll_clean(&events
);
1170 utils_close_pipe(kernel_poll_pipe
);
1171 kernel_poll_pipe
[0] = kernel_poll_pipe
[1] = -1;
1174 ERR("Health error occurred in %s", __func__
);
1175 WARN("Kernel thread died unexpectedly. "
1176 "Kernel tracing can continue but CPU hotplug is disabled.");
1178 health_unregister(health_sessiond
);
1179 DBG("Kernel thread dying");
1184 * Signal pthread condition of the consumer data that the thread.
1186 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
1188 pthread_mutex_lock(&data
->cond_mutex
);
1191 * The state is set before signaling. It can be any value, it's the waiter
1192 * job to correctly interpret this condition variable associated to the
1193 * consumer pthread_cond.
1195 * A value of 0 means that the corresponding thread of the consumer data
1196 * was not started. 1 indicates that the thread has started and is ready
1197 * for action. A negative value means that there was an error during the
1200 data
->consumer_thread_is_ready
= state
;
1201 (void) pthread_cond_signal(&data
->cond
);
1203 pthread_mutex_unlock(&data
->cond_mutex
);
1207 * This thread manage the consumer error sent back to the session daemon.
1209 static void *thread_manage_consumer(void *data
)
1211 int sock
= -1, i
, ret
, pollfd
, err
= -1, should_quit
= 0;
1212 uint32_t revents
, nb_fd
;
1213 enum lttcomm_return_code code
;
1214 struct lttng_poll_event events
;
1215 struct consumer_data
*consumer_data
= data
;
1217 DBG("[thread] Manage consumer started");
1219 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CONSUMER
);
1221 health_code_update();
1224 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1225 * metadata_sock. Nothing more will be added to this poll set.
1227 ret
= sessiond_set_thread_pollset(&events
, 3);
1233 * The error socket here is already in a listening state which was done
1234 * just before spawning this thread to avoid a race between the consumer
1235 * daemon exec trying to connect and the listen() call.
1237 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
1242 health_code_update();
1244 /* Infinite blocking call, waiting for transmission */
1246 health_poll_entry();
1248 if (testpoint(sessiond_thread_manage_consumer
)) {
1252 ret
= lttng_poll_wait(&events
, -1);
1256 * Restart interrupted system call.
1258 if (errno
== EINTR
) {
1266 for (i
= 0; i
< nb_fd
; i
++) {
1267 /* Fetch once the poll data */
1268 revents
= LTTNG_POLL_GETEV(&events
, i
);
1269 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1271 health_code_update();
1274 /* No activity for this FD (poll implementation). */
1278 /* Thread quit pipe has been closed. Killing thread. */
1279 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1285 /* Event on the registration socket */
1286 if (pollfd
== consumer_data
->err_sock
) {
1287 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1288 ERR("consumer err socket poll error");
1294 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1300 * Set the CLOEXEC flag. Return code is useless because either way, the
1303 (void) utils_set_fd_cloexec(sock
);
1305 health_code_update();
1307 DBG2("Receiving code from consumer err_sock");
1309 /* Getting status code from kconsumerd */
1310 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1311 sizeof(enum lttcomm_return_code
));
1316 health_code_update();
1317 if (code
== LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
1318 /* Connect both socket, command and metadata. */
1319 consumer_data
->cmd_sock
=
1320 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1321 consumer_data
->metadata_fd
=
1322 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1323 if (consumer_data
->cmd_sock
< 0
1324 || consumer_data
->metadata_fd
< 0) {
1325 PERROR("consumer connect cmd socket");
1326 /* On error, signal condition and quit. */
1327 signal_consumer_condition(consumer_data
, -1);
1330 consumer_data
->metadata_sock
.fd_ptr
= &consumer_data
->metadata_fd
;
1331 /* Create metadata socket lock. */
1332 consumer_data
->metadata_sock
.lock
= zmalloc(sizeof(pthread_mutex_t
));
1333 if (consumer_data
->metadata_sock
.lock
== NULL
) {
1334 PERROR("zmalloc pthread mutex");
1338 pthread_mutex_init(consumer_data
->metadata_sock
.lock
, NULL
);
1340 signal_consumer_condition(consumer_data
, 1);
1341 DBG("Consumer command socket ready (fd: %d", consumer_data
->cmd_sock
);
1342 DBG("Consumer metadata socket ready (fd: %d)",
1343 consumer_data
->metadata_fd
);
1345 ERR("consumer error when waiting for SOCK_READY : %s",
1346 lttcomm_get_readable_code(-code
));
1350 /* Remove the consumerd error sock since we've established a connexion */
1351 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1356 /* Add new accepted error socket. */
1357 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1362 /* Add metadata socket that is successfully connected. */
1363 ret
= lttng_poll_add(&events
, consumer_data
->metadata_fd
,
1364 LPOLLIN
| LPOLLRDHUP
);
1369 health_code_update();
1371 /* Infinite blocking call, waiting for transmission */
1374 health_code_update();
1376 /* Exit the thread because the thread quit pipe has been triggered. */
1378 /* Not a health error. */
1383 health_poll_entry();
1384 ret
= lttng_poll_wait(&events
, -1);
1388 * Restart interrupted system call.
1390 if (errno
== EINTR
) {
1398 for (i
= 0; i
< nb_fd
; i
++) {
1399 /* Fetch once the poll data */
1400 revents
= LTTNG_POLL_GETEV(&events
, i
);
1401 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1403 health_code_update();
1406 /* No activity for this FD (poll implementation). */
1411 * Thread quit pipe has been triggered, flag that we should stop
1412 * but continue the current loop to handle potential data from
1415 should_quit
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1417 if (pollfd
== sock
) {
1418 /* Event on the consumerd socket */
1419 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1420 ERR("consumer err socket second poll error");
1423 health_code_update();
1424 /* Wait for any kconsumerd error */
1425 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1426 sizeof(enum lttcomm_return_code
));
1428 ERR("consumer closed the command socket");
1432 ERR("consumer return code : %s",
1433 lttcomm_get_readable_code(-code
));
1436 } else if (pollfd
== consumer_data
->metadata_fd
) {
1437 /* UST metadata requests */
1438 ret
= ust_consumer_metadata_request(
1439 &consumer_data
->metadata_sock
);
1441 ERR("Handling metadata request");
1445 /* No need for an else branch all FDs are tested prior. */
1447 health_code_update();
1453 * We lock here because we are about to close the sockets and some other
1454 * thread might be using them so get exclusive access which will abort all
1455 * other consumer command by other threads.
1457 pthread_mutex_lock(&consumer_data
->lock
);
1459 /* Immediately set the consumerd state to stopped */
1460 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1461 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1462 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1463 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1464 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1466 /* Code flow error... */
1470 if (consumer_data
->err_sock
>= 0) {
1471 ret
= close(consumer_data
->err_sock
);
1475 consumer_data
->err_sock
= -1;
1477 if (consumer_data
->cmd_sock
>= 0) {
1478 ret
= close(consumer_data
->cmd_sock
);
1482 consumer_data
->cmd_sock
= -1;
1484 if (consumer_data
->metadata_sock
.fd_ptr
&&
1485 *consumer_data
->metadata_sock
.fd_ptr
>= 0) {
1486 ret
= close(*consumer_data
->metadata_sock
.fd_ptr
);
1498 unlink(consumer_data
->err_unix_sock_path
);
1499 unlink(consumer_data
->cmd_unix_sock_path
);
1500 consumer_data
->pid
= 0;
1501 pthread_mutex_unlock(&consumer_data
->lock
);
1503 /* Cleanup metadata socket mutex. */
1504 if (consumer_data
->metadata_sock
.lock
) {
1505 pthread_mutex_destroy(consumer_data
->metadata_sock
.lock
);
1506 free(consumer_data
->metadata_sock
.lock
);
1508 lttng_poll_clean(&events
);
1512 ERR("Health error occurred in %s", __func__
);
1514 health_unregister(health_sessiond
);
1515 DBG("consumer thread cleanup completed");
1521 * This thread manage application communication.
1523 static void *thread_manage_apps(void *data
)
1525 int i
, ret
, pollfd
, err
= -1;
1527 uint32_t revents
, nb_fd
;
1528 struct lttng_poll_event events
;
1530 DBG("[thread] Manage application started");
1532 rcu_register_thread();
1533 rcu_thread_online();
1535 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_MANAGE
);
1537 if (testpoint(sessiond_thread_manage_apps
)) {
1538 goto error_testpoint
;
1541 health_code_update();
1543 ret
= sessiond_set_thread_pollset(&events
, 2);
1545 goto error_poll_create
;
1548 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1553 if (testpoint(sessiond_thread_manage_apps_before_loop
)) {
1557 health_code_update();
1560 DBG("Apps thread polling");
1562 /* Inifinite blocking call, waiting for transmission */
1564 health_poll_entry();
1565 ret
= lttng_poll_wait(&events
, -1);
1566 DBG("Apps thread return from poll on %d fds",
1567 LTTNG_POLL_GETNB(&events
));
1571 * Restart interrupted system call.
1573 if (errno
== EINTR
) {
1581 for (i
= 0; i
< nb_fd
; i
++) {
1582 /* Fetch once the poll data */
1583 revents
= LTTNG_POLL_GETEV(&events
, i
);
1584 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1586 health_code_update();
1589 /* No activity for this FD (poll implementation). */
1593 /* Thread quit pipe has been closed. Killing thread. */
1594 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1600 /* Inspect the apps cmd pipe */
1601 if (pollfd
== apps_cmd_pipe
[0]) {
1602 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1603 ERR("Apps command pipe error");
1605 } else if (revents
& LPOLLIN
) {
1609 size_ret
= lttng_read(apps_cmd_pipe
[0], &sock
, sizeof(sock
));
1610 if (size_ret
< sizeof(sock
)) {
1611 PERROR("read apps cmd pipe");
1615 health_code_update();
1618 * We only monitor the error events of the socket. This
1619 * thread does not handle any incoming data from UST
1622 ret
= lttng_poll_add(&events
, sock
,
1623 LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
1628 DBG("Apps with sock %d added to poll set", sock
);
1632 * At this point, we know that a registered application made
1633 * the event at poll_wait.
1635 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1636 /* Removing from the poll set */
1637 ret
= lttng_poll_del(&events
, pollfd
);
1642 /* Socket closed on remote end. */
1643 ust_app_unregister(pollfd
);
1647 health_code_update();
1653 lttng_poll_clean(&events
);
1656 utils_close_pipe(apps_cmd_pipe
);
1657 apps_cmd_pipe
[0] = apps_cmd_pipe
[1] = -1;
1660 * We don't clean the UST app hash table here since already registered
1661 * applications can still be controlled so let them be until the session
1662 * daemon dies or the applications stop.
1667 ERR("Health error occurred in %s", __func__
);
1669 health_unregister(health_sessiond
);
1670 DBG("Application communication apps thread cleanup complete");
1671 rcu_thread_offline();
1672 rcu_unregister_thread();
1677 * Send a socket to a thread This is called from the dispatch UST registration
1678 * thread once all sockets are set for the application.
1680 * The sock value can be invalid, we don't really care, the thread will handle
1681 * it and make the necessary cleanup if so.
1683 * On success, return 0 else a negative value being the errno message of the
1686 static int send_socket_to_thread(int fd
, int sock
)
1691 * It's possible that the FD is set as invalid with -1 concurrently just
1692 * before calling this function being a shutdown state of the thread.
1699 ret
= lttng_write(fd
, &sock
, sizeof(sock
));
1700 if (ret
< sizeof(sock
)) {
1701 PERROR("write apps pipe %d", fd
);
1708 /* All good. Don't send back the write positive ret value. */
1715 * Sanitize the wait queue of the dispatch registration thread meaning removing
1716 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1717 * notify socket is never received.
1719 static void sanitize_wait_queue(struct ust_reg_wait_queue
*wait_queue
)
1721 int ret
, nb_fd
= 0, i
;
1722 unsigned int fd_added
= 0;
1723 struct lttng_poll_event events
;
1724 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1728 lttng_poll_init(&events
);
1730 /* Just skip everything for an empty queue. */
1731 if (!wait_queue
->count
) {
1735 ret
= lttng_poll_create(&events
, wait_queue
->count
, LTTNG_CLOEXEC
);
1740 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1741 &wait_queue
->head
, head
) {
1742 assert(wait_node
->app
);
1743 ret
= lttng_poll_add(&events
, wait_node
->app
->sock
,
1744 LPOLLHUP
| LPOLLERR
);
1757 * Poll but don't block so we can quickly identify the faulty events and
1758 * clean them afterwards from the wait queue.
1760 ret
= lttng_poll_wait(&events
, 0);
1766 for (i
= 0; i
< nb_fd
; i
++) {
1767 /* Get faulty FD. */
1768 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1769 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1772 /* No activity for this FD (poll implementation). */
1776 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1777 &wait_queue
->head
, head
) {
1778 if (pollfd
== wait_node
->app
->sock
&&
1779 (revents
& (LPOLLHUP
| LPOLLERR
))) {
1780 cds_list_del(&wait_node
->head
);
1781 wait_queue
->count
--;
1782 ust_app_destroy(wait_node
->app
);
1790 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd
);
1794 lttng_poll_clean(&events
);
1798 lttng_poll_clean(&events
);
1800 ERR("Unable to sanitize wait queue");
1805 * Dispatch request from the registration threads to the application
1806 * communication thread.
1808 static void *thread_dispatch_ust_registration(void *data
)
1811 struct cds_wfcq_node
*node
;
1812 struct ust_command
*ust_cmd
= NULL
;
1813 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1814 struct ust_reg_wait_queue wait_queue
= {
1818 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH
);
1820 if (testpoint(sessiond_thread_app_reg_dispatch
)) {
1821 goto error_testpoint
;
1824 health_code_update();
1826 CDS_INIT_LIST_HEAD(&wait_queue
.head
);
1828 DBG("[thread] Dispatch UST command started");
1830 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1831 health_code_update();
1833 /* Atomically prepare the queue futex */
1834 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1837 struct ust_app
*app
= NULL
;
1841 * Make sure we don't have node(s) that have hung up before receiving
1842 * the notify socket. This is to clean the list in order to avoid
1843 * memory leaks from notify socket that are never seen.
1845 sanitize_wait_queue(&wait_queue
);
1847 health_code_update();
1848 /* Dequeue command for registration */
1849 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1851 DBG("Woken up but nothing in the UST command queue");
1852 /* Continue thread execution */
1856 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1858 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1859 " gid:%d sock:%d name:%s (version %d.%d)",
1860 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1861 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1862 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1863 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1865 if (ust_cmd
->reg_msg
.type
== USTCTL_SOCKET_CMD
) {
1866 wait_node
= zmalloc(sizeof(*wait_node
));
1868 PERROR("zmalloc wait_node dispatch");
1869 ret
= close(ust_cmd
->sock
);
1871 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1873 lttng_fd_put(LTTNG_FD_APPS
, 1);
1877 CDS_INIT_LIST_HEAD(&wait_node
->head
);
1879 /* Create application object if socket is CMD. */
1880 wait_node
->app
= ust_app_create(&ust_cmd
->reg_msg
,
1882 if (!wait_node
->app
) {
1883 ret
= close(ust_cmd
->sock
);
1885 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1887 lttng_fd_put(LTTNG_FD_APPS
, 1);
1893 * Add application to the wait queue so we can set the notify
1894 * socket before putting this object in the global ht.
1896 cds_list_add(&wait_node
->head
, &wait_queue
.head
);
1901 * We have to continue here since we don't have the notify
1902 * socket and the application MUST be added to the hash table
1903 * only at that moment.
1908 * Look for the application in the local wait queue and set the
1909 * notify socket if found.
1911 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1912 &wait_queue
.head
, head
) {
1913 health_code_update();
1914 if (wait_node
->app
->pid
== ust_cmd
->reg_msg
.pid
) {
1915 wait_node
->app
->notify_sock
= ust_cmd
->sock
;
1916 cds_list_del(&wait_node
->head
);
1918 app
= wait_node
->app
;
1920 DBG3("UST app notify socket %d is set", ust_cmd
->sock
);
1926 * With no application at this stage the received socket is
1927 * basically useless so close it before we free the cmd data
1928 * structure for good.
1931 ret
= close(ust_cmd
->sock
);
1933 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1935 lttng_fd_put(LTTNG_FD_APPS
, 1);
1942 * @session_lock_list
1944 * Lock the global session list so from the register up to the
1945 * registration done message, no thread can see the application
1946 * and change its state.
1948 session_lock_list();
1952 * Add application to the global hash table. This needs to be
1953 * done before the update to the UST registry can locate the
1958 /* Set app version. This call will print an error if needed. */
1959 (void) ust_app_version(app
);
1961 /* Send notify socket through the notify pipe. */
1962 ret
= send_socket_to_thread(apps_cmd_notify_pipe
[1],
1966 session_unlock_list();
1968 * No notify thread, stop the UST tracing. However, this is
1969 * not an internal error of the this thread thus setting
1970 * the health error code to a normal exit.
1977 * Update newly registered application with the tracing
1978 * registry info already enabled information.
1980 update_ust_app(app
->sock
);
1983 * Don't care about return value. Let the manage apps threads
1984 * handle app unregistration upon socket close.
1986 (void) ust_app_register_done(app
->sock
);
1989 * Even if the application socket has been closed, send the app
1990 * to the thread and unregistration will take place at that
1993 ret
= send_socket_to_thread(apps_cmd_pipe
[1], app
->sock
);
1996 session_unlock_list();
1998 * No apps. thread, stop the UST tracing. However, this is
1999 * not an internal error of the this thread thus setting
2000 * the health error code to a normal exit.
2007 session_unlock_list();
2009 } while (node
!= NULL
);
2011 health_poll_entry();
2012 /* Futex wait on queue. Blocking call on futex() */
2013 futex_nto1_wait(&ust_cmd_queue
.futex
);
2016 /* Normal exit, no error */
2020 /* Clean up wait queue. */
2021 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
2022 &wait_queue
.head
, head
) {
2023 cds_list_del(&wait_node
->head
);
2029 DBG("Dispatch thread dying");
2032 ERR("Health error occurred in %s", __func__
);
2034 health_unregister(health_sessiond
);
2039 * This thread manage application registration.
2041 static void *thread_registration_apps(void *data
)
2043 int sock
= -1, i
, ret
, pollfd
, err
= -1;
2044 uint32_t revents
, nb_fd
;
2045 struct lttng_poll_event events
;
2047 * Get allocated in this thread, enqueued to a global queue, dequeued and
2048 * freed in the manage apps thread.
2050 struct ust_command
*ust_cmd
= NULL
;
2052 DBG("[thread] Manage application registration started");
2054 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG
);
2056 if (testpoint(sessiond_thread_registration_apps
)) {
2057 goto error_testpoint
;
2060 ret
= lttcomm_listen_unix_sock(apps_sock
);
2066 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
2067 * more will be added to this poll set.
2069 ret
= sessiond_set_thread_pollset(&events
, 2);
2071 goto error_create_poll
;
2074 /* Add the application registration socket */
2075 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
2077 goto error_poll_add
;
2080 /* Notify all applications to register */
2081 ret
= notify_ust_apps(1);
2083 ERR("Failed to notify applications or create the wait shared memory.\n"
2084 "Execution continues but there might be problem for already\n"
2085 "running applications that wishes to register.");
2089 DBG("Accepting application registration");
2091 /* Inifinite blocking call, waiting for transmission */
2093 health_poll_entry();
2094 ret
= lttng_poll_wait(&events
, -1);
2098 * Restart interrupted system call.
2100 if (errno
== EINTR
) {
2108 for (i
= 0; i
< nb_fd
; i
++) {
2109 health_code_update();
2111 /* Fetch once the poll data */
2112 revents
= LTTNG_POLL_GETEV(&events
, i
);
2113 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2116 /* No activity for this FD (poll implementation). */
2120 /* Thread quit pipe has been closed. Killing thread. */
2121 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
2127 /* Event on the registration socket */
2128 if (pollfd
== apps_sock
) {
2129 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2130 ERR("Register apps socket poll error");
2132 } else if (revents
& LPOLLIN
) {
2133 sock
= lttcomm_accept_unix_sock(apps_sock
);
2139 * Set socket timeout for both receiving and ending.
2140 * app_socket_timeout is in seconds, whereas
2141 * lttcomm_setsockopt_rcv_timeout and
2142 * lttcomm_setsockopt_snd_timeout expect msec as
2145 (void) lttcomm_setsockopt_rcv_timeout(sock
,
2146 app_socket_timeout
* 1000);
2147 (void) lttcomm_setsockopt_snd_timeout(sock
,
2148 app_socket_timeout
* 1000);
2151 * Set the CLOEXEC flag. Return code is useless because
2152 * either way, the show must go on.
2154 (void) utils_set_fd_cloexec(sock
);
2156 /* Create UST registration command for enqueuing */
2157 ust_cmd
= zmalloc(sizeof(struct ust_command
));
2158 if (ust_cmd
== NULL
) {
2159 PERROR("ust command zmalloc");
2164 * Using message-based transmissions to ensure we don't
2165 * have to deal with partially received messages.
2167 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2169 ERR("Exhausted file descriptors allowed for applications.");
2179 health_code_update();
2180 ret
= ust_app_recv_registration(sock
, &ust_cmd
->reg_msg
);
2183 /* Close socket of the application. */
2188 lttng_fd_put(LTTNG_FD_APPS
, 1);
2192 health_code_update();
2194 ust_cmd
->sock
= sock
;
2197 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2198 " gid:%d sock:%d name:%s (version %d.%d)",
2199 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
2200 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
2201 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
2202 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
2205 * Lock free enqueue the registration request. The red pill
2206 * has been taken! This apps will be part of the *system*.
2208 cds_wfcq_enqueue(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
, &ust_cmd
->node
);
2211 * Wake the registration queue futex. Implicit memory
2212 * barrier with the exchange in cds_wfcq_enqueue.
2214 futex_nto1_wake(&ust_cmd_queue
.futex
);
2222 /* Notify that the registration thread is gone */
2225 if (apps_sock
>= 0) {
2226 ret
= close(apps_sock
);
2236 lttng_fd_put(LTTNG_FD_APPS
, 1);
2238 unlink(apps_unix_sock_path
);
2241 lttng_poll_clean(&events
);
2245 DBG("UST Registration thread cleanup complete");
2248 ERR("Health error occurred in %s", __func__
);
2250 health_unregister(health_sessiond
);
2256 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2257 * exec or it will fails.
2259 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
2262 struct timespec timeout
;
2264 /* Make sure we set the readiness flag to 0 because we are NOT ready */
2265 consumer_data
->consumer_thread_is_ready
= 0;
2267 /* Setup pthread condition */
2268 ret
= pthread_condattr_init(&consumer_data
->condattr
);
2271 PERROR("pthread_condattr_init consumer data");
2276 * Set the monotonic clock in order to make sure we DO NOT jump in time
2277 * between the clock_gettime() call and the timedwait call. See bug #324
2278 * for a more details and how we noticed it.
2280 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
2283 PERROR("pthread_condattr_setclock consumer data");
2287 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
2290 PERROR("pthread_cond_init consumer data");
2294 ret
= pthread_create(&consumer_data
->thread
, NULL
, thread_manage_consumer
,
2298 PERROR("pthread_create consumer");
2303 /* We are about to wait on a pthread condition */
2304 pthread_mutex_lock(&consumer_data
->cond_mutex
);
2306 /* Get time for sem_timedwait absolute timeout */
2307 clock_ret
= clock_gettime(CLOCK_MONOTONIC
, &timeout
);
2309 * Set the timeout for the condition timed wait even if the clock gettime
2310 * call fails since we might loop on that call and we want to avoid to
2311 * increment the timeout too many times.
2313 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
2316 * The following loop COULD be skipped in some conditions so this is why we
2317 * set ret to 0 in order to make sure at least one round of the loop is
2323 * Loop until the condition is reached or when a timeout is reached. Note
2324 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2325 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2326 * possible. This loop does not take any chances and works with both of
2329 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
2330 if (clock_ret
< 0) {
2331 PERROR("clock_gettime spawn consumer");
2332 /* Infinite wait for the consumerd thread to be ready */
2333 ret
= pthread_cond_wait(&consumer_data
->cond
,
2334 &consumer_data
->cond_mutex
);
2336 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
2337 &consumer_data
->cond_mutex
, &timeout
);
2341 /* Release the pthread condition */
2342 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
2346 if (ret
== ETIMEDOUT
) {
2350 * Call has timed out so we kill the kconsumerd_thread and return
2353 ERR("Condition timed out. The consumer thread was never ready."
2355 pth_ret
= pthread_cancel(consumer_data
->thread
);
2357 PERROR("pthread_cancel consumer thread");
2360 PERROR("pthread_cond_wait failed consumer thread");
2362 /* Caller is expecting a negative value on failure. */
2367 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2368 if (consumer_data
->pid
== 0) {
2369 ERR("Consumerd did not start");
2370 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2373 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2382 * Join consumer thread
2384 static int join_consumer_thread(struct consumer_data
*consumer_data
)
2388 /* Consumer pid must be a real one. */
2389 if (consumer_data
->pid
> 0) {
2391 ret
= kill(consumer_data
->pid
, SIGTERM
);
2393 PERROR("Error killing consumer daemon");
2396 return pthread_join(consumer_data
->thread
, &status
);
2403 * Fork and exec a consumer daemon (consumerd).
2405 * Return pid if successful else -1.
2407 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
2411 const char *consumer_to_use
;
2412 const char *verbosity
;
2415 DBG("Spawning consumerd");
2422 if (opt_verbose_consumer
) {
2423 verbosity
= "--verbose";
2424 } else if (lttng_opt_quiet
) {
2425 verbosity
= "--quiet";
2430 switch (consumer_data
->type
) {
2431 case LTTNG_CONSUMER_KERNEL
:
2433 * Find out which consumerd to execute. We will first try the
2434 * 64-bit path, then the sessiond's installation directory, and
2435 * fallback on the 32-bit one,
2437 DBG3("Looking for a kernel consumer at these locations:");
2438 DBG3(" 1) %s", consumerd64_bin
);
2439 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
2440 DBG3(" 3) %s", consumerd32_bin
);
2441 if (stat(consumerd64_bin
, &st
) == 0) {
2442 DBG3("Found location #1");
2443 consumer_to_use
= consumerd64_bin
;
2444 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
2445 DBG3("Found location #2");
2446 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
2447 } else if (stat(consumerd32_bin
, &st
) == 0) {
2448 DBG3("Found location #3");
2449 consumer_to_use
= consumerd32_bin
;
2451 DBG("Could not find any valid consumerd executable");
2455 DBG("Using kernel consumer at: %s", consumer_to_use
);
2456 ret
= execl(consumer_to_use
,
2457 "lttng-consumerd", verbosity
, "-k",
2458 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2459 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2460 "--group", tracing_group_name
,
2463 case LTTNG_CONSUMER64_UST
:
2465 char *tmpnew
= NULL
;
2467 if (consumerd64_libdir
[0] != '\0') {
2471 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2475 tmplen
= strlen("LD_LIBRARY_PATH=")
2476 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
2477 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2482 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2483 strcat(tmpnew
, consumerd64_libdir
);
2484 if (tmp
[0] != '\0') {
2485 strcat(tmpnew
, ":");
2486 strcat(tmpnew
, tmp
);
2488 ret
= putenv(tmpnew
);
2495 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
2496 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
2497 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2498 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2499 "--group", tracing_group_name
,
2501 if (consumerd64_libdir
[0] != '\0') {
2506 case LTTNG_CONSUMER32_UST
:
2508 char *tmpnew
= NULL
;
2510 if (consumerd32_libdir
[0] != '\0') {
2514 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2518 tmplen
= strlen("LD_LIBRARY_PATH=")
2519 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
2520 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2525 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2526 strcat(tmpnew
, consumerd32_libdir
);
2527 if (tmp
[0] != '\0') {
2528 strcat(tmpnew
, ":");
2529 strcat(tmpnew
, tmp
);
2531 ret
= putenv(tmpnew
);
2538 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
2539 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
2540 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2541 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2542 "--group", tracing_group_name
,
2544 if (consumerd32_libdir
[0] != '\0') {
2550 PERROR("unknown consumer type");
2554 PERROR("Consumer execl()");
2556 /* Reaching this point, we got a failure on our execl(). */
2558 } else if (pid
> 0) {
2561 PERROR("start consumer fork");
2569 * Spawn the consumerd daemon and session daemon thread.
2571 static int start_consumerd(struct consumer_data
*consumer_data
)
2576 * Set the listen() state on the socket since there is a possible race
2577 * between the exec() of the consumer daemon and this call if place in the
2578 * consumer thread. See bug #366 for more details.
2580 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
2585 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2586 if (consumer_data
->pid
!= 0) {
2587 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2591 ret
= spawn_consumerd(consumer_data
);
2593 ERR("Spawning consumerd failed");
2594 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2598 /* Setting up the consumer_data pid */
2599 consumer_data
->pid
= ret
;
2600 DBG2("Consumer pid %d", consumer_data
->pid
);
2601 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2603 DBG2("Spawning consumer control thread");
2604 ret
= spawn_consumer_thread(consumer_data
);
2606 ERR("Fatal error spawning consumer control thread");
2614 /* Cleanup already created sockets on error. */
2615 if (consumer_data
->err_sock
>= 0) {
2618 err
= close(consumer_data
->err_sock
);
2620 PERROR("close consumer data error socket");
2627 * Setup necessary data for kernel tracer action.
2629 static int init_kernel_tracer(void)
2633 /* Modprobe lttng kernel modules */
2634 ret
= modprobe_lttng_control();
2639 /* Open debugfs lttng */
2640 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
2641 if (kernel_tracer_fd
< 0) {
2642 DBG("Failed to open %s", module_proc_lttng
);
2647 /* Validate kernel version */
2648 ret
= kernel_validate_version(kernel_tracer_fd
);
2653 ret
= modprobe_lttng_data();
2658 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
2662 modprobe_remove_lttng_control();
2663 ret
= close(kernel_tracer_fd
);
2667 kernel_tracer_fd
= -1;
2668 return LTTNG_ERR_KERN_VERSION
;
2671 ret
= close(kernel_tracer_fd
);
2677 modprobe_remove_lttng_control();
2680 WARN("No kernel tracer available");
2681 kernel_tracer_fd
= -1;
2683 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
2685 return LTTNG_ERR_KERN_NA
;
2691 * Copy consumer output from the tracing session to the domain session. The
2692 * function also applies the right modification on a per domain basis for the
2693 * trace files destination directory.
2695 * Should *NOT* be called with RCU read-side lock held.
2697 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2700 const char *dir_name
;
2701 struct consumer_output
*consumer
;
2704 assert(session
->consumer
);
2707 case LTTNG_DOMAIN_KERNEL
:
2708 DBG3("Copying tracing session consumer output in kernel session");
2710 * XXX: We should audit the session creation and what this function
2711 * does "extra" in order to avoid a destroy since this function is used
2712 * in the domain session creation (kernel and ust) only. Same for UST
2715 if (session
->kernel_session
->consumer
) {
2716 consumer_destroy_output(session
->kernel_session
->consumer
);
2718 session
->kernel_session
->consumer
=
2719 consumer_copy_output(session
->consumer
);
2720 /* Ease our life a bit for the next part */
2721 consumer
= session
->kernel_session
->consumer
;
2722 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2724 case LTTNG_DOMAIN_JUL
:
2725 case LTTNG_DOMAIN_LOG4J
:
2726 case LTTNG_DOMAIN_PYTHON
:
2727 case LTTNG_DOMAIN_UST
:
2728 DBG3("Copying tracing session consumer output in UST session");
2729 if (session
->ust_session
->consumer
) {
2730 consumer_destroy_output(session
->ust_session
->consumer
);
2732 session
->ust_session
->consumer
=
2733 consumer_copy_output(session
->consumer
);
2734 /* Ease our life a bit for the next part */
2735 consumer
= session
->ust_session
->consumer
;
2736 dir_name
= DEFAULT_UST_TRACE_DIR
;
2739 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2743 /* Append correct directory to subdir */
2744 strncat(consumer
->subdir
, dir_name
,
2745 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
2746 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2755 * Create an UST session and add it to the session ust list.
2757 * Should *NOT* be called with RCU read-side lock held.
2759 static int create_ust_session(struct ltt_session
*session
,
2760 struct lttng_domain
*domain
)
2763 struct ltt_ust_session
*lus
= NULL
;
2767 assert(session
->consumer
);
2769 switch (domain
->type
) {
2770 case LTTNG_DOMAIN_JUL
:
2771 case LTTNG_DOMAIN_LOG4J
:
2772 case LTTNG_DOMAIN_PYTHON
:
2773 case LTTNG_DOMAIN_UST
:
2776 ERR("Unknown UST domain on create session %d", domain
->type
);
2777 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2781 DBG("Creating UST session");
2783 lus
= trace_ust_create_session(session
->id
);
2785 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2789 lus
->uid
= session
->uid
;
2790 lus
->gid
= session
->gid
;
2791 lus
->output_traces
= session
->output_traces
;
2792 lus
->snapshot_mode
= session
->snapshot_mode
;
2793 lus
->live_timer_interval
= session
->live_timer
;
2794 session
->ust_session
= lus
;
2795 if (session
->shm_path
[0]) {
2796 strncpy(lus
->root_shm_path
, session
->shm_path
,
2797 sizeof(lus
->root_shm_path
));
2798 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
2799 strncpy(lus
->shm_path
, session
->shm_path
,
2800 sizeof(lus
->shm_path
));
2801 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
2802 strncat(lus
->shm_path
, "/ust",
2803 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
2805 /* Copy session output to the newly created UST session */
2806 ret
= copy_session_consumer(domain
->type
, session
);
2807 if (ret
!= LTTNG_OK
) {
2815 session
->ust_session
= NULL
;
2820 * Create a kernel tracer session then create the default channel.
2822 static int create_kernel_session(struct ltt_session
*session
)
2826 DBG("Creating kernel session");
2828 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2830 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2834 /* Code flow safety */
2835 assert(session
->kernel_session
);
2837 /* Copy session output to the newly created Kernel session */
2838 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2839 if (ret
!= LTTNG_OK
) {
2843 /* Create directory(ies) on local filesystem. */
2844 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2845 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2846 ret
= run_as_mkdir_recursive(
2847 session
->kernel_session
->consumer
->dst
.trace_path
,
2848 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2850 if (ret
!= -EEXIST
) {
2851 ERR("Trace directory creation error");
2857 session
->kernel_session
->uid
= session
->uid
;
2858 session
->kernel_session
->gid
= session
->gid
;
2859 session
->kernel_session
->output_traces
= session
->output_traces
;
2860 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
2865 trace_kernel_destroy_session(session
->kernel_session
);
2866 session
->kernel_session
= NULL
;
2871 * Count number of session permitted by uid/gid.
2873 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2876 struct ltt_session
*session
;
2878 DBG("Counting number of available session for UID %d GID %d",
2880 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2882 * Only list the sessions the user can control.
2884 if (!session_access_ok(session
, uid
, gid
)) {
2893 * Process the command requested by the lttng client within the command
2894 * context structure. This function make sure that the return structure (llm)
2895 * is set and ready for transmission before returning.
2897 * Return any error encountered or 0 for success.
2899 * "sock" is only used for special-case var. len data.
2901 * Should *NOT* be called with RCU read-side lock held.
2903 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2907 int need_tracing_session
= 1;
2910 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2914 switch (cmd_ctx
->lsm
->cmd_type
) {
2915 case LTTNG_CREATE_SESSION
:
2916 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2917 case LTTNG_CREATE_SESSION_LIVE
:
2918 case LTTNG_DESTROY_SESSION
:
2919 case LTTNG_LIST_SESSIONS
:
2920 case LTTNG_LIST_DOMAINS
:
2921 case LTTNG_START_TRACE
:
2922 case LTTNG_STOP_TRACE
:
2923 case LTTNG_DATA_PENDING
:
2924 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2925 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2926 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2927 case LTTNG_SNAPSHOT_RECORD
:
2928 case LTTNG_SAVE_SESSION
:
2929 case LTTNG_SET_SESSION_SHM_PATH
:
2936 if (opt_no_kernel
&& need_domain
2937 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
2939 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
2941 ret
= LTTNG_ERR_KERN_NA
;
2946 /* Deny register consumer if we already have a spawned consumer. */
2947 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
2948 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2949 if (kconsumer_data
.pid
> 0) {
2950 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2951 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2954 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2958 * Check for command that don't needs to allocate a returned payload. We do
2959 * this here so we don't have to make the call for no payload at each
2962 switch(cmd_ctx
->lsm
->cmd_type
) {
2963 case LTTNG_LIST_SESSIONS
:
2964 case LTTNG_LIST_TRACEPOINTS
:
2965 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2966 case LTTNG_LIST_DOMAINS
:
2967 case LTTNG_LIST_CHANNELS
:
2968 case LTTNG_LIST_EVENTS
:
2969 case LTTNG_LIST_SYSCALLS
:
2970 case LTTNG_LIST_TRACKER_PIDS
:
2973 /* Setup lttng message with no payload */
2974 ret
= setup_lttng_msg(cmd_ctx
, 0);
2976 /* This label does not try to unlock the session */
2977 goto init_setup_error
;
2981 /* Commands that DO NOT need a session. */
2982 switch (cmd_ctx
->lsm
->cmd_type
) {
2983 case LTTNG_CREATE_SESSION
:
2984 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2985 case LTTNG_CREATE_SESSION_LIVE
:
2986 case LTTNG_CALIBRATE
:
2987 case LTTNG_LIST_SESSIONS
:
2988 case LTTNG_LIST_TRACEPOINTS
:
2989 case LTTNG_LIST_SYSCALLS
:
2990 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2991 case LTTNG_SAVE_SESSION
:
2992 need_tracing_session
= 0;
2995 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
2997 * We keep the session list lock across _all_ commands
2998 * for now, because the per-session lock does not
2999 * handle teardown properly.
3001 session_lock_list();
3002 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3003 if (cmd_ctx
->session
== NULL
) {
3004 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
3007 /* Acquire lock for the session */
3008 session_lock(cmd_ctx
->session
);
3014 * Commands that need a valid session but should NOT create one if none
3015 * exists. Instead of creating one and destroying it when the command is
3016 * handled, process that right before so we save some round trip in useless
3019 switch (cmd_ctx
->lsm
->cmd_type
) {
3020 case LTTNG_DISABLE_CHANNEL
:
3021 case LTTNG_DISABLE_EVENT
:
3022 switch (cmd_ctx
->lsm
->domain
.type
) {
3023 case LTTNG_DOMAIN_KERNEL
:
3024 if (!cmd_ctx
->session
->kernel_session
) {
3025 ret
= LTTNG_ERR_NO_CHANNEL
;
3029 case LTTNG_DOMAIN_JUL
:
3030 case LTTNG_DOMAIN_LOG4J
:
3031 case LTTNG_DOMAIN_PYTHON
:
3032 case LTTNG_DOMAIN_UST
:
3033 if (!cmd_ctx
->session
->ust_session
) {
3034 ret
= LTTNG_ERR_NO_CHANNEL
;
3039 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3051 * Check domain type for specific "pre-action".
3053 switch (cmd_ctx
->lsm
->domain
.type
) {
3054 case LTTNG_DOMAIN_KERNEL
:
3056 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3060 /* Kernel tracer check */
3061 if (kernel_tracer_fd
== -1) {
3062 /* Basically, load kernel tracer modules */
3063 ret
= init_kernel_tracer();
3069 /* Consumer is in an ERROR state. Report back to client */
3070 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3071 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3075 /* Need a session for kernel command */
3076 if (need_tracing_session
) {
3077 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3078 ret
= create_kernel_session(cmd_ctx
->session
);
3080 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
3085 /* Start the kernel consumer daemon */
3086 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3087 if (kconsumer_data
.pid
== 0 &&
3088 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3089 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3090 ret
= start_consumerd(&kconsumer_data
);
3092 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3095 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3097 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3101 * The consumer was just spawned so we need to add the socket to
3102 * the consumer output of the session if exist.
3104 ret
= consumer_create_socket(&kconsumer_data
,
3105 cmd_ctx
->session
->kernel_session
->consumer
);
3112 case LTTNG_DOMAIN_JUL
:
3113 case LTTNG_DOMAIN_LOG4J
:
3114 case LTTNG_DOMAIN_PYTHON
:
3115 case LTTNG_DOMAIN_UST
:
3117 if (!ust_app_supported()) {
3118 ret
= LTTNG_ERR_NO_UST
;
3121 /* Consumer is in an ERROR state. Report back to client */
3122 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3123 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3127 if (need_tracing_session
) {
3128 /* Create UST session if none exist. */
3129 if (cmd_ctx
->session
->ust_session
== NULL
) {
3130 ret
= create_ust_session(cmd_ctx
->session
,
3131 &cmd_ctx
->lsm
->domain
);
3132 if (ret
!= LTTNG_OK
) {
3137 /* Start the UST consumer daemons */
3139 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3140 if (consumerd64_bin
[0] != '\0' &&
3141 ustconsumer64_data
.pid
== 0 &&
3142 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3143 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3144 ret
= start_consumerd(&ustconsumer64_data
);
3146 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
3147 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
3151 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
3152 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3154 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3158 * Setup socket for consumer 64 bit. No need for atomic access
3159 * since it was set above and can ONLY be set in this thread.
3161 ret
= consumer_create_socket(&ustconsumer64_data
,
3162 cmd_ctx
->session
->ust_session
->consumer
);
3168 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
3169 if (consumerd32_bin
[0] != '\0' &&
3170 ustconsumer32_data
.pid
== 0 &&
3171 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3172 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3173 ret
= start_consumerd(&ustconsumer32_data
);
3175 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
3176 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
3180 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
3181 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3183 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3187 * Setup socket for consumer 64 bit. No need for atomic access
3188 * since it was set above and can ONLY be set in this thread.
3190 ret
= consumer_create_socket(&ustconsumer32_data
,
3191 cmd_ctx
->session
->ust_session
->consumer
);
3203 /* Validate consumer daemon state when start/stop trace command */
3204 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3205 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3206 switch (cmd_ctx
->lsm
->domain
.type
) {
3207 case LTTNG_DOMAIN_JUL
:
3208 case LTTNG_DOMAIN_LOG4J
:
3209 case LTTNG_DOMAIN_PYTHON
:
3210 case LTTNG_DOMAIN_UST
:
3211 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3212 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3216 case LTTNG_DOMAIN_KERNEL
:
3217 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3218 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3226 * Check that the UID or GID match that of the tracing session.
3227 * The root user can interact with all sessions.
3229 if (need_tracing_session
) {
3230 if (!session_access_ok(cmd_ctx
->session
,
3231 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3232 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3233 ret
= LTTNG_ERR_EPERM
;
3239 * Send relayd information to consumer as soon as we have a domain and a
3242 if (cmd_ctx
->session
&& need_domain
) {
3244 * Setup relayd if not done yet. If the relayd information was already
3245 * sent to the consumer, this call will gracefully return.
3247 ret
= cmd_setup_relayd(cmd_ctx
->session
);
3248 if (ret
!= LTTNG_OK
) {
3253 /* Process by command type */
3254 switch (cmd_ctx
->lsm
->cmd_type
) {
3255 case LTTNG_ADD_CONTEXT
:
3257 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3258 cmd_ctx
->lsm
->u
.context
.channel_name
,
3259 &cmd_ctx
->lsm
->u
.context
.ctx
, kernel_poll_pipe
[1]);
3262 case LTTNG_DISABLE_CHANNEL
:
3264 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3265 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3268 case LTTNG_DISABLE_EVENT
:
3270 /* FIXME: passing packed structure to non-packed pointer */
3271 /* TODO: handle filter */
3272 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3273 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3274 &cmd_ctx
->lsm
->u
.disable
.event
);
3277 case LTTNG_ENABLE_CHANNEL
:
3279 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3280 &cmd_ctx
->lsm
->u
.channel
.chan
, kernel_poll_pipe
[1]);
3283 case LTTNG_TRACK_PID
:
3285 ret
= cmd_track_pid(cmd_ctx
->session
,
3286 cmd_ctx
->lsm
->domain
.type
,
3287 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3290 case LTTNG_UNTRACK_PID
:
3292 ret
= cmd_untrack_pid(cmd_ctx
->session
,
3293 cmd_ctx
->lsm
->domain
.type
,
3294 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3297 case LTTNG_ENABLE_EVENT
:
3299 struct lttng_event_exclusion
*exclusion
= NULL
;
3300 struct lttng_filter_bytecode
*bytecode
= NULL
;
3301 char *filter_expression
= NULL
;
3303 /* Handle exclusion events and receive it from the client. */
3304 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
3305 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
3307 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
3308 (count
* LTTNG_SYMBOL_NAME_LEN
));
3310 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
3314 DBG("Receiving var len exclusion event list from client ...");
3315 exclusion
->count
= count
;
3316 ret
= lttcomm_recv_unix_sock(sock
, exclusion
->names
,
3317 count
* LTTNG_SYMBOL_NAME_LEN
);
3319 DBG("Nothing recv() from client var len data... continuing");
3322 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
3327 /* Get filter expression from client. */
3328 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
3329 size_t expression_len
=
3330 cmd_ctx
->lsm
->u
.enable
.expression_len
;
3332 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
3333 ret
= LTTNG_ERR_FILTER_INVAL
;
3338 filter_expression
= zmalloc(expression_len
);
3339 if (!filter_expression
) {
3341 ret
= LTTNG_ERR_FILTER_NOMEM
;
3345 /* Receive var. len. data */
3346 DBG("Receiving var len filter's expression from client ...");
3347 ret
= lttcomm_recv_unix_sock(sock
, filter_expression
,
3350 DBG("Nothing recv() from client car len data... continuing");
3352 free(filter_expression
);
3354 ret
= LTTNG_ERR_FILTER_INVAL
;
3359 /* Handle filter and get bytecode from client. */
3360 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
3361 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
3363 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
3364 ret
= LTTNG_ERR_FILTER_INVAL
;
3365 free(filter_expression
);
3370 bytecode
= zmalloc(bytecode_len
);
3372 free(filter_expression
);
3374 ret
= LTTNG_ERR_FILTER_NOMEM
;
3378 /* Receive var. len. data */
3379 DBG("Receiving var len filter's bytecode from client ...");
3380 ret
= lttcomm_recv_unix_sock(sock
, bytecode
, bytecode_len
);
3382 DBG("Nothing recv() from client car len data... continuing");
3384 free(filter_expression
);
3387 ret
= LTTNG_ERR_FILTER_INVAL
;
3391 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
3392 free(filter_expression
);
3395 ret
= LTTNG_ERR_FILTER_INVAL
;
3400 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3401 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3402 &cmd_ctx
->lsm
->u
.enable
.event
,
3403 filter_expression
, bytecode
, exclusion
,
3404 kernel_poll_pipe
[1]);
3407 case LTTNG_LIST_TRACEPOINTS
:
3409 struct lttng_event
*events
;
3412 session_lock_list();
3413 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3414 session_unlock_list();
3415 if (nb_events
< 0) {
3416 /* Return value is a negative lttng_error_code. */
3422 * Setup lttng message with payload size set to the event list size in
3423 * bytes and then copy list into the llm payload.
3425 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3431 /* Copy event list into message payload */
3432 memcpy(cmd_ctx
->llm
->payload
, events
,
3433 sizeof(struct lttng_event
) * nb_events
);
3440 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3442 struct lttng_event_field
*fields
;
3445 session_lock_list();
3446 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
3448 session_unlock_list();
3449 if (nb_fields
< 0) {
3450 /* Return value is a negative lttng_error_code. */
3456 * Setup lttng message with payload size set to the event list size in
3457 * bytes and then copy list into the llm payload.
3459 ret
= setup_lttng_msg(cmd_ctx
,
3460 sizeof(struct lttng_event_field
) * nb_fields
);
3466 /* Copy event list into message payload */
3467 memcpy(cmd_ctx
->llm
->payload
, fields
,
3468 sizeof(struct lttng_event_field
) * nb_fields
);
3475 case LTTNG_LIST_SYSCALLS
:
3477 struct lttng_event
*events
;
3480 nb_events
= cmd_list_syscalls(&events
);
3481 if (nb_events
< 0) {
3482 /* Return value is a negative lttng_error_code. */
3488 * Setup lttng message with payload size set to the event list size in
3489 * bytes and then copy list into the llm payload.
3491 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3497 /* Copy event list into message payload */
3498 memcpy(cmd_ctx
->llm
->payload
, events
,
3499 sizeof(struct lttng_event
) * nb_events
);
3506 case LTTNG_LIST_TRACKER_PIDS
:
3508 int32_t *pids
= NULL
;
3511 nr_pids
= cmd_list_tracker_pids(cmd_ctx
->session
,
3512 cmd_ctx
->lsm
->domain
.type
, &pids
);
3514 /* Return value is a negative lttng_error_code. */
3520 * Setup lttng message with payload size set to the event list size in
3521 * bytes and then copy list into the llm payload.
3523 ret
= setup_lttng_msg(cmd_ctx
, sizeof(int32_t) * nr_pids
);
3529 /* Copy event list into message payload */
3530 memcpy(cmd_ctx
->llm
->payload
, pids
,
3531 sizeof(int) * nr_pids
);
3538 case LTTNG_SET_CONSUMER_URI
:
3541 struct lttng_uri
*uris
;
3543 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3544 len
= nb_uri
* sizeof(struct lttng_uri
);
3547 ret
= LTTNG_ERR_INVALID
;
3551 uris
= zmalloc(len
);
3553 ret
= LTTNG_ERR_FATAL
;
3557 /* Receive variable len data */
3558 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
3559 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3561 DBG("No URIs received from client... continuing");
3563 ret
= LTTNG_ERR_SESSION_FAIL
;
3568 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
3570 if (ret
!= LTTNG_OK
) {
3577 case LTTNG_START_TRACE
:
3579 ret
= cmd_start_trace(cmd_ctx
->session
);
3582 case LTTNG_STOP_TRACE
:
3584 ret
= cmd_stop_trace(cmd_ctx
->session
);
3587 case LTTNG_CREATE_SESSION
:
3590 struct lttng_uri
*uris
= NULL
;
3592 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3593 len
= nb_uri
* sizeof(struct lttng_uri
);
3596 uris
= zmalloc(len
);
3598 ret
= LTTNG_ERR_FATAL
;
3602 /* Receive variable len data */
3603 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3604 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3606 DBG("No URIs received from client... continuing");
3608 ret
= LTTNG_ERR_SESSION_FAIL
;
3613 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3614 DBG("Creating session with ONE network URI is a bad call");
3615 ret
= LTTNG_ERR_SESSION_FAIL
;
3621 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
3622 &cmd_ctx
->creds
, 0);
3628 case LTTNG_DESTROY_SESSION
:
3630 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
3632 /* Set session to NULL so we do not unlock it after free. */
3633 cmd_ctx
->session
= NULL
;
3636 case LTTNG_LIST_DOMAINS
:
3639 struct lttng_domain
*domains
= NULL
;
3641 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3643 /* Return value is a negative lttng_error_code. */
3648 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3654 /* Copy event list into message payload */
3655 memcpy(cmd_ctx
->llm
->payload
, domains
,
3656 nb_dom
* sizeof(struct lttng_domain
));
3663 case LTTNG_LIST_CHANNELS
:
3666 struct lttng_channel
*channels
= NULL
;
3668 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3669 cmd_ctx
->session
, &channels
);
3671 /* Return value is a negative lttng_error_code. */
3676 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3682 /* Copy event list into message payload */
3683 memcpy(cmd_ctx
->llm
->payload
, channels
,
3684 nb_chan
* sizeof(struct lttng_channel
));
3691 case LTTNG_LIST_EVENTS
:
3694 struct lttng_event
*events
= NULL
;
3696 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3697 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3699 /* Return value is a negative lttng_error_code. */
3704 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3710 /* Copy event list into message payload */
3711 memcpy(cmd_ctx
->llm
->payload
, events
,
3712 nb_event
* sizeof(struct lttng_event
));
3719 case LTTNG_LIST_SESSIONS
:
3721 unsigned int nr_sessions
;
3723 session_lock_list();
3724 nr_sessions
= lttng_sessions_count(
3725 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3726 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3728 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3730 session_unlock_list();
3734 /* Filled the session array */
3735 cmd_list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3736 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3737 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3739 session_unlock_list();
3744 case LTTNG_CALIBRATE
:
3746 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3747 &cmd_ctx
->lsm
->u
.calibrate
);
3750 case LTTNG_REGISTER_CONSUMER
:
3752 struct consumer_data
*cdata
;
3754 switch (cmd_ctx
->lsm
->domain
.type
) {
3755 case LTTNG_DOMAIN_KERNEL
:
3756 cdata
= &kconsumer_data
;
3759 ret
= LTTNG_ERR_UND
;
3763 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3764 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
3767 case LTTNG_DATA_PENDING
:
3769 ret
= cmd_data_pending(cmd_ctx
->session
);
3772 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3774 struct lttcomm_lttng_output_id reply
;
3776 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
3777 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
3778 if (ret
!= LTTNG_OK
) {
3782 ret
= setup_lttng_msg(cmd_ctx
, sizeof(reply
));
3787 /* Copy output list into message payload */
3788 memcpy(cmd_ctx
->llm
->payload
, &reply
, sizeof(reply
));
3792 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3794 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
3795 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
3798 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3801 struct lttng_snapshot_output
*outputs
= NULL
;
3803 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
3804 if (nb_output
< 0) {
3809 ret
= setup_lttng_msg(cmd_ctx
,
3810 nb_output
* sizeof(struct lttng_snapshot_output
));
3817 /* Copy output list into message payload */
3818 memcpy(cmd_ctx
->llm
->payload
, outputs
,
3819 nb_output
* sizeof(struct lttng_snapshot_output
));
3826 case LTTNG_SNAPSHOT_RECORD
:
3828 ret
= cmd_snapshot_record(cmd_ctx
->session
,
3829 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
3830 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
3833 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3836 struct lttng_uri
*uris
= NULL
;
3838 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3839 len
= nb_uri
* sizeof(struct lttng_uri
);
3842 uris
= zmalloc(len
);
3844 ret
= LTTNG_ERR_FATAL
;
3848 /* Receive variable len data */
3849 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3850 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3852 DBG("No URIs received from client... continuing");
3854 ret
= LTTNG_ERR_SESSION_FAIL
;
3859 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3860 DBG("Creating session with ONE network URI is a bad call");
3861 ret
= LTTNG_ERR_SESSION_FAIL
;
3867 ret
= cmd_create_session_snapshot(cmd_ctx
->lsm
->session
.name
, uris
,
3868 nb_uri
, &cmd_ctx
->creds
);
3872 case LTTNG_CREATE_SESSION_LIVE
:
3875 struct lttng_uri
*uris
= NULL
;
3877 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3878 len
= nb_uri
* sizeof(struct lttng_uri
);
3881 uris
= zmalloc(len
);
3883 ret
= LTTNG_ERR_FATAL
;
3887 /* Receive variable len data */
3888 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3889 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3891 DBG("No URIs received from client... continuing");
3893 ret
= LTTNG_ERR_SESSION_FAIL
;
3898 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3899 DBG("Creating session with ONE network URI is a bad call");
3900 ret
= LTTNG_ERR_SESSION_FAIL
;
3906 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
,
3907 nb_uri
, &cmd_ctx
->creds
, cmd_ctx
->lsm
->u
.session_live
.timer_interval
);
3911 case LTTNG_SAVE_SESSION
:
3913 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
3917 case LTTNG_SET_SESSION_SHM_PATH
:
3919 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
3920 cmd_ctx
->lsm
->u
.set_shm_path
.shm_path
);
3924 ret
= LTTNG_ERR_UND
;
3929 if (cmd_ctx
->llm
== NULL
) {
3930 DBG("Missing llm structure. Allocating one.");
3931 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3935 /* Set return code */
3936 cmd_ctx
->llm
->ret_code
= ret
;
3938 if (cmd_ctx
->session
) {
3939 session_unlock(cmd_ctx
->session
);
3941 if (need_tracing_session
) {
3942 session_unlock_list();
3949 * Thread managing health check socket.
3951 static void *thread_manage_health(void *data
)
3953 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
3954 uint32_t revents
, nb_fd
;
3955 struct lttng_poll_event events
;
3956 struct health_comm_msg msg
;
3957 struct health_comm_reply reply
;
3959 DBG("[thread] Manage health check started");
3961 rcu_register_thread();
3963 /* We might hit an error path before this is created. */
3964 lttng_poll_init(&events
);
3966 /* Create unix socket */
3967 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
3969 ERR("Unable to create health check Unix socket");
3975 /* lttng health client socket path permissions */
3976 ret
= chown(health_unix_sock_path
, 0,
3977 utils_get_group_id(tracing_group_name
));
3979 ERR("Unable to set group on %s", health_unix_sock_path
);
3985 ret
= chmod(health_unix_sock_path
,
3986 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3988 ERR("Unable to set permissions on %s", health_unix_sock_path
);
3996 * Set the CLOEXEC flag. Return code is useless because either way, the
3999 (void) utils_set_fd_cloexec(sock
);
4001 ret
= lttcomm_listen_unix_sock(sock
);
4007 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4008 * more will be added to this poll set.
4010 ret
= sessiond_set_thread_pollset(&events
, 2);
4015 /* Add the application registration socket */
4016 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
4021 sessiond_notify_ready();
4024 DBG("Health check ready");
4026 /* Inifinite blocking call, waiting for transmission */
4028 ret
= lttng_poll_wait(&events
, -1);
4031 * Restart interrupted system call.
4033 if (errno
== EINTR
) {
4041 for (i
= 0; i
< nb_fd
; i
++) {
4042 /* Fetch once the poll data */
4043 revents
= LTTNG_POLL_GETEV(&events
, i
);
4044 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4047 /* No activity for this FD (poll implementation). */
4051 /* Thread quit pipe has been closed. Killing thread. */
4052 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4058 /* Event on the registration socket */
4059 if (pollfd
== sock
) {
4060 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4061 ERR("Health socket poll error");
4067 new_sock
= lttcomm_accept_unix_sock(sock
);
4073 * Set the CLOEXEC flag. Return code is useless because either way, the
4076 (void) utils_set_fd_cloexec(new_sock
);
4078 DBG("Receiving data from client for health...");
4079 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
4081 DBG("Nothing recv() from client... continuing");
4082 ret
= close(new_sock
);
4090 rcu_thread_online();
4092 memset(&reply
, 0, sizeof(reply
));
4093 for (i
= 0; i
< NR_HEALTH_SESSIOND_TYPES
; i
++) {
4095 * health_check_state returns 0 if health is
4098 if (!health_check_state(health_sessiond
, i
)) {
4099 reply
.ret_code
|= 1ULL << i
;
4103 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
4105 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
4107 ERR("Failed to send health data back to client");
4110 /* End of transmission */
4111 ret
= close(new_sock
);
4121 ERR("Health error occurred in %s", __func__
);
4123 DBG("Health check thread dying");
4124 unlink(health_unix_sock_path
);
4132 lttng_poll_clean(&events
);
4134 rcu_unregister_thread();
4139 * This thread manage all clients request using the unix client socket for
4142 static void *thread_manage_clients(void *data
)
4144 int sock
= -1, ret
, i
, pollfd
, err
= -1;
4146 uint32_t revents
, nb_fd
;
4147 struct command_ctx
*cmd_ctx
= NULL
;
4148 struct lttng_poll_event events
;
4150 DBG("[thread] Manage client started");
4152 rcu_register_thread();
4154 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
4156 health_code_update();
4158 ret
= lttcomm_listen_unix_sock(client_sock
);
4164 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4165 * more will be added to this poll set.
4167 ret
= sessiond_set_thread_pollset(&events
, 2);
4169 goto error_create_poll
;
4172 /* Add the application registration socket */
4173 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
4178 sessiond_notify_ready();
4179 ret
= sem_post(&load_info
->message_thread_ready
);
4181 PERROR("sem_post message_thread_ready");
4185 /* This testpoint is after we signal readiness to the parent. */
4186 if (testpoint(sessiond_thread_manage_clients
)) {
4190 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
4194 health_code_update();
4197 DBG("Accepting client command ...");
4199 /* Inifinite blocking call, waiting for transmission */
4201 health_poll_entry();
4202 ret
= lttng_poll_wait(&events
, -1);
4206 * Restart interrupted system call.
4208 if (errno
== EINTR
) {
4216 for (i
= 0; i
< nb_fd
; i
++) {
4217 /* Fetch once the poll data */
4218 revents
= LTTNG_POLL_GETEV(&events
, i
);
4219 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4221 health_code_update();
4224 /* No activity for this FD (poll implementation). */
4228 /* Thread quit pipe has been closed. Killing thread. */
4229 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4235 /* Event on the registration socket */
4236 if (pollfd
== client_sock
) {
4237 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4238 ERR("Client socket poll error");
4244 DBG("Wait for client response");
4246 health_code_update();
4248 sock
= lttcomm_accept_unix_sock(client_sock
);
4254 * Set the CLOEXEC flag. Return code is useless because either way, the
4257 (void) utils_set_fd_cloexec(sock
);
4259 /* Set socket option for credentials retrieval */
4260 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
4265 /* Allocate context command to process the client request */
4266 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
4267 if (cmd_ctx
== NULL
) {
4268 PERROR("zmalloc cmd_ctx");
4272 /* Allocate data buffer for reception */
4273 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
4274 if (cmd_ctx
->lsm
== NULL
) {
4275 PERROR("zmalloc cmd_ctx->lsm");
4279 cmd_ctx
->llm
= NULL
;
4280 cmd_ctx
->session
= NULL
;
4282 health_code_update();
4285 * Data is received from the lttng client. The struct
4286 * lttcomm_session_msg (lsm) contains the command and data request of
4289 DBG("Receiving data from client ...");
4290 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
4291 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
4293 DBG("Nothing recv() from client... continuing");
4299 clean_command_ctx(&cmd_ctx
);
4303 health_code_update();
4305 // TODO: Validate cmd_ctx including sanity check for
4306 // security purpose.
4308 rcu_thread_online();
4310 * This function dispatch the work to the kernel or userspace tracer
4311 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4312 * informations for the client. The command context struct contains
4313 * everything this function may needs.
4315 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
4316 rcu_thread_offline();
4324 * TODO: Inform client somehow of the fatal error. At
4325 * this point, ret < 0 means that a zmalloc failed
4326 * (ENOMEM). Error detected but still accept
4327 * command, unless a socket error has been
4330 clean_command_ctx(&cmd_ctx
);
4334 health_code_update();
4336 DBG("Sending response (size: %d, retcode: %s (%d))",
4337 cmd_ctx
->lttng_msg_size
,
4338 lttng_strerror(-cmd_ctx
->llm
->ret_code
),
4339 cmd_ctx
->llm
->ret_code
);
4340 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
4342 ERR("Failed to send data back to client");
4345 /* End of transmission */
4352 clean_command_ctx(&cmd_ctx
);
4354 health_code_update();
4366 lttng_poll_clean(&events
);
4367 clean_command_ctx(&cmd_ctx
);
4371 unlink(client_unix_sock_path
);
4372 if (client_sock
>= 0) {
4373 ret
= close(client_sock
);
4381 ERR("Health error occurred in %s", __func__
);
4384 health_unregister(health_sessiond
);
4386 DBG("Client thread dying");
4388 rcu_unregister_thread();
4391 * Since we are creating the consumer threads, we own them, so we need
4392 * to join them before our thread exits.
4394 ret
= join_consumer_thread(&kconsumer_data
);
4397 PERROR("join_consumer");
4400 ret
= join_consumer_thread(&ustconsumer32_data
);
4403 PERROR("join_consumer ust32");
4406 ret
= join_consumer_thread(&ustconsumer64_data
);
4409 PERROR("join_consumer ust64");
4416 * usage function on stderr
4418 static void usage(void)
4420 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
4421 fprintf(stderr
, " -h, --help Display this usage.\n");
4422 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
4423 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
4424 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
4425 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
4426 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
4427 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
4428 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
4429 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
4430 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
4431 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
4432 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
4433 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
4434 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
4435 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
4436 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
4437 fprintf(stderr
, " -V, --version Show version number.\n");
4438 fprintf(stderr
, " -S, --sig-parent Send SIGUSR1 to parent pid to notify readiness.\n");
4439 fprintf(stderr
, " -q, --quiet No output at all.\n");
4440 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
4441 fprintf(stderr
, " -p, --pidfile FILE Write a pid to FILE name overriding the default value.\n");
4442 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
4443 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
4444 fprintf(stderr
, " --agent-tcp-port Agent registration TCP port\n");
4445 fprintf(stderr
, " -f --config PATH Load daemon configuration file\n");
4446 fprintf(stderr
, " -l --load PATH Load session configuration\n");
4447 fprintf(stderr
, " --kmod-probes Specify kernel module probes to load\n");
4448 fprintf(stderr
, " --extra-kmod-probes Specify extra kernel module probes to load\n");
4451 static int string_match(const char *str1
, const char *str2
)
4453 return (str1
&& str2
) && !strcmp(str1
, str2
);
4457 * Take an option from the getopt output and set it in the right variable to be
4460 * Return 0 on success else a negative value.
4462 static int set_option(int opt
, const char *arg
, const char *optname
)
4466 if (arg
&& arg
[0] == '\0') {
4468 * This only happens if the value is read from daemon config
4469 * file. This means the option requires an argument and the
4470 * configuration file contains a line such as:
4477 if (string_match(optname
, "client-sock") || opt
== 'c') {
4478 if (lttng_is_setuid_setgid()) {
4479 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4480 "-c, --client-sock");
4482 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", arg
);
4484 } else if (string_match(optname
, "apps-sock") || opt
== 'a') {
4485 if (lttng_is_setuid_setgid()) {
4486 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4489 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", arg
);
4491 } else if (string_match(optname
, "daemonize") || opt
== 'd') {
4493 } else if (string_match(optname
, "background") || opt
== 'b') {
4495 } else if (string_match(optname
, "group") || opt
== 'g') {
4496 if (lttng_is_setuid_setgid()) {
4497 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4501 * If the override option is set, the pointer points to a
4502 * *non* const thus freeing it even though the variable type is
4505 if (tracing_group_name_override
) {
4506 free((void *) tracing_group_name
);
4508 tracing_group_name
= strdup(arg
);
4509 if (!tracing_group_name
) {
4513 tracing_group_name_override
= 1;
4515 } else if (string_match(optname
, "help") || opt
== 'h') {
4518 } else if (string_match(optname
, "version") || opt
== 'V') {
4519 fprintf(stdout
, "%s\n", VERSION
);
4521 } else if (string_match(optname
, "sig-parent") || opt
== 'S') {
4523 } else if (string_match(optname
, "kconsumerd-err-sock")) {
4524 if (lttng_is_setuid_setgid()) {
4525 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4526 "--kconsumerd-err-sock");
4528 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4530 } else if (string_match(optname
, "kconsumerd-cmd-sock")) {
4531 if (lttng_is_setuid_setgid()) {
4532 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4533 "--kconsumerd-cmd-sock");
4535 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4537 } else if (string_match(optname
, "ustconsumerd64-err-sock")) {
4538 if (lttng_is_setuid_setgid()) {
4539 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4540 "--ustconsumerd64-err-sock");
4542 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4544 } else if (string_match(optname
, "ustconsumerd64-cmd-sock")) {
4545 if (lttng_is_setuid_setgid()) {
4546 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4547 "--ustconsumerd64-cmd-sock");
4549 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4551 } else if (string_match(optname
, "ustconsumerd32-err-sock")) {
4552 if (lttng_is_setuid_setgid()) {
4553 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4554 "--ustconsumerd32-err-sock");
4556 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4558 } else if (string_match(optname
, "ustconsumerd32-cmd-sock")) {
4559 if (lttng_is_setuid_setgid()) {
4560 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4561 "--ustconsumerd32-cmd-sock");
4563 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4565 } else if (string_match(optname
, "no-kernel")) {
4567 } else if (string_match(optname
, "quiet") || opt
== 'q') {
4568 lttng_opt_quiet
= 1;
4569 } else if (string_match(optname
, "verbose") || opt
== 'v') {
4570 /* Verbose level can increase using multiple -v */
4572 /* Value obtained from config file */
4573 lttng_opt_verbose
= config_parse_value(arg
);
4575 /* -v used on command line */
4576 lttng_opt_verbose
++;
4578 /* Clamp value to [0, 3] */
4579 lttng_opt_verbose
= lttng_opt_verbose
< 0 ? 0 :
4580 (lttng_opt_verbose
<= 3 ? lttng_opt_verbose
: 3);
4581 } else if (string_match(optname
, "verbose-consumer")) {
4583 opt_verbose_consumer
= config_parse_value(arg
);
4585 opt_verbose_consumer
+= 1;
4587 } else if (string_match(optname
, "consumerd32-path")) {
4588 if (lttng_is_setuid_setgid()) {
4589 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4590 "--consumerd32-path");
4592 if (consumerd32_bin_override
) {
4593 free((void *) consumerd32_bin
);
4595 consumerd32_bin
= strdup(arg
);
4596 if (!consumerd32_bin
) {
4600 consumerd32_bin_override
= 1;
4602 } else if (string_match(optname
, "consumerd32-libdir")) {
4603 if (lttng_is_setuid_setgid()) {
4604 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4605 "--consumerd32-libdir");
4607 if (consumerd32_libdir_override
) {
4608 free((void *) consumerd32_libdir
);
4610 consumerd32_libdir
= strdup(arg
);
4611 if (!consumerd32_libdir
) {
4615 consumerd32_libdir_override
= 1;
4617 } else if (string_match(optname
, "consumerd64-path")) {
4618 if (lttng_is_setuid_setgid()) {
4619 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4620 "--consumerd64-path");
4622 if (consumerd64_bin_override
) {
4623 free((void *) consumerd64_bin
);
4625 consumerd64_bin
= strdup(arg
);
4626 if (!consumerd64_bin
) {
4630 consumerd64_bin_override
= 1;
4632 } else if (string_match(optname
, "consumerd64-libdir")) {
4633 if (lttng_is_setuid_setgid()) {
4634 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4635 "--consumerd64-libdir");
4637 if (consumerd64_libdir_override
) {
4638 free((void *) consumerd64_libdir
);
4640 consumerd64_libdir
= strdup(arg
);
4641 if (!consumerd64_libdir
) {
4645 consumerd64_libdir_override
= 1;
4647 } else if (string_match(optname
, "pidfile") || opt
== 'p') {
4648 if (lttng_is_setuid_setgid()) {
4649 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4653 opt_pidfile
= strdup(arg
);
4659 } else if (string_match(optname
, "agent-tcp-port")) {
4660 if (lttng_is_setuid_setgid()) {
4661 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4662 "--agent-tcp-port");
4671 v
= strtoul(arg
, NULL
, 0);
4672 if (errno
!= 0 || !isdigit(arg
[0])) {
4673 ERR("Wrong value in --agent-tcp-port parameter: %s", arg
);
4676 if (v
== 0 || v
>= 65535) {
4677 ERR("Port overflow in --agent-tcp-port parameter: %s", arg
);
4680 agent_tcp_port
= (uint32_t) v
;
4681 DBG3("Agent TCP port set to non default: %u", agent_tcp_port
);
4683 } else if (string_match(optname
, "load") || opt
== 'l') {
4684 if (lttng_is_setuid_setgid()) {
4685 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4688 free(opt_load_session_path
);
4689 opt_load_session_path
= strdup(arg
);
4690 if (!opt_load_session_path
) {
4695 } else if (string_match(optname
, "kmod-probes")) {
4696 if (lttng_is_setuid_setgid()) {
4697 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4700 free(kmod_probes_list
);
4701 kmod_probes_list
= strdup(arg
);
4702 if (!kmod_probes_list
) {
4707 } else if (string_match(optname
, "extra-kmod-probes")) {
4708 if (lttng_is_setuid_setgid()) {
4709 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4710 "--extra-kmod-probes");
4712 free(kmod_extra_probes_list
);
4713 kmod_extra_probes_list
= strdup(arg
);
4714 if (!kmod_extra_probes_list
) {
4719 } else if (string_match(optname
, "config") || opt
== 'f') {
4720 /* This is handled in set_options() thus silent skip. */
4723 /* Unknown option or other error.
4724 * Error is printed by getopt, just return */
4729 if (ret
== -EINVAL
) {
4730 const char *opt_name
= "unknown";
4733 for (i
= 0; i
< sizeof(long_options
) / sizeof(struct option
);
4735 if (opt
== long_options
[i
].val
) {
4736 opt_name
= long_options
[i
].name
;
4741 WARN("Invalid argument provided for option \"%s\", using default value.",
4749 * config_entry_handler_cb used to handle options read from a config file.
4750 * See config_entry_handler_cb comment in common/config/config.h for the
4751 * return value conventions.
4753 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
4757 if (!entry
|| !entry
->name
|| !entry
->value
) {
4762 /* Check if the option is to be ignored */
4763 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
4764 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
4769 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1;
4772 /* Ignore if not fully matched. */
4773 if (strcmp(entry
->name
, long_options
[i
].name
)) {
4778 * If the option takes no argument on the command line, we have to
4779 * check if the value is "true". We support non-zero numeric values,
4782 if (!long_options
[i
].has_arg
) {
4783 ret
= config_parse_value(entry
->value
);
4786 WARN("Invalid configuration value \"%s\" for option %s",
4787 entry
->value
, entry
->name
);
4789 /* False, skip boolean config option. */
4794 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
4798 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry
->name
);
4805 * daemon configuration loading and argument parsing
4807 static int set_options(int argc
, char **argv
)
4809 int ret
= 0, c
= 0, option_index
= 0;
4810 int orig_optopt
= optopt
, orig_optind
= optind
;
4812 const char *config_path
= NULL
;
4814 optstring
= utils_generate_optstring(long_options
,
4815 sizeof(long_options
) / sizeof(struct option
));
4821 /* Check for the --config option */
4822 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
4823 &option_index
)) != -1) {
4827 } else if (c
!= 'f') {
4828 /* if not equal to --config option. */
4832 if (lttng_is_setuid_setgid()) {
4833 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4836 config_path
= utils_expand_path(optarg
);
4838 ERR("Failed to resolve path: %s", optarg
);
4843 ret
= config_get_section_entries(config_path
, config_section_name
,
4844 config_entry_handler
, NULL
);
4847 ERR("Invalid configuration option at line %i", ret
);
4853 /* Reset getopt's global state */
4854 optopt
= orig_optopt
;
4855 optind
= orig_optind
;
4859 * getopt_long() will not set option_index if it encounters a
4862 c
= getopt_long(argc
, argv
, optstring
, long_options
,
4869 * Pass NULL as the long option name if popt left the index
4872 ret
= set_option(c
, optarg
,
4873 option_index
< 0 ? NULL
:
4874 long_options
[option_index
].name
);
4886 * Creates the two needed socket by the daemon.
4887 * apps_sock - The communication socket for all UST apps.
4888 * client_sock - The communication of the cli tool (lttng).
4890 static int init_daemon_socket(void)
4895 old_umask
= umask(0);
4897 /* Create client tool unix socket */
4898 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4899 if (client_sock
< 0) {
4900 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4905 /* Set the cloexec flag */
4906 ret
= utils_set_fd_cloexec(client_sock
);
4908 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
4909 "Continuing but note that the consumer daemon will have a "
4910 "reference to this socket on exec()", client_sock
);
4913 /* File permission MUST be 660 */
4914 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4916 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4921 /* Create the application unix socket */
4922 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4923 if (apps_sock
< 0) {
4924 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4929 /* Set the cloexec flag */
4930 ret
= utils_set_fd_cloexec(apps_sock
);
4932 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
4933 "Continuing but note that the consumer daemon will have a "
4934 "reference to this socket on exec()", apps_sock
);
4937 /* File permission MUST be 666 */
4938 ret
= chmod(apps_unix_sock_path
,
4939 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4941 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4946 DBG3("Session daemon client socket %d and application socket %d created",
4947 client_sock
, apps_sock
);
4955 * Check if the global socket is available, and if a daemon is answering at the
4956 * other side. If yes, error is returned.
4958 static int check_existing_daemon(void)
4960 /* Is there anybody out there ? */
4961 if (lttng_session_daemon_alive()) {
4969 * Set the tracing group gid onto the client socket.
4971 * Race window between mkdir and chown is OK because we are going from more
4972 * permissive (root.root) to less permissive (root.tracing).
4974 static int set_permissions(char *rundir
)
4979 gid
= utils_get_group_id(tracing_group_name
);
4981 /* Set lttng run dir */
4982 ret
= chown(rundir
, 0, gid
);
4984 ERR("Unable to set group on %s", rundir
);
4989 * Ensure all applications and tracing group can search the run
4990 * dir. Allow everyone to read the directory, since it does not
4991 * buy us anything to hide its content.
4993 ret
= chmod(rundir
, S_IRWXU
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
4995 ERR("Unable to set permissions on %s", rundir
);
4999 /* lttng client socket path */
5000 ret
= chown(client_unix_sock_path
, 0, gid
);
5002 ERR("Unable to set group on %s", client_unix_sock_path
);
5006 /* kconsumer error socket path */
5007 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, 0);
5009 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5013 /* 64-bit ustconsumer error socket path */
5014 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, 0);
5016 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5020 /* 32-bit ustconsumer compat32 error socket path */
5021 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, 0);
5023 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5027 DBG("All permissions are set");
5033 * Create the lttng run directory needed for all global sockets and pipe.
5035 static int create_lttng_rundir(const char *rundir
)
5039 DBG3("Creating LTTng run directory: %s", rundir
);
5041 ret
= mkdir(rundir
, S_IRWXU
);
5043 if (errno
!= EEXIST
) {
5044 ERR("Unable to create %s", rundir
);
5056 * Setup sockets and directory needed by the kconsumerd communication with the
5059 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5063 char path
[PATH_MAX
];
5065 switch (consumer_data
->type
) {
5066 case LTTNG_CONSUMER_KERNEL
:
5067 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5069 case LTTNG_CONSUMER64_UST
:
5070 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5072 case LTTNG_CONSUMER32_UST
:
5073 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5076 ERR("Consumer type unknown");
5081 DBG2("Creating consumer directory: %s", path
);
5083 ret
= mkdir(path
, S_IRWXU
| S_IRGRP
| S_IXGRP
);
5085 if (errno
!= EEXIST
) {
5087 ERR("Failed to create %s", path
);
5093 ret
= chown(path
, 0, utils_get_group_id(tracing_group_name
));
5095 ERR("Unable to set group on %s", path
);
5101 /* Create the kconsumerd error unix socket */
5102 consumer_data
->err_sock
=
5103 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5104 if (consumer_data
->err_sock
< 0) {
5105 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5111 * Set the CLOEXEC flag. Return code is useless because either way, the
5114 ret
= utils_set_fd_cloexec(consumer_data
->err_sock
);
5116 PERROR("utils_set_fd_cloexec");
5117 /* continue anyway */
5120 /* File permission MUST be 660 */
5121 ret
= chmod(consumer_data
->err_unix_sock_path
,
5122 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5124 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5134 * Signal handler for the daemon
5136 * Simply stop all worker threads, leaving main() return gracefully after
5137 * joining all threads and calling cleanup().
5139 static void sighandler(int sig
)
5143 DBG("SIGPIPE caught");
5146 DBG("SIGINT caught");
5150 DBG("SIGTERM caught");
5154 CMM_STORE_SHARED(recv_child_signal
, 1);
5162 * Setup signal handler for :
5163 * SIGINT, SIGTERM, SIGPIPE
5165 static int set_signal_handler(void)
5168 struct sigaction sa
;
5171 if ((ret
= sigemptyset(&sigset
)) < 0) {
5172 PERROR("sigemptyset");
5176 sa
.sa_handler
= sighandler
;
5177 sa
.sa_mask
= sigset
;
5179 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5180 PERROR("sigaction");
5184 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5185 PERROR("sigaction");
5189 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5190 PERROR("sigaction");
5194 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
5195 PERROR("sigaction");
5199 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
5205 * Set open files limit to unlimited. This daemon can open a large number of
5206 * file descriptors in order to consumer multiple kernel traces.
5208 static void set_ulimit(void)
5213 /* The kernel does not allowed an infinite limit for open files */
5214 lim
.rlim_cur
= 65535;
5215 lim
.rlim_max
= 65535;
5217 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5219 PERROR("failed to set open files limit");
5224 * Write pidfile using the rundir and opt_pidfile.
5226 static int write_pidfile(void)
5229 char pidfile_path
[PATH_MAX
];
5234 strncpy(pidfile_path
, opt_pidfile
, sizeof(pidfile_path
));
5236 /* Build pidfile path from rundir and opt_pidfile. */
5237 ret
= snprintf(pidfile_path
, sizeof(pidfile_path
), "%s/"
5238 DEFAULT_LTTNG_SESSIOND_PIDFILE
, rundir
);
5240 PERROR("snprintf pidfile path");
5246 * Create pid file in rundir.
5248 ret
= utils_create_pid_file(getpid(), pidfile_path
);
5254 * Create lockfile using the rundir and return its fd.
5256 static int create_lockfile(void)
5259 char lockfile_path
[PATH_MAX
];
5261 ret
= generate_lock_file_path(lockfile_path
, sizeof(lockfile_path
));
5266 ret
= utils_create_lock_file(lockfile_path
);
5272 * Write agent TCP port using the rundir.
5274 static int write_agent_port(void)
5277 char path
[PATH_MAX
];
5281 ret
= snprintf(path
, sizeof(path
), "%s/"
5282 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
, rundir
);
5284 PERROR("snprintf agent port path");
5289 * Create TCP agent port file in rundir.
5291 ret
= utils_create_pid_file(agent_tcp_port
, path
);
5300 int main(int argc
, char **argv
)
5302 int ret
= 0, retval
= 0;
5304 const char *home_path
, *env_app_timeout
;
5306 init_kernel_workarounds();
5308 rcu_register_thread();
5310 if (set_signal_handler()) {
5312 goto exit_set_signal_handler
;
5315 setup_consumerd_path();
5317 page_size
= sysconf(_SC_PAGESIZE
);
5318 if (page_size
< 0) {
5319 PERROR("sysconf _SC_PAGESIZE");
5320 page_size
= LONG_MAX
;
5321 WARN("Fallback page size to %ld", page_size
);
5325 * Parse arguments and load the daemon configuration file.
5327 * We have an exit_options exit path to free memory reserved by
5328 * set_options. This is needed because the rest of sessiond_cleanup()
5329 * depends on ht_cleanup_thread, which depends on lttng_daemonize, which
5330 * depends on set_options.
5333 if (set_options(argc
, argv
)) {
5339 if (opt_daemon
|| opt_background
) {
5342 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
5350 * We are in the child. Make sure all other file descriptors are
5351 * closed, in case we are called with more opened file
5352 * descriptors than the standard ones.
5354 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5360 * Starting from here, we can create threads. This needs to be after
5361 * lttng_daemonize due to RCU.
5365 * Initialize the health check subsystem. This call should set the
5366 * appropriate time values.
5368 health_sessiond
= health_app_create(NR_HEALTH_SESSIOND_TYPES
);
5369 if (!health_sessiond
) {
5370 PERROR("health_app_create error");
5372 goto exit_health_sessiond_cleanup
;
5375 if (init_ht_cleanup_quit_pipe()) {
5377 goto exit_ht_cleanup_quit_pipe
;
5380 /* Setup the thread ht_cleanup communication pipe. */
5381 if (utils_create_pipe_cloexec(ht_cleanup_pipe
)) {
5383 goto exit_ht_cleanup_pipe
;
5386 /* Set up max poll set size */
5387 if (lttng_poll_set_max_size()) {
5389 goto exit_set_max_size
;
5392 /* Create thread to clean up RCU hash tables */
5393 ret
= pthread_create(&ht_cleanup_thread
, NULL
,
5394 thread_ht_cleanup
, (void *) NULL
);
5397 PERROR("pthread_create ht_cleanup");
5399 goto exit_ht_cleanup
;
5402 /* Create thread quit pipe */
5403 if (init_thread_quit_pipe()) {
5405 goto exit_init_data
;
5408 /* Check if daemon is UID = 0 */
5409 is_root
= !getuid();
5412 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5415 goto exit_init_data
;
5418 /* Create global run dir with root access */
5419 if (create_lttng_rundir(rundir
)) {
5421 goto exit_init_data
;
5424 if (strlen(apps_unix_sock_path
) == 0) {
5425 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5426 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5429 goto exit_init_data
;
5433 if (strlen(client_unix_sock_path
) == 0) {
5434 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5435 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5438 goto exit_init_data
;
5442 /* Set global SHM for ust */
5443 if (strlen(wait_shm_path
) == 0) {
5444 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5445 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5448 goto exit_init_data
;
5452 if (strlen(health_unix_sock_path
) == 0) {
5453 ret
= snprintf(health_unix_sock_path
,
5454 sizeof(health_unix_sock_path
),
5455 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5458 goto exit_init_data
;
5462 /* Setup kernel consumerd path */
5463 ret
= snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5464 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5467 goto exit_init_data
;
5469 ret
= snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5470 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5473 goto exit_init_data
;
5476 DBG2("Kernel consumer err path: %s",
5477 kconsumer_data
.err_unix_sock_path
);
5478 DBG2("Kernel consumer cmd path: %s",
5479 kconsumer_data
.cmd_unix_sock_path
);
5481 home_path
= utils_get_home_dir();
5482 if (home_path
== NULL
) {
5483 /* TODO: Add --socket PATH option */
5484 ERR("Can't get HOME directory for sockets creation.");
5486 goto exit_init_data
;
5490 * Create rundir from home path. This will create something like
5493 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5496 goto exit_init_data
;
5499 if (create_lttng_rundir(rundir
)) {
5501 goto exit_init_data
;
5504 if (strlen(apps_unix_sock_path
) == 0) {
5505 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5506 DEFAULT_HOME_APPS_UNIX_SOCK
,
5510 goto exit_init_data
;
5514 /* Set the cli tool unix socket path */
5515 if (strlen(client_unix_sock_path
) == 0) {
5516 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5517 DEFAULT_HOME_CLIENT_UNIX_SOCK
,
5521 goto exit_init_data
;
5525 /* Set global SHM for ust */
5526 if (strlen(wait_shm_path
) == 0) {
5527 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5528 DEFAULT_HOME_APPS_WAIT_SHM_PATH
,
5532 goto exit_init_data
;
5536 /* Set health check Unix path */
5537 if (strlen(health_unix_sock_path
) == 0) {
5538 ret
= snprintf(health_unix_sock_path
,
5539 sizeof(health_unix_sock_path
),
5540 DEFAULT_HOME_HEALTH_UNIX_SOCK
,
5544 goto exit_init_data
;
5549 lockfile_fd
= create_lockfile();
5550 if (lockfile_fd
< 0) {
5552 goto exit_init_data
;
5555 /* Set consumer initial state */
5556 kernel_consumerd_state
= CONSUMER_STOPPED
;
5557 ust_consumerd_state
= CONSUMER_STOPPED
;
5559 DBG("Client socket path %s", client_unix_sock_path
);
5560 DBG("Application socket path %s", apps_unix_sock_path
);
5561 DBG("Application wait path %s", wait_shm_path
);
5562 DBG("LTTng run directory path: %s", rundir
);
5564 /* 32 bits consumerd path setup */
5565 ret
= snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
5566 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
5568 PERROR("snprintf 32-bit consumer error socket path");
5570 goto exit_init_data
;
5572 ret
= snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
5573 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
5575 PERROR("snprintf 32-bit consumer command socket path");
5577 goto exit_init_data
;
5580 DBG2("UST consumer 32 bits err path: %s",
5581 ustconsumer32_data
.err_unix_sock_path
);
5582 DBG2("UST consumer 32 bits cmd path: %s",
5583 ustconsumer32_data
.cmd_unix_sock_path
);
5585 /* 64 bits consumerd path setup */
5586 ret
= snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
5587 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
5589 PERROR("snprintf 64-bit consumer error socket path");
5591 goto exit_init_data
;
5593 ret
= snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
5594 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
5596 PERROR("snprintf 64-bit consumer command socket path");
5598 goto exit_init_data
;
5601 DBG2("UST consumer 64 bits err path: %s",
5602 ustconsumer64_data
.err_unix_sock_path
);
5603 DBG2("UST consumer 64 bits cmd path: %s",
5604 ustconsumer64_data
.cmd_unix_sock_path
);
5607 * See if daemon already exist.
5609 if (check_existing_daemon()) {
5610 ERR("Already running daemon.\n");
5612 * We do not goto exit because we must not cleanup()
5613 * because a daemon is already running.
5616 goto exit_init_data
;
5620 * Init UST app hash table. Alloc hash table before this point since
5621 * cleanup() can get called after that point.
5623 if (ust_app_ht_alloc()) {
5624 ERR("Failed to allocate UST app hash table");
5626 goto exit_init_data
;
5630 * Initialize agent app hash table. We allocate the hash table here
5631 * since cleanup() can get called after this point.
5633 if (agent_app_ht_alloc()) {
5634 ERR("Failed to allocate Agent app hash table");
5636 goto exit_init_data
;
5640 * These actions must be executed as root. We do that *after* setting up
5641 * the sockets path because we MUST make the check for another daemon using
5642 * those paths *before* trying to set the kernel consumer sockets and init
5646 if (set_consumer_sockets(&kconsumer_data
, rundir
)) {
5648 goto exit_init_data
;
5651 /* Setup kernel tracer */
5652 if (!opt_no_kernel
) {
5653 init_kernel_tracer();
5654 if (kernel_tracer_fd
>= 0) {
5655 ret
= syscall_init_table();
5657 ERR("Unable to populate syscall table. "
5658 "Syscall tracing won't work "
5659 "for this session daemon.");
5664 /* Set ulimit for open files */
5667 /* init lttng_fd tracking must be done after set_ulimit. */
5670 if (set_consumer_sockets(&ustconsumer64_data
, rundir
)) {
5672 goto exit_init_data
;
5675 if (set_consumer_sockets(&ustconsumer32_data
, rundir
)) {
5677 goto exit_init_data
;
5680 /* Setup the needed unix socket */
5681 if (init_daemon_socket()) {
5683 goto exit_init_data
;
5686 /* Set credentials to socket */
5687 if (is_root
&& set_permissions(rundir
)) {
5689 goto exit_init_data
;
5692 /* Get parent pid if -S, --sig-parent is specified. */
5693 if (opt_sig_parent
) {
5697 /* Setup the kernel pipe for waking up the kernel thread */
5698 if (is_root
&& !opt_no_kernel
) {
5699 if (utils_create_pipe_cloexec(kernel_poll_pipe
)) {
5701 goto exit_init_data
;
5705 /* Setup the thread apps communication pipe. */
5706 if (utils_create_pipe_cloexec(apps_cmd_pipe
)) {
5708 goto exit_init_data
;
5711 /* Setup the thread apps notify communication pipe. */
5712 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe
)) {
5714 goto exit_init_data
;
5717 /* Initialize global buffer per UID and PID registry. */
5718 buffer_reg_init_uid_registry();
5719 buffer_reg_init_pid_registry();
5721 /* Init UST command queue. */
5722 cds_wfcq_init(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
5725 * Get session list pointer. This pointer MUST NOT be free'd. This list
5726 * is statically declared in session.c
5728 session_list_ptr
= session_get_list();
5732 /* Check for the application socket timeout env variable. */
5733 env_app_timeout
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
5734 if (env_app_timeout
) {
5735 app_socket_timeout
= atoi(env_app_timeout
);
5737 app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
;
5740 ret
= write_pidfile();
5742 ERR("Error in write_pidfile");
5744 goto exit_init_data
;
5746 ret
= write_agent_port();
5748 ERR("Error in write_agent_port");
5750 goto exit_init_data
;
5753 /* Initialize communication library */
5755 /* Initialize TCP timeout values */
5756 lttcomm_inet_init();
5758 if (load_session_init_data(&load_info
) < 0) {
5760 goto exit_init_data
;
5762 load_info
->path
= opt_load_session_path
;
5764 /* Create health-check thread */
5765 ret
= pthread_create(&health_thread
, NULL
,
5766 thread_manage_health
, (void *) NULL
);
5769 PERROR("pthread_create health");
5774 /* Create thread to manage the client socket */
5775 ret
= pthread_create(&client_thread
, NULL
,
5776 thread_manage_clients
, (void *) NULL
);
5779 PERROR("pthread_create clients");
5784 /* Create thread to dispatch registration */
5785 ret
= pthread_create(&dispatch_thread
, NULL
,
5786 thread_dispatch_ust_registration
, (void *) NULL
);
5789 PERROR("pthread_create dispatch");
5794 /* Create thread to manage application registration. */
5795 ret
= pthread_create(®_apps_thread
, NULL
,
5796 thread_registration_apps
, (void *) NULL
);
5799 PERROR("pthread_create registration");
5804 /* Create thread to manage application socket */
5805 ret
= pthread_create(&apps_thread
, NULL
,
5806 thread_manage_apps
, (void *) NULL
);
5809 PERROR("pthread_create apps");
5814 /* Create thread to manage application notify socket */
5815 ret
= pthread_create(&apps_notify_thread
, NULL
,
5816 ust_thread_manage_notify
, (void *) NULL
);
5819 PERROR("pthread_create notify");
5821 goto exit_apps_notify
;
5824 /* Create agent registration thread. */
5825 ret
= pthread_create(&agent_reg_thread
, NULL
,
5826 agent_thread_manage_registration
, (void *) NULL
);
5829 PERROR("pthread_create agent");
5831 goto exit_agent_reg
;
5834 /* Don't start this thread if kernel tracing is not requested nor root */
5835 if (is_root
&& !opt_no_kernel
) {
5836 /* Create kernel thread to manage kernel event */
5837 ret
= pthread_create(&kernel_thread
, NULL
,
5838 thread_manage_kernel
, (void *) NULL
);
5841 PERROR("pthread_create kernel");
5847 /* Create session loading thread. */
5848 ret
= pthread_create(&load_session_thread
, NULL
, thread_load_session
,
5852 PERROR("pthread_create load_session_thread");
5854 goto exit_load_session
;
5858 * This is where we start awaiting program completion (e.g. through
5859 * signal that asks threads to teardown).
5862 ret
= pthread_join(load_session_thread
, &status
);
5865 PERROR("pthread_join load_session_thread");
5870 if (is_root
&& !opt_no_kernel
) {
5871 ret
= pthread_join(kernel_thread
, &status
);
5874 PERROR("pthread_join");
5880 ret
= pthread_join(agent_reg_thread
, &status
);
5883 PERROR("pthread_join agent");
5888 ret
= pthread_join(apps_notify_thread
, &status
);
5891 PERROR("pthread_join apps notify");
5896 ret
= pthread_join(apps_thread
, &status
);
5899 PERROR("pthread_join apps");
5904 ret
= pthread_join(reg_apps_thread
, &status
);
5907 PERROR("pthread_join");
5912 ret
= pthread_join(dispatch_thread
, &status
);
5915 PERROR("pthread_join");
5920 ret
= pthread_join(client_thread
, &status
);
5923 PERROR("pthread_join");
5928 ret
= pthread_join(health_thread
, &status
);
5931 PERROR("pthread_join health thread");
5938 * sessiond_cleanup() is called when no other thread is running, except
5939 * the ht_cleanup thread, which is needed to destroy the hash tables.
5941 rcu_thread_online();
5943 rcu_thread_offline();
5944 rcu_unregister_thread();
5946 ret
= notify_thread_pipe(ht_cleanup_quit_pipe
[1]);
5948 ERR("write error on ht_cleanup quit pipe");
5952 ret
= pthread_join(ht_cleanup_thread
, &status
);
5955 PERROR("pthread_join ht cleanup thread");
5961 utils_close_pipe(ht_cleanup_pipe
);
5962 exit_ht_cleanup_pipe
:
5965 * Close the ht_cleanup quit pipe.
5967 utils_close_pipe(ht_cleanup_quit_pipe
);
5968 exit_ht_cleanup_quit_pipe
:
5970 health_app_destroy(health_sessiond
);
5971 exit_health_sessiond_cleanup
:
5974 sessiond_cleanup_options();
5976 exit_set_signal_handler
: