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();
766 * Send data on a unix socket using the liblttsessiondcomm API.
768 * Return lttcomm error code.
770 static int send_unix_sock(int sock
, void *buf
, size_t len
)
772 /* Check valid length */
777 return lttcomm_send_unix_sock(sock
, buf
, len
);
781 * Free memory of a command context structure.
783 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
785 DBG("Clean command context structure");
787 if ((*cmd_ctx
)->llm
) {
788 free((*cmd_ctx
)->llm
);
790 if ((*cmd_ctx
)->lsm
) {
791 free((*cmd_ctx
)->lsm
);
799 * Notify UST applications using the shm mmap futex.
801 static int notify_ust_apps(int active
)
805 DBG("Notifying applications of session daemon state: %d", active
);
807 /* See shm.c for this call implying mmap, shm and futex calls */
808 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
809 if (wait_shm_mmap
== NULL
) {
813 /* Wake waiting process */
814 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
816 /* Apps notified successfully */
824 * Setup the outgoing data buffer for the response (llm) by allocating the
825 * right amount of memory and copying the original information from the lsm
828 * Return 0 on success, negative value on error.
830 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
831 const void *payload_buf
, size_t payload_len
,
832 const void *cmd_header_buf
, size_t cmd_header_len
)
835 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
836 const size_t cmd_header_offset
= header_len
;
837 const size_t payload_offset
= cmd_header_offset
+ cmd_header_len
;
838 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
840 cmd_ctx
->llm
= zmalloc(total_msg_size
);
842 if (cmd_ctx
->llm
== NULL
) {
848 /* Copy common data */
849 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
850 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
851 cmd_ctx
->llm
->cmd_header_size
= cmd_header_len
;
852 cmd_ctx
->llm
->data_size
= payload_len
;
853 cmd_ctx
->lttng_msg_size
= total_msg_size
;
855 /* Copy command header */
856 if (cmd_header_len
) {
857 memcpy(((uint8_t *) cmd_ctx
->llm
) + cmd_header_offset
, cmd_header_buf
,
863 memcpy(((uint8_t *) cmd_ctx
->llm
) + payload_offset
, payload_buf
,
872 * Version of setup_lttng_msg() without command header.
874 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
875 void *payload_buf
, size_t payload_len
)
877 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
880 * Update the kernel poll set of all channel fd available over all tracing
881 * session. Add the wakeup pipe at the end of the set.
883 static int update_kernel_poll(struct lttng_poll_event
*events
)
886 struct ltt_session
*session
;
887 struct ltt_kernel_channel
*channel
;
889 DBG("Updating kernel poll set");
892 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
893 session_lock(session
);
894 if (session
->kernel_session
== NULL
) {
895 session_unlock(session
);
899 cds_list_for_each_entry(channel
,
900 &session
->kernel_session
->channel_list
.head
, list
) {
901 /* Add channel fd to the kernel poll set */
902 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
904 session_unlock(session
);
907 DBG("Channel fd %d added to kernel set", channel
->fd
);
909 session_unlock(session
);
911 session_unlock_list();
916 session_unlock_list();
921 * Find the channel fd from 'fd' over all tracing session. When found, check
922 * for new channel stream and send those stream fds to the kernel consumer.
924 * Useful for CPU hotplug feature.
926 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
929 struct ltt_session
*session
;
930 struct ltt_kernel_session
*ksess
;
931 struct ltt_kernel_channel
*channel
;
933 DBG("Updating kernel streams for channel fd %d", fd
);
936 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
937 session_lock(session
);
938 if (session
->kernel_session
== NULL
) {
939 session_unlock(session
);
942 ksess
= session
->kernel_session
;
944 cds_list_for_each_entry(channel
,
945 &ksess
->channel_list
.head
, list
) {
946 struct lttng_ht_iter iter
;
947 struct consumer_socket
*socket
;
949 if (channel
->fd
!= fd
) {
952 DBG("Channel found, updating kernel streams");
953 ret
= kernel_open_channel_stream(channel
);
957 /* Update the stream global counter */
958 ksess
->stream_count_global
+= ret
;
961 * Have we already sent fds to the consumer? If yes, it
962 * means that tracing is started so it is safe to send
963 * our updated stream fds.
965 if (ksess
->consumer_fds_sent
!= 1
966 || ksess
->consumer
== NULL
) {
972 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
973 &iter
.iter
, socket
, node
.node
) {
974 pthread_mutex_lock(socket
->lock
);
975 ret
= kernel_consumer_send_channel_stream(socket
,
977 session
->output_traces
? 1 : 0);
978 pthread_mutex_unlock(socket
->lock
);
986 session_unlock(session
);
988 session_unlock_list();
992 session_unlock(session
);
993 session_unlock_list();
998 * For each tracing session, update newly registered apps. The session list
999 * lock MUST be acquired before calling this.
1001 static void update_ust_app(int app_sock
)
1003 struct ltt_session
*sess
, *stmp
;
1005 /* Consumer is in an ERROR state. Stop any application update. */
1006 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
1007 /* Stop the update process since the consumer is dead. */
1011 /* For all tracing session(s) */
1012 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
1013 struct ust_app
*app
;
1016 if (!sess
->ust_session
) {
1017 goto unlock_session
;
1021 assert(app_sock
>= 0);
1022 app
= ust_app_find_by_sock(app_sock
);
1025 * Application can be unregistered before so
1026 * this is possible hence simply stopping the
1029 DBG3("UST app update failed to find app sock %d",
1033 ust_app_global_update(sess
->ust_session
, app
);
1037 session_unlock(sess
);
1042 * This thread manage event coming from the kernel.
1044 * Features supported in this thread:
1047 static void *thread_manage_kernel(void *data
)
1049 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
1050 uint32_t revents
, nb_fd
;
1052 struct lttng_poll_event events
;
1054 DBG("[thread] Thread manage kernel started");
1056 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_KERNEL
);
1059 * This first step of the while is to clean this structure which could free
1060 * non NULL pointers so initialize it before the loop.
1062 lttng_poll_init(&events
);
1064 if (testpoint(sessiond_thread_manage_kernel
)) {
1065 goto error_testpoint
;
1068 health_code_update();
1070 if (testpoint(sessiond_thread_manage_kernel_before_loop
)) {
1071 goto error_testpoint
;
1075 health_code_update();
1077 if (update_poll_flag
== 1) {
1078 /* Clean events object. We are about to populate it again. */
1079 lttng_poll_clean(&events
);
1081 ret
= sessiond_set_thread_pollset(&events
, 2);
1083 goto error_poll_create
;
1086 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
1091 /* This will add the available kernel channel if any. */
1092 ret
= update_kernel_poll(&events
);
1096 update_poll_flag
= 0;
1099 DBG("Thread kernel polling");
1101 /* Poll infinite value of time */
1103 health_poll_entry();
1104 ret
= lttng_poll_wait(&events
, -1);
1105 DBG("Thread kernel return from poll on %d fds",
1106 LTTNG_POLL_GETNB(&events
));
1110 * Restart interrupted system call.
1112 if (errno
== EINTR
) {
1116 } else if (ret
== 0) {
1117 /* Should not happen since timeout is infinite */
1118 ERR("Return value of poll is 0 with an infinite timeout.\n"
1119 "This should not have happened! Continuing...");
1125 for (i
= 0; i
< nb_fd
; i
++) {
1126 /* Fetch once the poll data */
1127 revents
= LTTNG_POLL_GETEV(&events
, i
);
1128 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1130 health_code_update();
1133 /* No activity for this FD (poll implementation). */
1137 /* Thread quit pipe has been closed. Killing thread. */
1138 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1144 /* Check for data on kernel pipe */
1145 if (revents
& LPOLLIN
) {
1146 if (pollfd
== kernel_poll_pipe
[0]) {
1147 (void) lttng_read(kernel_poll_pipe
[0],
1150 * Ret value is useless here, if this pipe gets any actions an
1151 * update is required anyway.
1153 update_poll_flag
= 1;
1157 * New CPU detected by the kernel. Adding kernel stream to
1158 * kernel session and updating the kernel consumer
1160 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
1166 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1167 update_poll_flag
= 1;
1170 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1178 lttng_poll_clean(&events
);
1181 utils_close_pipe(kernel_poll_pipe
);
1182 kernel_poll_pipe
[0] = kernel_poll_pipe
[1] = -1;
1185 ERR("Health error occurred in %s", __func__
);
1186 WARN("Kernel thread died unexpectedly. "
1187 "Kernel tracing can continue but CPU hotplug is disabled.");
1189 health_unregister(health_sessiond
);
1190 DBG("Kernel thread dying");
1195 * Signal pthread condition of the consumer data that the thread.
1197 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
1199 pthread_mutex_lock(&data
->cond_mutex
);
1202 * The state is set before signaling. It can be any value, it's the waiter
1203 * job to correctly interpret this condition variable associated to the
1204 * consumer pthread_cond.
1206 * A value of 0 means that the corresponding thread of the consumer data
1207 * was not started. 1 indicates that the thread has started and is ready
1208 * for action. A negative value means that there was an error during the
1211 data
->consumer_thread_is_ready
= state
;
1212 (void) pthread_cond_signal(&data
->cond
);
1214 pthread_mutex_unlock(&data
->cond_mutex
);
1218 * This thread manage the consumer error sent back to the session daemon.
1220 static void *thread_manage_consumer(void *data
)
1222 int sock
= -1, i
, ret
, pollfd
, err
= -1, should_quit
= 0;
1223 uint32_t revents
, nb_fd
;
1224 enum lttcomm_return_code code
;
1225 struct lttng_poll_event events
;
1226 struct consumer_data
*consumer_data
= data
;
1228 DBG("[thread] Manage consumer started");
1230 rcu_register_thread();
1231 rcu_thread_online();
1233 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CONSUMER
);
1235 health_code_update();
1238 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1239 * metadata_sock. Nothing more will be added to this poll set.
1241 ret
= sessiond_set_thread_pollset(&events
, 3);
1247 * The error socket here is already in a listening state which was done
1248 * just before spawning this thread to avoid a race between the consumer
1249 * daemon exec trying to connect and the listen() call.
1251 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
1256 health_code_update();
1258 /* Infinite blocking call, waiting for transmission */
1260 health_poll_entry();
1262 if (testpoint(sessiond_thread_manage_consumer
)) {
1266 ret
= lttng_poll_wait(&events
, -1);
1270 * Restart interrupted system call.
1272 if (errno
== EINTR
) {
1280 for (i
= 0; i
< nb_fd
; i
++) {
1281 /* Fetch once the poll data */
1282 revents
= LTTNG_POLL_GETEV(&events
, i
);
1283 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1285 health_code_update();
1288 /* No activity for this FD (poll implementation). */
1292 /* Thread quit pipe has been closed. Killing thread. */
1293 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1299 /* Event on the registration socket */
1300 if (pollfd
== consumer_data
->err_sock
) {
1301 if (revents
& LPOLLIN
) {
1303 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1304 ERR("consumer err socket poll error");
1307 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1313 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1319 * Set the CLOEXEC flag. Return code is useless because either way, the
1322 (void) utils_set_fd_cloexec(sock
);
1324 health_code_update();
1326 DBG2("Receiving code from consumer err_sock");
1328 /* Getting status code from kconsumerd */
1329 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1330 sizeof(enum lttcomm_return_code
));
1335 health_code_update();
1336 if (code
== LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
1337 /* Connect both socket, command and metadata. */
1338 consumer_data
->cmd_sock
=
1339 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1340 consumer_data
->metadata_fd
=
1341 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1342 if (consumer_data
->cmd_sock
< 0
1343 || consumer_data
->metadata_fd
< 0) {
1344 PERROR("consumer connect cmd socket");
1345 /* On error, signal condition and quit. */
1346 signal_consumer_condition(consumer_data
, -1);
1349 consumer_data
->metadata_sock
.fd_ptr
= &consumer_data
->metadata_fd
;
1350 /* Create metadata socket lock. */
1351 consumer_data
->metadata_sock
.lock
= zmalloc(sizeof(pthread_mutex_t
));
1352 if (consumer_data
->metadata_sock
.lock
== NULL
) {
1353 PERROR("zmalloc pthread mutex");
1356 pthread_mutex_init(consumer_data
->metadata_sock
.lock
, NULL
);
1358 signal_consumer_condition(consumer_data
, 1);
1359 DBG("Consumer command socket ready (fd: %d", consumer_data
->cmd_sock
);
1360 DBG("Consumer metadata socket ready (fd: %d)",
1361 consumer_data
->metadata_fd
);
1363 ERR("consumer error when waiting for SOCK_READY : %s",
1364 lttcomm_get_readable_code(-code
));
1368 /* Remove the consumerd error sock since we've established a connexion */
1369 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1374 /* Add new accepted error socket. */
1375 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1380 /* Add metadata socket that is successfully connected. */
1381 ret
= lttng_poll_add(&events
, consumer_data
->metadata_fd
,
1382 LPOLLIN
| LPOLLRDHUP
);
1387 health_code_update();
1389 /* Infinite blocking call, waiting for transmission */
1392 health_code_update();
1394 /* Exit the thread because the thread quit pipe has been triggered. */
1396 /* Not a health error. */
1401 health_poll_entry();
1402 ret
= lttng_poll_wait(&events
, -1);
1406 * Restart interrupted system call.
1408 if (errno
== EINTR
) {
1416 for (i
= 0; i
< nb_fd
; i
++) {
1417 /* Fetch once the poll data */
1418 revents
= LTTNG_POLL_GETEV(&events
, i
);
1419 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1421 health_code_update();
1424 /* No activity for this FD (poll implementation). */
1429 * Thread quit pipe has been triggered, flag that we should stop
1430 * but continue the current loop to handle potential data from
1433 should_quit
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1435 if (pollfd
== sock
) {
1436 /* Event on the consumerd socket */
1437 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1438 && !(revents
& LPOLLIN
)) {
1439 ERR("consumer err socket second poll error");
1442 health_code_update();
1443 /* Wait for any kconsumerd error */
1444 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1445 sizeof(enum lttcomm_return_code
));
1447 ERR("consumer closed the command socket");
1451 ERR("consumer return code : %s",
1452 lttcomm_get_readable_code(-code
));
1455 } else if (pollfd
== consumer_data
->metadata_fd
) {
1456 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1457 && !(revents
& LPOLLIN
)) {
1458 ERR("consumer err metadata socket second poll error");
1461 /* UST metadata requests */
1462 ret
= ust_consumer_metadata_request(
1463 &consumer_data
->metadata_sock
);
1465 ERR("Handling metadata request");
1469 /* No need for an else branch all FDs are tested prior. */
1471 health_code_update();
1477 * We lock here because we are about to close the sockets and some other
1478 * thread might be using them so get exclusive access which will abort all
1479 * other consumer command by other threads.
1481 pthread_mutex_lock(&consumer_data
->lock
);
1483 /* Immediately set the consumerd state to stopped */
1484 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1485 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1486 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1487 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1488 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1490 /* Code flow error... */
1494 if (consumer_data
->err_sock
>= 0) {
1495 ret
= close(consumer_data
->err_sock
);
1499 consumer_data
->err_sock
= -1;
1501 if (consumer_data
->cmd_sock
>= 0) {
1502 ret
= close(consumer_data
->cmd_sock
);
1506 consumer_data
->cmd_sock
= -1;
1508 if (consumer_data
->metadata_sock
.fd_ptr
&&
1509 *consumer_data
->metadata_sock
.fd_ptr
>= 0) {
1510 ret
= close(*consumer_data
->metadata_sock
.fd_ptr
);
1522 unlink(consumer_data
->err_unix_sock_path
);
1523 unlink(consumer_data
->cmd_unix_sock_path
);
1524 pthread_mutex_unlock(&consumer_data
->lock
);
1526 /* Cleanup metadata socket mutex. */
1527 if (consumer_data
->metadata_sock
.lock
) {
1528 pthread_mutex_destroy(consumer_data
->metadata_sock
.lock
);
1529 free(consumer_data
->metadata_sock
.lock
);
1531 lttng_poll_clean(&events
);
1535 ERR("Health error occurred in %s", __func__
);
1537 health_unregister(health_sessiond
);
1538 DBG("consumer thread cleanup completed");
1540 rcu_thread_offline();
1541 rcu_unregister_thread();
1547 * This thread manage application communication.
1549 static void *thread_manage_apps(void *data
)
1551 int i
, ret
, pollfd
, err
= -1;
1553 uint32_t revents
, nb_fd
;
1554 struct lttng_poll_event events
;
1556 DBG("[thread] Manage application started");
1558 rcu_register_thread();
1559 rcu_thread_online();
1561 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_MANAGE
);
1563 if (testpoint(sessiond_thread_manage_apps
)) {
1564 goto error_testpoint
;
1567 health_code_update();
1569 ret
= sessiond_set_thread_pollset(&events
, 2);
1571 goto error_poll_create
;
1574 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1579 if (testpoint(sessiond_thread_manage_apps_before_loop
)) {
1583 health_code_update();
1586 DBG("Apps thread polling");
1588 /* Inifinite blocking call, waiting for transmission */
1590 health_poll_entry();
1591 ret
= lttng_poll_wait(&events
, -1);
1592 DBG("Apps thread return from poll on %d fds",
1593 LTTNG_POLL_GETNB(&events
));
1597 * Restart interrupted system call.
1599 if (errno
== EINTR
) {
1607 for (i
= 0; i
< nb_fd
; i
++) {
1608 /* Fetch once the poll data */
1609 revents
= LTTNG_POLL_GETEV(&events
, i
);
1610 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1612 health_code_update();
1615 /* No activity for this FD (poll implementation). */
1619 /* Thread quit pipe has been closed. Killing thread. */
1620 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1626 /* Inspect the apps cmd pipe */
1627 if (pollfd
== apps_cmd_pipe
[0]) {
1628 if (revents
& LPOLLIN
) {
1632 size_ret
= lttng_read(apps_cmd_pipe
[0], &sock
, sizeof(sock
));
1633 if (size_ret
< sizeof(sock
)) {
1634 PERROR("read apps cmd pipe");
1638 health_code_update();
1641 * Since this is a command socket (write then read),
1642 * we only monitor the error events of the socket.
1644 ret
= lttng_poll_add(&events
, sock
,
1645 LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
1650 DBG("Apps with sock %d added to poll set", sock
);
1651 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1652 ERR("Apps command pipe error");
1655 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
1660 * At this point, we know that a registered application made
1661 * the event at poll_wait.
1663 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1664 /* Removing from the poll set */
1665 ret
= lttng_poll_del(&events
, pollfd
);
1670 /* Socket closed on remote end. */
1671 ust_app_unregister(pollfd
);
1673 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1678 health_code_update();
1684 lttng_poll_clean(&events
);
1687 utils_close_pipe(apps_cmd_pipe
);
1688 apps_cmd_pipe
[0] = apps_cmd_pipe
[1] = -1;
1691 * We don't clean the UST app hash table here since already registered
1692 * applications can still be controlled so let them be until the session
1693 * daemon dies or the applications stop.
1698 ERR("Health error occurred in %s", __func__
);
1700 health_unregister(health_sessiond
);
1701 DBG("Application communication apps thread cleanup complete");
1702 rcu_thread_offline();
1703 rcu_unregister_thread();
1708 * Send a socket to a thread This is called from the dispatch UST registration
1709 * thread once all sockets are set for the application.
1711 * The sock value can be invalid, we don't really care, the thread will handle
1712 * it and make the necessary cleanup if so.
1714 * On success, return 0 else a negative value being the errno message of the
1717 static int send_socket_to_thread(int fd
, int sock
)
1722 * It's possible that the FD is set as invalid with -1 concurrently just
1723 * before calling this function being a shutdown state of the thread.
1730 ret
= lttng_write(fd
, &sock
, sizeof(sock
));
1731 if (ret
< sizeof(sock
)) {
1732 PERROR("write apps pipe %d", fd
);
1739 /* All good. Don't send back the write positive ret value. */
1746 * Sanitize the wait queue of the dispatch registration thread meaning removing
1747 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1748 * notify socket is never received.
1750 static void sanitize_wait_queue(struct ust_reg_wait_queue
*wait_queue
)
1752 int ret
, nb_fd
= 0, i
;
1753 unsigned int fd_added
= 0;
1754 struct lttng_poll_event events
;
1755 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1759 lttng_poll_init(&events
);
1761 /* Just skip everything for an empty queue. */
1762 if (!wait_queue
->count
) {
1766 ret
= lttng_poll_create(&events
, wait_queue
->count
, LTTNG_CLOEXEC
);
1771 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1772 &wait_queue
->head
, head
) {
1773 assert(wait_node
->app
);
1774 ret
= lttng_poll_add(&events
, wait_node
->app
->sock
,
1775 LPOLLHUP
| LPOLLERR
);
1788 * Poll but don't block so we can quickly identify the faulty events and
1789 * clean them afterwards from the wait queue.
1791 ret
= lttng_poll_wait(&events
, 0);
1797 for (i
= 0; i
< nb_fd
; i
++) {
1798 /* Get faulty FD. */
1799 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1800 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1803 /* No activity for this FD (poll implementation). */
1807 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1808 &wait_queue
->head
, head
) {
1809 if (pollfd
== wait_node
->app
->sock
&&
1810 (revents
& (LPOLLHUP
| LPOLLERR
))) {
1811 cds_list_del(&wait_node
->head
);
1812 wait_queue
->count
--;
1813 ust_app_destroy(wait_node
->app
);
1816 * Silence warning of use-after-free in
1817 * cds_list_for_each_entry_safe which uses
1818 * __typeof__(*wait_node).
1823 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1830 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd
);
1834 lttng_poll_clean(&events
);
1838 lttng_poll_clean(&events
);
1840 ERR("Unable to sanitize wait queue");
1845 * Dispatch request from the registration threads to the application
1846 * communication thread.
1848 static void *thread_dispatch_ust_registration(void *data
)
1851 struct cds_wfcq_node
*node
;
1852 struct ust_command
*ust_cmd
= NULL
;
1853 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1854 struct ust_reg_wait_queue wait_queue
= {
1858 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH
);
1860 if (testpoint(sessiond_thread_app_reg_dispatch
)) {
1861 goto error_testpoint
;
1864 health_code_update();
1866 CDS_INIT_LIST_HEAD(&wait_queue
.head
);
1868 DBG("[thread] Dispatch UST command started");
1870 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1871 health_code_update();
1873 /* Atomically prepare the queue futex */
1874 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1877 struct ust_app
*app
= NULL
;
1881 * Make sure we don't have node(s) that have hung up before receiving
1882 * the notify socket. This is to clean the list in order to avoid
1883 * memory leaks from notify socket that are never seen.
1885 sanitize_wait_queue(&wait_queue
);
1887 health_code_update();
1888 /* Dequeue command for registration */
1889 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1891 DBG("Woken up but nothing in the UST command queue");
1892 /* Continue thread execution */
1896 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1898 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1899 " gid:%d sock:%d name:%s (version %d.%d)",
1900 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1901 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1902 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1903 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1905 if (ust_cmd
->reg_msg
.type
== USTCTL_SOCKET_CMD
) {
1906 wait_node
= zmalloc(sizeof(*wait_node
));
1908 PERROR("zmalloc wait_node dispatch");
1909 ret
= close(ust_cmd
->sock
);
1911 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1913 lttng_fd_put(LTTNG_FD_APPS
, 1);
1917 CDS_INIT_LIST_HEAD(&wait_node
->head
);
1919 /* Create application object if socket is CMD. */
1920 wait_node
->app
= ust_app_create(&ust_cmd
->reg_msg
,
1922 if (!wait_node
->app
) {
1923 ret
= close(ust_cmd
->sock
);
1925 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1927 lttng_fd_put(LTTNG_FD_APPS
, 1);
1933 * Add application to the wait queue so we can set the notify
1934 * socket before putting this object in the global ht.
1936 cds_list_add(&wait_node
->head
, &wait_queue
.head
);
1941 * We have to continue here since we don't have the notify
1942 * socket and the application MUST be added to the hash table
1943 * only at that moment.
1948 * Look for the application in the local wait queue and set the
1949 * notify socket if found.
1951 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1952 &wait_queue
.head
, head
) {
1953 health_code_update();
1954 if (wait_node
->app
->pid
== ust_cmd
->reg_msg
.pid
) {
1955 wait_node
->app
->notify_sock
= ust_cmd
->sock
;
1956 cds_list_del(&wait_node
->head
);
1958 app
= wait_node
->app
;
1960 DBG3("UST app notify socket %d is set", ust_cmd
->sock
);
1966 * With no application at this stage the received socket is
1967 * basically useless so close it before we free the cmd data
1968 * structure for good.
1971 ret
= close(ust_cmd
->sock
);
1973 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1975 lttng_fd_put(LTTNG_FD_APPS
, 1);
1982 * @session_lock_list
1984 * Lock the global session list so from the register up to the
1985 * registration done message, no thread can see the application
1986 * and change its state.
1988 session_lock_list();
1992 * Add application to the global hash table. This needs to be
1993 * done before the update to the UST registry can locate the
1998 /* Set app version. This call will print an error if needed. */
1999 (void) ust_app_version(app
);
2001 /* Send notify socket through the notify pipe. */
2002 ret
= send_socket_to_thread(apps_cmd_notify_pipe
[1],
2006 session_unlock_list();
2008 * No notify thread, stop the UST tracing. However, this is
2009 * not an internal error of the this thread thus setting
2010 * the health error code to a normal exit.
2017 * Update newly registered application with the tracing
2018 * registry info already enabled information.
2020 update_ust_app(app
->sock
);
2023 * Don't care about return value. Let the manage apps threads
2024 * handle app unregistration upon socket close.
2026 (void) ust_app_register_done(app
);
2029 * Even if the application socket has been closed, send the app
2030 * to the thread and unregistration will take place at that
2033 ret
= send_socket_to_thread(apps_cmd_pipe
[1], app
->sock
);
2036 session_unlock_list();
2038 * No apps. thread, stop the UST tracing. However, this is
2039 * not an internal error of the this thread thus setting
2040 * the health error code to a normal exit.
2047 session_unlock_list();
2049 } while (node
!= NULL
);
2051 health_poll_entry();
2052 /* Futex wait on queue. Blocking call on futex() */
2053 futex_nto1_wait(&ust_cmd_queue
.futex
);
2056 /* Normal exit, no error */
2060 /* Clean up wait queue. */
2061 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
2062 &wait_queue
.head
, head
) {
2063 cds_list_del(&wait_node
->head
);
2068 /* Empty command queue. */
2070 /* Dequeue command for registration */
2071 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
2075 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
2076 ret
= close(ust_cmd
->sock
);
2078 PERROR("close ust sock exit dispatch %d", ust_cmd
->sock
);
2080 lttng_fd_put(LTTNG_FD_APPS
, 1);
2085 DBG("Dispatch thread dying");
2088 ERR("Health error occurred in %s", __func__
);
2090 health_unregister(health_sessiond
);
2095 * This thread manage application registration.
2097 static void *thread_registration_apps(void *data
)
2099 int sock
= -1, i
, ret
, pollfd
, err
= -1;
2100 uint32_t revents
, nb_fd
;
2101 struct lttng_poll_event events
;
2103 * Get allocated in this thread, enqueued to a global queue, dequeued and
2104 * freed in the manage apps thread.
2106 struct ust_command
*ust_cmd
= NULL
;
2108 DBG("[thread] Manage application registration started");
2110 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG
);
2112 if (testpoint(sessiond_thread_registration_apps
)) {
2113 goto error_testpoint
;
2116 ret
= lttcomm_listen_unix_sock(apps_sock
);
2122 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
2123 * more will be added to this poll set.
2125 ret
= sessiond_set_thread_pollset(&events
, 2);
2127 goto error_create_poll
;
2130 /* Add the application registration socket */
2131 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
2133 goto error_poll_add
;
2136 /* Notify all applications to register */
2137 ret
= notify_ust_apps(1);
2139 ERR("Failed to notify applications or create the wait shared memory.\n"
2140 "Execution continues but there might be problem for already\n"
2141 "running applications that wishes to register.");
2145 DBG("Accepting application registration");
2147 /* Inifinite blocking call, waiting for transmission */
2149 health_poll_entry();
2150 ret
= lttng_poll_wait(&events
, -1);
2154 * Restart interrupted system call.
2156 if (errno
== EINTR
) {
2164 for (i
= 0; i
< nb_fd
; i
++) {
2165 health_code_update();
2167 /* Fetch once the poll data */
2168 revents
= LTTNG_POLL_GETEV(&events
, i
);
2169 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2172 /* No activity for this FD (poll implementation). */
2176 /* Thread quit pipe has been closed. Killing thread. */
2177 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
2183 /* Event on the registration socket */
2184 if (pollfd
== apps_sock
) {
2185 if (revents
& LPOLLIN
) {
2186 sock
= lttcomm_accept_unix_sock(apps_sock
);
2192 * Set socket timeout for both receiving and ending.
2193 * app_socket_timeout is in seconds, whereas
2194 * lttcomm_setsockopt_rcv_timeout and
2195 * lttcomm_setsockopt_snd_timeout expect msec as
2198 if (app_socket_timeout
>= 0) {
2199 (void) lttcomm_setsockopt_rcv_timeout(sock
,
2200 app_socket_timeout
* 1000);
2201 (void) lttcomm_setsockopt_snd_timeout(sock
,
2202 app_socket_timeout
* 1000);
2206 * Set the CLOEXEC flag. Return code is useless because
2207 * either way, the show must go on.
2209 (void) utils_set_fd_cloexec(sock
);
2211 /* Create UST registration command for enqueuing */
2212 ust_cmd
= zmalloc(sizeof(struct ust_command
));
2213 if (ust_cmd
== NULL
) {
2214 PERROR("ust command zmalloc");
2223 * Using message-based transmissions to ensure we don't
2224 * have to deal with partially received messages.
2226 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2228 ERR("Exhausted file descriptors allowed for applications.");
2238 health_code_update();
2239 ret
= ust_app_recv_registration(sock
, &ust_cmd
->reg_msg
);
2242 /* Close socket of the application. */
2247 lttng_fd_put(LTTNG_FD_APPS
, 1);
2251 health_code_update();
2253 ust_cmd
->sock
= sock
;
2256 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2257 " gid:%d sock:%d name:%s (version %d.%d)",
2258 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
2259 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
2260 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
2261 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
2264 * Lock free enqueue the registration request. The red pill
2265 * has been taken! This apps will be part of the *system*.
2267 cds_wfcq_enqueue(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
, &ust_cmd
->node
);
2270 * Wake the registration queue futex. Implicit memory
2271 * barrier with the exchange in cds_wfcq_enqueue.
2273 futex_nto1_wake(&ust_cmd_queue
.futex
);
2274 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2275 ERR("Register apps socket poll error");
2278 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2287 /* Notify that the registration thread is gone */
2290 if (apps_sock
>= 0) {
2291 ret
= close(apps_sock
);
2301 lttng_fd_put(LTTNG_FD_APPS
, 1);
2303 unlink(apps_unix_sock_path
);
2306 lttng_poll_clean(&events
);
2310 DBG("UST Registration thread cleanup complete");
2313 ERR("Health error occurred in %s", __func__
);
2315 health_unregister(health_sessiond
);
2321 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2322 * exec or it will fails.
2324 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
2327 struct timespec timeout
;
2330 * Make sure we set the readiness flag to 0 because we are NOT ready.
2331 * This access to consumer_thread_is_ready does not need to be
2332 * protected by consumer_data.cond_mutex (yet) since the consumer
2333 * management thread has not been started at this point.
2335 consumer_data
->consumer_thread_is_ready
= 0;
2337 /* Setup pthread condition */
2338 ret
= pthread_condattr_init(&consumer_data
->condattr
);
2341 PERROR("pthread_condattr_init consumer data");
2346 * Set the monotonic clock in order to make sure we DO NOT jump in time
2347 * between the clock_gettime() call and the timedwait call. See bug #324
2348 * for a more details and how we noticed it.
2350 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
2353 PERROR("pthread_condattr_setclock consumer data");
2357 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
2360 PERROR("pthread_cond_init consumer data");
2364 ret
= pthread_create(&consumer_data
->thread
, default_pthread_attr(),
2365 thread_manage_consumer
, consumer_data
);
2368 PERROR("pthread_create consumer");
2373 /* We are about to wait on a pthread condition */
2374 pthread_mutex_lock(&consumer_data
->cond_mutex
);
2376 /* Get time for sem_timedwait absolute timeout */
2377 clock_ret
= lttng_clock_gettime(CLOCK_MONOTONIC
, &timeout
);
2379 * Set the timeout for the condition timed wait even if the clock gettime
2380 * call fails since we might loop on that call and we want to avoid to
2381 * increment the timeout too many times.
2383 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
2386 * The following loop COULD be skipped in some conditions so this is why we
2387 * set ret to 0 in order to make sure at least one round of the loop is
2393 * Loop until the condition is reached or when a timeout is reached. Note
2394 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2395 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2396 * possible. This loop does not take any chances and works with both of
2399 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
2400 if (clock_ret
< 0) {
2401 PERROR("clock_gettime spawn consumer");
2402 /* Infinite wait for the consumerd thread to be ready */
2403 ret
= pthread_cond_wait(&consumer_data
->cond
,
2404 &consumer_data
->cond_mutex
);
2406 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
2407 &consumer_data
->cond_mutex
, &timeout
);
2411 /* Release the pthread condition */
2412 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
2416 if (ret
== ETIMEDOUT
) {
2420 * Call has timed out so we kill the kconsumerd_thread and return
2423 ERR("Condition timed out. The consumer thread was never ready."
2425 pth_ret
= pthread_cancel(consumer_data
->thread
);
2427 PERROR("pthread_cancel consumer thread");
2430 PERROR("pthread_cond_wait failed consumer thread");
2432 /* Caller is expecting a negative value on failure. */
2437 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2438 if (consumer_data
->pid
== 0) {
2439 ERR("Consumerd did not start");
2440 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2443 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2452 * Join consumer thread
2454 static int join_consumer_thread(struct consumer_data
*consumer_data
)
2458 /* Consumer pid must be a real one. */
2459 if (consumer_data
->pid
> 0) {
2461 ret
= kill(consumer_data
->pid
, SIGTERM
);
2463 PERROR("Error killing consumer daemon");
2466 return pthread_join(consumer_data
->thread
, &status
);
2473 * Fork and exec a consumer daemon (consumerd).
2475 * Return pid if successful else -1.
2477 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
2481 const char *consumer_to_use
;
2482 const char *verbosity
;
2485 DBG("Spawning consumerd");
2492 if (opt_verbose_consumer
) {
2493 verbosity
= "--verbose";
2494 } else if (lttng_opt_quiet
) {
2495 verbosity
= "--quiet";
2500 switch (consumer_data
->type
) {
2501 case LTTNG_CONSUMER_KERNEL
:
2503 * Find out which consumerd to execute. We will first try the
2504 * 64-bit path, then the sessiond's installation directory, and
2505 * fallback on the 32-bit one,
2507 DBG3("Looking for a kernel consumer at these locations:");
2508 DBG3(" 1) %s", consumerd64_bin
);
2509 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
2510 DBG3(" 3) %s", consumerd32_bin
);
2511 if (stat(consumerd64_bin
, &st
) == 0) {
2512 DBG3("Found location #1");
2513 consumer_to_use
= consumerd64_bin
;
2514 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
2515 DBG3("Found location #2");
2516 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
2517 } else if (stat(consumerd32_bin
, &st
) == 0) {
2518 DBG3("Found location #3");
2519 consumer_to_use
= consumerd32_bin
;
2521 DBG("Could not find any valid consumerd executable");
2525 DBG("Using kernel consumer at: %s", consumer_to_use
);
2526 ret
= execl(consumer_to_use
,
2527 "lttng-consumerd", verbosity
, "-k",
2528 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2529 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2530 "--group", tracing_group_name
,
2533 case LTTNG_CONSUMER64_UST
:
2535 char *tmpnew
= NULL
;
2537 if (consumerd64_libdir
[0] != '\0') {
2541 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2545 tmplen
= strlen("LD_LIBRARY_PATH=")
2546 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
2547 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2552 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2553 strcat(tmpnew
, consumerd64_libdir
);
2554 if (tmp
[0] != '\0') {
2555 strcat(tmpnew
, ":");
2556 strcat(tmpnew
, tmp
);
2558 ret
= putenv(tmpnew
);
2565 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
2566 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
2567 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2568 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2569 "--group", tracing_group_name
,
2571 if (consumerd64_libdir
[0] != '\0') {
2576 case LTTNG_CONSUMER32_UST
:
2578 char *tmpnew
= NULL
;
2580 if (consumerd32_libdir
[0] != '\0') {
2584 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2588 tmplen
= strlen("LD_LIBRARY_PATH=")
2589 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
2590 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2595 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2596 strcat(tmpnew
, consumerd32_libdir
);
2597 if (tmp
[0] != '\0') {
2598 strcat(tmpnew
, ":");
2599 strcat(tmpnew
, tmp
);
2601 ret
= putenv(tmpnew
);
2608 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
2609 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
2610 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2611 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2612 "--group", tracing_group_name
,
2614 if (consumerd32_libdir
[0] != '\0') {
2620 PERROR("unknown consumer type");
2624 PERROR("Consumer execl()");
2626 /* Reaching this point, we got a failure on our execl(). */
2628 } else if (pid
> 0) {
2631 PERROR("start consumer fork");
2639 * Spawn the consumerd daemon and session daemon thread.
2641 static int start_consumerd(struct consumer_data
*consumer_data
)
2646 * Set the listen() state on the socket since there is a possible race
2647 * between the exec() of the consumer daemon and this call if place in the
2648 * consumer thread. See bug #366 for more details.
2650 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
2655 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2656 if (consumer_data
->pid
!= 0) {
2657 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2661 ret
= spawn_consumerd(consumer_data
);
2663 ERR("Spawning consumerd failed");
2664 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2668 /* Setting up the consumer_data pid */
2669 consumer_data
->pid
= ret
;
2670 DBG2("Consumer pid %d", consumer_data
->pid
);
2671 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2673 DBG2("Spawning consumer control thread");
2674 ret
= spawn_consumer_thread(consumer_data
);
2676 ERR("Fatal error spawning consumer control thread");
2684 /* Cleanup already created sockets on error. */
2685 if (consumer_data
->err_sock
>= 0) {
2688 err
= close(consumer_data
->err_sock
);
2690 PERROR("close consumer data error socket");
2697 * Setup necessary data for kernel tracer action.
2699 static int init_kernel_tracer(void)
2703 /* Modprobe lttng kernel modules */
2704 ret
= modprobe_lttng_control();
2709 /* Open debugfs lttng */
2710 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
2711 if (kernel_tracer_fd
< 0) {
2712 DBG("Failed to open %s", module_proc_lttng
);
2717 /* Validate kernel version */
2718 ret
= kernel_validate_version(kernel_tracer_fd
);
2723 ret
= modprobe_lttng_data();
2728 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
2732 modprobe_remove_lttng_control();
2733 ret
= close(kernel_tracer_fd
);
2737 kernel_tracer_fd
= -1;
2738 return LTTNG_ERR_KERN_VERSION
;
2741 ret
= close(kernel_tracer_fd
);
2747 modprobe_remove_lttng_control();
2750 WARN("No kernel tracer available");
2751 kernel_tracer_fd
= -1;
2753 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
2755 return LTTNG_ERR_KERN_NA
;
2761 * Copy consumer output from the tracing session to the domain session. The
2762 * function also applies the right modification on a per domain basis for the
2763 * trace files destination directory.
2765 * Should *NOT* be called with RCU read-side lock held.
2767 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2770 const char *dir_name
;
2771 struct consumer_output
*consumer
;
2774 assert(session
->consumer
);
2777 case LTTNG_DOMAIN_KERNEL
:
2778 DBG3("Copying tracing session consumer output in kernel session");
2780 * XXX: We should audit the session creation and what this function
2781 * does "extra" in order to avoid a destroy since this function is used
2782 * in the domain session creation (kernel and ust) only. Same for UST
2785 if (session
->kernel_session
->consumer
) {
2786 consumer_output_put(session
->kernel_session
->consumer
);
2788 session
->kernel_session
->consumer
=
2789 consumer_copy_output(session
->consumer
);
2790 /* Ease our life a bit for the next part */
2791 consumer
= session
->kernel_session
->consumer
;
2792 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2794 case LTTNG_DOMAIN_JUL
:
2795 case LTTNG_DOMAIN_LOG4J
:
2796 case LTTNG_DOMAIN_PYTHON
:
2797 case LTTNG_DOMAIN_UST
:
2798 DBG3("Copying tracing session consumer output in UST session");
2799 if (session
->ust_session
->consumer
) {
2800 consumer_output_put(session
->ust_session
->consumer
);
2802 session
->ust_session
->consumer
=
2803 consumer_copy_output(session
->consumer
);
2804 /* Ease our life a bit for the next part */
2805 consumer
= session
->ust_session
->consumer
;
2806 dir_name
= DEFAULT_UST_TRACE_DIR
;
2809 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2813 /* Append correct directory to subdir */
2814 strncat(consumer
->subdir
, dir_name
,
2815 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
2816 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2825 * Create an UST session and add it to the session ust list.
2827 * Should *NOT* be called with RCU read-side lock held.
2829 static int create_ust_session(struct ltt_session
*session
,
2830 struct lttng_domain
*domain
)
2833 struct ltt_ust_session
*lus
= NULL
;
2837 assert(session
->consumer
);
2839 switch (domain
->type
) {
2840 case LTTNG_DOMAIN_JUL
:
2841 case LTTNG_DOMAIN_LOG4J
:
2842 case LTTNG_DOMAIN_PYTHON
:
2843 case LTTNG_DOMAIN_UST
:
2846 ERR("Unknown UST domain on create session %d", domain
->type
);
2847 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2851 DBG("Creating UST session");
2853 lus
= trace_ust_create_session(session
->id
);
2855 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2859 lus
->uid
= session
->uid
;
2860 lus
->gid
= session
->gid
;
2861 lus
->output_traces
= session
->output_traces
;
2862 lus
->snapshot_mode
= session
->snapshot_mode
;
2863 lus
->live_timer_interval
= session
->live_timer
;
2864 session
->ust_session
= lus
;
2865 if (session
->shm_path
[0]) {
2866 strncpy(lus
->root_shm_path
, session
->shm_path
,
2867 sizeof(lus
->root_shm_path
));
2868 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
2869 strncpy(lus
->shm_path
, session
->shm_path
,
2870 sizeof(lus
->shm_path
));
2871 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
2872 strncat(lus
->shm_path
, "/ust",
2873 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
2875 /* Copy session output to the newly created UST session */
2876 ret
= copy_session_consumer(domain
->type
, session
);
2877 if (ret
!= LTTNG_OK
) {
2885 session
->ust_session
= NULL
;
2890 * Create a kernel tracer session then create the default channel.
2892 static int create_kernel_session(struct ltt_session
*session
)
2896 DBG("Creating kernel session");
2898 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2900 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2904 /* Code flow safety */
2905 assert(session
->kernel_session
);
2907 /* Copy session output to the newly created Kernel session */
2908 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2909 if (ret
!= LTTNG_OK
) {
2913 /* Create directory(ies) on local filesystem. */
2914 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2915 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2916 ret
= run_as_mkdir_recursive(
2917 session
->kernel_session
->consumer
->dst
.trace_path
,
2918 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2920 if (errno
!= EEXIST
) {
2921 ERR("Trace directory creation error");
2927 session
->kernel_session
->uid
= session
->uid
;
2928 session
->kernel_session
->gid
= session
->gid
;
2929 session
->kernel_session
->output_traces
= session
->output_traces
;
2930 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
2935 trace_kernel_destroy_session(session
->kernel_session
);
2936 session
->kernel_session
= NULL
;
2941 * Count number of session permitted by uid/gid.
2943 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2946 struct ltt_session
*session
;
2948 DBG("Counting number of available session for UID %d GID %d",
2950 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2952 * Only list the sessions the user can control.
2954 if (!session_access_ok(session
, uid
, gid
)) {
2963 * Process the command requested by the lttng client within the command
2964 * context structure. This function make sure that the return structure (llm)
2965 * is set and ready for transmission before returning.
2967 * Return any error encountered or 0 for success.
2969 * "sock" is only used for special-case var. len data.
2971 * Should *NOT* be called with RCU read-side lock held.
2973 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2977 int need_tracing_session
= 1;
2980 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2982 assert(!rcu_read_ongoing());
2986 switch (cmd_ctx
->lsm
->cmd_type
) {
2987 case LTTNG_CREATE_SESSION
:
2988 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2989 case LTTNG_CREATE_SESSION_LIVE
:
2990 case LTTNG_DESTROY_SESSION
:
2991 case LTTNG_LIST_SESSIONS
:
2992 case LTTNG_LIST_DOMAINS
:
2993 case LTTNG_START_TRACE
:
2994 case LTTNG_STOP_TRACE
:
2995 case LTTNG_DATA_PENDING
:
2996 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2997 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2998 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2999 case LTTNG_SNAPSHOT_RECORD
:
3000 case LTTNG_SAVE_SESSION
:
3001 case LTTNG_SET_SESSION_SHM_PATH
:
3002 case LTTNG_REGENERATE_METADATA
:
3003 case LTTNG_REGENERATE_STATEDUMP
:
3010 if (opt_no_kernel
&& need_domain
3011 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3013 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3015 ret
= LTTNG_ERR_KERN_NA
;
3020 /* Deny register consumer if we already have a spawned consumer. */
3021 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
3022 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3023 if (kconsumer_data
.pid
> 0) {
3024 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3025 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3028 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3032 * Check for command that don't needs to allocate a returned payload. We do
3033 * this here so we don't have to make the call for no payload at each
3036 switch(cmd_ctx
->lsm
->cmd_type
) {
3037 case LTTNG_LIST_SESSIONS
:
3038 case LTTNG_LIST_TRACEPOINTS
:
3039 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3040 case LTTNG_LIST_DOMAINS
:
3041 case LTTNG_LIST_CHANNELS
:
3042 case LTTNG_LIST_EVENTS
:
3043 case LTTNG_LIST_SYSCALLS
:
3044 case LTTNG_LIST_TRACKER_PIDS
:
3045 case LTTNG_DATA_PENDING
:
3048 /* Setup lttng message with no payload */
3049 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
3051 /* This label does not try to unlock the session */
3052 goto init_setup_error
;
3056 /* Commands that DO NOT need a session. */
3057 switch (cmd_ctx
->lsm
->cmd_type
) {
3058 case LTTNG_CREATE_SESSION
:
3059 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3060 case LTTNG_CREATE_SESSION_LIVE
:
3061 case LTTNG_LIST_SESSIONS
:
3062 case LTTNG_LIST_TRACEPOINTS
:
3063 case LTTNG_LIST_SYSCALLS
:
3064 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3065 case LTTNG_SAVE_SESSION
:
3066 need_tracing_session
= 0;
3069 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3071 * We keep the session list lock across _all_ commands
3072 * for now, because the per-session lock does not
3073 * handle teardown properly.
3075 session_lock_list();
3076 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3077 if (cmd_ctx
->session
== NULL
) {
3078 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
3081 /* Acquire lock for the session */
3082 session_lock(cmd_ctx
->session
);
3088 * Commands that need a valid session but should NOT create one if none
3089 * exists. Instead of creating one and destroying it when the command is
3090 * handled, process that right before so we save some round trip in useless
3093 switch (cmd_ctx
->lsm
->cmd_type
) {
3094 case LTTNG_DISABLE_CHANNEL
:
3095 case LTTNG_DISABLE_EVENT
:
3096 switch (cmd_ctx
->lsm
->domain
.type
) {
3097 case LTTNG_DOMAIN_KERNEL
:
3098 if (!cmd_ctx
->session
->kernel_session
) {
3099 ret
= LTTNG_ERR_NO_CHANNEL
;
3103 case LTTNG_DOMAIN_JUL
:
3104 case LTTNG_DOMAIN_LOG4J
:
3105 case LTTNG_DOMAIN_PYTHON
:
3106 case LTTNG_DOMAIN_UST
:
3107 if (!cmd_ctx
->session
->ust_session
) {
3108 ret
= LTTNG_ERR_NO_CHANNEL
;
3113 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3125 * Check domain type for specific "pre-action".
3127 switch (cmd_ctx
->lsm
->domain
.type
) {
3128 case LTTNG_DOMAIN_KERNEL
:
3130 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3134 /* Kernel tracer check */
3135 if (kernel_tracer_fd
== -1) {
3136 /* Basically, load kernel tracer modules */
3137 ret
= init_kernel_tracer();
3143 /* Consumer is in an ERROR state. Report back to client */
3144 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3145 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3149 /* Need a session for kernel command */
3150 if (need_tracing_session
) {
3151 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3152 ret
= create_kernel_session(cmd_ctx
->session
);
3154 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
3159 /* Start the kernel consumer daemon */
3160 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3161 if (kconsumer_data
.pid
== 0 &&
3162 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3163 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3164 ret
= start_consumerd(&kconsumer_data
);
3166 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3169 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3171 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3175 * The consumer was just spawned so we need to add the socket to
3176 * the consumer output of the session if exist.
3178 ret
= consumer_create_socket(&kconsumer_data
,
3179 cmd_ctx
->session
->kernel_session
->consumer
);
3186 case LTTNG_DOMAIN_JUL
:
3187 case LTTNG_DOMAIN_LOG4J
:
3188 case LTTNG_DOMAIN_PYTHON
:
3189 case LTTNG_DOMAIN_UST
:
3191 if (!ust_app_supported()) {
3192 ret
= LTTNG_ERR_NO_UST
;
3195 /* Consumer is in an ERROR state. Report back to client */
3196 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3197 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3201 if (need_tracing_session
) {
3202 /* Create UST session if none exist. */
3203 if (cmd_ctx
->session
->ust_session
== NULL
) {
3204 ret
= create_ust_session(cmd_ctx
->session
,
3205 &cmd_ctx
->lsm
->domain
);
3206 if (ret
!= LTTNG_OK
) {
3211 /* Start the UST consumer daemons */
3213 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3214 if (consumerd64_bin
[0] != '\0' &&
3215 ustconsumer64_data
.pid
== 0 &&
3216 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3217 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3218 ret
= start_consumerd(&ustconsumer64_data
);
3220 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
3221 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
3225 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
3226 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3228 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3232 * Setup socket for consumer 64 bit. No need for atomic access
3233 * since it was set above and can ONLY be set in this thread.
3235 ret
= consumer_create_socket(&ustconsumer64_data
,
3236 cmd_ctx
->session
->ust_session
->consumer
);
3242 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
3243 if (consumerd32_bin
[0] != '\0' &&
3244 ustconsumer32_data
.pid
== 0 &&
3245 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3246 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3247 ret
= start_consumerd(&ustconsumer32_data
);
3249 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
3250 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
3254 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
3255 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3257 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3261 * Setup socket for consumer 64 bit. No need for atomic access
3262 * since it was set above and can ONLY be set in this thread.
3264 ret
= consumer_create_socket(&ustconsumer32_data
,
3265 cmd_ctx
->session
->ust_session
->consumer
);
3277 /* Validate consumer daemon state when start/stop trace command */
3278 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3279 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3280 switch (cmd_ctx
->lsm
->domain
.type
) {
3281 case LTTNG_DOMAIN_NONE
:
3283 case LTTNG_DOMAIN_JUL
:
3284 case LTTNG_DOMAIN_LOG4J
:
3285 case LTTNG_DOMAIN_PYTHON
:
3286 case LTTNG_DOMAIN_UST
:
3287 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3288 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3292 case LTTNG_DOMAIN_KERNEL
:
3293 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3294 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3299 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3305 * Check that the UID or GID match that of the tracing session.
3306 * The root user can interact with all sessions.
3308 if (need_tracing_session
) {
3309 if (!session_access_ok(cmd_ctx
->session
,
3310 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3311 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3312 ret
= LTTNG_ERR_EPERM
;
3318 * Send relayd information to consumer as soon as we have a domain and a
3321 if (cmd_ctx
->session
&& need_domain
) {
3323 * Setup relayd if not done yet. If the relayd information was already
3324 * sent to the consumer, this call will gracefully return.
3326 ret
= cmd_setup_relayd(cmd_ctx
->session
);
3327 if (ret
!= LTTNG_OK
) {
3332 /* Process by command type */
3333 switch (cmd_ctx
->lsm
->cmd_type
) {
3334 case LTTNG_ADD_CONTEXT
:
3337 * An LTTNG_ADD_CONTEXT command might have a supplementary
3338 * payload if the context being added is an application context.
3340 if (cmd_ctx
->lsm
->u
.context
.ctx
.ctx
==
3341 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
3342 char *provider_name
= NULL
, *context_name
= NULL
;
3343 size_t provider_name_len
=
3344 cmd_ctx
->lsm
->u
.context
.provider_name_len
;
3345 size_t context_name_len
=
3346 cmd_ctx
->lsm
->u
.context
.context_name_len
;
3348 if (provider_name_len
== 0 || context_name_len
== 0) {
3350 * Application provider and context names MUST
3353 ret
= -LTTNG_ERR_INVALID
;
3357 provider_name
= zmalloc(provider_name_len
+ 1);
3358 if (!provider_name
) {
3359 ret
= -LTTNG_ERR_NOMEM
;
3362 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
=
3365 context_name
= zmalloc(context_name_len
+ 1);
3366 if (!context_name
) {
3367 ret
= -LTTNG_ERR_NOMEM
;
3368 goto error_add_context
;
3370 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
=
3373 ret
= lttcomm_recv_unix_sock(sock
, provider_name
,
3376 goto error_add_context
;
3379 ret
= lttcomm_recv_unix_sock(sock
, context_name
,
3382 goto error_add_context
;
3387 * cmd_add_context assumes ownership of the provider and context
3390 ret
= cmd_add_context(cmd_ctx
->session
,
3391 cmd_ctx
->lsm
->domain
.type
,
3392 cmd_ctx
->lsm
->u
.context
.channel_name
,
3393 &cmd_ctx
->lsm
->u
.context
.ctx
,
3394 kernel_poll_pipe
[1]);
3396 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
3397 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
3399 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
);
3400 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
);
3406 case LTTNG_DISABLE_CHANNEL
:
3408 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3409 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3412 case LTTNG_DISABLE_EVENT
:
3416 * FIXME: handle filter; for now we just receive the filter's
3417 * bytecode along with the filter expression which are sent by
3418 * liblttng-ctl and discard them.
3420 * This fixes an issue where the client may block while sending
3421 * the filter payload and encounter an error because the session
3422 * daemon closes the socket without ever handling this data.
3424 size_t count
= cmd_ctx
->lsm
->u
.disable
.expression_len
+
3425 cmd_ctx
->lsm
->u
.disable
.bytecode_len
;
3428 char data
[LTTNG_FILTER_MAX_LEN
];
3430 DBG("Discarding disable event command payload of size %zu", count
);
3432 ret
= lttcomm_recv_unix_sock(sock
, data
,
3433 count
> sizeof(data
) ? sizeof(data
) : count
);
3438 count
-= (size_t) ret
;
3441 /* FIXME: passing packed structure to non-packed pointer */
3442 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3443 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3444 &cmd_ctx
->lsm
->u
.disable
.event
);
3447 case LTTNG_ENABLE_CHANNEL
:
3449 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3450 &cmd_ctx
->lsm
->u
.channel
.chan
, kernel_poll_pipe
[1]);
3453 case LTTNG_TRACK_PID
:
3455 ret
= cmd_track_pid(cmd_ctx
->session
,
3456 cmd_ctx
->lsm
->domain
.type
,
3457 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3460 case LTTNG_UNTRACK_PID
:
3462 ret
= cmd_untrack_pid(cmd_ctx
->session
,
3463 cmd_ctx
->lsm
->domain
.type
,
3464 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3467 case LTTNG_ENABLE_EVENT
:
3469 struct lttng_event_exclusion
*exclusion
= NULL
;
3470 struct lttng_filter_bytecode
*bytecode
= NULL
;
3471 char *filter_expression
= NULL
;
3473 /* Handle exclusion events and receive it from the client. */
3474 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
3475 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
3477 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
3478 (count
* LTTNG_SYMBOL_NAME_LEN
));
3480 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
3484 DBG("Receiving var len exclusion event list from client ...");
3485 exclusion
->count
= count
;
3486 ret
= lttcomm_recv_unix_sock(sock
, exclusion
->names
,
3487 count
* LTTNG_SYMBOL_NAME_LEN
);
3489 DBG("Nothing recv() from client var len data... continuing");
3492 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
3497 /* Get filter expression from client. */
3498 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
3499 size_t expression_len
=
3500 cmd_ctx
->lsm
->u
.enable
.expression_len
;
3502 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
3503 ret
= LTTNG_ERR_FILTER_INVAL
;
3508 filter_expression
= zmalloc(expression_len
);
3509 if (!filter_expression
) {
3511 ret
= LTTNG_ERR_FILTER_NOMEM
;
3515 /* Receive var. len. data */
3516 DBG("Receiving var len filter's expression from client ...");
3517 ret
= lttcomm_recv_unix_sock(sock
, filter_expression
,
3520 DBG("Nothing recv() from client car len data... continuing");
3522 free(filter_expression
);
3524 ret
= LTTNG_ERR_FILTER_INVAL
;
3529 /* Handle filter and get bytecode from client. */
3530 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
3531 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
3533 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
3534 ret
= LTTNG_ERR_FILTER_INVAL
;
3535 free(filter_expression
);
3540 bytecode
= zmalloc(bytecode_len
);
3542 free(filter_expression
);
3544 ret
= LTTNG_ERR_FILTER_NOMEM
;
3548 /* Receive var. len. data */
3549 DBG("Receiving var len filter's bytecode from client ...");
3550 ret
= lttcomm_recv_unix_sock(sock
, bytecode
, bytecode_len
);
3552 DBG("Nothing recv() from client car len data... continuing");
3554 free(filter_expression
);
3557 ret
= LTTNG_ERR_FILTER_INVAL
;
3561 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
3562 free(filter_expression
);
3565 ret
= LTTNG_ERR_FILTER_INVAL
;
3570 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3571 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3572 &cmd_ctx
->lsm
->u
.enable
.event
,
3573 filter_expression
, bytecode
, exclusion
,
3574 kernel_poll_pipe
[1]);
3577 case LTTNG_LIST_TRACEPOINTS
:
3579 struct lttng_event
*events
;
3582 session_lock_list();
3583 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3584 session_unlock_list();
3585 if (nb_events
< 0) {
3586 /* Return value is a negative lttng_error_code. */
3592 * Setup lttng message with payload size set to the event list size in
3593 * bytes and then copy list into the llm payload.
3595 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
3596 sizeof(struct lttng_event
) * nb_events
);
3606 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3608 struct lttng_event_field
*fields
;
3611 session_lock_list();
3612 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
3614 session_unlock_list();
3615 if (nb_fields
< 0) {
3616 /* Return value is a negative lttng_error_code. */
3622 * Setup lttng message with payload size set to the event list size in
3623 * bytes and then copy list into the llm payload.
3625 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
3626 sizeof(struct lttng_event_field
) * nb_fields
);
3636 case LTTNG_LIST_SYSCALLS
:
3638 struct lttng_event
*events
;
3641 nb_events
= cmd_list_syscalls(&events
);
3642 if (nb_events
< 0) {
3643 /* Return value is a negative lttng_error_code. */
3649 * Setup lttng message with payload size set to the event list size in
3650 * bytes and then copy list into the llm payload.
3652 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
3653 sizeof(struct lttng_event
) * nb_events
);
3663 case LTTNG_LIST_TRACKER_PIDS
:
3665 int32_t *pids
= NULL
;
3668 nr_pids
= cmd_list_tracker_pids(cmd_ctx
->session
,
3669 cmd_ctx
->lsm
->domain
.type
, &pids
);
3671 /* Return value is a negative lttng_error_code. */
3677 * Setup lttng message with payload size set to the event list size in
3678 * bytes and then copy list into the llm payload.
3680 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, pids
,
3681 sizeof(int32_t) * nr_pids
);
3691 case LTTNG_SET_CONSUMER_URI
:
3694 struct lttng_uri
*uris
;
3696 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3697 len
= nb_uri
* sizeof(struct lttng_uri
);
3700 ret
= LTTNG_ERR_INVALID
;
3704 uris
= zmalloc(len
);
3706 ret
= LTTNG_ERR_FATAL
;
3710 /* Receive variable len data */
3711 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
3712 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3714 DBG("No URIs received from client... continuing");
3716 ret
= LTTNG_ERR_SESSION_FAIL
;
3721 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
3723 if (ret
!= LTTNG_OK
) {
3730 case LTTNG_START_TRACE
:
3732 ret
= cmd_start_trace(cmd_ctx
->session
);
3735 case LTTNG_STOP_TRACE
:
3737 ret
= cmd_stop_trace(cmd_ctx
->session
);
3740 case LTTNG_CREATE_SESSION
:
3743 struct lttng_uri
*uris
= NULL
;
3745 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3746 len
= nb_uri
* sizeof(struct lttng_uri
);
3749 uris
= zmalloc(len
);
3751 ret
= LTTNG_ERR_FATAL
;
3755 /* Receive variable len data */
3756 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3757 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3759 DBG("No URIs received from client... continuing");
3761 ret
= LTTNG_ERR_SESSION_FAIL
;
3766 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3767 DBG("Creating session with ONE network URI is a bad call");
3768 ret
= LTTNG_ERR_SESSION_FAIL
;
3774 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
3775 &cmd_ctx
->creds
, 0);
3781 case LTTNG_DESTROY_SESSION
:
3783 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
3785 /* Set session to NULL so we do not unlock it after free. */
3786 cmd_ctx
->session
= NULL
;
3789 case LTTNG_LIST_DOMAINS
:
3792 struct lttng_domain
*domains
= NULL
;
3794 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3796 /* Return value is a negative lttng_error_code. */
3801 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
3802 nb_dom
* sizeof(struct lttng_domain
));
3812 case LTTNG_LIST_CHANNELS
:
3814 ssize_t payload_size
;
3815 struct lttng_channel
*channels
= NULL
;
3817 payload_size
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3818 cmd_ctx
->session
, &channels
);
3819 if (payload_size
< 0) {
3820 /* Return value is a negative lttng_error_code. */
3821 ret
= -payload_size
;
3825 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, channels
,
3836 case LTTNG_LIST_EVENTS
:
3839 struct lttng_event
*events
= NULL
;
3840 struct lttcomm_event_command_header cmd_header
;
3843 memset(&cmd_header
, 0, sizeof(cmd_header
));
3844 /* Extended infos are included at the end of events */
3845 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
,
3846 cmd_ctx
->session
, cmd_ctx
->lsm
->u
.list
.channel_name
,
3847 &events
, &total_size
);
3850 /* Return value is a negative lttng_error_code. */
3855 cmd_header
.nb_events
= nb_event
;
3856 ret
= setup_lttng_msg(cmd_ctx
, events
, total_size
,
3857 &cmd_header
, sizeof(cmd_header
));
3867 case LTTNG_LIST_SESSIONS
:
3869 unsigned int nr_sessions
;
3870 void *sessions_payload
;
3873 session_lock_list();
3874 nr_sessions
= lttng_sessions_count(
3875 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3876 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3877 payload_len
= sizeof(struct lttng_session
) * nr_sessions
;
3878 sessions_payload
= zmalloc(payload_len
);
3880 if (!sessions_payload
) {
3881 session_unlock_list();
3886 cmd_list_lttng_sessions(sessions_payload
,
3887 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3888 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3889 session_unlock_list();
3891 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
3893 free(sessions_payload
);
3902 case LTTNG_REGISTER_CONSUMER
:
3904 struct consumer_data
*cdata
;
3906 switch (cmd_ctx
->lsm
->domain
.type
) {
3907 case LTTNG_DOMAIN_KERNEL
:
3908 cdata
= &kconsumer_data
;
3911 ret
= LTTNG_ERR_UND
;
3915 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3916 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
3919 case LTTNG_DATA_PENDING
:
3922 uint8_t pending_ret_byte
;
3924 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
3929 * This function may returns 0 or 1 to indicate whether or not
3930 * there is data pending. In case of error, it should return an
3931 * LTTNG_ERR code. However, some code paths may still return
3932 * a nondescript error code, which we handle by returning an
3935 if (pending_ret
== 0 || pending_ret
== 1) {
3937 * ret will be set to LTTNG_OK at the end of
3940 } else if (pending_ret
< 0) {
3941 ret
= LTTNG_ERR_UNK
;
3948 pending_ret_byte
= (uint8_t) pending_ret
;
3950 /* 1 byte to return whether or not data is pending */
3951 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
3952 &pending_ret_byte
, 1);
3961 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3963 struct lttcomm_lttng_output_id reply
;
3965 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
3966 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
3967 if (ret
!= LTTNG_OK
) {
3971 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
3977 /* Copy output list into message payload */
3981 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3983 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
3984 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
3987 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3990 struct lttng_snapshot_output
*outputs
= NULL
;
3992 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
3993 if (nb_output
< 0) {
3998 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
3999 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
4000 nb_output
* sizeof(struct lttng_snapshot_output
));
4010 case LTTNG_SNAPSHOT_RECORD
:
4012 ret
= cmd_snapshot_record(cmd_ctx
->session
,
4013 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
4014 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
4017 case LTTNG_CREATE_SESSION_SNAPSHOT
:
4020 struct lttng_uri
*uris
= NULL
;
4022 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4023 len
= nb_uri
* sizeof(struct lttng_uri
);
4026 uris
= zmalloc(len
);
4028 ret
= LTTNG_ERR_FATAL
;
4032 /* Receive variable len data */
4033 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4034 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4036 DBG("No URIs received from client... continuing");
4038 ret
= LTTNG_ERR_SESSION_FAIL
;
4043 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4044 DBG("Creating session with ONE network URI is a bad call");
4045 ret
= LTTNG_ERR_SESSION_FAIL
;
4051 ret
= cmd_create_session_snapshot(cmd_ctx
->lsm
->session
.name
, uris
,
4052 nb_uri
, &cmd_ctx
->creds
);
4056 case LTTNG_CREATE_SESSION_LIVE
:
4059 struct lttng_uri
*uris
= NULL
;
4061 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4062 len
= nb_uri
* sizeof(struct lttng_uri
);
4065 uris
= zmalloc(len
);
4067 ret
= LTTNG_ERR_FATAL
;
4071 /* Receive variable len data */
4072 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4073 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4075 DBG("No URIs received from client... continuing");
4077 ret
= LTTNG_ERR_SESSION_FAIL
;
4082 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4083 DBG("Creating session with ONE network URI is a bad call");
4084 ret
= LTTNG_ERR_SESSION_FAIL
;
4090 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
,
4091 nb_uri
, &cmd_ctx
->creds
, cmd_ctx
->lsm
->u
.session_live
.timer_interval
);
4095 case LTTNG_SAVE_SESSION
:
4097 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
4101 case LTTNG_SET_SESSION_SHM_PATH
:
4103 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
4104 cmd_ctx
->lsm
->u
.set_shm_path
.shm_path
);
4107 case LTTNG_REGENERATE_METADATA
:
4109 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
4112 case LTTNG_REGENERATE_STATEDUMP
:
4114 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
4118 ret
= LTTNG_ERR_UND
;
4123 if (cmd_ctx
->llm
== NULL
) {
4124 DBG("Missing llm structure. Allocating one.");
4125 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
4129 /* Set return code */
4130 cmd_ctx
->llm
->ret_code
= ret
;
4132 if (cmd_ctx
->session
) {
4133 session_unlock(cmd_ctx
->session
);
4135 if (need_tracing_session
) {
4136 session_unlock_list();
4139 assert(!rcu_read_ongoing());
4144 * Thread managing health check socket.
4146 static void *thread_manage_health(void *data
)
4148 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
4149 uint32_t revents
, nb_fd
;
4150 struct lttng_poll_event events
;
4151 struct health_comm_msg msg
;
4152 struct health_comm_reply reply
;
4154 DBG("[thread] Manage health check started");
4156 rcu_register_thread();
4158 /* We might hit an error path before this is created. */
4159 lttng_poll_init(&events
);
4161 /* Create unix socket */
4162 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
4164 ERR("Unable to create health check Unix socket");
4169 /* lttng health client socket path permissions */
4170 ret
= chown(health_unix_sock_path
, 0,
4171 utils_get_group_id(tracing_group_name
));
4173 ERR("Unable to set group on %s", health_unix_sock_path
);
4178 ret
= chmod(health_unix_sock_path
,
4179 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4181 ERR("Unable to set permissions on %s", health_unix_sock_path
);
4188 * Set the CLOEXEC flag. Return code is useless because either way, the
4191 (void) utils_set_fd_cloexec(sock
);
4193 ret
= lttcomm_listen_unix_sock(sock
);
4199 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4200 * more will be added to this poll set.
4202 ret
= sessiond_set_thread_pollset(&events
, 2);
4207 /* Add the application registration socket */
4208 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
4213 sessiond_notify_ready();
4216 DBG("Health check ready");
4218 /* Inifinite blocking call, waiting for transmission */
4220 ret
= lttng_poll_wait(&events
, -1);
4223 * Restart interrupted system call.
4225 if (errno
== EINTR
) {
4233 for (i
= 0; i
< nb_fd
; i
++) {
4234 /* Fetch once the poll data */
4235 revents
= LTTNG_POLL_GETEV(&events
, i
);
4236 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4239 /* No activity for this FD (poll implementation). */
4243 /* Thread quit pipe has been closed. Killing thread. */
4244 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4250 /* Event on the registration socket */
4251 if (pollfd
== sock
) {
4252 if (revents
& LPOLLIN
) {
4254 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4255 ERR("Health socket poll error");
4258 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4264 new_sock
= lttcomm_accept_unix_sock(sock
);
4270 * Set the CLOEXEC flag. Return code is useless because either way, the
4273 (void) utils_set_fd_cloexec(new_sock
);
4275 DBG("Receiving data from client for health...");
4276 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
4278 DBG("Nothing recv() from client... continuing");
4279 ret
= close(new_sock
);
4286 rcu_thread_online();
4288 memset(&reply
, 0, sizeof(reply
));
4289 for (i
= 0; i
< NR_HEALTH_SESSIOND_TYPES
; i
++) {
4291 * health_check_state returns 0 if health is
4294 if (!health_check_state(health_sessiond
, i
)) {
4295 reply
.ret_code
|= 1ULL << i
;
4299 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
4301 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
4303 ERR("Failed to send health data back to client");
4306 /* End of transmission */
4307 ret
= close(new_sock
);
4316 ERR("Health error occurred in %s", __func__
);
4318 DBG("Health check thread dying");
4319 unlink(health_unix_sock_path
);
4327 lttng_poll_clean(&events
);
4329 rcu_unregister_thread();
4334 * This thread manage all clients request using the unix client socket for
4337 static void *thread_manage_clients(void *data
)
4339 int sock
= -1, ret
, i
, pollfd
, err
= -1;
4341 uint32_t revents
, nb_fd
;
4342 struct command_ctx
*cmd_ctx
= NULL
;
4343 struct lttng_poll_event events
;
4345 DBG("[thread] Manage client started");
4347 rcu_register_thread();
4349 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
4351 health_code_update();
4353 ret
= lttcomm_listen_unix_sock(client_sock
);
4359 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4360 * more will be added to this poll set.
4362 ret
= sessiond_set_thread_pollset(&events
, 2);
4364 goto error_create_poll
;
4367 /* Add the application registration socket */
4368 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
4373 sessiond_notify_ready();
4374 ret
= sem_post(&load_info
->message_thread_ready
);
4376 PERROR("sem_post message_thread_ready");
4380 /* This testpoint is after we signal readiness to the parent. */
4381 if (testpoint(sessiond_thread_manage_clients
)) {
4385 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
4389 health_code_update();
4392 DBG("Accepting client command ...");
4394 /* Inifinite blocking call, waiting for transmission */
4396 health_poll_entry();
4397 ret
= lttng_poll_wait(&events
, -1);
4401 * Restart interrupted system call.
4403 if (errno
== EINTR
) {
4411 for (i
= 0; i
< nb_fd
; i
++) {
4412 /* Fetch once the poll data */
4413 revents
= LTTNG_POLL_GETEV(&events
, i
);
4414 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4416 health_code_update();
4419 /* No activity for this FD (poll implementation). */
4423 /* Thread quit pipe has been closed. Killing thread. */
4424 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4430 /* Event on the registration socket */
4431 if (pollfd
== client_sock
) {
4432 if (revents
& LPOLLIN
) {
4434 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4435 ERR("Client socket poll error");
4438 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4444 DBG("Wait for client response");
4446 health_code_update();
4448 sock
= lttcomm_accept_unix_sock(client_sock
);
4454 * Set the CLOEXEC flag. Return code is useless because either way, the
4457 (void) utils_set_fd_cloexec(sock
);
4459 /* Set socket option for credentials retrieval */
4460 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
4465 /* Allocate context command to process the client request */
4466 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
4467 if (cmd_ctx
== NULL
) {
4468 PERROR("zmalloc cmd_ctx");
4472 /* Allocate data buffer for reception */
4473 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
4474 if (cmd_ctx
->lsm
== NULL
) {
4475 PERROR("zmalloc cmd_ctx->lsm");
4479 cmd_ctx
->llm
= NULL
;
4480 cmd_ctx
->session
= NULL
;
4482 health_code_update();
4485 * Data is received from the lttng client. The struct
4486 * lttcomm_session_msg (lsm) contains the command and data request of
4489 DBG("Receiving data from client ...");
4490 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
4491 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
4493 DBG("Nothing recv() from client... continuing");
4499 clean_command_ctx(&cmd_ctx
);
4503 health_code_update();
4505 // TODO: Validate cmd_ctx including sanity check for
4506 // security purpose.
4508 rcu_thread_online();
4510 * This function dispatch the work to the kernel or userspace tracer
4511 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4512 * informations for the client. The command context struct contains
4513 * everything this function may needs.
4515 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
4516 rcu_thread_offline();
4524 * TODO: Inform client somehow of the fatal error. At
4525 * this point, ret < 0 means that a zmalloc failed
4526 * (ENOMEM). Error detected but still accept
4527 * command, unless a socket error has been
4530 clean_command_ctx(&cmd_ctx
);
4534 health_code_update();
4536 DBG("Sending response (size: %d, retcode: %s (%d))",
4537 cmd_ctx
->lttng_msg_size
,
4538 lttng_strerror(-cmd_ctx
->llm
->ret_code
),
4539 cmd_ctx
->llm
->ret_code
);
4540 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
4542 ERR("Failed to send data back to client");
4545 /* End of transmission */
4552 clean_command_ctx(&cmd_ctx
);
4554 health_code_update();
4566 lttng_poll_clean(&events
);
4567 clean_command_ctx(&cmd_ctx
);
4571 unlink(client_unix_sock_path
);
4572 if (client_sock
>= 0) {
4573 ret
= close(client_sock
);
4581 ERR("Health error occurred in %s", __func__
);
4584 health_unregister(health_sessiond
);
4586 DBG("Client thread dying");
4588 rcu_unregister_thread();
4591 * Since we are creating the consumer threads, we own them, so we need
4592 * to join them before our thread exits.
4594 ret
= join_consumer_thread(&kconsumer_data
);
4597 PERROR("join_consumer");
4600 ret
= join_consumer_thread(&ustconsumer32_data
);
4603 PERROR("join_consumer ust32");
4606 ret
= join_consumer_thread(&ustconsumer64_data
);
4609 PERROR("join_consumer ust64");
4614 static int string_match(const char *str1
, const char *str2
)
4616 return (str1
&& str2
) && !strcmp(str1
, str2
);
4620 * Take an option from the getopt output and set it in the right variable to be
4623 * Return 0 on success else a negative value.
4625 static int set_option(int opt
, const char *arg
, const char *optname
)
4629 if (string_match(optname
, "client-sock") || opt
== 'c') {
4630 if (!arg
|| *arg
== '\0') {
4634 if (lttng_is_setuid_setgid()) {
4635 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4636 "-c, --client-sock");
4638 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", arg
);
4640 } else if (string_match(optname
, "apps-sock") || opt
== 'a') {
4641 if (!arg
|| *arg
== '\0') {
4645 if (lttng_is_setuid_setgid()) {
4646 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4649 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", arg
);
4651 } else if (string_match(optname
, "daemonize") || opt
== 'd') {
4653 } else if (string_match(optname
, "background") || opt
== 'b') {
4655 } else if (string_match(optname
, "group") || opt
== 'g') {
4656 if (!arg
|| *arg
== '\0') {
4660 if (lttng_is_setuid_setgid()) {
4661 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4665 * If the override option is set, the pointer points to a
4666 * *non* const thus freeing it even though the variable type is
4669 if (tracing_group_name_override
) {
4670 free((void *) tracing_group_name
);
4672 tracing_group_name
= strdup(arg
);
4673 if (!tracing_group_name
) {
4677 tracing_group_name_override
= 1;
4679 } else if (string_match(optname
, "help") || opt
== 'h') {
4680 ret
= utils_show_man_page(8, "lttng-sessiond");
4682 ERR("Cannot view man page lttng-sessiond(8)");
4685 exit(ret
? EXIT_FAILURE
: EXIT_SUCCESS
);
4686 } else if (string_match(optname
, "version") || opt
== 'V') {
4687 fprintf(stdout
, "%s\n", VERSION
);
4689 } else if (string_match(optname
, "sig-parent") || opt
== 'S') {
4691 } else if (string_match(optname
, "kconsumerd-err-sock")) {
4692 if (!arg
|| *arg
== '\0') {
4696 if (lttng_is_setuid_setgid()) {
4697 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4698 "--kconsumerd-err-sock");
4700 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4702 } else if (string_match(optname
, "kconsumerd-cmd-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-cmd-sock");
4711 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4713 } else if (string_match(optname
, "ustconsumerd64-err-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 "--ustconsumerd64-err-sock");
4722 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4724 } else if (string_match(optname
, "ustconsumerd64-cmd-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-cmd-sock");
4733 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4735 } else if (string_match(optname
, "ustconsumerd32-err-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 "--ustconsumerd32-err-sock");
4744 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4746 } else if (string_match(optname
, "ustconsumerd32-cmd-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-cmd-sock");
4755 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4757 } else if (string_match(optname
, "no-kernel")) {
4759 } else if (string_match(optname
, "quiet") || opt
== 'q') {
4760 lttng_opt_quiet
= 1;
4761 } else if (string_match(optname
, "verbose") || opt
== 'v') {
4762 /* Verbose level can increase using multiple -v */
4764 /* Value obtained from config file */
4765 lttng_opt_verbose
= config_parse_value(arg
);
4767 /* -v used on command line */
4768 lttng_opt_verbose
++;
4770 /* Clamp value to [0, 3] */
4771 lttng_opt_verbose
= lttng_opt_verbose
< 0 ? 0 :
4772 (lttng_opt_verbose
<= 3 ? lttng_opt_verbose
: 3);
4773 } else if (string_match(optname
, "verbose-consumer")) {
4775 opt_verbose_consumer
= config_parse_value(arg
);
4777 opt_verbose_consumer
++;
4779 } else if (string_match(optname
, "consumerd32-path")) {
4780 if (!arg
|| *arg
== '\0') {
4784 if (lttng_is_setuid_setgid()) {
4785 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4786 "--consumerd32-path");
4788 if (consumerd32_bin_override
) {
4789 free((void *) consumerd32_bin
);
4791 consumerd32_bin
= strdup(arg
);
4792 if (!consumerd32_bin
) {
4796 consumerd32_bin_override
= 1;
4798 } else if (string_match(optname
, "consumerd32-libdir")) {
4799 if (!arg
|| *arg
== '\0') {
4803 if (lttng_is_setuid_setgid()) {
4804 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4805 "--consumerd32-libdir");
4807 if (consumerd32_libdir_override
) {
4808 free((void *) consumerd32_libdir
);
4810 consumerd32_libdir
= strdup(arg
);
4811 if (!consumerd32_libdir
) {
4815 consumerd32_libdir_override
= 1;
4817 } else if (string_match(optname
, "consumerd64-path")) {
4818 if (!arg
|| *arg
== '\0') {
4822 if (lttng_is_setuid_setgid()) {
4823 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4824 "--consumerd64-path");
4826 if (consumerd64_bin_override
) {
4827 free((void *) consumerd64_bin
);
4829 consumerd64_bin
= strdup(arg
);
4830 if (!consumerd64_bin
) {
4834 consumerd64_bin_override
= 1;
4836 } else if (string_match(optname
, "consumerd64-libdir")) {
4837 if (!arg
|| *arg
== '\0') {
4841 if (lttng_is_setuid_setgid()) {
4842 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4843 "--consumerd64-libdir");
4845 if (consumerd64_libdir_override
) {
4846 free((void *) consumerd64_libdir
);
4848 consumerd64_libdir
= strdup(arg
);
4849 if (!consumerd64_libdir
) {
4853 consumerd64_libdir_override
= 1;
4855 } else if (string_match(optname
, "pidfile") || opt
== 'p') {
4856 if (!arg
|| *arg
== '\0') {
4860 if (lttng_is_setuid_setgid()) {
4861 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4865 opt_pidfile
= strdup(arg
);
4871 } else if (string_match(optname
, "agent-tcp-port")) {
4872 if (!arg
|| *arg
== '\0') {
4876 if (lttng_is_setuid_setgid()) {
4877 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4878 "--agent-tcp-port");
4883 v
= strtoul(arg
, NULL
, 0);
4884 if (errno
!= 0 || !isdigit(arg
[0])) {
4885 ERR("Wrong value in --agent-tcp-port parameter: %s", arg
);
4888 if (v
== 0 || v
>= 65535) {
4889 ERR("Port overflow in --agent-tcp-port parameter: %s", arg
);
4892 agent_tcp_port
= (uint32_t) v
;
4893 DBG3("Agent TCP port set to non default: %u", agent_tcp_port
);
4895 } else if (string_match(optname
, "load") || opt
== 'l') {
4896 if (!arg
|| *arg
== '\0') {
4900 if (lttng_is_setuid_setgid()) {
4901 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4904 free(opt_load_session_path
);
4905 opt_load_session_path
= strdup(arg
);
4906 if (!opt_load_session_path
) {
4911 } else if (string_match(optname
, "kmod-probes")) {
4912 if (!arg
|| *arg
== '\0') {
4916 if (lttng_is_setuid_setgid()) {
4917 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4920 free(kmod_probes_list
);
4921 kmod_probes_list
= strdup(arg
);
4922 if (!kmod_probes_list
) {
4927 } else if (string_match(optname
, "extra-kmod-probes")) {
4928 if (!arg
|| *arg
== '\0') {
4932 if (lttng_is_setuid_setgid()) {
4933 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4934 "--extra-kmod-probes");
4936 free(kmod_extra_probes_list
);
4937 kmod_extra_probes_list
= strdup(arg
);
4938 if (!kmod_extra_probes_list
) {
4943 } else if (string_match(optname
, "config") || opt
== 'f') {
4944 /* This is handled in set_options() thus silent skip. */
4947 /* Unknown option or other error.
4948 * Error is printed by getopt, just return */
4953 if (ret
== -EINVAL
) {
4954 const char *opt_name
= "unknown";
4957 for (i
= 0; i
< sizeof(long_options
) / sizeof(struct option
);
4959 if (opt
== long_options
[i
].val
) {
4960 opt_name
= long_options
[i
].name
;
4965 WARN("Invalid argument provided for option \"%s\", using default value.",
4973 * config_entry_handler_cb used to handle options read from a config file.
4974 * See config_entry_handler_cb comment in common/config/session-config.h for the
4975 * return value conventions.
4977 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
4981 if (!entry
|| !entry
->name
|| !entry
->value
) {
4986 /* Check if the option is to be ignored */
4987 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
4988 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
4993 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1;
4996 /* Ignore if not fully matched. */
4997 if (strcmp(entry
->name
, long_options
[i
].name
)) {
5002 * If the option takes no argument on the command line, we have to
5003 * check if the value is "true". We support non-zero numeric values,
5006 if (!long_options
[i
].has_arg
) {
5007 ret
= config_parse_value(entry
->value
);
5010 WARN("Invalid configuration value \"%s\" for option %s",
5011 entry
->value
, entry
->name
);
5013 /* False, skip boolean config option. */
5018 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
5022 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry
->name
);
5029 * daemon configuration loading and argument parsing
5031 static int set_options(int argc
, char **argv
)
5033 int ret
= 0, c
= 0, option_index
= 0;
5034 int orig_optopt
= optopt
, orig_optind
= optind
;
5036 const char *config_path
= NULL
;
5038 optstring
= utils_generate_optstring(long_options
,
5039 sizeof(long_options
) / sizeof(struct option
));
5045 /* Check for the --config option */
5046 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
5047 &option_index
)) != -1) {
5051 } else if (c
!= 'f') {
5052 /* if not equal to --config option. */
5056 if (lttng_is_setuid_setgid()) {
5057 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5060 config_path
= utils_expand_path(optarg
);
5062 ERR("Failed to resolve path: %s", optarg
);
5067 ret
= config_get_section_entries(config_path
, config_section_name
,
5068 config_entry_handler
, NULL
);
5071 ERR("Invalid configuration option at line %i", ret
);
5077 /* Reset getopt's global state */
5078 optopt
= orig_optopt
;
5079 optind
= orig_optind
;
5083 * getopt_long() will not set option_index if it encounters a
5086 c
= getopt_long(argc
, argv
, optstring
, long_options
,
5093 * Pass NULL as the long option name if popt left the index
5096 ret
= set_option(c
, optarg
,
5097 option_index
< 0 ? NULL
:
5098 long_options
[option_index
].name
);
5110 * Creates the two needed socket by the daemon.
5111 * apps_sock - The communication socket for all UST apps.
5112 * client_sock - The communication of the cli tool (lttng).
5114 static int init_daemon_socket(void)
5119 old_umask
= umask(0);
5121 /* Create client tool unix socket */
5122 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5123 if (client_sock
< 0) {
5124 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5129 /* Set the cloexec flag */
5130 ret
= utils_set_fd_cloexec(client_sock
);
5132 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
5133 "Continuing but note that the consumer daemon will have a "
5134 "reference to this socket on exec()", client_sock
);
5137 /* File permission MUST be 660 */
5138 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5140 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5145 /* Create the application unix socket */
5146 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5147 if (apps_sock
< 0) {
5148 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5153 /* Set the cloexec flag */
5154 ret
= utils_set_fd_cloexec(apps_sock
);
5156 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
5157 "Continuing but note that the consumer daemon will have a "
5158 "reference to this socket on exec()", apps_sock
);
5161 /* File permission MUST be 666 */
5162 ret
= chmod(apps_unix_sock_path
,
5163 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5165 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5170 DBG3("Session daemon client socket %d and application socket %d created",
5171 client_sock
, apps_sock
);
5179 * Check if the global socket is available, and if a daemon is answering at the
5180 * other side. If yes, error is returned.
5182 static int check_existing_daemon(void)
5184 /* Is there anybody out there ? */
5185 if (lttng_session_daemon_alive()) {
5193 * Set the tracing group gid onto the client socket.
5195 * Race window between mkdir and chown is OK because we are going from more
5196 * permissive (root.root) to less permissive (root.tracing).
5198 static int set_permissions(char *rundir
)
5203 gid
= utils_get_group_id(tracing_group_name
);
5205 /* Set lttng run dir */
5206 ret
= chown(rundir
, 0, gid
);
5208 ERR("Unable to set group on %s", rundir
);
5213 * Ensure all applications and tracing group can search the run
5214 * dir. Allow everyone to read the directory, since it does not
5215 * buy us anything to hide its content.
5217 ret
= chmod(rundir
, S_IRWXU
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
5219 ERR("Unable to set permissions on %s", rundir
);
5223 /* lttng client socket path */
5224 ret
= chown(client_unix_sock_path
, 0, gid
);
5226 ERR("Unable to set group on %s", client_unix_sock_path
);
5230 /* kconsumer error socket path */
5231 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, 0);
5233 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5237 /* 64-bit ustconsumer error socket path */
5238 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, 0);
5240 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5244 /* 32-bit ustconsumer compat32 error socket path */
5245 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, 0);
5247 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5251 DBG("All permissions are set");
5257 * Create the lttng run directory needed for all global sockets and pipe.
5259 static int create_lttng_rundir(const char *rundir
)
5263 DBG3("Creating LTTng run directory: %s", rundir
);
5265 ret
= mkdir(rundir
, S_IRWXU
);
5267 if (errno
!= EEXIST
) {
5268 ERR("Unable to create %s", rundir
);
5280 * Setup sockets and directory needed by the kconsumerd communication with the
5283 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5287 char path
[PATH_MAX
];
5289 switch (consumer_data
->type
) {
5290 case LTTNG_CONSUMER_KERNEL
:
5291 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5293 case LTTNG_CONSUMER64_UST
:
5294 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5296 case LTTNG_CONSUMER32_UST
:
5297 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5300 ERR("Consumer type unknown");
5305 DBG2("Creating consumer directory: %s", path
);
5307 ret
= mkdir(path
, S_IRWXU
| S_IRGRP
| S_IXGRP
);
5309 if (errno
!= EEXIST
) {
5311 ERR("Failed to create %s", path
);
5317 ret
= chown(path
, 0, utils_get_group_id(tracing_group_name
));
5319 ERR("Unable to set group on %s", path
);
5325 /* Create the kconsumerd error unix socket */
5326 consumer_data
->err_sock
=
5327 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5328 if (consumer_data
->err_sock
< 0) {
5329 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5335 * Set the CLOEXEC flag. Return code is useless because either way, the
5338 ret
= utils_set_fd_cloexec(consumer_data
->err_sock
);
5340 PERROR("utils_set_fd_cloexec");
5341 /* continue anyway */
5344 /* File permission MUST be 660 */
5345 ret
= chmod(consumer_data
->err_unix_sock_path
,
5346 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5348 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5358 * Signal handler for the daemon
5360 * Simply stop all worker threads, leaving main() return gracefully after
5361 * joining all threads and calling cleanup().
5363 static void sighandler(int sig
)
5367 DBG("SIGINT caught");
5371 DBG("SIGTERM caught");
5375 CMM_STORE_SHARED(recv_child_signal
, 1);
5383 * Setup signal handler for :
5384 * SIGINT, SIGTERM, SIGPIPE
5386 static int set_signal_handler(void)
5389 struct sigaction sa
;
5392 if ((ret
= sigemptyset(&sigset
)) < 0) {
5393 PERROR("sigemptyset");
5397 sa
.sa_mask
= sigset
;
5400 sa
.sa_handler
= sighandler
;
5401 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5402 PERROR("sigaction");
5406 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5407 PERROR("sigaction");
5411 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
5412 PERROR("sigaction");
5416 sa
.sa_handler
= SIG_IGN
;
5417 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5418 PERROR("sigaction");
5422 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
5428 * Set open files limit to unlimited. This daemon can open a large number of
5429 * file descriptors in order to consume multiple kernel traces.
5431 static void set_ulimit(void)
5436 /* The kernel does not allow an infinite limit for open files */
5437 lim
.rlim_cur
= 65535;
5438 lim
.rlim_max
= 65535;
5440 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5442 PERROR("failed to set open files limit");
5447 * Write pidfile using the rundir and opt_pidfile.
5449 static int write_pidfile(void)
5452 char pidfile_path
[PATH_MAX
];
5457 if (lttng_strncpy(pidfile_path
, opt_pidfile
, sizeof(pidfile_path
))) {
5462 /* Build pidfile path from rundir and opt_pidfile. */
5463 ret
= snprintf(pidfile_path
, sizeof(pidfile_path
), "%s/"
5464 DEFAULT_LTTNG_SESSIOND_PIDFILE
, rundir
);
5466 PERROR("snprintf pidfile path");
5472 * Create pid file in rundir.
5474 ret
= utils_create_pid_file(getpid(), pidfile_path
);
5480 * Create lockfile using the rundir and return its fd.
5482 static int create_lockfile(void)
5485 char lockfile_path
[PATH_MAX
];
5487 ret
= generate_lock_file_path(lockfile_path
, sizeof(lockfile_path
));
5492 ret
= utils_create_lock_file(lockfile_path
);
5498 * Write agent TCP port using the rundir.
5500 static int write_agent_port(void)
5503 char path
[PATH_MAX
];
5507 ret
= snprintf(path
, sizeof(path
), "%s/"
5508 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
, rundir
);
5510 PERROR("snprintf agent port path");
5515 * Create TCP agent port file in rundir.
5517 ret
= utils_create_pid_file(agent_tcp_port
, path
);
5526 int main(int argc
, char **argv
)
5528 int ret
= 0, retval
= 0;
5530 const char *home_path
, *env_app_timeout
;
5532 init_kernel_workarounds();
5534 rcu_register_thread();
5536 if (set_signal_handler()) {
5538 goto exit_set_signal_handler
;
5541 setup_consumerd_path();
5543 page_size
= sysconf(_SC_PAGESIZE
);
5544 if (page_size
< 0) {
5545 PERROR("sysconf _SC_PAGESIZE");
5546 page_size
= LONG_MAX
;
5547 WARN("Fallback page size to %ld", page_size
);
5551 * Parse arguments and load the daemon configuration file.
5553 * We have an exit_options exit path to free memory reserved by
5554 * set_options. This is needed because the rest of sessiond_cleanup()
5555 * depends on ht_cleanup_thread, which depends on lttng_daemonize, which
5556 * depends on set_options.
5559 if (set_options(argc
, argv
)) {
5565 if (opt_daemon
|| opt_background
) {
5568 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
5576 * We are in the child. Make sure all other file descriptors are
5577 * closed, in case we are called with more opened file
5578 * descriptors than the standard ones.
5580 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5585 if (run_as_create_worker(argv
[0]) < 0) {
5586 goto exit_create_run_as_worker_cleanup
;
5590 * Starting from here, we can create threads. This needs to be after
5591 * lttng_daemonize due to RCU.
5595 * Initialize the health check subsystem. This call should set the
5596 * appropriate time values.
5598 health_sessiond
= health_app_create(NR_HEALTH_SESSIOND_TYPES
);
5599 if (!health_sessiond
) {
5600 PERROR("health_app_create error");
5602 goto exit_health_sessiond_cleanup
;
5605 /* Create thread to clean up RCU hash tables */
5606 if (init_ht_cleanup_thread(&ht_cleanup_thread
)) {
5608 goto exit_ht_cleanup
;
5611 /* Create thread quit pipe */
5612 if (init_thread_quit_pipe()) {
5614 goto exit_init_data
;
5617 /* Check if daemon is UID = 0 */
5618 is_root
= !getuid();
5621 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5624 goto exit_init_data
;
5627 /* Create global run dir with root access */
5628 if (create_lttng_rundir(rundir
)) {
5630 goto exit_init_data
;
5633 if (strlen(apps_unix_sock_path
) == 0) {
5634 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5635 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5638 goto exit_init_data
;
5642 if (strlen(client_unix_sock_path
) == 0) {
5643 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5644 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5647 goto exit_init_data
;
5651 /* Set global SHM for ust */
5652 if (strlen(wait_shm_path
) == 0) {
5653 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5654 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5657 goto exit_init_data
;
5661 if (strlen(health_unix_sock_path
) == 0) {
5662 ret
= snprintf(health_unix_sock_path
,
5663 sizeof(health_unix_sock_path
),
5664 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5667 goto exit_init_data
;
5671 /* Setup kernel consumerd path */
5672 ret
= snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5673 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5676 goto exit_init_data
;
5678 ret
= snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5679 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5682 goto exit_init_data
;
5685 DBG2("Kernel consumer err path: %s",
5686 kconsumer_data
.err_unix_sock_path
);
5687 DBG2("Kernel consumer cmd path: %s",
5688 kconsumer_data
.cmd_unix_sock_path
);
5690 home_path
= utils_get_home_dir();
5691 if (home_path
== NULL
) {
5692 /* TODO: Add --socket PATH option */
5693 ERR("Can't get HOME directory for sockets creation.");
5695 goto exit_init_data
;
5699 * Create rundir from home path. This will create something like
5702 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5705 goto exit_init_data
;
5708 if (create_lttng_rundir(rundir
)) {
5710 goto exit_init_data
;
5713 if (strlen(apps_unix_sock_path
) == 0) {
5714 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5715 DEFAULT_HOME_APPS_UNIX_SOCK
,
5719 goto exit_init_data
;
5723 /* Set the cli tool unix socket path */
5724 if (strlen(client_unix_sock_path
) == 0) {
5725 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5726 DEFAULT_HOME_CLIENT_UNIX_SOCK
,
5730 goto exit_init_data
;
5734 /* Set global SHM for ust */
5735 if (strlen(wait_shm_path
) == 0) {
5736 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5737 DEFAULT_HOME_APPS_WAIT_SHM_PATH
,
5741 goto exit_init_data
;
5745 /* Set health check Unix path */
5746 if (strlen(health_unix_sock_path
) == 0) {
5747 ret
= snprintf(health_unix_sock_path
,
5748 sizeof(health_unix_sock_path
),
5749 DEFAULT_HOME_HEALTH_UNIX_SOCK
,
5753 goto exit_init_data
;
5758 lockfile_fd
= create_lockfile();
5759 if (lockfile_fd
< 0) {
5761 goto exit_init_data
;
5764 /* Set consumer initial state */
5765 kernel_consumerd_state
= CONSUMER_STOPPED
;
5766 ust_consumerd_state
= CONSUMER_STOPPED
;
5768 DBG("Client socket path %s", client_unix_sock_path
);
5769 DBG("Application socket path %s", apps_unix_sock_path
);
5770 DBG("Application wait path %s", wait_shm_path
);
5771 DBG("LTTng run directory path: %s", rundir
);
5773 /* 32 bits consumerd path setup */
5774 ret
= snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
5775 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
5777 PERROR("snprintf 32-bit consumer error socket path");
5779 goto exit_init_data
;
5781 ret
= snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
5782 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
5784 PERROR("snprintf 32-bit consumer command socket path");
5786 goto exit_init_data
;
5789 DBG2("UST consumer 32 bits err path: %s",
5790 ustconsumer32_data
.err_unix_sock_path
);
5791 DBG2("UST consumer 32 bits cmd path: %s",
5792 ustconsumer32_data
.cmd_unix_sock_path
);
5794 /* 64 bits consumerd path setup */
5795 ret
= snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
5796 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
5798 PERROR("snprintf 64-bit consumer error socket path");
5800 goto exit_init_data
;
5802 ret
= snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
5803 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
5805 PERROR("snprintf 64-bit consumer command socket path");
5807 goto exit_init_data
;
5810 DBG2("UST consumer 64 bits err path: %s",
5811 ustconsumer64_data
.err_unix_sock_path
);
5812 DBG2("UST consumer 64 bits cmd path: %s",
5813 ustconsumer64_data
.cmd_unix_sock_path
);
5816 * See if daemon already exist.
5818 if (check_existing_daemon()) {
5819 ERR("Already running daemon.\n");
5821 * We do not goto exit because we must not cleanup()
5822 * because a daemon is already running.
5825 goto exit_init_data
;
5829 * Init UST app hash table. Alloc hash table before this point since
5830 * cleanup() can get called after that point.
5832 if (ust_app_ht_alloc()) {
5833 ERR("Failed to allocate UST app hash table");
5835 goto exit_init_data
;
5839 * Initialize agent app hash table. We allocate the hash table here
5840 * since cleanup() can get called after this point.
5842 if (agent_app_ht_alloc()) {
5843 ERR("Failed to allocate Agent app hash table");
5845 goto exit_init_data
;
5849 * These actions must be executed as root. We do that *after* setting up
5850 * the sockets path because we MUST make the check for another daemon using
5851 * those paths *before* trying to set the kernel consumer sockets and init
5855 if (set_consumer_sockets(&kconsumer_data
, rundir
)) {
5857 goto exit_init_data
;
5860 /* Setup kernel tracer */
5861 if (!opt_no_kernel
) {
5862 init_kernel_tracer();
5863 if (kernel_tracer_fd
>= 0) {
5864 ret
= syscall_init_table();
5866 ERR("Unable to populate syscall table. "
5867 "Syscall tracing won't work "
5868 "for this session daemon.");
5873 /* Set ulimit for open files */
5876 /* init lttng_fd tracking must be done after set_ulimit. */
5879 if (set_consumer_sockets(&ustconsumer64_data
, rundir
)) {
5881 goto exit_init_data
;
5884 if (set_consumer_sockets(&ustconsumer32_data
, rundir
)) {
5886 goto exit_init_data
;
5889 /* Setup the needed unix socket */
5890 if (init_daemon_socket()) {
5892 goto exit_init_data
;
5895 /* Set credentials to socket */
5896 if (is_root
&& set_permissions(rundir
)) {
5898 goto exit_init_data
;
5901 /* Get parent pid if -S, --sig-parent is specified. */
5902 if (opt_sig_parent
) {
5906 /* Setup the kernel pipe for waking up the kernel thread */
5907 if (is_root
&& !opt_no_kernel
) {
5908 if (utils_create_pipe_cloexec(kernel_poll_pipe
)) {
5910 goto exit_init_data
;
5914 /* Setup the thread apps communication pipe. */
5915 if (utils_create_pipe_cloexec(apps_cmd_pipe
)) {
5917 goto exit_init_data
;
5920 /* Setup the thread apps notify communication pipe. */
5921 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe
)) {
5923 goto exit_init_data
;
5926 /* Initialize global buffer per UID and PID registry. */
5927 buffer_reg_init_uid_registry();
5928 buffer_reg_init_pid_registry();
5930 /* Init UST command queue. */
5931 cds_wfcq_init(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
5934 * Get session list pointer. This pointer MUST NOT be free'd. This list
5935 * is statically declared in session.c
5937 session_list_ptr
= session_get_list();
5941 /* Check for the application socket timeout env variable. */
5942 env_app_timeout
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
5943 if (env_app_timeout
) {
5944 app_socket_timeout
= atoi(env_app_timeout
);
5946 app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
;
5949 ret
= write_pidfile();
5951 ERR("Error in write_pidfile");
5953 goto exit_init_data
;
5955 ret
= write_agent_port();
5957 ERR("Error in write_agent_port");
5959 goto exit_init_data
;
5962 /* Initialize communication library */
5964 /* Initialize TCP timeout values */
5965 lttcomm_inet_init();
5967 if (load_session_init_data(&load_info
) < 0) {
5969 goto exit_init_data
;
5971 load_info
->path
= opt_load_session_path
;
5973 /* Create health-check thread */
5974 ret
= pthread_create(&health_thread
, default_pthread_attr(),
5975 thread_manage_health
, (void *) NULL
);
5978 PERROR("pthread_create health");
5983 /* Create thread to manage the client socket */
5984 ret
= pthread_create(&client_thread
, default_pthread_attr(),
5985 thread_manage_clients
, (void *) NULL
);
5988 PERROR("pthread_create clients");
5993 /* Create thread to dispatch registration */
5994 ret
= pthread_create(&dispatch_thread
, default_pthread_attr(),
5995 thread_dispatch_ust_registration
, (void *) NULL
);
5998 PERROR("pthread_create dispatch");
6003 /* Create thread to manage application registration. */
6004 ret
= pthread_create(®_apps_thread
, default_pthread_attr(),
6005 thread_registration_apps
, (void *) NULL
);
6008 PERROR("pthread_create registration");
6013 /* Create thread to manage application socket */
6014 ret
= pthread_create(&apps_thread
, default_pthread_attr(),
6015 thread_manage_apps
, (void *) NULL
);
6018 PERROR("pthread_create apps");
6023 /* Create thread to manage application notify socket */
6024 ret
= pthread_create(&apps_notify_thread
, default_pthread_attr(),
6025 ust_thread_manage_notify
, (void *) NULL
);
6028 PERROR("pthread_create notify");
6030 goto exit_apps_notify
;
6033 /* Create agent registration thread. */
6034 ret
= pthread_create(&agent_reg_thread
, default_pthread_attr(),
6035 agent_thread_manage_registration
, (void *) NULL
);
6038 PERROR("pthread_create agent");
6040 goto exit_agent_reg
;
6043 /* Don't start this thread if kernel tracing is not requested nor root */
6044 if (is_root
&& !opt_no_kernel
) {
6045 /* Create kernel thread to manage kernel event */
6046 ret
= pthread_create(&kernel_thread
, default_pthread_attr(),
6047 thread_manage_kernel
, (void *) NULL
);
6050 PERROR("pthread_create kernel");
6056 /* Create session loading thread. */
6057 ret
= pthread_create(&load_session_thread
, default_pthread_attr(),
6058 thread_load_session
, load_info
);
6061 PERROR("pthread_create load_session_thread");
6063 goto exit_load_session
;
6067 * This is where we start awaiting program completion (e.g. through
6068 * signal that asks threads to teardown).
6071 ret
= pthread_join(load_session_thread
, &status
);
6074 PERROR("pthread_join load_session_thread");
6079 if (is_root
&& !opt_no_kernel
) {
6080 ret
= pthread_join(kernel_thread
, &status
);
6083 PERROR("pthread_join");
6089 ret
= pthread_join(agent_reg_thread
, &status
);
6092 PERROR("pthread_join agent");
6097 ret
= pthread_join(apps_notify_thread
, &status
);
6100 PERROR("pthread_join apps notify");
6105 ret
= pthread_join(apps_thread
, &status
);
6108 PERROR("pthread_join apps");
6113 ret
= pthread_join(reg_apps_thread
, &status
);
6116 PERROR("pthread_join");
6122 * Join dispatch thread after joining reg_apps_thread to ensure
6123 * we don't leak applications in the queue.
6125 ret
= pthread_join(dispatch_thread
, &status
);
6128 PERROR("pthread_join");
6133 ret
= pthread_join(client_thread
, &status
);
6136 PERROR("pthread_join");
6141 ret
= pthread_join(health_thread
, &status
);
6144 PERROR("pthread_join health thread");
6151 * sessiond_cleanup() is called when no other thread is running, except
6152 * the ht_cleanup thread, which is needed to destroy the hash tables.
6154 rcu_thread_online();
6156 rcu_thread_offline();
6157 rcu_unregister_thread();
6160 * Ensure all prior call_rcu are done. call_rcu callbacks may push
6161 * hash tables to the ht_cleanup thread. Therefore, we ensure that
6162 * the queue is empty before shutting down the clean-up thread.
6166 ret
= fini_ht_cleanup_thread(&ht_cleanup_thread
);
6172 health_app_destroy(health_sessiond
);
6173 exit_health_sessiond_cleanup
:
6174 exit_create_run_as_worker_cleanup
:
6177 sessiond_cleanup_options();
6179 exit_set_signal_handler
: