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.
32 #include <sys/mount.h>
33 #include <sys/resource.h>
34 #include <sys/socket.h>
36 #include <sys/types.h>
38 #include <urcu/uatomic.h>
42 #include <common/common.h>
43 #include <common/compat/socket.h>
44 #include <common/compat/getenv.h>
45 #include <common/defaults.h>
46 #include <common/kernel-consumer/kernel-consumer.h>
47 #include <common/futex.h>
48 #include <common/relayd/relayd.h>
49 #include <common/utils.h>
50 #include <common/daemonize.h>
51 #include <common/config/session-config.h>
53 #include "lttng-sessiond.h"
54 #include "buffer-registry.h"
61 #include "kernel-consumer.h"
65 #include "ust-consumer.h"
68 #include "health-sessiond.h"
69 #include "testpoint.h"
70 #include "ust-thread.h"
71 #include "agent-thread.h"
73 #include "load-session-thread.h"
76 #include "ht-cleanup.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 };
196 * This pipe is used to inform the thread managing application communication
197 * that a command is queued and ready to be processed.
199 static int apps_cmd_pipe
[2] = { -1, -1 };
201 int apps_cmd_notify_pipe
[2] = { -1, -1 };
203 /* Pthread, Mutexes and Semaphores */
204 static pthread_t apps_thread
;
205 static pthread_t apps_notify_thread
;
206 static pthread_t reg_apps_thread
;
207 static pthread_t client_thread
;
208 static pthread_t kernel_thread
;
209 static pthread_t dispatch_thread
;
210 static pthread_t health_thread
;
211 static pthread_t ht_cleanup_thread
;
212 static pthread_t agent_reg_thread
;
213 static pthread_t load_session_thread
;
216 * UST registration command queue. This queue is tied with a futex and uses a N
217 * wakers / 1 waiter implemented and detailed in futex.c/.h
219 * The thread_registration_apps and thread_dispatch_ust_registration uses this
220 * queue along with the wait/wake scheme. The thread_manage_apps receives down
221 * the line new application socket and monitors it for any I/O error or clean
222 * close that triggers an unregistration of the application.
224 static struct ust_cmd_queue ust_cmd_queue
;
227 * Pointer initialized before thread creation.
229 * This points to the tracing session list containing the session count and a
230 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
231 * MUST NOT be taken if you call a public function in session.c.
233 * The lock is nested inside the structure: session_list_ptr->lock. Please use
234 * session_lock_list and session_unlock_list for lock acquisition.
236 static struct ltt_session_list
*session_list_ptr
;
238 int ust_consumerd64_fd
= -1;
239 int ust_consumerd32_fd
= -1;
241 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
242 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
243 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
244 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
245 static int consumerd32_bin_override
;
246 static int consumerd64_bin_override
;
247 static int consumerd32_libdir_override
;
248 static int consumerd64_libdir_override
;
250 static const char *module_proc_lttng
= "/proc/lttng";
253 * Consumer daemon state which is changed when spawning it, killing it or in
254 * case of a fatal error.
256 enum consumerd_state
{
257 CONSUMER_STARTED
= 1,
258 CONSUMER_STOPPED
= 2,
263 * This consumer daemon state is used to validate if a client command will be
264 * able to reach the consumer. If not, the client is informed. For instance,
265 * doing a "lttng start" when the consumer state is set to ERROR will return an
266 * error to the client.
268 * The following example shows a possible race condition of this scheme:
270 * consumer thread error happens
272 * client cmd checks state -> still OK
273 * consumer thread exit, sets error
274 * client cmd try to talk to consumer
277 * However, since the consumer is a different daemon, we have no way of making
278 * sure the command will reach it safely even with this state flag. This is why
279 * we consider that up to the state validation during command processing, the
280 * command is safe. After that, we can not guarantee the correctness of the
281 * client request vis-a-vis the consumer.
283 static enum consumerd_state ust_consumerd_state
;
284 static enum consumerd_state kernel_consumerd_state
;
287 * Socket timeout for receiving and sending in seconds.
289 static int app_socket_timeout
;
291 /* Set in main() with the current page size. */
294 /* Application health monitoring */
295 struct health_app
*health_sessiond
;
297 /* Agent TCP port for registration. Used by the agent thread. */
298 unsigned int agent_tcp_port
= DEFAULT_AGENT_TCP_PORT
;
300 /* Am I root or not. */
301 int is_root
; /* Set to 1 if the daemon is running as root */
303 const char * const config_section_name
= "sessiond";
305 /* Load session thread information to operate. */
306 struct load_session_thread_data
*load_info
;
308 /* Global hash tables */
309 struct lttng_ht
*agent_apps_ht_by_sock
= NULL
;
312 * Whether sessiond is ready for commands/health check requests.
313 * NR_LTTNG_SESSIOND_READY must match the number of calls to
314 * sessiond_notify_ready().
316 #define NR_LTTNG_SESSIOND_READY 3
317 int lttng_sessiond_ready
= NR_LTTNG_SESSIOND_READY
;
319 int sessiond_check_thread_quit_pipe(int fd
, uint32_t events
)
321 return (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) ? 1 : 0;
324 /* Notify parents that we are ready for cmd and health check */
326 void sessiond_notify_ready(void)
328 if (uatomic_sub_return(<tng_sessiond_ready
, 1) == 0) {
330 * Notify parent pid that we are ready to accept command
331 * for client side. This ppid is the one from the
332 * external process that spawned us.
334 if (opt_sig_parent
) {
339 * Notify the parent of the fork() process that we are
342 if (opt_daemon
|| opt_background
) {
343 kill(child_ppid
, SIGUSR1
);
349 void setup_consumerd_path(void)
351 const char *bin
, *libdir
;
354 * Allow INSTALL_BIN_PATH to be used as a target path for the
355 * native architecture size consumer if CONFIG_CONSUMER*_PATH
356 * has not been defined.
358 #if (CAA_BITS_PER_LONG == 32)
359 if (!consumerd32_bin
[0]) {
360 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
362 if (!consumerd32_libdir
[0]) {
363 consumerd32_libdir
= INSTALL_LIB_PATH
;
365 #elif (CAA_BITS_PER_LONG == 64)
366 if (!consumerd64_bin
[0]) {
367 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
369 if (!consumerd64_libdir
[0]) {
370 consumerd64_libdir
= INSTALL_LIB_PATH
;
373 #error "Unknown bitness"
377 * runtime env. var. overrides the build default.
379 bin
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
381 consumerd32_bin
= bin
;
383 bin
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
385 consumerd64_bin
= bin
;
387 libdir
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
389 consumerd32_libdir
= libdir
;
391 libdir
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
393 consumerd64_libdir
= libdir
;
398 int __sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
,
405 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
411 ret
= lttng_poll_add(events
, a_pipe
[0], LPOLLIN
| LPOLLERR
);
423 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
425 int sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
)
427 return __sessiond_set_thread_pollset(events
, size
, thread_quit_pipe
);
431 * Init thread quit pipe.
433 * Return -1 on error or 0 if all pipes are created.
435 static int __init_thread_quit_pipe(int *a_pipe
)
441 PERROR("thread quit pipe");
445 for (i
= 0; i
< 2; i
++) {
446 ret
= fcntl(a_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
457 static int init_thread_quit_pipe(void)
459 return __init_thread_quit_pipe(thread_quit_pipe
);
463 * Stop all threads by closing the thread quit pipe.
465 static void stop_threads(void)
469 /* Stopping all threads */
470 DBG("Terminating all threads");
471 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
473 ERR("write error on thread quit pipe");
476 /* Dispatch thread */
477 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
478 futex_nto1_wake(&ust_cmd_queue
.futex
);
482 * Close every consumer sockets.
484 static void close_consumer_sockets(void)
488 if (kconsumer_data
.err_sock
>= 0) {
489 ret
= close(kconsumer_data
.err_sock
);
491 PERROR("kernel consumer err_sock close");
494 if (ustconsumer32_data
.err_sock
>= 0) {
495 ret
= close(ustconsumer32_data
.err_sock
);
497 PERROR("UST consumerd32 err_sock close");
500 if (ustconsumer64_data
.err_sock
>= 0) {
501 ret
= close(ustconsumer64_data
.err_sock
);
503 PERROR("UST consumerd64 err_sock close");
506 if (kconsumer_data
.cmd_sock
>= 0) {
507 ret
= close(kconsumer_data
.cmd_sock
);
509 PERROR("kernel consumer cmd_sock close");
512 if (ustconsumer32_data
.cmd_sock
>= 0) {
513 ret
= close(ustconsumer32_data
.cmd_sock
);
515 PERROR("UST consumerd32 cmd_sock close");
518 if (ustconsumer64_data
.cmd_sock
>= 0) {
519 ret
= close(ustconsumer64_data
.cmd_sock
);
521 PERROR("UST consumerd64 cmd_sock close");
527 * Generate the full lock file path using the rundir.
529 * Return the snprintf() return value thus a negative value is an error.
531 static int generate_lock_file_path(char *path
, size_t len
)
538 /* Build lockfile path from rundir. */
539 ret
= snprintf(path
, len
, "%s/" DEFAULT_LTTNG_SESSIOND_LOCKFILE
, rundir
);
541 PERROR("snprintf lockfile path");
548 * Wait on consumer process termination.
550 * Need to be called with the consumer data lock held or from a context
551 * ensuring no concurrent access to data (e.g: cleanup).
553 static void wait_consumer(struct consumer_data
*consumer_data
)
558 if (consumer_data
->pid
<= 0) {
562 DBG("Waiting for complete teardown of consumerd (PID: %d)",
564 ret
= waitpid(consumer_data
->pid
, &status
, 0);
566 PERROR("consumerd waitpid pid: %d", consumer_data
->pid
)
568 if (!WIFEXITED(status
)) {
569 ERR("consumerd termination with error: %d",
572 consumer_data
->pid
= 0;
576 * Cleanup the session daemon's data structures.
578 static void sessiond_cleanup(void)
581 struct ltt_session
*sess
, *stmp
;
584 DBG("Cleanup sessiond");
587 * Close the thread quit pipe. It has already done its job,
588 * since we are now called.
590 utils_close_pipe(thread_quit_pipe
);
593 * If opt_pidfile is undefined, the default file will be wiped when
594 * removing the rundir.
597 ret
= remove(opt_pidfile
);
599 PERROR("remove pidfile %s", opt_pidfile
);
603 DBG("Removing sessiond and consumerd content of directory %s", rundir
);
606 snprintf(path
, PATH_MAX
,
608 rundir
, DEFAULT_LTTNG_SESSIOND_PIDFILE
);
609 DBG("Removing %s", path
);
612 snprintf(path
, PATH_MAX
, "%s/%s", rundir
,
613 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
614 DBG("Removing %s", path
);
618 snprintf(path
, PATH_MAX
,
619 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
621 DBG("Removing %s", path
);
624 snprintf(path
, PATH_MAX
,
625 DEFAULT_KCONSUMERD_PATH
,
627 DBG("Removing directory %s", path
);
630 /* ust consumerd 32 */
631 snprintf(path
, PATH_MAX
,
632 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
634 DBG("Removing %s", path
);
637 snprintf(path
, PATH_MAX
,
638 DEFAULT_USTCONSUMERD32_PATH
,
640 DBG("Removing directory %s", path
);
643 /* ust consumerd 64 */
644 snprintf(path
, PATH_MAX
,
645 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
647 DBG("Removing %s", path
);
650 snprintf(path
, PATH_MAX
,
651 DEFAULT_USTCONSUMERD64_PATH
,
653 DBG("Removing directory %s", path
);
656 DBG("Cleaning up all sessions");
658 /* Destroy session list mutex */
659 if (session_list_ptr
!= NULL
) {
660 pthread_mutex_destroy(&session_list_ptr
->lock
);
662 /* Cleanup ALL session */
663 cds_list_for_each_entry_safe(sess
, stmp
,
664 &session_list_ptr
->head
, list
) {
665 cmd_destroy_session(sess
, kernel_poll_pipe
[1]);
669 wait_consumer(&kconsumer_data
);
670 wait_consumer(&ustconsumer64_data
);
671 wait_consumer(&ustconsumer32_data
);
673 DBG("Cleaning up all agent apps");
674 agent_app_ht_clean();
676 DBG("Closing all UST sockets");
677 ust_app_clean_list();
678 buffer_reg_destroy_registries();
680 if (is_root
&& !opt_no_kernel
) {
681 DBG2("Closing kernel fd");
682 if (kernel_tracer_fd
>= 0) {
683 ret
= close(kernel_tracer_fd
);
688 DBG("Unloading kernel modules");
689 modprobe_remove_lttng_all();
693 close_consumer_sockets();
696 load_session_destroy_data(load_info
);
701 * Cleanup lock file by deleting it and finaly closing it which will
702 * release the file system lock.
704 if (lockfile_fd
>= 0) {
705 char lockfile_path
[PATH_MAX
];
707 ret
= generate_lock_file_path(lockfile_path
,
708 sizeof(lockfile_path
));
710 ret
= remove(lockfile_path
);
712 PERROR("remove lock file");
714 ret
= close(lockfile_fd
);
716 PERROR("close lock file");
722 * We do NOT rmdir rundir because there are other processes
723 * using it, for instance lttng-relayd, which can start in
724 * parallel with this teardown.
731 * Cleanup the daemon's option data structures.
733 static void sessiond_cleanup_options(void)
735 DBG("Cleaning up options");
738 * If the override option is set, the pointer points to a *non* const
739 * thus freeing it even though the variable type is set to const.
741 if (tracing_group_name_override
) {
742 free((void *) tracing_group_name
);
744 if (consumerd32_bin_override
) {
745 free((void *) consumerd32_bin
);
747 if (consumerd64_bin_override
) {
748 free((void *) consumerd64_bin
);
750 if (consumerd32_libdir_override
) {
751 free((void *) consumerd32_libdir
);
753 if (consumerd64_libdir_override
) {
754 free((void *) consumerd64_libdir
);
758 free(opt_load_session_path
);
759 free(kmod_probes_list
);
760 free(kmod_extra_probes_list
);
762 run_as_destroy_worker();
765 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
766 "Matthew, BEET driven development works!%c[%dm",
767 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
772 * Send data on a unix socket using the liblttsessiondcomm API.
774 * Return lttcomm error code.
776 static int send_unix_sock(int sock
, void *buf
, size_t len
)
778 /* Check valid length */
783 return lttcomm_send_unix_sock(sock
, buf
, len
);
787 * Free memory of a command context structure.
789 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
791 DBG("Clean command context structure");
793 if ((*cmd_ctx
)->llm
) {
794 free((*cmd_ctx
)->llm
);
796 if ((*cmd_ctx
)->lsm
) {
797 free((*cmd_ctx
)->lsm
);
805 * Notify UST applications using the shm mmap futex.
807 static int notify_ust_apps(int active
)
811 DBG("Notifying applications of session daemon state: %d", active
);
813 /* See shm.c for this call implying mmap, shm and futex calls */
814 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
815 if (wait_shm_mmap
== NULL
) {
819 /* Wake waiting process */
820 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
822 /* Apps notified successfully */
830 * Setup the outgoing data buffer for the response (llm) by allocating the
831 * right amount of memory and copying the original information from the lsm
834 * Return 0 on success, negative value on error.
836 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
837 const void *payload_buf
, size_t payload_len
,
838 const void *cmd_header_buf
, size_t cmd_header_len
)
841 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
842 const size_t cmd_header_offset
= header_len
;
843 const size_t payload_offset
= cmd_header_offset
+ cmd_header_len
;
844 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
846 cmd_ctx
->llm
= zmalloc(total_msg_size
);
848 if (cmd_ctx
->llm
== NULL
) {
854 /* Copy common data */
855 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
856 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
857 cmd_ctx
->llm
->cmd_header_size
= cmd_header_len
;
858 cmd_ctx
->llm
->data_size
= payload_len
;
859 cmd_ctx
->lttng_msg_size
= total_msg_size
;
861 /* Copy command header */
862 if (cmd_header_len
) {
863 memcpy(((uint8_t *) cmd_ctx
->llm
) + cmd_header_offset
, cmd_header_buf
,
869 memcpy(((uint8_t *) cmd_ctx
->llm
) + payload_offset
, payload_buf
,
878 * Version of setup_lttng_msg() without command header.
880 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
881 void *payload_buf
, size_t payload_len
)
883 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
886 * Update the kernel poll set of all channel fd available over all tracing
887 * session. Add the wakeup pipe at the end of the set.
889 static int update_kernel_poll(struct lttng_poll_event
*events
)
892 struct ltt_session
*session
;
893 struct ltt_kernel_channel
*channel
;
895 DBG("Updating kernel poll set");
898 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
899 session_lock(session
);
900 if (session
->kernel_session
== NULL
) {
901 session_unlock(session
);
905 cds_list_for_each_entry(channel
,
906 &session
->kernel_session
->channel_list
.head
, list
) {
907 /* Add channel fd to the kernel poll set */
908 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
910 session_unlock(session
);
913 DBG("Channel fd %d added to kernel set", channel
->fd
);
915 session_unlock(session
);
917 session_unlock_list();
922 session_unlock_list();
927 * Find the channel fd from 'fd' over all tracing session. When found, check
928 * for new channel stream and send those stream fds to the kernel consumer.
930 * Useful for CPU hotplug feature.
932 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
935 struct ltt_session
*session
;
936 struct ltt_kernel_session
*ksess
;
937 struct ltt_kernel_channel
*channel
;
939 DBG("Updating kernel streams for channel fd %d", fd
);
942 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
943 session_lock(session
);
944 if (session
->kernel_session
== NULL
) {
945 session_unlock(session
);
948 ksess
= session
->kernel_session
;
950 cds_list_for_each_entry(channel
,
951 &ksess
->channel_list
.head
, list
) {
952 struct lttng_ht_iter iter
;
953 struct consumer_socket
*socket
;
955 if (channel
->fd
!= fd
) {
958 DBG("Channel found, updating kernel streams");
959 ret
= kernel_open_channel_stream(channel
);
963 /* Update the stream global counter */
964 ksess
->stream_count_global
+= ret
;
967 * Have we already sent fds to the consumer? If yes, it
968 * means that tracing is started so it is safe to send
969 * our updated stream fds.
971 if (ksess
->consumer_fds_sent
!= 1
972 || ksess
->consumer
== NULL
) {
978 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
979 &iter
.iter
, socket
, node
.node
) {
980 pthread_mutex_lock(socket
->lock
);
981 ret
= kernel_consumer_send_channel_stream(socket
,
983 session
->output_traces
? 1 : 0);
984 pthread_mutex_unlock(socket
->lock
);
992 session_unlock(session
);
994 session_unlock_list();
998 session_unlock(session
);
999 session_unlock_list();
1004 * For each tracing session, update newly registered apps. The session list
1005 * lock MUST be acquired before calling this.
1007 static void update_ust_app(int app_sock
)
1009 struct ltt_session
*sess
, *stmp
;
1011 /* Consumer is in an ERROR state. Stop any application update. */
1012 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
1013 /* Stop the update process since the consumer is dead. */
1017 /* For all tracing session(s) */
1018 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
1019 struct ust_app
*app
;
1022 if (!sess
->ust_session
) {
1023 goto unlock_session
;
1027 assert(app_sock
>= 0);
1028 app
= ust_app_find_by_sock(app_sock
);
1031 * Application can be unregistered before so
1032 * this is possible hence simply stopping the
1035 DBG3("UST app update failed to find app sock %d",
1039 ust_app_global_update(sess
->ust_session
, app
);
1043 session_unlock(sess
);
1048 * This thread manage event coming from the kernel.
1050 * Features supported in this thread:
1053 static void *thread_manage_kernel(void *data
)
1055 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
1056 uint32_t revents
, nb_fd
;
1058 struct lttng_poll_event events
;
1060 DBG("[thread] Thread manage kernel started");
1062 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_KERNEL
);
1065 * This first step of the while is to clean this structure which could free
1066 * non NULL pointers so initialize it before the loop.
1068 lttng_poll_init(&events
);
1070 if (testpoint(sessiond_thread_manage_kernel
)) {
1071 goto error_testpoint
;
1074 health_code_update();
1076 if (testpoint(sessiond_thread_manage_kernel_before_loop
)) {
1077 goto error_testpoint
;
1081 health_code_update();
1083 if (update_poll_flag
== 1) {
1084 /* Clean events object. We are about to populate it again. */
1085 lttng_poll_clean(&events
);
1087 ret
= sessiond_set_thread_pollset(&events
, 2);
1089 goto error_poll_create
;
1092 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
1097 /* This will add the available kernel channel if any. */
1098 ret
= update_kernel_poll(&events
);
1102 update_poll_flag
= 0;
1105 DBG("Thread kernel polling");
1107 /* Poll infinite value of time */
1109 health_poll_entry();
1110 ret
= lttng_poll_wait(&events
, -1);
1111 DBG("Thread kernel return from poll on %d fds",
1112 LTTNG_POLL_GETNB(&events
));
1116 * Restart interrupted system call.
1118 if (errno
== EINTR
) {
1122 } else if (ret
== 0) {
1123 /* Should not happen since timeout is infinite */
1124 ERR("Return value of poll is 0 with an infinite timeout.\n"
1125 "This should not have happened! Continuing...");
1131 for (i
= 0; i
< nb_fd
; i
++) {
1132 /* Fetch once the poll data */
1133 revents
= LTTNG_POLL_GETEV(&events
, i
);
1134 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1136 health_code_update();
1139 /* No activity for this FD (poll implementation). */
1143 /* Thread quit pipe has been closed. Killing thread. */
1144 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1150 /* Check for data on kernel pipe */
1151 if (revents
& LPOLLIN
) {
1152 if (pollfd
== kernel_poll_pipe
[0]) {
1153 (void) lttng_read(kernel_poll_pipe
[0],
1156 * Ret value is useless here, if this pipe gets any actions an
1157 * update is required anyway.
1159 update_poll_flag
= 1;
1163 * New CPU detected by the kernel. Adding kernel stream to
1164 * kernel session and updating the kernel consumer
1166 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
1172 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1173 update_poll_flag
= 1;
1176 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1184 lttng_poll_clean(&events
);
1187 utils_close_pipe(kernel_poll_pipe
);
1188 kernel_poll_pipe
[0] = kernel_poll_pipe
[1] = -1;
1191 ERR("Health error occurred in %s", __func__
);
1192 WARN("Kernel thread died unexpectedly. "
1193 "Kernel tracing can continue but CPU hotplug is disabled.");
1195 health_unregister(health_sessiond
);
1196 DBG("Kernel thread dying");
1201 * Signal pthread condition of the consumer data that the thread.
1203 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
1205 pthread_mutex_lock(&data
->cond_mutex
);
1208 * The state is set before signaling. It can be any value, it's the waiter
1209 * job to correctly interpret this condition variable associated to the
1210 * consumer pthread_cond.
1212 * A value of 0 means that the corresponding thread of the consumer data
1213 * was not started. 1 indicates that the thread has started and is ready
1214 * for action. A negative value means that there was an error during the
1217 data
->consumer_thread_is_ready
= state
;
1218 (void) pthread_cond_signal(&data
->cond
);
1220 pthread_mutex_unlock(&data
->cond_mutex
);
1224 * This thread manage the consumer error sent back to the session daemon.
1226 static void *thread_manage_consumer(void *data
)
1228 int sock
= -1, i
, ret
, pollfd
, err
= -1, should_quit
= 0;
1229 uint32_t revents
, nb_fd
;
1230 enum lttcomm_return_code code
;
1231 struct lttng_poll_event events
;
1232 struct consumer_data
*consumer_data
= data
;
1234 DBG("[thread] Manage consumer started");
1236 rcu_register_thread();
1237 rcu_thread_online();
1239 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CONSUMER
);
1241 health_code_update();
1244 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1245 * metadata_sock. Nothing more will be added to this poll set.
1247 ret
= sessiond_set_thread_pollset(&events
, 3);
1253 * The error socket here is already in a listening state which was done
1254 * just before spawning this thread to avoid a race between the consumer
1255 * daemon exec trying to connect and the listen() call.
1257 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
1262 health_code_update();
1264 /* Infinite blocking call, waiting for transmission */
1266 health_poll_entry();
1268 if (testpoint(sessiond_thread_manage_consumer
)) {
1272 ret
= lttng_poll_wait(&events
, -1);
1276 * Restart interrupted system call.
1278 if (errno
== EINTR
) {
1286 for (i
= 0; i
< nb_fd
; i
++) {
1287 /* Fetch once the poll data */
1288 revents
= LTTNG_POLL_GETEV(&events
, i
);
1289 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1291 health_code_update();
1294 /* No activity for this FD (poll implementation). */
1298 /* Thread quit pipe has been closed. Killing thread. */
1299 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1305 /* Event on the registration socket */
1306 if (pollfd
== consumer_data
->err_sock
) {
1307 if (revents
& LPOLLIN
) {
1309 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1310 ERR("consumer err socket poll error");
1313 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1319 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1325 * Set the CLOEXEC flag. Return code is useless because either way, the
1328 (void) utils_set_fd_cloexec(sock
);
1330 health_code_update();
1332 DBG2("Receiving code from consumer err_sock");
1334 /* Getting status code from kconsumerd */
1335 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1336 sizeof(enum lttcomm_return_code
));
1341 health_code_update();
1342 if (code
== LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
1343 /* Connect both socket, command and metadata. */
1344 consumer_data
->cmd_sock
=
1345 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1346 consumer_data
->metadata_fd
=
1347 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1348 if (consumer_data
->cmd_sock
< 0
1349 || consumer_data
->metadata_fd
< 0) {
1350 PERROR("consumer connect cmd socket");
1351 /* On error, signal condition and quit. */
1352 signal_consumer_condition(consumer_data
, -1);
1355 consumer_data
->metadata_sock
.fd_ptr
= &consumer_data
->metadata_fd
;
1356 /* Create metadata socket lock. */
1357 consumer_data
->metadata_sock
.lock
= zmalloc(sizeof(pthread_mutex_t
));
1358 if (consumer_data
->metadata_sock
.lock
== NULL
) {
1359 PERROR("zmalloc pthread mutex");
1362 pthread_mutex_init(consumer_data
->metadata_sock
.lock
, NULL
);
1364 signal_consumer_condition(consumer_data
, 1);
1365 DBG("Consumer command socket ready (fd: %d", consumer_data
->cmd_sock
);
1366 DBG("Consumer metadata socket ready (fd: %d)",
1367 consumer_data
->metadata_fd
);
1369 ERR("consumer error when waiting for SOCK_READY : %s",
1370 lttcomm_get_readable_code(-code
));
1374 /* Remove the consumerd error sock since we've established a connexion */
1375 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1380 /* Add new accepted error socket. */
1381 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1386 /* Add metadata socket that is successfully connected. */
1387 ret
= lttng_poll_add(&events
, consumer_data
->metadata_fd
,
1388 LPOLLIN
| LPOLLRDHUP
);
1393 health_code_update();
1395 /* Infinite blocking call, waiting for transmission */
1398 health_code_update();
1400 /* Exit the thread because the thread quit pipe has been triggered. */
1402 /* Not a health error. */
1407 health_poll_entry();
1408 ret
= lttng_poll_wait(&events
, -1);
1412 * Restart interrupted system call.
1414 if (errno
== EINTR
) {
1422 for (i
= 0; i
< nb_fd
; i
++) {
1423 /* Fetch once the poll data */
1424 revents
= LTTNG_POLL_GETEV(&events
, i
);
1425 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1427 health_code_update();
1430 /* No activity for this FD (poll implementation). */
1435 * Thread quit pipe has been triggered, flag that we should stop
1436 * but continue the current loop to handle potential data from
1439 should_quit
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1441 if (pollfd
== sock
) {
1442 /* Event on the consumerd socket */
1443 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1444 && !(revents
& LPOLLIN
)) {
1445 ERR("consumer err socket second poll error");
1448 health_code_update();
1449 /* Wait for any kconsumerd error */
1450 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1451 sizeof(enum lttcomm_return_code
));
1453 ERR("consumer closed the command socket");
1457 ERR("consumer return code : %s",
1458 lttcomm_get_readable_code(-code
));
1461 } else if (pollfd
== consumer_data
->metadata_fd
) {
1462 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1463 && !(revents
& LPOLLIN
)) {
1464 ERR("consumer err metadata socket second poll error");
1467 /* UST metadata requests */
1468 ret
= ust_consumer_metadata_request(
1469 &consumer_data
->metadata_sock
);
1471 ERR("Handling metadata request");
1475 /* No need for an else branch all FDs are tested prior. */
1477 health_code_update();
1483 * We lock here because we are about to close the sockets and some other
1484 * thread might be using them so get exclusive access which will abort all
1485 * other consumer command by other threads.
1487 pthread_mutex_lock(&consumer_data
->lock
);
1489 /* Immediately set the consumerd state to stopped */
1490 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1491 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1492 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1493 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1494 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1496 /* Code flow error... */
1500 if (consumer_data
->err_sock
>= 0) {
1501 ret
= close(consumer_data
->err_sock
);
1505 consumer_data
->err_sock
= -1;
1507 if (consumer_data
->cmd_sock
>= 0) {
1508 ret
= close(consumer_data
->cmd_sock
);
1512 consumer_data
->cmd_sock
= -1;
1514 if (consumer_data
->metadata_sock
.fd_ptr
&&
1515 *consumer_data
->metadata_sock
.fd_ptr
>= 0) {
1516 ret
= close(*consumer_data
->metadata_sock
.fd_ptr
);
1528 unlink(consumer_data
->err_unix_sock_path
);
1529 unlink(consumer_data
->cmd_unix_sock_path
);
1530 pthread_mutex_unlock(&consumer_data
->lock
);
1532 /* Cleanup metadata socket mutex. */
1533 if (consumer_data
->metadata_sock
.lock
) {
1534 pthread_mutex_destroy(consumer_data
->metadata_sock
.lock
);
1535 free(consumer_data
->metadata_sock
.lock
);
1537 lttng_poll_clean(&events
);
1541 ERR("Health error occurred in %s", __func__
);
1543 health_unregister(health_sessiond
);
1544 DBG("consumer thread cleanup completed");
1546 rcu_thread_offline();
1547 rcu_unregister_thread();
1553 * This thread manage application communication.
1555 static void *thread_manage_apps(void *data
)
1557 int i
, ret
, pollfd
, err
= -1;
1559 uint32_t revents
, nb_fd
;
1560 struct lttng_poll_event events
;
1562 DBG("[thread] Manage application started");
1564 rcu_register_thread();
1565 rcu_thread_online();
1567 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_MANAGE
);
1569 if (testpoint(sessiond_thread_manage_apps
)) {
1570 goto error_testpoint
;
1573 health_code_update();
1575 ret
= sessiond_set_thread_pollset(&events
, 2);
1577 goto error_poll_create
;
1580 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1585 if (testpoint(sessiond_thread_manage_apps_before_loop
)) {
1589 health_code_update();
1592 DBG("Apps thread polling");
1594 /* Inifinite blocking call, waiting for transmission */
1596 health_poll_entry();
1597 ret
= lttng_poll_wait(&events
, -1);
1598 DBG("Apps thread return from poll on %d fds",
1599 LTTNG_POLL_GETNB(&events
));
1603 * Restart interrupted system call.
1605 if (errno
== EINTR
) {
1613 for (i
= 0; i
< nb_fd
; i
++) {
1614 /* Fetch once the poll data */
1615 revents
= LTTNG_POLL_GETEV(&events
, i
);
1616 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1618 health_code_update();
1621 /* No activity for this FD (poll implementation). */
1625 /* Thread quit pipe has been closed. Killing thread. */
1626 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1632 /* Inspect the apps cmd pipe */
1633 if (pollfd
== apps_cmd_pipe
[0]) {
1634 if (revents
& LPOLLIN
) {
1638 size_ret
= lttng_read(apps_cmd_pipe
[0], &sock
, sizeof(sock
));
1639 if (size_ret
< sizeof(sock
)) {
1640 PERROR("read apps cmd pipe");
1644 health_code_update();
1647 * Since this is a command socket (write then read),
1648 * we only monitor the error events of the socket.
1650 ret
= lttng_poll_add(&events
, sock
,
1651 LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
1656 DBG("Apps with sock %d added to poll set", sock
);
1657 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1658 ERR("Apps command pipe error");
1661 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
1666 * At this point, we know that a registered application made
1667 * the event at poll_wait.
1669 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1670 /* Removing from the poll set */
1671 ret
= lttng_poll_del(&events
, pollfd
);
1676 /* Socket closed on remote end. */
1677 ust_app_unregister(pollfd
);
1679 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1684 health_code_update();
1690 lttng_poll_clean(&events
);
1693 utils_close_pipe(apps_cmd_pipe
);
1694 apps_cmd_pipe
[0] = apps_cmd_pipe
[1] = -1;
1697 * We don't clean the UST app hash table here since already registered
1698 * applications can still be controlled so let them be until the session
1699 * daemon dies or the applications stop.
1704 ERR("Health error occurred in %s", __func__
);
1706 health_unregister(health_sessiond
);
1707 DBG("Application communication apps thread cleanup complete");
1708 rcu_thread_offline();
1709 rcu_unregister_thread();
1714 * Send a socket to a thread This is called from the dispatch UST registration
1715 * thread once all sockets are set for the application.
1717 * The sock value can be invalid, we don't really care, the thread will handle
1718 * it and make the necessary cleanup if so.
1720 * On success, return 0 else a negative value being the errno message of the
1723 static int send_socket_to_thread(int fd
, int sock
)
1728 * It's possible that the FD is set as invalid with -1 concurrently just
1729 * before calling this function being a shutdown state of the thread.
1736 ret
= lttng_write(fd
, &sock
, sizeof(sock
));
1737 if (ret
< sizeof(sock
)) {
1738 PERROR("write apps pipe %d", fd
);
1745 /* All good. Don't send back the write positive ret value. */
1752 * Sanitize the wait queue of the dispatch registration thread meaning removing
1753 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1754 * notify socket is never received.
1756 static void sanitize_wait_queue(struct ust_reg_wait_queue
*wait_queue
)
1758 int ret
, nb_fd
= 0, i
;
1759 unsigned int fd_added
= 0;
1760 struct lttng_poll_event events
;
1761 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1765 lttng_poll_init(&events
);
1767 /* Just skip everything for an empty queue. */
1768 if (!wait_queue
->count
) {
1772 ret
= lttng_poll_create(&events
, wait_queue
->count
, LTTNG_CLOEXEC
);
1777 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1778 &wait_queue
->head
, head
) {
1779 assert(wait_node
->app
);
1780 ret
= lttng_poll_add(&events
, wait_node
->app
->sock
,
1781 LPOLLHUP
| LPOLLERR
);
1794 * Poll but don't block so we can quickly identify the faulty events and
1795 * clean them afterwards from the wait queue.
1797 ret
= lttng_poll_wait(&events
, 0);
1803 for (i
= 0; i
< nb_fd
; i
++) {
1804 /* Get faulty FD. */
1805 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1806 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1809 /* No activity for this FD (poll implementation). */
1813 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1814 &wait_queue
->head
, head
) {
1815 if (pollfd
== wait_node
->app
->sock
&&
1816 (revents
& (LPOLLHUP
| LPOLLERR
))) {
1817 cds_list_del(&wait_node
->head
);
1818 wait_queue
->count
--;
1819 ust_app_destroy(wait_node
->app
);
1822 * Silence warning of use-after-free in
1823 * cds_list_for_each_entry_safe which uses
1824 * __typeof__(*wait_node).
1829 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1836 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd
);
1840 lttng_poll_clean(&events
);
1844 lttng_poll_clean(&events
);
1846 ERR("Unable to sanitize wait queue");
1851 * Dispatch request from the registration threads to the application
1852 * communication thread.
1854 static void *thread_dispatch_ust_registration(void *data
)
1857 struct cds_wfcq_node
*node
;
1858 struct ust_command
*ust_cmd
= NULL
;
1859 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1860 struct ust_reg_wait_queue wait_queue
= {
1864 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH
);
1866 if (testpoint(sessiond_thread_app_reg_dispatch
)) {
1867 goto error_testpoint
;
1870 health_code_update();
1872 CDS_INIT_LIST_HEAD(&wait_queue
.head
);
1874 DBG("[thread] Dispatch UST command started");
1876 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1877 health_code_update();
1879 /* Atomically prepare the queue futex */
1880 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1883 struct ust_app
*app
= NULL
;
1887 * Make sure we don't have node(s) that have hung up before receiving
1888 * the notify socket. This is to clean the list in order to avoid
1889 * memory leaks from notify socket that are never seen.
1891 sanitize_wait_queue(&wait_queue
);
1893 health_code_update();
1894 /* Dequeue command for registration */
1895 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1897 DBG("Woken up but nothing in the UST command queue");
1898 /* Continue thread execution */
1902 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1904 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1905 " gid:%d sock:%d name:%s (version %d.%d)",
1906 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1907 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1908 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1909 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1911 if (ust_cmd
->reg_msg
.type
== USTCTL_SOCKET_CMD
) {
1912 wait_node
= zmalloc(sizeof(*wait_node
));
1914 PERROR("zmalloc wait_node dispatch");
1915 ret
= close(ust_cmd
->sock
);
1917 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1919 lttng_fd_put(LTTNG_FD_APPS
, 1);
1923 CDS_INIT_LIST_HEAD(&wait_node
->head
);
1925 /* Create application object if socket is CMD. */
1926 wait_node
->app
= ust_app_create(&ust_cmd
->reg_msg
,
1928 if (!wait_node
->app
) {
1929 ret
= close(ust_cmd
->sock
);
1931 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1933 lttng_fd_put(LTTNG_FD_APPS
, 1);
1939 * Add application to the wait queue so we can set the notify
1940 * socket before putting this object in the global ht.
1942 cds_list_add(&wait_node
->head
, &wait_queue
.head
);
1947 * We have to continue here since we don't have the notify
1948 * socket and the application MUST be added to the hash table
1949 * only at that moment.
1954 * Look for the application in the local wait queue and set the
1955 * notify socket if found.
1957 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1958 &wait_queue
.head
, head
) {
1959 health_code_update();
1960 if (wait_node
->app
->pid
== ust_cmd
->reg_msg
.pid
) {
1961 wait_node
->app
->notify_sock
= ust_cmd
->sock
;
1962 cds_list_del(&wait_node
->head
);
1964 app
= wait_node
->app
;
1966 DBG3("UST app notify socket %d is set", ust_cmd
->sock
);
1972 * With no application at this stage the received socket is
1973 * basically useless so close it before we free the cmd data
1974 * structure for good.
1977 ret
= close(ust_cmd
->sock
);
1979 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1981 lttng_fd_put(LTTNG_FD_APPS
, 1);
1988 * @session_lock_list
1990 * Lock the global session list so from the register up to the
1991 * registration done message, no thread can see the application
1992 * and change its state.
1994 session_lock_list();
1998 * Add application to the global hash table. This needs to be
1999 * done before the update to the UST registry can locate the
2004 /* Set app version. This call will print an error if needed. */
2005 (void) ust_app_version(app
);
2007 /* Send notify socket through the notify pipe. */
2008 ret
= send_socket_to_thread(apps_cmd_notify_pipe
[1],
2012 session_unlock_list();
2014 * No notify thread, stop the UST tracing. However, this is
2015 * not an internal error of the this thread thus setting
2016 * the health error code to a normal exit.
2023 * Update newly registered application with the tracing
2024 * registry info already enabled information.
2026 update_ust_app(app
->sock
);
2029 * Don't care about return value. Let the manage apps threads
2030 * handle app unregistration upon socket close.
2032 (void) ust_app_register_done(app
);
2035 * Even if the application socket has been closed, send the app
2036 * to the thread and unregistration will take place at that
2039 ret
= send_socket_to_thread(apps_cmd_pipe
[1], app
->sock
);
2042 session_unlock_list();
2044 * No apps. thread, stop the UST tracing. However, this is
2045 * not an internal error of the this thread thus setting
2046 * the health error code to a normal exit.
2053 session_unlock_list();
2055 } while (node
!= NULL
);
2057 health_poll_entry();
2058 /* Futex wait on queue. Blocking call on futex() */
2059 futex_nto1_wait(&ust_cmd_queue
.futex
);
2062 /* Normal exit, no error */
2066 /* Clean up wait queue. */
2067 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
2068 &wait_queue
.head
, head
) {
2069 cds_list_del(&wait_node
->head
);
2074 /* Empty command queue. */
2076 /* Dequeue command for registration */
2077 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
2081 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
2082 ret
= close(ust_cmd
->sock
);
2084 PERROR("close ust sock exit dispatch %d", ust_cmd
->sock
);
2086 lttng_fd_put(LTTNG_FD_APPS
, 1);
2091 DBG("Dispatch thread dying");
2094 ERR("Health error occurred in %s", __func__
);
2096 health_unregister(health_sessiond
);
2101 * This thread manage application registration.
2103 static void *thread_registration_apps(void *data
)
2105 int sock
= -1, i
, ret
, pollfd
, err
= -1;
2106 uint32_t revents
, nb_fd
;
2107 struct lttng_poll_event events
;
2109 * Get allocated in this thread, enqueued to a global queue, dequeued and
2110 * freed in the manage apps thread.
2112 struct ust_command
*ust_cmd
= NULL
;
2114 DBG("[thread] Manage application registration started");
2116 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG
);
2118 if (testpoint(sessiond_thread_registration_apps
)) {
2119 goto error_testpoint
;
2122 ret
= lttcomm_listen_unix_sock(apps_sock
);
2128 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
2129 * more will be added to this poll set.
2131 ret
= sessiond_set_thread_pollset(&events
, 2);
2133 goto error_create_poll
;
2136 /* Add the application registration socket */
2137 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
2139 goto error_poll_add
;
2142 /* Notify all applications to register */
2143 ret
= notify_ust_apps(1);
2145 ERR("Failed to notify applications or create the wait shared memory.\n"
2146 "Execution continues but there might be problem for already\n"
2147 "running applications that wishes to register.");
2151 DBG("Accepting application registration");
2153 /* Inifinite blocking call, waiting for transmission */
2155 health_poll_entry();
2156 ret
= lttng_poll_wait(&events
, -1);
2160 * Restart interrupted system call.
2162 if (errno
== EINTR
) {
2170 for (i
= 0; i
< nb_fd
; i
++) {
2171 health_code_update();
2173 /* Fetch once the poll data */
2174 revents
= LTTNG_POLL_GETEV(&events
, i
);
2175 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2178 /* No activity for this FD (poll implementation). */
2182 /* Thread quit pipe has been closed. Killing thread. */
2183 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
2189 /* Event on the registration socket */
2190 if (pollfd
== apps_sock
) {
2191 if (revents
& LPOLLIN
) {
2192 sock
= lttcomm_accept_unix_sock(apps_sock
);
2198 * Set socket timeout for both receiving and ending.
2199 * app_socket_timeout is in seconds, whereas
2200 * lttcomm_setsockopt_rcv_timeout and
2201 * lttcomm_setsockopt_snd_timeout expect msec as
2204 (void) lttcomm_setsockopt_rcv_timeout(sock
,
2205 app_socket_timeout
* 1000);
2206 (void) lttcomm_setsockopt_snd_timeout(sock
,
2207 app_socket_timeout
* 1000);
2210 * Set the CLOEXEC flag. Return code is useless because
2211 * either way, the show must go on.
2213 (void) utils_set_fd_cloexec(sock
);
2215 /* Create UST registration command for enqueuing */
2216 ust_cmd
= zmalloc(sizeof(struct ust_command
));
2217 if (ust_cmd
== NULL
) {
2218 PERROR("ust command zmalloc");
2227 * Using message-based transmissions to ensure we don't
2228 * have to deal with partially received messages.
2230 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2232 ERR("Exhausted file descriptors allowed for applications.");
2242 health_code_update();
2243 ret
= ust_app_recv_registration(sock
, &ust_cmd
->reg_msg
);
2246 /* Close socket of the application. */
2251 lttng_fd_put(LTTNG_FD_APPS
, 1);
2255 health_code_update();
2257 ust_cmd
->sock
= sock
;
2260 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2261 " gid:%d sock:%d name:%s (version %d.%d)",
2262 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
2263 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
2264 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
2265 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
2268 * Lock free enqueue the registration request. The red pill
2269 * has been taken! This apps will be part of the *system*.
2271 cds_wfcq_enqueue(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
, &ust_cmd
->node
);
2274 * Wake the registration queue futex. Implicit memory
2275 * barrier with the exchange in cds_wfcq_enqueue.
2277 futex_nto1_wake(&ust_cmd_queue
.futex
);
2278 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2279 ERR("Register apps socket poll error");
2282 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2291 /* Notify that the registration thread is gone */
2294 if (apps_sock
>= 0) {
2295 ret
= close(apps_sock
);
2305 lttng_fd_put(LTTNG_FD_APPS
, 1);
2307 unlink(apps_unix_sock_path
);
2310 lttng_poll_clean(&events
);
2314 DBG("UST Registration thread cleanup complete");
2317 ERR("Health error occurred in %s", __func__
);
2319 health_unregister(health_sessiond
);
2325 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2326 * exec or it will fails.
2328 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
2331 struct timespec timeout
;
2334 * Make sure we set the readiness flag to 0 because we are NOT ready.
2335 * This access to consumer_thread_is_ready does not need to be
2336 * protected by consumer_data.cond_mutex (yet) since the consumer
2337 * management thread has not been started at this point.
2339 consumer_data
->consumer_thread_is_ready
= 0;
2341 /* Setup pthread condition */
2342 ret
= pthread_condattr_init(&consumer_data
->condattr
);
2345 PERROR("pthread_condattr_init consumer data");
2350 * Set the monotonic clock in order to make sure we DO NOT jump in time
2351 * between the clock_gettime() call and the timedwait call. See bug #324
2352 * for a more details and how we noticed it.
2354 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
2357 PERROR("pthread_condattr_setclock consumer data");
2361 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
2364 PERROR("pthread_cond_init consumer data");
2368 ret
= pthread_create(&consumer_data
->thread
, default_pthread_attr(),
2369 thread_manage_consumer
, consumer_data
);
2372 PERROR("pthread_create consumer");
2377 /* We are about to wait on a pthread condition */
2378 pthread_mutex_lock(&consumer_data
->cond_mutex
);
2380 /* Get time for sem_timedwait absolute timeout */
2381 clock_ret
= clock_gettime(CLOCK_MONOTONIC
, &timeout
);
2383 * Set the timeout for the condition timed wait even if the clock gettime
2384 * call fails since we might loop on that call and we want to avoid to
2385 * increment the timeout too many times.
2387 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
2390 * The following loop COULD be skipped in some conditions so this is why we
2391 * set ret to 0 in order to make sure at least one round of the loop is
2397 * Loop until the condition is reached or when a timeout is reached. Note
2398 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2399 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2400 * possible. This loop does not take any chances and works with both of
2403 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
2404 if (clock_ret
< 0) {
2405 PERROR("clock_gettime spawn consumer");
2406 /* Infinite wait for the consumerd thread to be ready */
2407 ret
= pthread_cond_wait(&consumer_data
->cond
,
2408 &consumer_data
->cond_mutex
);
2410 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
2411 &consumer_data
->cond_mutex
, &timeout
);
2415 /* Release the pthread condition */
2416 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
2420 if (ret
== ETIMEDOUT
) {
2424 * Call has timed out so we kill the kconsumerd_thread and return
2427 ERR("Condition timed out. The consumer thread was never ready."
2429 pth_ret
= pthread_cancel(consumer_data
->thread
);
2431 PERROR("pthread_cancel consumer thread");
2434 PERROR("pthread_cond_wait failed consumer thread");
2436 /* Caller is expecting a negative value on failure. */
2441 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2442 if (consumer_data
->pid
== 0) {
2443 ERR("Consumerd did not start");
2444 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2447 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2456 * Join consumer thread
2458 static int join_consumer_thread(struct consumer_data
*consumer_data
)
2462 /* Consumer pid must be a real one. */
2463 if (consumer_data
->pid
> 0) {
2465 ret
= kill(consumer_data
->pid
, SIGTERM
);
2467 PERROR("Error killing consumer daemon");
2470 return pthread_join(consumer_data
->thread
, &status
);
2477 * Fork and exec a consumer daemon (consumerd).
2479 * Return pid if successful else -1.
2481 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
2485 const char *consumer_to_use
;
2486 const char *verbosity
;
2489 DBG("Spawning consumerd");
2496 if (opt_verbose_consumer
) {
2497 verbosity
= "--verbose";
2498 } else if (lttng_opt_quiet
) {
2499 verbosity
= "--quiet";
2504 switch (consumer_data
->type
) {
2505 case LTTNG_CONSUMER_KERNEL
:
2507 * Find out which consumerd to execute. We will first try the
2508 * 64-bit path, then the sessiond's installation directory, and
2509 * fallback on the 32-bit one,
2511 DBG3("Looking for a kernel consumer at these locations:");
2512 DBG3(" 1) %s", consumerd64_bin
);
2513 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
2514 DBG3(" 3) %s", consumerd32_bin
);
2515 if (stat(consumerd64_bin
, &st
) == 0) {
2516 DBG3("Found location #1");
2517 consumer_to_use
= consumerd64_bin
;
2518 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
2519 DBG3("Found location #2");
2520 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
2521 } else if (stat(consumerd32_bin
, &st
) == 0) {
2522 DBG3("Found location #3");
2523 consumer_to_use
= consumerd32_bin
;
2525 DBG("Could not find any valid consumerd executable");
2529 DBG("Using kernel consumer at: %s", consumer_to_use
);
2530 ret
= execl(consumer_to_use
,
2531 "lttng-consumerd", verbosity
, "-k",
2532 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2533 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2534 "--group", tracing_group_name
,
2537 case LTTNG_CONSUMER64_UST
:
2539 char *tmpnew
= NULL
;
2541 if (consumerd64_libdir
[0] != '\0') {
2545 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2549 tmplen
= strlen("LD_LIBRARY_PATH=")
2550 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
2551 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2556 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2557 strcat(tmpnew
, consumerd64_libdir
);
2558 if (tmp
[0] != '\0') {
2559 strcat(tmpnew
, ":");
2560 strcat(tmpnew
, tmp
);
2562 ret
= putenv(tmpnew
);
2569 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
2570 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
2571 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2572 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2573 "--group", tracing_group_name
,
2575 if (consumerd64_libdir
[0] != '\0') {
2580 case LTTNG_CONSUMER32_UST
:
2582 char *tmpnew
= NULL
;
2584 if (consumerd32_libdir
[0] != '\0') {
2588 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2592 tmplen
= strlen("LD_LIBRARY_PATH=")
2593 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
2594 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2599 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2600 strcat(tmpnew
, consumerd32_libdir
);
2601 if (tmp
[0] != '\0') {
2602 strcat(tmpnew
, ":");
2603 strcat(tmpnew
, tmp
);
2605 ret
= putenv(tmpnew
);
2612 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
2613 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
2614 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2615 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2616 "--group", tracing_group_name
,
2618 if (consumerd32_libdir
[0] != '\0') {
2624 PERROR("unknown consumer type");
2628 PERROR("Consumer execl()");
2630 /* Reaching this point, we got a failure on our execl(). */
2632 } else if (pid
> 0) {
2635 PERROR("start consumer fork");
2643 * Spawn the consumerd daemon and session daemon thread.
2645 static int start_consumerd(struct consumer_data
*consumer_data
)
2650 * Set the listen() state on the socket since there is a possible race
2651 * between the exec() of the consumer daemon and this call if place in the
2652 * consumer thread. See bug #366 for more details.
2654 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
2659 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2660 if (consumer_data
->pid
!= 0) {
2661 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2665 ret
= spawn_consumerd(consumer_data
);
2667 ERR("Spawning consumerd failed");
2668 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2672 /* Setting up the consumer_data pid */
2673 consumer_data
->pid
= ret
;
2674 DBG2("Consumer pid %d", consumer_data
->pid
);
2675 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2677 DBG2("Spawning consumer control thread");
2678 ret
= spawn_consumer_thread(consumer_data
);
2680 ERR("Fatal error spawning consumer control thread");
2688 /* Cleanup already created sockets on error. */
2689 if (consumer_data
->err_sock
>= 0) {
2692 err
= close(consumer_data
->err_sock
);
2694 PERROR("close consumer data error socket");
2701 * Setup necessary data for kernel tracer action.
2703 static int init_kernel_tracer(void)
2707 /* Modprobe lttng kernel modules */
2708 ret
= modprobe_lttng_control();
2713 /* Open debugfs lttng */
2714 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
2715 if (kernel_tracer_fd
< 0) {
2716 DBG("Failed to open %s", module_proc_lttng
);
2721 /* Validate kernel version */
2722 ret
= kernel_validate_version(kernel_tracer_fd
);
2727 ret
= modprobe_lttng_data();
2732 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
2736 modprobe_remove_lttng_control();
2737 ret
= close(kernel_tracer_fd
);
2741 kernel_tracer_fd
= -1;
2742 return LTTNG_ERR_KERN_VERSION
;
2745 ret
= close(kernel_tracer_fd
);
2751 modprobe_remove_lttng_control();
2754 WARN("No kernel tracer available");
2755 kernel_tracer_fd
= -1;
2757 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
2759 return LTTNG_ERR_KERN_NA
;
2765 * Copy consumer output from the tracing session to the domain session. The
2766 * function also applies the right modification on a per domain basis for the
2767 * trace files destination directory.
2769 * Should *NOT* be called with RCU read-side lock held.
2771 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2774 const char *dir_name
;
2775 struct consumer_output
*consumer
;
2778 assert(session
->consumer
);
2781 case LTTNG_DOMAIN_KERNEL
:
2782 DBG3("Copying tracing session consumer output in kernel session");
2784 * XXX: We should audit the session creation and what this function
2785 * does "extra" in order to avoid a destroy since this function is used
2786 * in the domain session creation (kernel and ust) only. Same for UST
2789 if (session
->kernel_session
->consumer
) {
2790 consumer_output_put(session
->kernel_session
->consumer
);
2792 session
->kernel_session
->consumer
=
2793 consumer_copy_output(session
->consumer
);
2794 /* Ease our life a bit for the next part */
2795 consumer
= session
->kernel_session
->consumer
;
2796 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2798 case LTTNG_DOMAIN_JUL
:
2799 case LTTNG_DOMAIN_LOG4J
:
2800 case LTTNG_DOMAIN_PYTHON
:
2801 case LTTNG_DOMAIN_UST
:
2802 DBG3("Copying tracing session consumer output in UST session");
2803 if (session
->ust_session
->consumer
) {
2804 consumer_output_put(session
->ust_session
->consumer
);
2806 session
->ust_session
->consumer
=
2807 consumer_copy_output(session
->consumer
);
2808 /* Ease our life a bit for the next part */
2809 consumer
= session
->ust_session
->consumer
;
2810 dir_name
= DEFAULT_UST_TRACE_DIR
;
2813 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2817 /* Append correct directory to subdir */
2818 strncat(consumer
->subdir
, dir_name
,
2819 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
2820 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2829 * Create an UST session and add it to the session ust list.
2831 * Should *NOT* be called with RCU read-side lock held.
2833 static int create_ust_session(struct ltt_session
*session
,
2834 struct lttng_domain
*domain
)
2837 struct ltt_ust_session
*lus
= NULL
;
2841 assert(session
->consumer
);
2843 switch (domain
->type
) {
2844 case LTTNG_DOMAIN_JUL
:
2845 case LTTNG_DOMAIN_LOG4J
:
2846 case LTTNG_DOMAIN_PYTHON
:
2847 case LTTNG_DOMAIN_UST
:
2850 ERR("Unknown UST domain on create session %d", domain
->type
);
2851 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2855 DBG("Creating UST session");
2857 lus
= trace_ust_create_session(session
->id
);
2859 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2863 lus
->uid
= session
->uid
;
2864 lus
->gid
= session
->gid
;
2865 lus
->output_traces
= session
->output_traces
;
2866 lus
->snapshot_mode
= session
->snapshot_mode
;
2867 lus
->live_timer_interval
= session
->live_timer
;
2868 session
->ust_session
= lus
;
2869 if (session
->shm_path
[0]) {
2870 strncpy(lus
->root_shm_path
, session
->shm_path
,
2871 sizeof(lus
->root_shm_path
));
2872 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
2873 strncpy(lus
->shm_path
, session
->shm_path
,
2874 sizeof(lus
->shm_path
));
2875 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
2876 strncat(lus
->shm_path
, "/ust",
2877 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
2879 /* Copy session output to the newly created UST session */
2880 ret
= copy_session_consumer(domain
->type
, session
);
2881 if (ret
!= LTTNG_OK
) {
2889 session
->ust_session
= NULL
;
2894 * Create a kernel tracer session then create the default channel.
2896 static int create_kernel_session(struct ltt_session
*session
)
2900 DBG("Creating kernel session");
2902 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2904 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2908 /* Code flow safety */
2909 assert(session
->kernel_session
);
2911 /* Copy session output to the newly created Kernel session */
2912 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2913 if (ret
!= LTTNG_OK
) {
2917 /* Create directory(ies) on local filesystem. */
2918 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2919 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2920 ret
= run_as_mkdir_recursive(
2921 session
->kernel_session
->consumer
->dst
.trace_path
,
2922 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2924 if (errno
!= EEXIST
) {
2925 ERR("Trace directory creation error");
2931 session
->kernel_session
->uid
= session
->uid
;
2932 session
->kernel_session
->gid
= session
->gid
;
2933 session
->kernel_session
->output_traces
= session
->output_traces
;
2934 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
2939 trace_kernel_destroy_session(session
->kernel_session
);
2940 session
->kernel_session
= NULL
;
2945 * Count number of session permitted by uid/gid.
2947 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2950 struct ltt_session
*session
;
2952 DBG("Counting number of available session for UID %d GID %d",
2954 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2956 * Only list the sessions the user can control.
2958 if (!session_access_ok(session
, uid
, gid
)) {
2967 * Process the command requested by the lttng client within the command
2968 * context structure. This function make sure that the return structure (llm)
2969 * is set and ready for transmission before returning.
2971 * Return any error encountered or 0 for success.
2973 * "sock" is only used for special-case var. len data.
2975 * Should *NOT* be called with RCU read-side lock held.
2977 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2981 int need_tracing_session
= 1;
2984 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2986 assert(!rcu_read_ongoing());
2990 switch (cmd_ctx
->lsm
->cmd_type
) {
2991 case LTTNG_CREATE_SESSION
:
2992 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2993 case LTTNG_CREATE_SESSION_LIVE
:
2994 case LTTNG_DESTROY_SESSION
:
2995 case LTTNG_LIST_SESSIONS
:
2996 case LTTNG_LIST_DOMAINS
:
2997 case LTTNG_START_TRACE
:
2998 case LTTNG_STOP_TRACE
:
2999 case LTTNG_DATA_PENDING
:
3000 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3001 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3002 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3003 case LTTNG_SNAPSHOT_RECORD
:
3004 case LTTNG_SAVE_SESSION
:
3005 case LTTNG_SET_SESSION_SHM_PATH
:
3006 case LTTNG_REGENERATE_METADATA
:
3007 case LTTNG_REGENERATE_STATEDUMP
:
3014 if (opt_no_kernel
&& need_domain
3015 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3017 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3019 ret
= LTTNG_ERR_KERN_NA
;
3024 /* Deny register consumer if we already have a spawned consumer. */
3025 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
3026 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3027 if (kconsumer_data
.pid
> 0) {
3028 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3029 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3032 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3036 * Check for command that don't needs to allocate a returned payload. We do
3037 * this here so we don't have to make the call for no payload at each
3040 switch(cmd_ctx
->lsm
->cmd_type
) {
3041 case LTTNG_LIST_SESSIONS
:
3042 case LTTNG_LIST_TRACEPOINTS
:
3043 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3044 case LTTNG_LIST_DOMAINS
:
3045 case LTTNG_LIST_CHANNELS
:
3046 case LTTNG_LIST_EVENTS
:
3047 case LTTNG_LIST_SYSCALLS
:
3048 case LTTNG_LIST_TRACKER_PIDS
:
3049 case LTTNG_DATA_PENDING
:
3052 /* Setup lttng message with no payload */
3053 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
3055 /* This label does not try to unlock the session */
3056 goto init_setup_error
;
3060 /* Commands that DO NOT need a session. */
3061 switch (cmd_ctx
->lsm
->cmd_type
) {
3062 case LTTNG_CREATE_SESSION
:
3063 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3064 case LTTNG_CREATE_SESSION_LIVE
:
3065 case LTTNG_CALIBRATE
:
3066 case LTTNG_LIST_SESSIONS
:
3067 case LTTNG_LIST_TRACEPOINTS
:
3068 case LTTNG_LIST_SYSCALLS
:
3069 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3070 case LTTNG_SAVE_SESSION
:
3071 need_tracing_session
= 0;
3074 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3076 * We keep the session list lock across _all_ commands
3077 * for now, because the per-session lock does not
3078 * handle teardown properly.
3080 session_lock_list();
3081 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3082 if (cmd_ctx
->session
== NULL
) {
3083 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
3086 /* Acquire lock for the session */
3087 session_lock(cmd_ctx
->session
);
3093 * Commands that need a valid session but should NOT create one if none
3094 * exists. Instead of creating one and destroying it when the command is
3095 * handled, process that right before so we save some round trip in useless
3098 switch (cmd_ctx
->lsm
->cmd_type
) {
3099 case LTTNG_DISABLE_CHANNEL
:
3100 case LTTNG_DISABLE_EVENT
:
3101 switch (cmd_ctx
->lsm
->domain
.type
) {
3102 case LTTNG_DOMAIN_KERNEL
:
3103 if (!cmd_ctx
->session
->kernel_session
) {
3104 ret
= LTTNG_ERR_NO_CHANNEL
;
3108 case LTTNG_DOMAIN_JUL
:
3109 case LTTNG_DOMAIN_LOG4J
:
3110 case LTTNG_DOMAIN_PYTHON
:
3111 case LTTNG_DOMAIN_UST
:
3112 if (!cmd_ctx
->session
->ust_session
) {
3113 ret
= LTTNG_ERR_NO_CHANNEL
;
3118 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3130 * Check domain type for specific "pre-action".
3132 switch (cmd_ctx
->lsm
->domain
.type
) {
3133 case LTTNG_DOMAIN_KERNEL
:
3135 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3139 /* Kernel tracer check */
3140 if (kernel_tracer_fd
== -1) {
3141 /* Basically, load kernel tracer modules */
3142 ret
= init_kernel_tracer();
3148 /* Consumer is in an ERROR state. Report back to client */
3149 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3150 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3154 /* Need a session for kernel command */
3155 if (need_tracing_session
) {
3156 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3157 ret
= create_kernel_session(cmd_ctx
->session
);
3159 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
3164 /* Start the kernel consumer daemon */
3165 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3166 if (kconsumer_data
.pid
== 0 &&
3167 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3168 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3169 ret
= start_consumerd(&kconsumer_data
);
3171 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3174 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3176 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3180 * The consumer was just spawned so we need to add the socket to
3181 * the consumer output of the session if exist.
3183 ret
= consumer_create_socket(&kconsumer_data
,
3184 cmd_ctx
->session
->kernel_session
->consumer
);
3191 case LTTNG_DOMAIN_JUL
:
3192 case LTTNG_DOMAIN_LOG4J
:
3193 case LTTNG_DOMAIN_PYTHON
:
3194 case LTTNG_DOMAIN_UST
:
3196 if (!ust_app_supported()) {
3197 ret
= LTTNG_ERR_NO_UST
;
3200 /* Consumer is in an ERROR state. Report back to client */
3201 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3202 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3206 if (need_tracing_session
) {
3207 /* Create UST session if none exist. */
3208 if (cmd_ctx
->session
->ust_session
== NULL
) {
3209 ret
= create_ust_session(cmd_ctx
->session
,
3210 &cmd_ctx
->lsm
->domain
);
3211 if (ret
!= LTTNG_OK
) {
3216 /* Start the UST consumer daemons */
3218 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3219 if (consumerd64_bin
[0] != '\0' &&
3220 ustconsumer64_data
.pid
== 0 &&
3221 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3222 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3223 ret
= start_consumerd(&ustconsumer64_data
);
3225 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
3226 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
3230 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
3231 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3233 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3237 * Setup socket for consumer 64 bit. No need for atomic access
3238 * since it was set above and can ONLY be set in this thread.
3240 ret
= consumer_create_socket(&ustconsumer64_data
,
3241 cmd_ctx
->session
->ust_session
->consumer
);
3247 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
3248 if (consumerd32_bin
[0] != '\0' &&
3249 ustconsumer32_data
.pid
== 0 &&
3250 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3251 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3252 ret
= start_consumerd(&ustconsumer32_data
);
3254 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
3255 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
3259 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
3260 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3262 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3266 * Setup socket for consumer 64 bit. No need for atomic access
3267 * since it was set above and can ONLY be set in this thread.
3269 ret
= consumer_create_socket(&ustconsumer32_data
,
3270 cmd_ctx
->session
->ust_session
->consumer
);
3282 /* Validate consumer daemon state when start/stop trace command */
3283 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3284 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3285 switch (cmd_ctx
->lsm
->domain
.type
) {
3286 case LTTNG_DOMAIN_NONE
:
3288 case LTTNG_DOMAIN_JUL
:
3289 case LTTNG_DOMAIN_LOG4J
:
3290 case LTTNG_DOMAIN_PYTHON
:
3291 case LTTNG_DOMAIN_UST
:
3292 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3293 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3297 case LTTNG_DOMAIN_KERNEL
:
3298 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3299 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3304 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3310 * Check that the UID or GID match that of the tracing session.
3311 * The root user can interact with all sessions.
3313 if (need_tracing_session
) {
3314 if (!session_access_ok(cmd_ctx
->session
,
3315 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3316 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3317 ret
= LTTNG_ERR_EPERM
;
3323 * Send relayd information to consumer as soon as we have a domain and a
3326 if (cmd_ctx
->session
&& need_domain
) {
3328 * Setup relayd if not done yet. If the relayd information was already
3329 * sent to the consumer, this call will gracefully return.
3331 ret
= cmd_setup_relayd(cmd_ctx
->session
);
3332 if (ret
!= LTTNG_OK
) {
3337 /* Process by command type */
3338 switch (cmd_ctx
->lsm
->cmd_type
) {
3339 case LTTNG_ADD_CONTEXT
:
3342 * An LTTNG_ADD_CONTEXT command might have a supplementary
3343 * payload if the context being added is an application context.
3345 if (cmd_ctx
->lsm
->u
.context
.ctx
.ctx
==
3346 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
3347 char *provider_name
= NULL
, *context_name
= NULL
;
3348 size_t provider_name_len
=
3349 cmd_ctx
->lsm
->u
.context
.provider_name_len
;
3350 size_t context_name_len
=
3351 cmd_ctx
->lsm
->u
.context
.context_name_len
;
3353 if (provider_name_len
== 0 || context_name_len
== 0) {
3355 * Application provider and context names MUST
3358 ret
= -LTTNG_ERR_INVALID
;
3362 provider_name
= zmalloc(provider_name_len
+ 1);
3363 if (!provider_name
) {
3364 ret
= -LTTNG_ERR_NOMEM
;
3367 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
=
3370 context_name
= zmalloc(context_name_len
+ 1);
3371 if (!context_name
) {
3372 ret
= -LTTNG_ERR_NOMEM
;
3373 goto error_add_context
;
3375 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
=
3378 ret
= lttcomm_recv_unix_sock(sock
, provider_name
,
3381 goto error_add_context
;
3384 ret
= lttcomm_recv_unix_sock(sock
, context_name
,
3387 goto error_add_context
;
3392 * cmd_add_context assumes ownership of the provider and context
3395 ret
= cmd_add_context(cmd_ctx
->session
,
3396 cmd_ctx
->lsm
->domain
.type
,
3397 cmd_ctx
->lsm
->u
.context
.channel_name
,
3398 &cmd_ctx
->lsm
->u
.context
.ctx
,
3399 kernel_poll_pipe
[1]);
3401 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
3402 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
3404 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
);
3405 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
);
3411 case LTTNG_DISABLE_CHANNEL
:
3413 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3414 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3417 case LTTNG_DISABLE_EVENT
:
3421 * FIXME: handle filter; for now we just receive the filter's
3422 * bytecode along with the filter expression which are sent by
3423 * liblttng-ctl and discard them.
3425 * This fixes an issue where the client may block while sending
3426 * the filter payload and encounter an error because the session
3427 * daemon closes the socket without ever handling this data.
3429 size_t count
= cmd_ctx
->lsm
->u
.disable
.expression_len
+
3430 cmd_ctx
->lsm
->u
.disable
.bytecode_len
;
3433 char data
[LTTNG_FILTER_MAX_LEN
];
3435 DBG("Discarding disable event command payload of size %zu", count
);
3437 ret
= lttcomm_recv_unix_sock(sock
, data
,
3438 count
> sizeof(data
) ? sizeof(data
) : count
);
3443 count
-= (size_t) ret
;
3446 /* FIXME: passing packed structure to non-packed pointer */
3447 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3448 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3449 &cmd_ctx
->lsm
->u
.disable
.event
);
3452 case LTTNG_ENABLE_CHANNEL
:
3454 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3455 &cmd_ctx
->lsm
->u
.channel
.chan
, kernel_poll_pipe
[1]);
3458 case LTTNG_TRACK_PID
:
3460 ret
= cmd_track_pid(cmd_ctx
->session
,
3461 cmd_ctx
->lsm
->domain
.type
,
3462 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3465 case LTTNG_UNTRACK_PID
:
3467 ret
= cmd_untrack_pid(cmd_ctx
->session
,
3468 cmd_ctx
->lsm
->domain
.type
,
3469 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3472 case LTTNG_ENABLE_EVENT
:
3474 struct lttng_event_exclusion
*exclusion
= NULL
;
3475 struct lttng_filter_bytecode
*bytecode
= NULL
;
3476 char *filter_expression
= NULL
;
3478 /* Handle exclusion events and receive it from the client. */
3479 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
3480 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
3482 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
3483 (count
* LTTNG_SYMBOL_NAME_LEN
));
3485 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
3489 DBG("Receiving var len exclusion event list from client ...");
3490 exclusion
->count
= count
;
3491 ret
= lttcomm_recv_unix_sock(sock
, exclusion
->names
,
3492 count
* LTTNG_SYMBOL_NAME_LEN
);
3494 DBG("Nothing recv() from client var len data... continuing");
3497 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
3502 /* Get filter expression from client. */
3503 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
3504 size_t expression_len
=
3505 cmd_ctx
->lsm
->u
.enable
.expression_len
;
3507 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
3508 ret
= LTTNG_ERR_FILTER_INVAL
;
3513 filter_expression
= zmalloc(expression_len
);
3514 if (!filter_expression
) {
3516 ret
= LTTNG_ERR_FILTER_NOMEM
;
3520 /* Receive var. len. data */
3521 DBG("Receiving var len filter's expression from client ...");
3522 ret
= lttcomm_recv_unix_sock(sock
, filter_expression
,
3525 DBG("Nothing recv() from client car len data... continuing");
3527 free(filter_expression
);
3529 ret
= LTTNG_ERR_FILTER_INVAL
;
3534 /* Handle filter and get bytecode from client. */
3535 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
3536 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
3538 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
3539 ret
= LTTNG_ERR_FILTER_INVAL
;
3540 free(filter_expression
);
3545 bytecode
= zmalloc(bytecode_len
);
3547 free(filter_expression
);
3549 ret
= LTTNG_ERR_FILTER_NOMEM
;
3553 /* Receive var. len. data */
3554 DBG("Receiving var len filter's bytecode from client ...");
3555 ret
= lttcomm_recv_unix_sock(sock
, bytecode
, bytecode_len
);
3557 DBG("Nothing recv() from client car len data... continuing");
3559 free(filter_expression
);
3562 ret
= LTTNG_ERR_FILTER_INVAL
;
3566 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
3567 free(filter_expression
);
3570 ret
= LTTNG_ERR_FILTER_INVAL
;
3575 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3576 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3577 &cmd_ctx
->lsm
->u
.enable
.event
,
3578 filter_expression
, bytecode
, exclusion
,
3579 kernel_poll_pipe
[1]);
3582 case LTTNG_LIST_TRACEPOINTS
:
3584 struct lttng_event
*events
;
3587 session_lock_list();
3588 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3589 session_unlock_list();
3590 if (nb_events
< 0) {
3591 /* Return value is a negative lttng_error_code. */
3597 * Setup lttng message with payload size set to the event list size in
3598 * bytes and then copy list into the llm payload.
3600 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
3601 sizeof(struct lttng_event
) * nb_events
);
3611 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3613 struct lttng_event_field
*fields
;
3616 session_lock_list();
3617 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
3619 session_unlock_list();
3620 if (nb_fields
< 0) {
3621 /* Return value is a negative lttng_error_code. */
3627 * Setup lttng message with payload size set to the event list size in
3628 * bytes and then copy list into the llm payload.
3630 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
3631 sizeof(struct lttng_event_field
) * nb_fields
);
3641 case LTTNG_LIST_SYSCALLS
:
3643 struct lttng_event
*events
;
3646 nb_events
= cmd_list_syscalls(&events
);
3647 if (nb_events
< 0) {
3648 /* Return value is a negative lttng_error_code. */
3654 * Setup lttng message with payload size set to the event list size in
3655 * bytes and then copy list into the llm payload.
3657 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
3658 sizeof(struct lttng_event
) * nb_events
);
3668 case LTTNG_LIST_TRACKER_PIDS
:
3670 int32_t *pids
= NULL
;
3673 nr_pids
= cmd_list_tracker_pids(cmd_ctx
->session
,
3674 cmd_ctx
->lsm
->domain
.type
, &pids
);
3676 /* Return value is a negative lttng_error_code. */
3682 * Setup lttng message with payload size set to the event list size in
3683 * bytes and then copy list into the llm payload.
3685 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, pids
,
3686 sizeof(int32_t) * nr_pids
);
3696 case LTTNG_SET_CONSUMER_URI
:
3699 struct lttng_uri
*uris
;
3701 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3702 len
= nb_uri
* sizeof(struct lttng_uri
);
3705 ret
= LTTNG_ERR_INVALID
;
3709 uris
= zmalloc(len
);
3711 ret
= LTTNG_ERR_FATAL
;
3715 /* Receive variable len data */
3716 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
3717 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3719 DBG("No URIs received from client... continuing");
3721 ret
= LTTNG_ERR_SESSION_FAIL
;
3726 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
3728 if (ret
!= LTTNG_OK
) {
3735 case LTTNG_START_TRACE
:
3737 ret
= cmd_start_trace(cmd_ctx
->session
);
3740 case LTTNG_STOP_TRACE
:
3742 ret
= cmd_stop_trace(cmd_ctx
->session
);
3745 case LTTNG_CREATE_SESSION
:
3748 struct lttng_uri
*uris
= NULL
;
3750 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3751 len
= nb_uri
* sizeof(struct lttng_uri
);
3754 uris
= zmalloc(len
);
3756 ret
= LTTNG_ERR_FATAL
;
3760 /* Receive variable len data */
3761 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3762 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3764 DBG("No URIs received from client... continuing");
3766 ret
= LTTNG_ERR_SESSION_FAIL
;
3771 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3772 DBG("Creating session with ONE network URI is a bad call");
3773 ret
= LTTNG_ERR_SESSION_FAIL
;
3779 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
3780 &cmd_ctx
->creds
, 0);
3786 case LTTNG_DESTROY_SESSION
:
3788 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
3790 /* Set session to NULL so we do not unlock it after free. */
3791 cmd_ctx
->session
= NULL
;
3794 case LTTNG_LIST_DOMAINS
:
3797 struct lttng_domain
*domains
= NULL
;
3799 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3801 /* Return value is a negative lttng_error_code. */
3806 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
3807 nb_dom
* sizeof(struct lttng_domain
));
3817 case LTTNG_LIST_CHANNELS
:
3819 ssize_t payload_size
;
3820 struct lttng_channel
*channels
= NULL
;
3822 payload_size
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3823 cmd_ctx
->session
, &channels
);
3824 if (payload_size
< 0) {
3825 /* Return value is a negative lttng_error_code. */
3826 ret
= -payload_size
;
3830 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, channels
,
3841 case LTTNG_LIST_EVENTS
:
3844 struct lttng_event
*events
= NULL
;
3845 struct lttcomm_event_command_header cmd_header
;
3848 memset(&cmd_header
, 0, sizeof(cmd_header
));
3849 /* Extended infos are included at the end of events */
3850 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
,
3851 cmd_ctx
->session
, cmd_ctx
->lsm
->u
.list
.channel_name
,
3852 &events
, &total_size
);
3855 /* Return value is a negative lttng_error_code. */
3860 cmd_header
.nb_events
= nb_event
;
3861 ret
= setup_lttng_msg(cmd_ctx
, events
, total_size
,
3862 &cmd_header
, sizeof(cmd_header
));
3872 case LTTNG_LIST_SESSIONS
:
3874 unsigned int nr_sessions
;
3875 void *sessions_payload
;
3878 session_lock_list();
3879 nr_sessions
= lttng_sessions_count(
3880 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3881 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3882 payload_len
= sizeof(struct lttng_session
) * nr_sessions
;
3883 sessions_payload
= zmalloc(payload_len
);
3885 if (!sessions_payload
) {
3886 session_unlock_list();
3891 cmd_list_lttng_sessions(sessions_payload
,
3892 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3893 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3894 session_unlock_list();
3896 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
3898 free(sessions_payload
);
3907 case LTTNG_CALIBRATE
:
3909 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3910 &cmd_ctx
->lsm
->u
.calibrate
);
3913 case LTTNG_REGISTER_CONSUMER
:
3915 struct consumer_data
*cdata
;
3917 switch (cmd_ctx
->lsm
->domain
.type
) {
3918 case LTTNG_DOMAIN_KERNEL
:
3919 cdata
= &kconsumer_data
;
3922 ret
= LTTNG_ERR_UND
;
3926 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3927 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
3930 case LTTNG_DATA_PENDING
:
3933 uint8_t pending_ret_byte
;
3935 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
3940 * This function may returns 0 or 1 to indicate whether or not
3941 * there is data pending. In case of error, it should return an
3942 * LTTNG_ERR code. However, some code paths may still return
3943 * a nondescript error code, which we handle by returning an
3946 if (pending_ret
== 0 || pending_ret
== 1) {
3948 * ret will be set to LTTNG_OK at the end of
3951 } else if (pending_ret
< 0) {
3952 ret
= LTTNG_ERR_UNK
;
3959 pending_ret_byte
= (uint8_t) pending_ret
;
3961 /* 1 byte to return whether or not data is pending */
3962 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
3963 &pending_ret_byte
, 1);
3972 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3974 struct lttcomm_lttng_output_id reply
;
3976 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
3977 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
3978 if (ret
!= LTTNG_OK
) {
3982 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
3988 /* Copy output list into message payload */
3992 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3994 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
3995 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
3998 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
4001 struct lttng_snapshot_output
*outputs
= NULL
;
4003 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
4004 if (nb_output
< 0) {
4009 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
4010 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
4011 nb_output
* sizeof(struct lttng_snapshot_output
));
4021 case LTTNG_SNAPSHOT_RECORD
:
4023 ret
= cmd_snapshot_record(cmd_ctx
->session
,
4024 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
4025 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
4028 case LTTNG_CREATE_SESSION_SNAPSHOT
:
4031 struct lttng_uri
*uris
= NULL
;
4033 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4034 len
= nb_uri
* sizeof(struct lttng_uri
);
4037 uris
= zmalloc(len
);
4039 ret
= LTTNG_ERR_FATAL
;
4043 /* Receive variable len data */
4044 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4045 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4047 DBG("No URIs received from client... continuing");
4049 ret
= LTTNG_ERR_SESSION_FAIL
;
4054 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4055 DBG("Creating session with ONE network URI is a bad call");
4056 ret
= LTTNG_ERR_SESSION_FAIL
;
4062 ret
= cmd_create_session_snapshot(cmd_ctx
->lsm
->session
.name
, uris
,
4063 nb_uri
, &cmd_ctx
->creds
);
4067 case LTTNG_CREATE_SESSION_LIVE
:
4070 struct lttng_uri
*uris
= NULL
;
4072 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4073 len
= nb_uri
* sizeof(struct lttng_uri
);
4076 uris
= zmalloc(len
);
4078 ret
= LTTNG_ERR_FATAL
;
4082 /* Receive variable len data */
4083 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4084 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4086 DBG("No URIs received from client... continuing");
4088 ret
= LTTNG_ERR_SESSION_FAIL
;
4093 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4094 DBG("Creating session with ONE network URI is a bad call");
4095 ret
= LTTNG_ERR_SESSION_FAIL
;
4101 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
,
4102 nb_uri
, &cmd_ctx
->creds
, cmd_ctx
->lsm
->u
.session_live
.timer_interval
);
4106 case LTTNG_SAVE_SESSION
:
4108 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
4112 case LTTNG_SET_SESSION_SHM_PATH
:
4114 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
4115 cmd_ctx
->lsm
->u
.set_shm_path
.shm_path
);
4118 case LTTNG_REGENERATE_METADATA
:
4120 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
4123 case LTTNG_REGENERATE_STATEDUMP
:
4125 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
4129 ret
= LTTNG_ERR_UND
;
4134 if (cmd_ctx
->llm
== NULL
) {
4135 DBG("Missing llm structure. Allocating one.");
4136 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
4140 /* Set return code */
4141 cmd_ctx
->llm
->ret_code
= ret
;
4143 if (cmd_ctx
->session
) {
4144 session_unlock(cmd_ctx
->session
);
4146 if (need_tracing_session
) {
4147 session_unlock_list();
4150 assert(!rcu_read_ongoing());
4155 * Thread managing health check socket.
4157 static void *thread_manage_health(void *data
)
4159 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
4160 uint32_t revents
, nb_fd
;
4161 struct lttng_poll_event events
;
4162 struct health_comm_msg msg
;
4163 struct health_comm_reply reply
;
4165 DBG("[thread] Manage health check started");
4167 rcu_register_thread();
4169 /* We might hit an error path before this is created. */
4170 lttng_poll_init(&events
);
4172 /* Create unix socket */
4173 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
4175 ERR("Unable to create health check Unix socket");
4180 /* lttng health client socket path permissions */
4181 ret
= chown(health_unix_sock_path
, 0,
4182 utils_get_group_id(tracing_group_name
));
4184 ERR("Unable to set group on %s", health_unix_sock_path
);
4189 ret
= chmod(health_unix_sock_path
,
4190 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4192 ERR("Unable to set permissions on %s", health_unix_sock_path
);
4199 * Set the CLOEXEC flag. Return code is useless because either way, the
4202 (void) utils_set_fd_cloexec(sock
);
4204 ret
= lttcomm_listen_unix_sock(sock
);
4210 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4211 * more will be added to this poll set.
4213 ret
= sessiond_set_thread_pollset(&events
, 2);
4218 /* Add the application registration socket */
4219 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
4224 sessiond_notify_ready();
4227 DBG("Health check ready");
4229 /* Inifinite blocking call, waiting for transmission */
4231 ret
= lttng_poll_wait(&events
, -1);
4234 * Restart interrupted system call.
4236 if (errno
== EINTR
) {
4244 for (i
= 0; i
< nb_fd
; i
++) {
4245 /* Fetch once the poll data */
4246 revents
= LTTNG_POLL_GETEV(&events
, i
);
4247 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4250 /* No activity for this FD (poll implementation). */
4254 /* Thread quit pipe has been closed. Killing thread. */
4255 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4261 /* Event on the registration socket */
4262 if (pollfd
== sock
) {
4263 if (revents
& LPOLLIN
) {
4265 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4266 ERR("Health socket poll error");
4269 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4275 new_sock
= lttcomm_accept_unix_sock(sock
);
4281 * Set the CLOEXEC flag. Return code is useless because either way, the
4284 (void) utils_set_fd_cloexec(new_sock
);
4286 DBG("Receiving data from client for health...");
4287 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
4289 DBG("Nothing recv() from client... continuing");
4290 ret
= close(new_sock
);
4297 rcu_thread_online();
4299 memset(&reply
, 0, sizeof(reply
));
4300 for (i
= 0; i
< NR_HEALTH_SESSIOND_TYPES
; i
++) {
4302 * health_check_state returns 0 if health is
4305 if (!health_check_state(health_sessiond
, i
)) {
4306 reply
.ret_code
|= 1ULL << i
;
4310 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
4312 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
4314 ERR("Failed to send health data back to client");
4317 /* End of transmission */
4318 ret
= close(new_sock
);
4327 ERR("Health error occurred in %s", __func__
);
4329 DBG("Health check thread dying");
4330 unlink(health_unix_sock_path
);
4338 lttng_poll_clean(&events
);
4340 rcu_unregister_thread();
4345 * This thread manage all clients request using the unix client socket for
4348 static void *thread_manage_clients(void *data
)
4350 int sock
= -1, ret
, i
, pollfd
, err
= -1;
4352 uint32_t revents
, nb_fd
;
4353 struct command_ctx
*cmd_ctx
= NULL
;
4354 struct lttng_poll_event events
;
4356 DBG("[thread] Manage client started");
4358 rcu_register_thread();
4360 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
4362 health_code_update();
4364 ret
= lttcomm_listen_unix_sock(client_sock
);
4370 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4371 * more will be added to this poll set.
4373 ret
= sessiond_set_thread_pollset(&events
, 2);
4375 goto error_create_poll
;
4378 /* Add the application registration socket */
4379 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
4384 sessiond_notify_ready();
4385 ret
= sem_post(&load_info
->message_thread_ready
);
4387 PERROR("sem_post message_thread_ready");
4391 /* This testpoint is after we signal readiness to the parent. */
4392 if (testpoint(sessiond_thread_manage_clients
)) {
4396 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
4400 health_code_update();
4403 DBG("Accepting client command ...");
4405 /* Inifinite blocking call, waiting for transmission */
4407 health_poll_entry();
4408 ret
= lttng_poll_wait(&events
, -1);
4412 * Restart interrupted system call.
4414 if (errno
== EINTR
) {
4422 for (i
= 0; i
< nb_fd
; i
++) {
4423 /* Fetch once the poll data */
4424 revents
= LTTNG_POLL_GETEV(&events
, i
);
4425 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4427 health_code_update();
4430 /* No activity for this FD (poll implementation). */
4434 /* Thread quit pipe has been closed. Killing thread. */
4435 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4441 /* Event on the registration socket */
4442 if (pollfd
== client_sock
) {
4443 if (revents
& LPOLLIN
) {
4445 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4446 ERR("Client socket poll error");
4449 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4455 DBG("Wait for client response");
4457 health_code_update();
4459 sock
= lttcomm_accept_unix_sock(client_sock
);
4465 * Set the CLOEXEC flag. Return code is useless because either way, the
4468 (void) utils_set_fd_cloexec(sock
);
4470 /* Set socket option for credentials retrieval */
4471 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
4476 /* Allocate context command to process the client request */
4477 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
4478 if (cmd_ctx
== NULL
) {
4479 PERROR("zmalloc cmd_ctx");
4483 /* Allocate data buffer for reception */
4484 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
4485 if (cmd_ctx
->lsm
== NULL
) {
4486 PERROR("zmalloc cmd_ctx->lsm");
4490 cmd_ctx
->llm
= NULL
;
4491 cmd_ctx
->session
= NULL
;
4493 health_code_update();
4496 * Data is received from the lttng client. The struct
4497 * lttcomm_session_msg (lsm) contains the command and data request of
4500 DBG("Receiving data from client ...");
4501 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
4502 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
4504 DBG("Nothing recv() from client... continuing");
4510 clean_command_ctx(&cmd_ctx
);
4514 health_code_update();
4516 // TODO: Validate cmd_ctx including sanity check for
4517 // security purpose.
4519 rcu_thread_online();
4521 * This function dispatch the work to the kernel or userspace tracer
4522 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4523 * informations for the client. The command context struct contains
4524 * everything this function may needs.
4526 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
4527 rcu_thread_offline();
4535 * TODO: Inform client somehow of the fatal error. At
4536 * this point, ret < 0 means that a zmalloc failed
4537 * (ENOMEM). Error detected but still accept
4538 * command, unless a socket error has been
4541 clean_command_ctx(&cmd_ctx
);
4545 health_code_update();
4547 DBG("Sending response (size: %d, retcode: %s (%d))",
4548 cmd_ctx
->lttng_msg_size
,
4549 lttng_strerror(-cmd_ctx
->llm
->ret_code
),
4550 cmd_ctx
->llm
->ret_code
);
4551 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
4553 ERR("Failed to send data back to client");
4556 /* End of transmission */
4563 clean_command_ctx(&cmd_ctx
);
4565 health_code_update();
4577 lttng_poll_clean(&events
);
4578 clean_command_ctx(&cmd_ctx
);
4582 unlink(client_unix_sock_path
);
4583 if (client_sock
>= 0) {
4584 ret
= close(client_sock
);
4592 ERR("Health error occurred in %s", __func__
);
4595 health_unregister(health_sessiond
);
4597 DBG("Client thread dying");
4599 rcu_unregister_thread();
4602 * Since we are creating the consumer threads, we own them, so we need
4603 * to join them before our thread exits.
4605 ret
= join_consumer_thread(&kconsumer_data
);
4608 PERROR("join_consumer");
4611 ret
= join_consumer_thread(&ustconsumer32_data
);
4614 PERROR("join_consumer ust32");
4617 ret
= join_consumer_thread(&ustconsumer64_data
);
4620 PERROR("join_consumer ust64");
4625 static int string_match(const char *str1
, const char *str2
)
4627 return (str1
&& str2
) && !strcmp(str1
, str2
);
4631 * Take an option from the getopt output and set it in the right variable to be
4634 * Return 0 on success else a negative value.
4636 static int set_option(int opt
, const char *arg
, const char *optname
)
4640 if (string_match(optname
, "client-sock") || opt
== 'c') {
4641 if (!arg
|| *arg
== '\0') {
4645 if (lttng_is_setuid_setgid()) {
4646 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4647 "-c, --client-sock");
4649 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", arg
);
4651 } else if (string_match(optname
, "apps-sock") || opt
== 'a') {
4652 if (!arg
|| *arg
== '\0') {
4656 if (lttng_is_setuid_setgid()) {
4657 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4660 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", arg
);
4662 } else if (string_match(optname
, "daemonize") || opt
== 'd') {
4664 } else if (string_match(optname
, "background") || opt
== 'b') {
4666 } else if (string_match(optname
, "group") || opt
== 'g') {
4667 if (!arg
|| *arg
== '\0') {
4671 if (lttng_is_setuid_setgid()) {
4672 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4676 * If the override option is set, the pointer points to a
4677 * *non* const thus freeing it even though the variable type is
4680 if (tracing_group_name_override
) {
4681 free((void *) tracing_group_name
);
4683 tracing_group_name
= strdup(arg
);
4684 if (!tracing_group_name
) {
4688 tracing_group_name_override
= 1;
4690 } else if (string_match(optname
, "help") || opt
== 'h') {
4691 ret
= utils_show_man_page(8, "lttng-sessiond");
4693 ERR("Cannot view man page lttng-sessiond(8)");
4696 exit(ret
? EXIT_FAILURE
: EXIT_SUCCESS
);
4697 } else if (string_match(optname
, "version") || opt
== 'V') {
4698 fprintf(stdout
, "%s\n", VERSION
);
4700 } else if (string_match(optname
, "sig-parent") || opt
== 'S') {
4702 } else if (string_match(optname
, "kconsumerd-err-sock")) {
4703 if (!arg
|| *arg
== '\0') {
4707 if (lttng_is_setuid_setgid()) {
4708 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4709 "--kconsumerd-err-sock");
4711 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4713 } else if (string_match(optname
, "kconsumerd-cmd-sock")) {
4714 if (!arg
|| *arg
== '\0') {
4718 if (lttng_is_setuid_setgid()) {
4719 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4720 "--kconsumerd-cmd-sock");
4722 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4724 } else if (string_match(optname
, "ustconsumerd64-err-sock")) {
4725 if (!arg
|| *arg
== '\0') {
4729 if (lttng_is_setuid_setgid()) {
4730 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4731 "--ustconsumerd64-err-sock");
4733 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4735 } else if (string_match(optname
, "ustconsumerd64-cmd-sock")) {
4736 if (!arg
|| *arg
== '\0') {
4740 if (lttng_is_setuid_setgid()) {
4741 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4742 "--ustconsumerd64-cmd-sock");
4744 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4746 } else if (string_match(optname
, "ustconsumerd32-err-sock")) {
4747 if (!arg
|| *arg
== '\0') {
4751 if (lttng_is_setuid_setgid()) {
4752 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4753 "--ustconsumerd32-err-sock");
4755 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4757 } else if (string_match(optname
, "ustconsumerd32-cmd-sock")) {
4758 if (!arg
|| *arg
== '\0') {
4762 if (lttng_is_setuid_setgid()) {
4763 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4764 "--ustconsumerd32-cmd-sock");
4766 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4768 } else if (string_match(optname
, "no-kernel")) {
4770 } else if (string_match(optname
, "quiet") || opt
== 'q') {
4771 lttng_opt_quiet
= 1;
4772 } else if (string_match(optname
, "verbose") || opt
== 'v') {
4773 /* Verbose level can increase using multiple -v */
4775 /* Value obtained from config file */
4776 lttng_opt_verbose
= config_parse_value(arg
);
4778 /* -v used on command line */
4779 lttng_opt_verbose
++;
4781 /* Clamp value to [0, 3] */
4782 lttng_opt_verbose
= lttng_opt_verbose
< 0 ? 0 :
4783 (lttng_opt_verbose
<= 3 ? lttng_opt_verbose
: 3);
4784 } else if (string_match(optname
, "verbose-consumer")) {
4786 opt_verbose_consumer
= config_parse_value(arg
);
4788 opt_verbose_consumer
++;
4790 } else if (string_match(optname
, "consumerd32-path")) {
4791 if (!arg
|| *arg
== '\0') {
4795 if (lttng_is_setuid_setgid()) {
4796 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4797 "--consumerd32-path");
4799 if (consumerd32_bin_override
) {
4800 free((void *) consumerd32_bin
);
4802 consumerd32_bin
= strdup(arg
);
4803 if (!consumerd32_bin
) {
4807 consumerd32_bin_override
= 1;
4809 } else if (string_match(optname
, "consumerd32-libdir")) {
4810 if (!arg
|| *arg
== '\0') {
4814 if (lttng_is_setuid_setgid()) {
4815 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4816 "--consumerd32-libdir");
4818 if (consumerd32_libdir_override
) {
4819 free((void *) consumerd32_libdir
);
4821 consumerd32_libdir
= strdup(arg
);
4822 if (!consumerd32_libdir
) {
4826 consumerd32_libdir_override
= 1;
4828 } else if (string_match(optname
, "consumerd64-path")) {
4829 if (!arg
|| *arg
== '\0') {
4833 if (lttng_is_setuid_setgid()) {
4834 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4835 "--consumerd64-path");
4837 if (consumerd64_bin_override
) {
4838 free((void *) consumerd64_bin
);
4840 consumerd64_bin
= strdup(arg
);
4841 if (!consumerd64_bin
) {
4845 consumerd64_bin_override
= 1;
4847 } else if (string_match(optname
, "consumerd64-libdir")) {
4848 if (!arg
|| *arg
== '\0') {
4852 if (lttng_is_setuid_setgid()) {
4853 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4854 "--consumerd64-libdir");
4856 if (consumerd64_libdir_override
) {
4857 free((void *) consumerd64_libdir
);
4859 consumerd64_libdir
= strdup(arg
);
4860 if (!consumerd64_libdir
) {
4864 consumerd64_libdir_override
= 1;
4866 } else if (string_match(optname
, "pidfile") || opt
== 'p') {
4867 if (!arg
|| *arg
== '\0') {
4871 if (lttng_is_setuid_setgid()) {
4872 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4876 opt_pidfile
= strdup(arg
);
4882 } else if (string_match(optname
, "agent-tcp-port")) {
4883 if (!arg
|| *arg
== '\0') {
4887 if (lttng_is_setuid_setgid()) {
4888 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4889 "--agent-tcp-port");
4894 v
= strtoul(arg
, NULL
, 0);
4895 if (errno
!= 0 || !isdigit(arg
[0])) {
4896 ERR("Wrong value in --agent-tcp-port parameter: %s", arg
);
4899 if (v
== 0 || v
>= 65535) {
4900 ERR("Port overflow in --agent-tcp-port parameter: %s", arg
);
4903 agent_tcp_port
= (uint32_t) v
;
4904 DBG3("Agent TCP port set to non default: %u", agent_tcp_port
);
4906 } else if (string_match(optname
, "load") || opt
== 'l') {
4907 if (!arg
|| *arg
== '\0') {
4911 if (lttng_is_setuid_setgid()) {
4912 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4915 free(opt_load_session_path
);
4916 opt_load_session_path
= strdup(arg
);
4917 if (!opt_load_session_path
) {
4922 } else if (string_match(optname
, "kmod-probes")) {
4923 if (!arg
|| *arg
== '\0') {
4927 if (lttng_is_setuid_setgid()) {
4928 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4931 free(kmod_probes_list
);
4932 kmod_probes_list
= strdup(arg
);
4933 if (!kmod_probes_list
) {
4938 } else if (string_match(optname
, "extra-kmod-probes")) {
4939 if (!arg
|| *arg
== '\0') {
4943 if (lttng_is_setuid_setgid()) {
4944 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4945 "--extra-kmod-probes");
4947 free(kmod_extra_probes_list
);
4948 kmod_extra_probes_list
= strdup(arg
);
4949 if (!kmod_extra_probes_list
) {
4954 } else if (string_match(optname
, "config") || opt
== 'f') {
4955 /* This is handled in set_options() thus silent skip. */
4958 /* Unknown option or other error.
4959 * Error is printed by getopt, just return */
4964 if (ret
== -EINVAL
) {
4965 const char *opt_name
= "unknown";
4968 for (i
= 0; i
< sizeof(long_options
) / sizeof(struct option
);
4970 if (opt
== long_options
[i
].val
) {
4971 opt_name
= long_options
[i
].name
;
4976 WARN("Invalid argument provided for option \"%s\", using default value.",
4984 * config_entry_handler_cb used to handle options read from a config file.
4985 * See config_entry_handler_cb comment in common/config/session-config.h for the
4986 * return value conventions.
4988 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
4992 if (!entry
|| !entry
->name
|| !entry
->value
) {
4997 /* Check if the option is to be ignored */
4998 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
4999 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
5004 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1;
5007 /* Ignore if not fully matched. */
5008 if (strcmp(entry
->name
, long_options
[i
].name
)) {
5013 * If the option takes no argument on the command line, we have to
5014 * check if the value is "true". We support non-zero numeric values,
5017 if (!long_options
[i
].has_arg
) {
5018 ret
= config_parse_value(entry
->value
);
5021 WARN("Invalid configuration value \"%s\" for option %s",
5022 entry
->value
, entry
->name
);
5024 /* False, skip boolean config option. */
5029 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
5033 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry
->name
);
5040 * daemon configuration loading and argument parsing
5042 static int set_options(int argc
, char **argv
)
5044 int ret
= 0, c
= 0, option_index
= 0;
5045 int orig_optopt
= optopt
, orig_optind
= optind
;
5047 const char *config_path
= NULL
;
5049 optstring
= utils_generate_optstring(long_options
,
5050 sizeof(long_options
) / sizeof(struct option
));
5056 /* Check for the --config option */
5057 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
5058 &option_index
)) != -1) {
5062 } else if (c
!= 'f') {
5063 /* if not equal to --config option. */
5067 if (lttng_is_setuid_setgid()) {
5068 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5071 config_path
= utils_expand_path(optarg
);
5073 ERR("Failed to resolve path: %s", optarg
);
5078 ret
= config_get_section_entries(config_path
, config_section_name
,
5079 config_entry_handler
, NULL
);
5082 ERR("Invalid configuration option at line %i", ret
);
5088 /* Reset getopt's global state */
5089 optopt
= orig_optopt
;
5090 optind
= orig_optind
;
5094 * getopt_long() will not set option_index if it encounters a
5097 c
= getopt_long(argc
, argv
, optstring
, long_options
,
5104 * Pass NULL as the long option name if popt left the index
5107 ret
= set_option(c
, optarg
,
5108 option_index
< 0 ? NULL
:
5109 long_options
[option_index
].name
);
5121 * Creates the two needed socket by the daemon.
5122 * apps_sock - The communication socket for all UST apps.
5123 * client_sock - The communication of the cli tool (lttng).
5125 static int init_daemon_socket(void)
5130 old_umask
= umask(0);
5132 /* Create client tool unix socket */
5133 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5134 if (client_sock
< 0) {
5135 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5140 /* Set the cloexec flag */
5141 ret
= utils_set_fd_cloexec(client_sock
);
5143 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
5144 "Continuing but note that the consumer daemon will have a "
5145 "reference to this socket on exec()", client_sock
);
5148 /* File permission MUST be 660 */
5149 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5151 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5156 /* Create the application unix socket */
5157 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5158 if (apps_sock
< 0) {
5159 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5164 /* Set the cloexec flag */
5165 ret
= utils_set_fd_cloexec(apps_sock
);
5167 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
5168 "Continuing but note that the consumer daemon will have a "
5169 "reference to this socket on exec()", apps_sock
);
5172 /* File permission MUST be 666 */
5173 ret
= chmod(apps_unix_sock_path
,
5174 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5176 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5181 DBG3("Session daemon client socket %d and application socket %d created",
5182 client_sock
, apps_sock
);
5190 * Check if the global socket is available, and if a daemon is answering at the
5191 * other side. If yes, error is returned.
5193 static int check_existing_daemon(void)
5195 /* Is there anybody out there ? */
5196 if (lttng_session_daemon_alive()) {
5204 * Set the tracing group gid onto the client socket.
5206 * Race window between mkdir and chown is OK because we are going from more
5207 * permissive (root.root) to less permissive (root.tracing).
5209 static int set_permissions(char *rundir
)
5214 gid
= utils_get_group_id(tracing_group_name
);
5216 /* Set lttng run dir */
5217 ret
= chown(rundir
, 0, gid
);
5219 ERR("Unable to set group on %s", rundir
);
5224 * Ensure all applications and tracing group can search the run
5225 * dir. Allow everyone to read the directory, since it does not
5226 * buy us anything to hide its content.
5228 ret
= chmod(rundir
, S_IRWXU
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
5230 ERR("Unable to set permissions on %s", rundir
);
5234 /* lttng client socket path */
5235 ret
= chown(client_unix_sock_path
, 0, gid
);
5237 ERR("Unable to set group on %s", client_unix_sock_path
);
5241 /* kconsumer error socket path */
5242 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, 0);
5244 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5248 /* 64-bit ustconsumer error socket path */
5249 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, 0);
5251 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5255 /* 32-bit ustconsumer compat32 error socket path */
5256 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, 0);
5258 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5262 DBG("All permissions are set");
5268 * Create the lttng run directory needed for all global sockets and pipe.
5270 static int create_lttng_rundir(const char *rundir
)
5274 DBG3("Creating LTTng run directory: %s", rundir
);
5276 ret
= mkdir(rundir
, S_IRWXU
);
5278 if (errno
!= EEXIST
) {
5279 ERR("Unable to create %s", rundir
);
5291 * Setup sockets and directory needed by the kconsumerd communication with the
5294 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5298 char path
[PATH_MAX
];
5300 switch (consumer_data
->type
) {
5301 case LTTNG_CONSUMER_KERNEL
:
5302 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5304 case LTTNG_CONSUMER64_UST
:
5305 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5307 case LTTNG_CONSUMER32_UST
:
5308 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5311 ERR("Consumer type unknown");
5316 DBG2("Creating consumer directory: %s", path
);
5318 ret
= mkdir(path
, S_IRWXU
| S_IRGRP
| S_IXGRP
);
5320 if (errno
!= EEXIST
) {
5322 ERR("Failed to create %s", path
);
5328 ret
= chown(path
, 0, utils_get_group_id(tracing_group_name
));
5330 ERR("Unable to set group on %s", path
);
5336 /* Create the kconsumerd error unix socket */
5337 consumer_data
->err_sock
=
5338 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5339 if (consumer_data
->err_sock
< 0) {
5340 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5346 * Set the CLOEXEC flag. Return code is useless because either way, the
5349 ret
= utils_set_fd_cloexec(consumer_data
->err_sock
);
5351 PERROR("utils_set_fd_cloexec");
5352 /* continue anyway */
5355 /* File permission MUST be 660 */
5356 ret
= chmod(consumer_data
->err_unix_sock_path
,
5357 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5359 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5369 * Signal handler for the daemon
5371 * Simply stop all worker threads, leaving main() return gracefully after
5372 * joining all threads and calling cleanup().
5374 static void sighandler(int sig
)
5378 DBG("SIGPIPE caught");
5381 DBG("SIGINT caught");
5385 DBG("SIGTERM caught");
5389 CMM_STORE_SHARED(recv_child_signal
, 1);
5397 * Setup signal handler for :
5398 * SIGINT, SIGTERM, SIGPIPE
5400 static int set_signal_handler(void)
5403 struct sigaction sa
;
5406 if ((ret
= sigemptyset(&sigset
)) < 0) {
5407 PERROR("sigemptyset");
5411 sa
.sa_handler
= sighandler
;
5412 sa
.sa_mask
= sigset
;
5414 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5415 PERROR("sigaction");
5419 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5420 PERROR("sigaction");
5424 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5425 PERROR("sigaction");
5429 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
5430 PERROR("sigaction");
5434 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
5440 * Set open files limit to unlimited. This daemon can open a large number of
5441 * file descriptors in order to consume multiple kernel traces.
5443 static void set_ulimit(void)
5448 /* The kernel does not allow an infinite limit for open files */
5449 lim
.rlim_cur
= 65535;
5450 lim
.rlim_max
= 65535;
5452 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5454 PERROR("failed to set open files limit");
5459 * Write pidfile using the rundir and opt_pidfile.
5461 static int write_pidfile(void)
5464 char pidfile_path
[PATH_MAX
];
5469 if (lttng_strncpy(pidfile_path
, opt_pidfile
, sizeof(pidfile_path
))) {
5474 /* Build pidfile path from rundir and opt_pidfile. */
5475 ret
= snprintf(pidfile_path
, sizeof(pidfile_path
), "%s/"
5476 DEFAULT_LTTNG_SESSIOND_PIDFILE
, rundir
);
5478 PERROR("snprintf pidfile path");
5484 * Create pid file in rundir.
5486 ret
= utils_create_pid_file(getpid(), pidfile_path
);
5492 * Create lockfile using the rundir and return its fd.
5494 static int create_lockfile(void)
5497 char lockfile_path
[PATH_MAX
];
5499 ret
= generate_lock_file_path(lockfile_path
, sizeof(lockfile_path
));
5504 ret
= utils_create_lock_file(lockfile_path
);
5510 * Write agent TCP port using the rundir.
5512 static int write_agent_port(void)
5515 char path
[PATH_MAX
];
5519 ret
= snprintf(path
, sizeof(path
), "%s/"
5520 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
, rundir
);
5522 PERROR("snprintf agent port path");
5527 * Create TCP agent port file in rundir.
5529 ret
= utils_create_pid_file(agent_tcp_port
, path
);
5538 int main(int argc
, char **argv
)
5540 int ret
= 0, retval
= 0;
5542 const char *home_path
, *env_app_timeout
;
5544 init_kernel_workarounds();
5546 rcu_register_thread();
5548 if (set_signal_handler()) {
5550 goto exit_set_signal_handler
;
5553 setup_consumerd_path();
5555 page_size
= sysconf(_SC_PAGESIZE
);
5556 if (page_size
< 0) {
5557 PERROR("sysconf _SC_PAGESIZE");
5558 page_size
= LONG_MAX
;
5559 WARN("Fallback page size to %ld", page_size
);
5563 * Parse arguments and load the daemon configuration file.
5565 * We have an exit_options exit path to free memory reserved by
5566 * set_options. This is needed because the rest of sessiond_cleanup()
5567 * depends on ht_cleanup_thread, which depends on lttng_daemonize, which
5568 * depends on set_options.
5571 if (set_options(argc
, argv
)) {
5577 if (opt_daemon
|| opt_background
) {
5580 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
5588 * We are in the child. Make sure all other file descriptors are
5589 * closed, in case we are called with more opened file
5590 * descriptors than the standard ones.
5592 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5597 if (run_as_create_worker(argv
[0]) < 0) {
5598 goto exit_create_run_as_worker_cleanup
;
5602 * Starting from here, we can create threads. This needs to be after
5603 * lttng_daemonize due to RCU.
5607 * Initialize the health check subsystem. This call should set the
5608 * appropriate time values.
5610 health_sessiond
= health_app_create(NR_HEALTH_SESSIOND_TYPES
);
5611 if (!health_sessiond
) {
5612 PERROR("health_app_create error");
5614 goto exit_health_sessiond_cleanup
;
5617 /* Create thread to clean up RCU hash tables */
5618 if (init_ht_cleanup_thread(&ht_cleanup_thread
)) {
5620 goto exit_ht_cleanup
;
5623 /* Create thread quit pipe */
5624 if (init_thread_quit_pipe()) {
5626 goto exit_init_data
;
5629 /* Check if daemon is UID = 0 */
5630 is_root
= !getuid();
5633 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5636 goto exit_init_data
;
5639 /* Create global run dir with root access */
5640 if (create_lttng_rundir(rundir
)) {
5642 goto exit_init_data
;
5645 if (strlen(apps_unix_sock_path
) == 0) {
5646 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5647 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5650 goto exit_init_data
;
5654 if (strlen(client_unix_sock_path
) == 0) {
5655 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5656 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5659 goto exit_init_data
;
5663 /* Set global SHM for ust */
5664 if (strlen(wait_shm_path
) == 0) {
5665 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5666 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5669 goto exit_init_data
;
5673 if (strlen(health_unix_sock_path
) == 0) {
5674 ret
= snprintf(health_unix_sock_path
,
5675 sizeof(health_unix_sock_path
),
5676 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5679 goto exit_init_data
;
5683 /* Setup kernel consumerd path */
5684 ret
= snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5685 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5688 goto exit_init_data
;
5690 ret
= snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5691 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5694 goto exit_init_data
;
5697 DBG2("Kernel consumer err path: %s",
5698 kconsumer_data
.err_unix_sock_path
);
5699 DBG2("Kernel consumer cmd path: %s",
5700 kconsumer_data
.cmd_unix_sock_path
);
5702 home_path
= utils_get_home_dir();
5703 if (home_path
== NULL
) {
5704 /* TODO: Add --socket PATH option */
5705 ERR("Can't get HOME directory for sockets creation.");
5707 goto exit_init_data
;
5711 * Create rundir from home path. This will create something like
5714 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5717 goto exit_init_data
;
5720 if (create_lttng_rundir(rundir
)) {
5722 goto exit_init_data
;
5725 if (strlen(apps_unix_sock_path
) == 0) {
5726 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5727 DEFAULT_HOME_APPS_UNIX_SOCK
,
5731 goto exit_init_data
;
5735 /* Set the cli tool unix socket path */
5736 if (strlen(client_unix_sock_path
) == 0) {
5737 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5738 DEFAULT_HOME_CLIENT_UNIX_SOCK
,
5742 goto exit_init_data
;
5746 /* Set global SHM for ust */
5747 if (strlen(wait_shm_path
) == 0) {
5748 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5749 DEFAULT_HOME_APPS_WAIT_SHM_PATH
,
5753 goto exit_init_data
;
5757 /* Set health check Unix path */
5758 if (strlen(health_unix_sock_path
) == 0) {
5759 ret
= snprintf(health_unix_sock_path
,
5760 sizeof(health_unix_sock_path
),
5761 DEFAULT_HOME_HEALTH_UNIX_SOCK
,
5765 goto exit_init_data
;
5770 lockfile_fd
= create_lockfile();
5771 if (lockfile_fd
< 0) {
5773 goto exit_init_data
;
5776 /* Set consumer initial state */
5777 kernel_consumerd_state
= CONSUMER_STOPPED
;
5778 ust_consumerd_state
= CONSUMER_STOPPED
;
5780 DBG("Client socket path %s", client_unix_sock_path
);
5781 DBG("Application socket path %s", apps_unix_sock_path
);
5782 DBG("Application wait path %s", wait_shm_path
);
5783 DBG("LTTng run directory path: %s", rundir
);
5785 /* 32 bits consumerd path setup */
5786 ret
= snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
5787 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
5789 PERROR("snprintf 32-bit consumer error socket path");
5791 goto exit_init_data
;
5793 ret
= snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
5794 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
5796 PERROR("snprintf 32-bit consumer command socket path");
5798 goto exit_init_data
;
5801 DBG2("UST consumer 32 bits err path: %s",
5802 ustconsumer32_data
.err_unix_sock_path
);
5803 DBG2("UST consumer 32 bits cmd path: %s",
5804 ustconsumer32_data
.cmd_unix_sock_path
);
5806 /* 64 bits consumerd path setup */
5807 ret
= snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
5808 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
5810 PERROR("snprintf 64-bit consumer error socket path");
5812 goto exit_init_data
;
5814 ret
= snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
5815 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
5817 PERROR("snprintf 64-bit consumer command socket path");
5819 goto exit_init_data
;
5822 DBG2("UST consumer 64 bits err path: %s",
5823 ustconsumer64_data
.err_unix_sock_path
);
5824 DBG2("UST consumer 64 bits cmd path: %s",
5825 ustconsumer64_data
.cmd_unix_sock_path
);
5828 * See if daemon already exist.
5830 if (check_existing_daemon()) {
5831 ERR("Already running daemon.\n");
5833 * We do not goto exit because we must not cleanup()
5834 * because a daemon is already running.
5837 goto exit_init_data
;
5841 * Init UST app hash table. Alloc hash table before this point since
5842 * cleanup() can get called after that point.
5844 if (ust_app_ht_alloc()) {
5845 ERR("Failed to allocate UST app hash table");
5847 goto exit_init_data
;
5851 * Initialize agent app hash table. We allocate the hash table here
5852 * since cleanup() can get called after this point.
5854 if (agent_app_ht_alloc()) {
5855 ERR("Failed to allocate Agent app hash table");
5857 goto exit_init_data
;
5861 * These actions must be executed as root. We do that *after* setting up
5862 * the sockets path because we MUST make the check for another daemon using
5863 * those paths *before* trying to set the kernel consumer sockets and init
5867 if (set_consumer_sockets(&kconsumer_data
, rundir
)) {
5869 goto exit_init_data
;
5872 /* Setup kernel tracer */
5873 if (!opt_no_kernel
) {
5874 init_kernel_tracer();
5875 if (kernel_tracer_fd
>= 0) {
5876 ret
= syscall_init_table();
5878 ERR("Unable to populate syscall table. "
5879 "Syscall tracing won't work "
5880 "for this session daemon.");
5885 /* Set ulimit for open files */
5888 /* init lttng_fd tracking must be done after set_ulimit. */
5891 if (set_consumer_sockets(&ustconsumer64_data
, rundir
)) {
5893 goto exit_init_data
;
5896 if (set_consumer_sockets(&ustconsumer32_data
, rundir
)) {
5898 goto exit_init_data
;
5901 /* Setup the needed unix socket */
5902 if (init_daemon_socket()) {
5904 goto exit_init_data
;
5907 /* Set credentials to socket */
5908 if (is_root
&& set_permissions(rundir
)) {
5910 goto exit_init_data
;
5913 /* Get parent pid if -S, --sig-parent is specified. */
5914 if (opt_sig_parent
) {
5918 /* Setup the kernel pipe for waking up the kernel thread */
5919 if (is_root
&& !opt_no_kernel
) {
5920 if (utils_create_pipe_cloexec(kernel_poll_pipe
)) {
5922 goto exit_init_data
;
5926 /* Setup the thread apps communication pipe. */
5927 if (utils_create_pipe_cloexec(apps_cmd_pipe
)) {
5929 goto exit_init_data
;
5932 /* Setup the thread apps notify communication pipe. */
5933 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe
)) {
5935 goto exit_init_data
;
5938 /* Initialize global buffer per UID and PID registry. */
5939 buffer_reg_init_uid_registry();
5940 buffer_reg_init_pid_registry();
5942 /* Init UST command queue. */
5943 cds_wfcq_init(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
5946 * Get session list pointer. This pointer MUST NOT be free'd. This list
5947 * is statically declared in session.c
5949 session_list_ptr
= session_get_list();
5953 /* Check for the application socket timeout env variable. */
5954 env_app_timeout
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
5955 if (env_app_timeout
) {
5956 app_socket_timeout
= atoi(env_app_timeout
);
5958 app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
;
5961 ret
= write_pidfile();
5963 ERR("Error in write_pidfile");
5965 goto exit_init_data
;
5967 ret
= write_agent_port();
5969 ERR("Error in write_agent_port");
5971 goto exit_init_data
;
5974 /* Initialize communication library */
5976 /* Initialize TCP timeout values */
5977 lttcomm_inet_init();
5979 if (load_session_init_data(&load_info
) < 0) {
5981 goto exit_init_data
;
5983 load_info
->path
= opt_load_session_path
;
5985 /* Create health-check thread */
5986 ret
= pthread_create(&health_thread
, default_pthread_attr(),
5987 thread_manage_health
, (void *) NULL
);
5990 PERROR("pthread_create health");
5995 /* Create thread to manage the client socket */
5996 ret
= pthread_create(&client_thread
, default_pthread_attr(),
5997 thread_manage_clients
, (void *) NULL
);
6000 PERROR("pthread_create clients");
6005 /* Create thread to dispatch registration */
6006 ret
= pthread_create(&dispatch_thread
, default_pthread_attr(),
6007 thread_dispatch_ust_registration
, (void *) NULL
);
6010 PERROR("pthread_create dispatch");
6015 /* Create thread to manage application registration. */
6016 ret
= pthread_create(®_apps_thread
, default_pthread_attr(),
6017 thread_registration_apps
, (void *) NULL
);
6020 PERROR("pthread_create registration");
6025 /* Create thread to manage application socket */
6026 ret
= pthread_create(&apps_thread
, default_pthread_attr(),
6027 thread_manage_apps
, (void *) NULL
);
6030 PERROR("pthread_create apps");
6035 /* Create thread to manage application notify socket */
6036 ret
= pthread_create(&apps_notify_thread
, default_pthread_attr(),
6037 ust_thread_manage_notify
, (void *) NULL
);
6040 PERROR("pthread_create notify");
6042 goto exit_apps_notify
;
6045 /* Create agent registration thread. */
6046 ret
= pthread_create(&agent_reg_thread
, default_pthread_attr(),
6047 agent_thread_manage_registration
, (void *) NULL
);
6050 PERROR("pthread_create agent");
6052 goto exit_agent_reg
;
6055 /* Don't start this thread if kernel tracing is not requested nor root */
6056 if (is_root
&& !opt_no_kernel
) {
6057 /* Create kernel thread to manage kernel event */
6058 ret
= pthread_create(&kernel_thread
, default_pthread_attr(),
6059 thread_manage_kernel
, (void *) NULL
);
6062 PERROR("pthread_create kernel");
6068 /* Create session loading thread. */
6069 ret
= pthread_create(&load_session_thread
, default_pthread_attr(),
6070 thread_load_session
, load_info
);
6073 PERROR("pthread_create load_session_thread");
6075 goto exit_load_session
;
6079 * This is where we start awaiting program completion (e.g. through
6080 * signal that asks threads to teardown).
6083 ret
= pthread_join(load_session_thread
, &status
);
6086 PERROR("pthread_join load_session_thread");
6091 if (is_root
&& !opt_no_kernel
) {
6092 ret
= pthread_join(kernel_thread
, &status
);
6095 PERROR("pthread_join");
6101 ret
= pthread_join(agent_reg_thread
, &status
);
6104 PERROR("pthread_join agent");
6109 ret
= pthread_join(apps_notify_thread
, &status
);
6112 PERROR("pthread_join apps notify");
6117 ret
= pthread_join(apps_thread
, &status
);
6120 PERROR("pthread_join apps");
6125 ret
= pthread_join(reg_apps_thread
, &status
);
6128 PERROR("pthread_join");
6134 * Join dispatch thread after joining reg_apps_thread to ensure
6135 * we don't leak applications in the queue.
6137 ret
= pthread_join(dispatch_thread
, &status
);
6140 PERROR("pthread_join");
6145 ret
= pthread_join(client_thread
, &status
);
6148 PERROR("pthread_join");
6153 ret
= pthread_join(health_thread
, &status
);
6156 PERROR("pthread_join health thread");
6163 * sessiond_cleanup() is called when no other thread is running, except
6164 * the ht_cleanup thread, which is needed to destroy the hash tables.
6166 rcu_thread_online();
6168 rcu_thread_offline();
6169 rcu_unregister_thread();
6172 * Ensure all prior call_rcu are done. call_rcu callbacks may push
6173 * hash tables to the ht_cleanup thread. Therefore, we ensure that
6174 * the queue is empty before shutting down the clean-up thread.
6178 ret
= fini_ht_cleanup_thread(&ht_cleanup_thread
);
6184 health_app_destroy(health_sessiond
);
6185 exit_health_sessiond_cleanup
:
6186 exit_create_run_as_worker_cleanup
:
6189 sessiond_cleanup_options();
6191 exit_set_signal_handler
: