2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
33 #include <sys/mount.h>
34 #include <sys/resource.h>
35 #include <sys/socket.h>
37 #include <sys/types.h>
39 #include <urcu/uatomic.h>
43 #include <common/common.h>
44 #include <common/compat/socket.h>
45 #include <common/compat/getenv.h>
46 #include <common/defaults.h>
47 #include <common/kernel-consumer/kernel-consumer.h>
48 #include <common/futex.h>
49 #include <common/relayd/relayd.h>
50 #include <common/utils.h>
51 #include <common/daemonize.h>
52 #include <common/config/config.h>
54 #include "lttng-sessiond.h"
55 #include "buffer-registry.h"
62 #include "kernel-consumer.h"
66 #include "ust-consumer.h"
69 #include "health-sessiond.h"
70 #include "testpoint.h"
71 #include "ust-thread.h"
72 #include "agent-thread.h"
74 #include "load-session-thread.h"
77 #define CONSUMERD_FILE "lttng-consumerd"
80 static const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
81 static int tracing_group_name_override
;
82 static char *opt_pidfile
;
83 static int opt_sig_parent
;
84 static int opt_verbose_consumer
;
85 static int opt_daemon
, opt_background
;
86 static int opt_no_kernel
;
87 static char *opt_load_session_path
;
88 static pid_t ppid
; /* Parent PID for --sig-parent option */
89 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
91 static int lockfile_fd
= -1;
93 /* Set to 1 when a SIGUSR1 signal is received. */
94 static int recv_child_signal
;
97 * Consumer daemon specific control data. Every value not initialized here is
98 * set to 0 by the static definition.
100 static struct consumer_data kconsumer_data
= {
101 .type
= LTTNG_CONSUMER_KERNEL
,
102 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
103 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
106 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
107 .lock
= PTHREAD_MUTEX_INITIALIZER
,
108 .cond
= PTHREAD_COND_INITIALIZER
,
109 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
111 static struct consumer_data ustconsumer64_data
= {
112 .type
= LTTNG_CONSUMER64_UST
,
113 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
114 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
117 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
118 .lock
= PTHREAD_MUTEX_INITIALIZER
,
119 .cond
= PTHREAD_COND_INITIALIZER
,
120 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
122 static struct consumer_data ustconsumer32_data
= {
123 .type
= LTTNG_CONSUMER32_UST
,
124 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
125 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
128 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
129 .lock
= PTHREAD_MUTEX_INITIALIZER
,
130 .cond
= PTHREAD_COND_INITIALIZER
,
131 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
134 /* Command line options */
135 static const struct option long_options
[] = {
136 { "client-sock", required_argument
, 0, 'c' },
137 { "apps-sock", required_argument
, 0, 'a' },
138 { "kconsumerd-cmd-sock", required_argument
, 0, '\0' },
139 { "kconsumerd-err-sock", required_argument
, 0, '\0' },
140 { "ustconsumerd32-cmd-sock", required_argument
, 0, '\0' },
141 { "ustconsumerd32-err-sock", required_argument
, 0, '\0' },
142 { "ustconsumerd64-cmd-sock", required_argument
, 0, '\0' },
143 { "ustconsumerd64-err-sock", required_argument
, 0, '\0' },
144 { "consumerd32-path", required_argument
, 0, '\0' },
145 { "consumerd32-libdir", required_argument
, 0, '\0' },
146 { "consumerd64-path", required_argument
, 0, '\0' },
147 { "consumerd64-libdir", required_argument
, 0, '\0' },
148 { "daemonize", no_argument
, 0, 'd' },
149 { "background", no_argument
, 0, 'b' },
150 { "sig-parent", no_argument
, 0, 'S' },
151 { "help", no_argument
, 0, 'h' },
152 { "group", required_argument
, 0, 'g' },
153 { "version", no_argument
, 0, 'V' },
154 { "quiet", no_argument
, 0, 'q' },
155 { "verbose", no_argument
, 0, 'v' },
156 { "verbose-consumer", no_argument
, 0, '\0' },
157 { "no-kernel", no_argument
, 0, '\0' },
158 { "pidfile", required_argument
, 0, 'p' },
159 { "agent-tcp-port", required_argument
, 0, '\0' },
160 { "config", required_argument
, 0, 'f' },
161 { "load", required_argument
, 0, 'l' },
162 { "kmod-probes", required_argument
, 0, '\0' },
163 { "extra-kmod-probes", required_argument
, 0, '\0' },
167 /* Command line options to ignore from configuration file */
168 static const char *config_ignore_options
[] = { "help", "version", "config" };
170 /* Shared between threads */
171 static int dispatch_thread_exit
;
173 /* Global application Unix socket path */
174 static char apps_unix_sock_path
[PATH_MAX
];
175 /* Global client Unix socket path */
176 static char client_unix_sock_path
[PATH_MAX
];
177 /* global wait shm path for UST */
178 static char wait_shm_path
[PATH_MAX
];
179 /* Global health check unix path */
180 static char health_unix_sock_path
[PATH_MAX
];
182 /* Sockets and FDs */
183 static int client_sock
= -1;
184 static int apps_sock
= -1;
185 int kernel_tracer_fd
= -1;
186 static int kernel_poll_pipe
[2] = { -1, -1 };
189 * Quit pipe for all threads. This permits a single cancellation point
190 * for all threads when receiving an event on the pipe.
192 static int thread_quit_pipe
[2] = { -1, -1 };
193 static int ht_cleanup_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
;
309 * Whether sessiond is ready for commands/health check requests.
310 * NR_LTTNG_SESSIOND_READY must match the number of calls to
311 * sessiond_notify_ready().
313 #define NR_LTTNG_SESSIOND_READY 3
314 int lttng_sessiond_ready
= NR_LTTNG_SESSIOND_READY
;
316 /* Notify parents that we are ready for cmd and health check */
318 void sessiond_notify_ready(void)
320 if (uatomic_sub_return(<tng_sessiond_ready
, 1) == 0) {
322 * Notify parent pid that we are ready to accept command
323 * for client side. This ppid is the one from the
324 * external process that spawned us.
326 if (opt_sig_parent
) {
331 * Notify the parent of the fork() process that we are
334 if (opt_daemon
|| opt_background
) {
335 kill(child_ppid
, SIGUSR1
);
341 void setup_consumerd_path(void)
343 const char *bin
, *libdir
;
346 * Allow INSTALL_BIN_PATH to be used as a target path for the
347 * native architecture size consumer if CONFIG_CONSUMER*_PATH
348 * has not been defined.
350 #if (CAA_BITS_PER_LONG == 32)
351 if (!consumerd32_bin
[0]) {
352 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
354 if (!consumerd32_libdir
[0]) {
355 consumerd32_libdir
= INSTALL_LIB_PATH
;
357 #elif (CAA_BITS_PER_LONG == 64)
358 if (!consumerd64_bin
[0]) {
359 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
361 if (!consumerd64_libdir
[0]) {
362 consumerd64_libdir
= INSTALL_LIB_PATH
;
365 #error "Unknown bitness"
369 * runtime env. var. overrides the build default.
371 bin
= lttng_secure_getenv("LTTNG_CONSUMERD32_BIN");
373 consumerd32_bin
= bin
;
375 bin
= lttng_secure_getenv("LTTNG_CONSUMERD64_BIN");
377 consumerd64_bin
= bin
;
379 libdir
= lttng_secure_getenv("LTTNG_CONSUMERD32_LIBDIR");
381 consumerd32_libdir
= libdir
;
383 libdir
= lttng_secure_getenv("LTTNG_CONSUMERD64_LIBDIR");
385 consumerd64_libdir
= libdir
;
390 int __sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
,
397 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
403 ret
= lttng_poll_add(events
, a_pipe
[0], LPOLLIN
| LPOLLERR
);
415 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
417 int sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
)
419 return __sessiond_set_thread_pollset(events
, size
, thread_quit_pipe
);
423 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
425 int sessiond_set_ht_cleanup_thread_pollset(struct lttng_poll_event
*events
,
428 return __sessiond_set_thread_pollset(events
, size
,
429 ht_cleanup_quit_pipe
);
433 int __sessiond_check_thread_quit_pipe(int fd
, uint32_t events
, int a_pipe
)
435 if (fd
== a_pipe
&& (events
& LPOLLIN
)) {
442 * Check if the thread quit pipe was triggered.
444 * Return 1 if it was triggered else 0;
446 int sessiond_check_thread_quit_pipe(int fd
, uint32_t events
)
448 return __sessiond_check_thread_quit_pipe(fd
, events
,
449 thread_quit_pipe
[0]);
453 * Check if the ht_cleanup thread quit pipe was triggered.
455 * Return 1 if it was triggered else 0;
457 int sessiond_check_ht_cleanup_quit(int fd
, uint32_t events
)
459 return __sessiond_check_thread_quit_pipe(fd
, events
,
460 ht_cleanup_quit_pipe
[0]);
464 * Init thread quit pipe.
466 * Return -1 on error or 0 if all pipes are created.
468 static int __init_thread_quit_pipe(int *a_pipe
)
474 PERROR("thread quit pipe");
478 for (i
= 0; i
< 2; i
++) {
479 ret
= fcntl(a_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
490 static int init_thread_quit_pipe(void)
492 return __init_thread_quit_pipe(thread_quit_pipe
);
495 static int init_ht_cleanup_quit_pipe(void)
497 return __init_thread_quit_pipe(ht_cleanup_quit_pipe
);
501 * Stop all threads by closing the thread quit pipe.
503 static void stop_threads(void)
507 /* Stopping all threads */
508 DBG("Terminating all threads");
509 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
511 ERR("write error on thread quit pipe");
514 /* Dispatch thread */
515 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
516 futex_nto1_wake(&ust_cmd_queue
.futex
);
520 * Close every consumer sockets.
522 static void close_consumer_sockets(void)
526 if (kconsumer_data
.err_sock
>= 0) {
527 ret
= close(kconsumer_data
.err_sock
);
529 PERROR("kernel consumer err_sock close");
532 if (ustconsumer32_data
.err_sock
>= 0) {
533 ret
= close(ustconsumer32_data
.err_sock
);
535 PERROR("UST consumerd32 err_sock close");
538 if (ustconsumer64_data
.err_sock
>= 0) {
539 ret
= close(ustconsumer64_data
.err_sock
);
541 PERROR("UST consumerd64 err_sock close");
544 if (kconsumer_data
.cmd_sock
>= 0) {
545 ret
= close(kconsumer_data
.cmd_sock
);
547 PERROR("kernel consumer cmd_sock close");
550 if (ustconsumer32_data
.cmd_sock
>= 0) {
551 ret
= close(ustconsumer32_data
.cmd_sock
);
553 PERROR("UST consumerd32 cmd_sock close");
556 if (ustconsumer64_data
.cmd_sock
>= 0) {
557 ret
= close(ustconsumer64_data
.cmd_sock
);
559 PERROR("UST consumerd64 cmd_sock close");
565 * Generate the full lock file path using the rundir.
567 * Return the snprintf() return value thus a negative value is an error.
569 static int generate_lock_file_path(char *path
, size_t len
)
576 /* Build lockfile path from rundir. */
577 ret
= snprintf(path
, len
, "%s/" DEFAULT_LTTNG_SESSIOND_LOCKFILE
, rundir
);
579 PERROR("snprintf lockfile path");
586 * Wait on consumer process termination.
588 * Need to be called with the consumer data lock held or from a context
589 * ensuring no concurrent access to data (e.g: cleanup).
591 static void wait_consumer(struct consumer_data
*consumer_data
)
596 if (consumer_data
->pid
<= 0) {
600 DBG("Waiting for complete teardown of consumerd (PID: %d)",
602 ret
= waitpid(consumer_data
->pid
, &status
, 0);
604 PERROR("consumerd waitpid pid: %d", consumer_data
->pid
)
606 if (!WIFEXITED(status
)) {
607 ERR("consumerd termination with error: %d",
610 consumer_data
->pid
= 0;
614 * Cleanup the session daemon's data structures.
616 static void sessiond_cleanup(void)
619 struct ltt_session
*sess
, *stmp
;
622 DBG("Cleanup sessiond");
625 * Close the thread quit pipe. It has already done its job,
626 * since we are now called.
628 utils_close_pipe(thread_quit_pipe
);
631 * If opt_pidfile is undefined, the default file will be wiped when
632 * removing the rundir.
635 ret
= remove(opt_pidfile
);
637 PERROR("remove pidfile %s", opt_pidfile
);
641 DBG("Removing sessiond and consumerd content of directory %s", rundir
);
644 snprintf(path
, PATH_MAX
,
646 rundir
, DEFAULT_LTTNG_SESSIOND_PIDFILE
);
647 DBG("Removing %s", path
);
650 snprintf(path
, PATH_MAX
, "%s/%s", rundir
,
651 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
652 DBG("Removing %s", path
);
656 snprintf(path
, PATH_MAX
,
657 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
659 DBG("Removing %s", path
);
662 snprintf(path
, PATH_MAX
,
663 DEFAULT_KCONSUMERD_PATH
,
665 DBG("Removing directory %s", path
);
668 /* ust consumerd 32 */
669 snprintf(path
, PATH_MAX
,
670 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
672 DBG("Removing %s", path
);
675 snprintf(path
, PATH_MAX
,
676 DEFAULT_USTCONSUMERD32_PATH
,
678 DBG("Removing directory %s", path
);
681 /* ust consumerd 64 */
682 snprintf(path
, PATH_MAX
,
683 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
685 DBG("Removing %s", path
);
688 snprintf(path
, PATH_MAX
,
689 DEFAULT_USTCONSUMERD64_PATH
,
691 DBG("Removing directory %s", path
);
694 DBG("Cleaning up all sessions");
696 /* Destroy session list mutex */
697 if (session_list_ptr
!= NULL
) {
698 pthread_mutex_destroy(&session_list_ptr
->lock
);
700 /* Cleanup ALL session */
701 cds_list_for_each_entry_safe(sess
, stmp
,
702 &session_list_ptr
->head
, list
) {
703 cmd_destroy_session(sess
, kernel_poll_pipe
[1]);
707 wait_consumer(&kconsumer_data
);
708 wait_consumer(&ustconsumer64_data
);
709 wait_consumer(&ustconsumer32_data
);
711 DBG("Cleaning up all agent apps");
712 agent_app_ht_clean();
714 DBG("Closing all UST sockets");
715 ust_app_clean_list();
716 buffer_reg_destroy_registries();
718 if (is_root
&& !opt_no_kernel
) {
719 DBG2("Closing kernel fd");
720 if (kernel_tracer_fd
>= 0) {
721 ret
= close(kernel_tracer_fd
);
726 DBG("Unloading kernel modules");
727 modprobe_remove_lttng_all();
731 close_consumer_sockets();
734 load_session_destroy_data(load_info
);
739 * Cleanup lock file by deleting it and finaly closing it which will
740 * release the file system lock.
742 if (lockfile_fd
>= 0) {
743 char lockfile_path
[PATH_MAX
];
745 ret
= generate_lock_file_path(lockfile_path
,
746 sizeof(lockfile_path
));
748 ret
= remove(lockfile_path
);
750 PERROR("remove lock file");
752 ret
= close(lockfile_fd
);
754 PERROR("close lock file");
760 * We do NOT rmdir rundir because there are other processes
761 * using it, for instance lttng-relayd, which can start in
762 * parallel with this teardown.
769 * Cleanup the daemon's option data structures.
771 static void sessiond_cleanup_options(void)
773 DBG("Cleaning up options");
776 * If the override option is set, the pointer points to a *non* const
777 * thus freeing it even though the variable type is set to const.
779 if (tracing_group_name_override
) {
780 free((void *) tracing_group_name
);
782 if (consumerd32_bin_override
) {
783 free((void *) consumerd32_bin
);
785 if (consumerd64_bin_override
) {
786 free((void *) consumerd64_bin
);
788 if (consumerd32_libdir_override
) {
789 free((void *) consumerd32_libdir
);
791 if (consumerd64_libdir_override
) {
792 free((void *) consumerd64_libdir
);
796 free(opt_load_session_path
);
797 free(kmod_probes_list
);
798 free(kmod_extra_probes_list
);
800 run_as_destroy_worker();
803 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
804 "Matthew, BEET driven development works!%c[%dm",
805 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
810 * Send data on a unix socket using the liblttsessiondcomm API.
812 * Return lttcomm error code.
814 static int send_unix_sock(int sock
, void *buf
, size_t len
)
816 /* Check valid length */
821 return lttcomm_send_unix_sock(sock
, buf
, len
);
825 * Free memory of a command context structure.
827 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
829 DBG("Clean command context structure");
831 if ((*cmd_ctx
)->llm
) {
832 free((*cmd_ctx
)->llm
);
834 if ((*cmd_ctx
)->lsm
) {
835 free((*cmd_ctx
)->lsm
);
843 * Notify UST applications using the shm mmap futex.
845 static int notify_ust_apps(int active
)
849 DBG("Notifying applications of session daemon state: %d", active
);
851 /* See shm.c for this call implying mmap, shm and futex calls */
852 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
853 if (wait_shm_mmap
== NULL
) {
857 /* Wake waiting process */
858 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
860 /* Apps notified successfully */
868 * Setup the outgoing data buffer for the response (llm) by allocating the
869 * right amount of memory and copying the original information from the lsm
872 * Return total size of the buffer pointed by buf.
874 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
880 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
881 if (cmd_ctx
->llm
== NULL
) {
887 /* Copy common data */
888 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
889 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
891 cmd_ctx
->llm
->data_size
= size
;
892 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
901 * Update the kernel poll set of all channel fd available over all tracing
902 * session. Add the wakeup pipe at the end of the set.
904 static int update_kernel_poll(struct lttng_poll_event
*events
)
907 struct ltt_session
*session
;
908 struct ltt_kernel_channel
*channel
;
910 DBG("Updating kernel poll set");
913 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
914 session_lock(session
);
915 if (session
->kernel_session
== NULL
) {
916 session_unlock(session
);
920 cds_list_for_each_entry(channel
,
921 &session
->kernel_session
->channel_list
.head
, list
) {
922 /* Add channel fd to the kernel poll set */
923 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
925 session_unlock(session
);
928 DBG("Channel fd %d added to kernel set", channel
->fd
);
930 session_unlock(session
);
932 session_unlock_list();
937 session_unlock_list();
942 * Find the channel fd from 'fd' over all tracing session. When found, check
943 * for new channel stream and send those stream fds to the kernel consumer.
945 * Useful for CPU hotplug feature.
947 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
950 struct ltt_session
*session
;
951 struct ltt_kernel_session
*ksess
;
952 struct ltt_kernel_channel
*channel
;
954 DBG("Updating kernel streams for channel fd %d", fd
);
957 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
958 session_lock(session
);
959 if (session
->kernel_session
== NULL
) {
960 session_unlock(session
);
963 ksess
= session
->kernel_session
;
965 cds_list_for_each_entry(channel
,
966 &ksess
->channel_list
.head
, list
) {
967 struct lttng_ht_iter iter
;
968 struct consumer_socket
*socket
;
970 if (channel
->fd
!= fd
) {
973 DBG("Channel found, updating kernel streams");
974 ret
= kernel_open_channel_stream(channel
);
978 /* Update the stream global counter */
979 ksess
->stream_count_global
+= ret
;
982 * Have we already sent fds to the consumer? If yes, it
983 * means that tracing is started so it is safe to send
984 * our updated stream fds.
986 if (ksess
->consumer_fds_sent
!= 1
987 || ksess
->consumer
== NULL
) {
993 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
994 &iter
.iter
, socket
, node
.node
) {
995 pthread_mutex_lock(socket
->lock
);
996 ret
= kernel_consumer_send_channel_stream(socket
,
998 session
->output_traces
? 1 : 0);
999 pthread_mutex_unlock(socket
->lock
);
1007 session_unlock(session
);
1009 session_unlock_list();
1013 session_unlock(session
);
1014 session_unlock_list();
1019 * For each tracing session, update newly registered apps. The session list
1020 * lock MUST be acquired before calling this.
1022 static void update_ust_app(int app_sock
)
1024 struct ltt_session
*sess
, *stmp
;
1026 /* Consumer is in an ERROR state. Stop any application update. */
1027 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
1028 /* Stop the update process since the consumer is dead. */
1032 /* For all tracing session(s) */
1033 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
1034 struct ust_app
*app
;
1037 if (!sess
->ust_session
) {
1038 goto unlock_session
;
1042 assert(app_sock
>= 0);
1043 app
= ust_app_find_by_sock(app_sock
);
1046 * Application can be unregistered before so
1047 * this is possible hence simply stopping the
1050 DBG3("UST app update failed to find app sock %d",
1054 ust_app_global_update(sess
->ust_session
, app
);
1058 session_unlock(sess
);
1063 * This thread manage event coming from the kernel.
1065 * Features supported in this thread:
1068 static void *thread_manage_kernel(void *data
)
1070 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
1071 uint32_t revents
, nb_fd
;
1073 struct lttng_poll_event events
;
1075 DBG("[thread] Thread manage kernel started");
1077 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_KERNEL
);
1080 * This first step of the while is to clean this structure which could free
1081 * non NULL pointers so initialize it before the loop.
1083 lttng_poll_init(&events
);
1085 if (testpoint(sessiond_thread_manage_kernel
)) {
1086 goto error_testpoint
;
1089 health_code_update();
1091 if (testpoint(sessiond_thread_manage_kernel_before_loop
)) {
1092 goto error_testpoint
;
1096 health_code_update();
1098 if (update_poll_flag
== 1) {
1099 /* Clean events object. We are about to populate it again. */
1100 lttng_poll_clean(&events
);
1102 ret
= sessiond_set_thread_pollset(&events
, 2);
1104 goto error_poll_create
;
1107 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
1112 /* This will add the available kernel channel if any. */
1113 ret
= update_kernel_poll(&events
);
1117 update_poll_flag
= 0;
1120 DBG("Thread kernel polling");
1122 /* Poll infinite value of time */
1124 health_poll_entry();
1125 ret
= lttng_poll_wait(&events
, -1);
1126 DBG("Thread kernel return from poll on %d fds",
1127 LTTNG_POLL_GETNB(&events
));
1131 * Restart interrupted system call.
1133 if (errno
== EINTR
) {
1137 } else if (ret
== 0) {
1138 /* Should not happen since timeout is infinite */
1139 ERR("Return value of poll is 0 with an infinite timeout.\n"
1140 "This should not have happened! Continuing...");
1146 for (i
= 0; i
< nb_fd
; i
++) {
1147 /* Fetch once the poll data */
1148 revents
= LTTNG_POLL_GETEV(&events
, i
);
1149 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1151 health_code_update();
1154 /* No activity for this FD (poll implementation). */
1158 /* Thread quit pipe has been closed. Killing thread. */
1159 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1165 /* Check for data on kernel pipe */
1166 if (revents
& LPOLLIN
) {
1167 if (pollfd
== kernel_poll_pipe
[0]) {
1168 (void) lttng_read(kernel_poll_pipe
[0],
1171 * Ret value is useless here, if this pipe gets any actions an
1172 * update is required anyway.
1174 update_poll_flag
= 1;
1178 * New CPU detected by the kernel. Adding kernel stream to
1179 * kernel session and updating the kernel consumer
1181 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
1187 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1188 update_poll_flag
= 1;
1191 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1199 lttng_poll_clean(&events
);
1202 utils_close_pipe(kernel_poll_pipe
);
1203 kernel_poll_pipe
[0] = kernel_poll_pipe
[1] = -1;
1206 ERR("Health error occurred in %s", __func__
);
1207 WARN("Kernel thread died unexpectedly. "
1208 "Kernel tracing can continue but CPU hotplug is disabled.");
1210 health_unregister(health_sessiond
);
1211 DBG("Kernel thread dying");
1216 * Signal pthread condition of the consumer data that the thread.
1218 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
1220 pthread_mutex_lock(&data
->cond_mutex
);
1223 * The state is set before signaling. It can be any value, it's the waiter
1224 * job to correctly interpret this condition variable associated to the
1225 * consumer pthread_cond.
1227 * A value of 0 means that the corresponding thread of the consumer data
1228 * was not started. 1 indicates that the thread has started and is ready
1229 * for action. A negative value means that there was an error during the
1232 data
->consumer_thread_is_ready
= state
;
1233 (void) pthread_cond_signal(&data
->cond
);
1235 pthread_mutex_unlock(&data
->cond_mutex
);
1239 * This thread manage the consumer error sent back to the session daemon.
1241 static void *thread_manage_consumer(void *data
)
1243 int sock
= -1, i
, ret
, pollfd
, err
= -1, should_quit
= 0;
1244 uint32_t revents
, nb_fd
;
1245 enum lttcomm_return_code code
;
1246 struct lttng_poll_event events
;
1247 struct consumer_data
*consumer_data
= data
;
1249 DBG("[thread] Manage consumer started");
1251 rcu_register_thread();
1252 rcu_thread_online();
1254 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CONSUMER
);
1256 health_code_update();
1259 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1260 * metadata_sock. Nothing more will be added to this poll set.
1262 ret
= sessiond_set_thread_pollset(&events
, 3);
1268 * The error socket here is already in a listening state which was done
1269 * just before spawning this thread to avoid a race between the consumer
1270 * daemon exec trying to connect and the listen() call.
1272 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
1277 health_code_update();
1279 /* Infinite blocking call, waiting for transmission */
1281 health_poll_entry();
1283 if (testpoint(sessiond_thread_manage_consumer
)) {
1287 ret
= lttng_poll_wait(&events
, -1);
1291 * Restart interrupted system call.
1293 if (errno
== EINTR
) {
1301 for (i
= 0; i
< nb_fd
; i
++) {
1302 /* Fetch once the poll data */
1303 revents
= LTTNG_POLL_GETEV(&events
, i
);
1304 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1306 health_code_update();
1309 /* No activity for this FD (poll implementation). */
1313 /* Thread quit pipe has been closed. Killing thread. */
1314 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1320 /* Event on the registration socket */
1321 if (pollfd
== consumer_data
->err_sock
) {
1322 if (revents
& LPOLLIN
) {
1324 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1325 ERR("consumer err socket poll error");
1328 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1334 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1340 * Set the CLOEXEC flag. Return code is useless because either way, the
1343 (void) utils_set_fd_cloexec(sock
);
1345 health_code_update();
1347 DBG2("Receiving code from consumer err_sock");
1349 /* Getting status code from kconsumerd */
1350 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1351 sizeof(enum lttcomm_return_code
));
1356 health_code_update();
1357 if (code
== LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
1358 /* Connect both socket, command and metadata. */
1359 consumer_data
->cmd_sock
=
1360 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1361 consumer_data
->metadata_fd
=
1362 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1363 if (consumer_data
->cmd_sock
< 0
1364 || consumer_data
->metadata_fd
< 0) {
1365 PERROR("consumer connect cmd socket");
1366 /* On error, signal condition and quit. */
1367 signal_consumer_condition(consumer_data
, -1);
1370 consumer_data
->metadata_sock
.fd_ptr
= &consumer_data
->metadata_fd
;
1371 /* Create metadata socket lock. */
1372 consumer_data
->metadata_sock
.lock
= zmalloc(sizeof(pthread_mutex_t
));
1373 if (consumer_data
->metadata_sock
.lock
== NULL
) {
1374 PERROR("zmalloc pthread mutex");
1378 pthread_mutex_init(consumer_data
->metadata_sock
.lock
, NULL
);
1380 signal_consumer_condition(consumer_data
, 1);
1381 DBG("Consumer command socket ready (fd: %d", consumer_data
->cmd_sock
);
1382 DBG("Consumer metadata socket ready (fd: %d)",
1383 consumer_data
->metadata_fd
);
1385 ERR("consumer error when waiting for SOCK_READY : %s",
1386 lttcomm_get_readable_code(-code
));
1390 /* Remove the consumerd error sock since we've established a connexion */
1391 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1396 /* Add new accepted error socket. */
1397 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1402 /* Add metadata socket that is successfully connected. */
1403 ret
= lttng_poll_add(&events
, consumer_data
->metadata_fd
,
1404 LPOLLIN
| LPOLLRDHUP
);
1409 health_code_update();
1411 /* Infinite blocking call, waiting for transmission */
1414 health_code_update();
1416 /* Exit the thread because the thread quit pipe has been triggered. */
1418 /* Not a health error. */
1423 health_poll_entry();
1424 ret
= lttng_poll_wait(&events
, -1);
1428 * Restart interrupted system call.
1430 if (errno
== EINTR
) {
1438 for (i
= 0; i
< nb_fd
; i
++) {
1439 /* Fetch once the poll data */
1440 revents
= LTTNG_POLL_GETEV(&events
, i
);
1441 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1443 health_code_update();
1446 /* No activity for this FD (poll implementation). */
1451 * Thread quit pipe has been triggered, flag that we should stop
1452 * but continue the current loop to handle potential data from
1455 should_quit
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1457 if (pollfd
== sock
) {
1458 /* Event on the consumerd socket */
1459 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1460 && !(revents
& LPOLLIN
)) {
1461 ERR("consumer err socket second poll error");
1464 health_code_update();
1465 /* Wait for any kconsumerd error */
1466 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1467 sizeof(enum lttcomm_return_code
));
1469 ERR("consumer closed the command socket");
1473 ERR("consumer return code : %s",
1474 lttcomm_get_readable_code(-code
));
1477 } else if (pollfd
== consumer_data
->metadata_fd
) {
1478 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1479 && !(revents
& LPOLLIN
)) {
1480 ERR("consumer err metadata socket second poll error");
1483 /* UST metadata requests */
1484 ret
= ust_consumer_metadata_request(
1485 &consumer_data
->metadata_sock
);
1487 ERR("Handling metadata request");
1491 /* No need for an else branch all FDs are tested prior. */
1493 health_code_update();
1499 * We lock here because we are about to close the sockets and some other
1500 * thread might be using them so get exclusive access which will abort all
1501 * other consumer command by other threads.
1503 pthread_mutex_lock(&consumer_data
->lock
);
1505 /* Immediately set the consumerd state to stopped */
1506 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1507 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1508 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1509 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1510 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1512 /* Code flow error... */
1516 if (consumer_data
->err_sock
>= 0) {
1517 ret
= close(consumer_data
->err_sock
);
1521 consumer_data
->err_sock
= -1;
1523 if (consumer_data
->cmd_sock
>= 0) {
1524 ret
= close(consumer_data
->cmd_sock
);
1528 consumer_data
->cmd_sock
= -1;
1530 if (consumer_data
->metadata_sock
.fd_ptr
&&
1531 *consumer_data
->metadata_sock
.fd_ptr
>= 0) {
1532 ret
= close(*consumer_data
->metadata_sock
.fd_ptr
);
1544 unlink(consumer_data
->err_unix_sock_path
);
1545 unlink(consumer_data
->cmd_unix_sock_path
);
1546 pthread_mutex_unlock(&consumer_data
->lock
);
1548 /* Cleanup metadata socket mutex. */
1549 if (consumer_data
->metadata_sock
.lock
) {
1550 pthread_mutex_destroy(consumer_data
->metadata_sock
.lock
);
1551 free(consumer_data
->metadata_sock
.lock
);
1553 lttng_poll_clean(&events
);
1557 ERR("Health error occurred in %s", __func__
);
1559 health_unregister(health_sessiond
);
1560 DBG("consumer thread cleanup completed");
1562 rcu_thread_offline();
1563 rcu_unregister_thread();
1569 * This thread manage application communication.
1571 static void *thread_manage_apps(void *data
)
1573 int i
, ret
, pollfd
, err
= -1;
1575 uint32_t revents
, nb_fd
;
1576 struct lttng_poll_event events
;
1578 DBG("[thread] Manage application started");
1580 rcu_register_thread();
1581 rcu_thread_online();
1583 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_MANAGE
);
1585 if (testpoint(sessiond_thread_manage_apps
)) {
1586 goto error_testpoint
;
1589 health_code_update();
1591 ret
= sessiond_set_thread_pollset(&events
, 2);
1593 goto error_poll_create
;
1596 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1601 if (testpoint(sessiond_thread_manage_apps_before_loop
)) {
1605 health_code_update();
1608 DBG("Apps thread polling");
1610 /* Inifinite blocking call, waiting for transmission */
1612 health_poll_entry();
1613 ret
= lttng_poll_wait(&events
, -1);
1614 DBG("Apps thread return from poll on %d fds",
1615 LTTNG_POLL_GETNB(&events
));
1619 * Restart interrupted system call.
1621 if (errno
== EINTR
) {
1629 for (i
= 0; i
< nb_fd
; i
++) {
1630 /* Fetch once the poll data */
1631 revents
= LTTNG_POLL_GETEV(&events
, i
);
1632 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1634 health_code_update();
1637 /* No activity for this FD (poll implementation). */
1641 /* Thread quit pipe has been closed. Killing thread. */
1642 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1648 /* Inspect the apps cmd pipe */
1649 if (pollfd
== apps_cmd_pipe
[0]) {
1650 if (revents
& LPOLLIN
) {
1654 size_ret
= lttng_read(apps_cmd_pipe
[0], &sock
, sizeof(sock
));
1655 if (size_ret
< sizeof(sock
)) {
1656 PERROR("read apps cmd pipe");
1660 health_code_update();
1663 * Since this is a command socket (write then read),
1664 * we only monitor the error events of the socket.
1666 ret
= lttng_poll_add(&events
, sock
,
1667 LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
1672 DBG("Apps with sock %d added to poll set", sock
);
1673 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1674 ERR("Apps command pipe error");
1677 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
1682 * At this point, we know that a registered application made
1683 * the event at poll_wait.
1685 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1686 /* Removing from the poll set */
1687 ret
= lttng_poll_del(&events
, pollfd
);
1692 /* Socket closed on remote end. */
1693 ust_app_unregister(pollfd
);
1695 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1700 health_code_update();
1706 lttng_poll_clean(&events
);
1709 utils_close_pipe(apps_cmd_pipe
);
1710 apps_cmd_pipe
[0] = apps_cmd_pipe
[1] = -1;
1713 * We don't clean the UST app hash table here since already registered
1714 * applications can still be controlled so let them be until the session
1715 * daemon dies or the applications stop.
1720 ERR("Health error occurred in %s", __func__
);
1722 health_unregister(health_sessiond
);
1723 DBG("Application communication apps thread cleanup complete");
1724 rcu_thread_offline();
1725 rcu_unregister_thread();
1730 * Send a socket to a thread This is called from the dispatch UST registration
1731 * thread once all sockets are set for the application.
1733 * The sock value can be invalid, we don't really care, the thread will handle
1734 * it and make the necessary cleanup if so.
1736 * On success, return 0 else a negative value being the errno message of the
1739 static int send_socket_to_thread(int fd
, int sock
)
1744 * It's possible that the FD is set as invalid with -1 concurrently just
1745 * before calling this function being a shutdown state of the thread.
1752 ret
= lttng_write(fd
, &sock
, sizeof(sock
));
1753 if (ret
< sizeof(sock
)) {
1754 PERROR("write apps pipe %d", fd
);
1761 /* All good. Don't send back the write positive ret value. */
1768 * Sanitize the wait queue of the dispatch registration thread meaning removing
1769 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1770 * notify socket is never received.
1772 static void sanitize_wait_queue(struct ust_reg_wait_queue
*wait_queue
)
1774 int ret
, nb_fd
= 0, i
;
1775 unsigned int fd_added
= 0;
1776 struct lttng_poll_event events
;
1777 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1781 lttng_poll_init(&events
);
1783 /* Just skip everything for an empty queue. */
1784 if (!wait_queue
->count
) {
1788 ret
= lttng_poll_create(&events
, wait_queue
->count
, LTTNG_CLOEXEC
);
1793 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1794 &wait_queue
->head
, head
) {
1795 assert(wait_node
->app
);
1796 ret
= lttng_poll_add(&events
, wait_node
->app
->sock
,
1797 LPOLLHUP
| LPOLLERR
);
1810 * Poll but don't block so we can quickly identify the faulty events and
1811 * clean them afterwards from the wait queue.
1813 ret
= lttng_poll_wait(&events
, 0);
1819 for (i
= 0; i
< nb_fd
; i
++) {
1820 /* Get faulty FD. */
1821 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1822 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1825 /* No activity for this FD (poll implementation). */
1829 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1830 &wait_queue
->head
, head
) {
1831 if (pollfd
== wait_node
->app
->sock
&&
1832 (revents
& (LPOLLHUP
| LPOLLERR
))) {
1833 cds_list_del(&wait_node
->head
);
1834 wait_queue
->count
--;
1835 ust_app_destroy(wait_node
->app
);
1839 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1846 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd
);
1850 lttng_poll_clean(&events
);
1854 lttng_poll_clean(&events
);
1856 ERR("Unable to sanitize wait queue");
1861 * Dispatch request from the registration threads to the application
1862 * communication thread.
1864 static void *thread_dispatch_ust_registration(void *data
)
1867 struct cds_wfcq_node
*node
;
1868 struct ust_command
*ust_cmd
= NULL
;
1869 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1870 struct ust_reg_wait_queue wait_queue
= {
1874 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH
);
1876 if (testpoint(sessiond_thread_app_reg_dispatch
)) {
1877 goto error_testpoint
;
1880 health_code_update();
1882 CDS_INIT_LIST_HEAD(&wait_queue
.head
);
1884 DBG("[thread] Dispatch UST command started");
1886 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1887 health_code_update();
1889 /* Atomically prepare the queue futex */
1890 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1893 struct ust_app
*app
= NULL
;
1897 * Make sure we don't have node(s) that have hung up before receiving
1898 * the notify socket. This is to clean the list in order to avoid
1899 * memory leaks from notify socket that are never seen.
1901 sanitize_wait_queue(&wait_queue
);
1903 health_code_update();
1904 /* Dequeue command for registration */
1905 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1907 DBG("Woken up but nothing in the UST command queue");
1908 /* Continue thread execution */
1912 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1914 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1915 " gid:%d sock:%d name:%s (version %d.%d)",
1916 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1917 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1918 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1919 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1921 if (ust_cmd
->reg_msg
.type
== USTCTL_SOCKET_CMD
) {
1922 wait_node
= zmalloc(sizeof(*wait_node
));
1924 PERROR("zmalloc wait_node dispatch");
1925 ret
= close(ust_cmd
->sock
);
1927 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1929 lttng_fd_put(LTTNG_FD_APPS
, 1);
1933 CDS_INIT_LIST_HEAD(&wait_node
->head
);
1935 /* Create application object if socket is CMD. */
1936 wait_node
->app
= ust_app_create(&ust_cmd
->reg_msg
,
1938 if (!wait_node
->app
) {
1939 ret
= close(ust_cmd
->sock
);
1941 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1943 lttng_fd_put(LTTNG_FD_APPS
, 1);
1949 * Add application to the wait queue so we can set the notify
1950 * socket before putting this object in the global ht.
1952 cds_list_add(&wait_node
->head
, &wait_queue
.head
);
1957 * We have to continue here since we don't have the notify
1958 * socket and the application MUST be added to the hash table
1959 * only at that moment.
1964 * Look for the application in the local wait queue and set the
1965 * notify socket if found.
1967 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1968 &wait_queue
.head
, head
) {
1969 health_code_update();
1970 if (wait_node
->app
->pid
== ust_cmd
->reg_msg
.pid
) {
1971 wait_node
->app
->notify_sock
= ust_cmd
->sock
;
1972 cds_list_del(&wait_node
->head
);
1974 app
= wait_node
->app
;
1976 DBG3("UST app notify socket %d is set", ust_cmd
->sock
);
1982 * With no application at this stage the received socket is
1983 * basically useless so close it before we free the cmd data
1984 * structure for good.
1987 ret
= close(ust_cmd
->sock
);
1989 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1991 lttng_fd_put(LTTNG_FD_APPS
, 1);
1998 * @session_lock_list
2000 * Lock the global session list so from the register up to the
2001 * registration done message, no thread can see the application
2002 * and change its state.
2004 session_lock_list();
2008 * Add application to the global hash table. This needs to be
2009 * done before the update to the UST registry can locate the
2014 /* Set app version. This call will print an error if needed. */
2015 (void) ust_app_version(app
);
2017 /* Send notify socket through the notify pipe. */
2018 ret
= send_socket_to_thread(apps_cmd_notify_pipe
[1],
2022 session_unlock_list();
2024 * No notify thread, stop the UST tracing. However, this is
2025 * not an internal error of the this thread thus setting
2026 * the health error code to a normal exit.
2033 * Update newly registered application with the tracing
2034 * registry info already enabled information.
2036 update_ust_app(app
->sock
);
2039 * Don't care about return value. Let the manage apps threads
2040 * handle app unregistration upon socket close.
2042 (void) ust_app_register_done(app
);
2045 * Even if the application socket has been closed, send the app
2046 * to the thread and unregistration will take place at that
2049 ret
= send_socket_to_thread(apps_cmd_pipe
[1], app
->sock
);
2052 session_unlock_list();
2054 * No apps. thread, stop the UST tracing. However, this is
2055 * not an internal error of the this thread thus setting
2056 * the health error code to a normal exit.
2063 session_unlock_list();
2065 } while (node
!= NULL
);
2067 health_poll_entry();
2068 /* Futex wait on queue. Blocking call on futex() */
2069 futex_nto1_wait(&ust_cmd_queue
.futex
);
2072 /* Normal exit, no error */
2076 /* Clean up wait queue. */
2077 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
2078 &wait_queue
.head
, head
) {
2079 cds_list_del(&wait_node
->head
);
2084 /* Empty command queue. */
2086 /* Dequeue command for registration */
2087 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
2091 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
2092 ret
= close(ust_cmd
->sock
);
2094 PERROR("close ust sock exit dispatch %d", ust_cmd
->sock
);
2096 lttng_fd_put(LTTNG_FD_APPS
, 1);
2101 DBG("Dispatch thread dying");
2104 ERR("Health error occurred in %s", __func__
);
2106 health_unregister(health_sessiond
);
2111 * This thread manage application registration.
2113 static void *thread_registration_apps(void *data
)
2115 int sock
= -1, i
, ret
, pollfd
, err
= -1;
2116 uint32_t revents
, nb_fd
;
2117 struct lttng_poll_event events
;
2119 * Get allocated in this thread, enqueued to a global queue, dequeued and
2120 * freed in the manage apps thread.
2122 struct ust_command
*ust_cmd
= NULL
;
2124 DBG("[thread] Manage application registration started");
2126 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG
);
2128 if (testpoint(sessiond_thread_registration_apps
)) {
2129 goto error_testpoint
;
2132 ret
= lttcomm_listen_unix_sock(apps_sock
);
2138 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
2139 * more will be added to this poll set.
2141 ret
= sessiond_set_thread_pollset(&events
, 2);
2143 goto error_create_poll
;
2146 /* Add the application registration socket */
2147 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
2149 goto error_poll_add
;
2152 /* Notify all applications to register */
2153 ret
= notify_ust_apps(1);
2155 ERR("Failed to notify applications or create the wait shared memory.\n"
2156 "Execution continues but there might be problem for already\n"
2157 "running applications that wishes to register.");
2161 DBG("Accepting application registration");
2163 /* Inifinite blocking call, waiting for transmission */
2165 health_poll_entry();
2166 ret
= lttng_poll_wait(&events
, -1);
2170 * Restart interrupted system call.
2172 if (errno
== EINTR
) {
2180 for (i
= 0; i
< nb_fd
; i
++) {
2181 health_code_update();
2183 /* Fetch once the poll data */
2184 revents
= LTTNG_POLL_GETEV(&events
, i
);
2185 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2188 /* No activity for this FD (poll implementation). */
2192 /* Thread quit pipe has been closed. Killing thread. */
2193 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
2199 /* Event on the registration socket */
2200 if (pollfd
== apps_sock
) {
2201 if (revents
& LPOLLIN
) {
2202 sock
= lttcomm_accept_unix_sock(apps_sock
);
2208 * Set socket timeout for both receiving and ending.
2209 * app_socket_timeout is in seconds, whereas
2210 * lttcomm_setsockopt_rcv_timeout and
2211 * lttcomm_setsockopt_snd_timeout expect msec as
2214 (void) lttcomm_setsockopt_rcv_timeout(sock
,
2215 app_socket_timeout
* 1000);
2216 (void) lttcomm_setsockopt_snd_timeout(sock
,
2217 app_socket_timeout
* 1000);
2220 * Set the CLOEXEC flag. Return code is useless because
2221 * either way, the show must go on.
2223 (void) utils_set_fd_cloexec(sock
);
2225 /* Create UST registration command for enqueuing */
2226 ust_cmd
= zmalloc(sizeof(struct ust_command
));
2227 if (ust_cmd
== NULL
) {
2228 PERROR("ust command zmalloc");
2237 * Using message-based transmissions to ensure we don't
2238 * have to deal with partially received messages.
2240 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2242 ERR("Exhausted file descriptors allowed for applications.");
2252 health_code_update();
2253 ret
= ust_app_recv_registration(sock
, &ust_cmd
->reg_msg
);
2256 /* Close socket of the application. */
2261 lttng_fd_put(LTTNG_FD_APPS
, 1);
2265 health_code_update();
2267 ust_cmd
->sock
= sock
;
2270 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2271 " gid:%d sock:%d name:%s (version %d.%d)",
2272 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
2273 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
2274 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
2275 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
2278 * Lock free enqueue the registration request. The red pill
2279 * has been taken! This apps will be part of the *system*.
2281 cds_wfcq_enqueue(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
, &ust_cmd
->node
);
2284 * Wake the registration queue futex. Implicit memory
2285 * barrier with the exchange in cds_wfcq_enqueue.
2287 futex_nto1_wake(&ust_cmd_queue
.futex
);
2288 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2289 ERR("Register apps socket poll error");
2292 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2301 /* Notify that the registration thread is gone */
2304 if (apps_sock
>= 0) {
2305 ret
= close(apps_sock
);
2315 lttng_fd_put(LTTNG_FD_APPS
, 1);
2317 unlink(apps_unix_sock_path
);
2320 lttng_poll_clean(&events
);
2324 DBG("UST Registration thread cleanup complete");
2327 ERR("Health error occurred in %s", __func__
);
2329 health_unregister(health_sessiond
);
2335 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2336 * exec or it will fails.
2338 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
2341 struct timespec timeout
;
2343 /* Make sure we set the readiness flag to 0 because we are NOT ready */
2344 consumer_data
->consumer_thread_is_ready
= 0;
2346 /* Setup pthread condition */
2347 ret
= pthread_condattr_init(&consumer_data
->condattr
);
2350 PERROR("pthread_condattr_init consumer data");
2355 * Set the monotonic clock in order to make sure we DO NOT jump in time
2356 * between the clock_gettime() call and the timedwait call. See bug #324
2357 * for a more details and how we noticed it.
2359 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
2362 PERROR("pthread_condattr_setclock consumer data");
2366 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
2369 PERROR("pthread_cond_init consumer data");
2373 ret
= pthread_create(&consumer_data
->thread
, NULL
, thread_manage_consumer
,
2377 PERROR("pthread_create consumer");
2382 /* We are about to wait on a pthread condition */
2383 pthread_mutex_lock(&consumer_data
->cond_mutex
);
2385 /* Get time for sem_timedwait absolute timeout */
2386 clock_ret
= clock_gettime(CLOCK_MONOTONIC
, &timeout
);
2388 * Set the timeout for the condition timed wait even if the clock gettime
2389 * call fails since we might loop on that call and we want to avoid to
2390 * increment the timeout too many times.
2392 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
2395 * The following loop COULD be skipped in some conditions so this is why we
2396 * set ret to 0 in order to make sure at least one round of the loop is
2402 * Loop until the condition is reached or when a timeout is reached. Note
2403 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2404 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2405 * possible. This loop does not take any chances and works with both of
2408 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
2409 if (clock_ret
< 0) {
2410 PERROR("clock_gettime spawn consumer");
2411 /* Infinite wait for the consumerd thread to be ready */
2412 ret
= pthread_cond_wait(&consumer_data
->cond
,
2413 &consumer_data
->cond_mutex
);
2415 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
2416 &consumer_data
->cond_mutex
, &timeout
);
2420 /* Release the pthread condition */
2421 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
2425 if (ret
== ETIMEDOUT
) {
2429 * Call has timed out so we kill the kconsumerd_thread and return
2432 ERR("Condition timed out. The consumer thread was never ready."
2434 pth_ret
= pthread_cancel(consumer_data
->thread
);
2436 PERROR("pthread_cancel consumer thread");
2439 PERROR("pthread_cond_wait failed consumer thread");
2441 /* Caller is expecting a negative value on failure. */
2446 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2447 if (consumer_data
->pid
== 0) {
2448 ERR("Consumerd did not start");
2449 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2452 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2461 * Join consumer thread
2463 static int join_consumer_thread(struct consumer_data
*consumer_data
)
2467 /* Consumer pid must be a real one. */
2468 if (consumer_data
->pid
> 0) {
2470 ret
= kill(consumer_data
->pid
, SIGTERM
);
2472 PERROR("Error killing consumer daemon");
2475 return pthread_join(consumer_data
->thread
, &status
);
2482 * Fork and exec a consumer daemon (consumerd).
2484 * Return pid if successful else -1.
2486 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
2490 const char *consumer_to_use
;
2491 const char *verbosity
;
2494 DBG("Spawning consumerd");
2501 if (opt_verbose_consumer
) {
2502 verbosity
= "--verbose";
2503 } else if (lttng_opt_quiet
) {
2504 verbosity
= "--quiet";
2509 switch (consumer_data
->type
) {
2510 case LTTNG_CONSUMER_KERNEL
:
2512 * Find out which consumerd to execute. We will first try the
2513 * 64-bit path, then the sessiond's installation directory, and
2514 * fallback on the 32-bit one,
2516 DBG3("Looking for a kernel consumer at these locations:");
2517 DBG3(" 1) %s", consumerd64_bin
);
2518 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
2519 DBG3(" 3) %s", consumerd32_bin
);
2520 if (stat(consumerd64_bin
, &st
) == 0) {
2521 DBG3("Found location #1");
2522 consumer_to_use
= consumerd64_bin
;
2523 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
2524 DBG3("Found location #2");
2525 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
2526 } else if (stat(consumerd32_bin
, &st
) == 0) {
2527 DBG3("Found location #3");
2528 consumer_to_use
= consumerd32_bin
;
2530 DBG("Could not find any valid consumerd executable");
2534 DBG("Using kernel consumer at: %s", consumer_to_use
);
2535 ret
= execl(consumer_to_use
,
2536 "lttng-consumerd", verbosity
, "-k",
2537 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2538 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2539 "--group", tracing_group_name
,
2542 case LTTNG_CONSUMER64_UST
:
2544 char *tmpnew
= NULL
;
2546 if (consumerd64_libdir
[0] != '\0') {
2550 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2554 tmplen
= strlen("LD_LIBRARY_PATH=")
2555 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
2556 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2561 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2562 strcat(tmpnew
, consumerd64_libdir
);
2563 if (tmp
[0] != '\0') {
2564 strcat(tmpnew
, ":");
2565 strcat(tmpnew
, tmp
);
2567 ret
= putenv(tmpnew
);
2574 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
2575 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
2576 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2577 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2578 "--group", tracing_group_name
,
2580 if (consumerd64_libdir
[0] != '\0') {
2585 case LTTNG_CONSUMER32_UST
:
2587 char *tmpnew
= NULL
;
2589 if (consumerd32_libdir
[0] != '\0') {
2593 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2597 tmplen
= strlen("LD_LIBRARY_PATH=")
2598 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
2599 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2604 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2605 strcat(tmpnew
, consumerd32_libdir
);
2606 if (tmp
[0] != '\0') {
2607 strcat(tmpnew
, ":");
2608 strcat(tmpnew
, tmp
);
2610 ret
= putenv(tmpnew
);
2617 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
2618 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
2619 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2620 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2621 "--group", tracing_group_name
,
2623 if (consumerd32_libdir
[0] != '\0') {
2629 PERROR("unknown consumer type");
2633 PERROR("Consumer execl()");
2635 /* Reaching this point, we got a failure on our execl(). */
2637 } else if (pid
> 0) {
2640 PERROR("start consumer fork");
2648 * Spawn the consumerd daemon and session daemon thread.
2650 static int start_consumerd(struct consumer_data
*consumer_data
)
2655 * Set the listen() state on the socket since there is a possible race
2656 * between the exec() of the consumer daemon and this call if place in the
2657 * consumer thread. See bug #366 for more details.
2659 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
2664 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2665 if (consumer_data
->pid
!= 0) {
2666 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2670 ret
= spawn_consumerd(consumer_data
);
2672 ERR("Spawning consumerd failed");
2673 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2677 /* Setting up the consumer_data pid */
2678 consumer_data
->pid
= ret
;
2679 DBG2("Consumer pid %d", consumer_data
->pid
);
2680 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2682 DBG2("Spawning consumer control thread");
2683 ret
= spawn_consumer_thread(consumer_data
);
2685 ERR("Fatal error spawning consumer control thread");
2693 /* Cleanup already created sockets on error. */
2694 if (consumer_data
->err_sock
>= 0) {
2697 err
= close(consumer_data
->err_sock
);
2699 PERROR("close consumer data error socket");
2706 * Setup necessary data for kernel tracer action.
2708 static int init_kernel_tracer(void)
2712 /* Modprobe lttng kernel modules */
2713 ret
= modprobe_lttng_control();
2718 /* Open debugfs lttng */
2719 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
2720 if (kernel_tracer_fd
< 0) {
2721 DBG("Failed to open %s", module_proc_lttng
);
2726 /* Validate kernel version */
2727 ret
= kernel_validate_version(kernel_tracer_fd
);
2732 ret
= modprobe_lttng_data();
2737 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
2741 modprobe_remove_lttng_control();
2742 ret
= close(kernel_tracer_fd
);
2746 kernel_tracer_fd
= -1;
2747 return LTTNG_ERR_KERN_VERSION
;
2750 ret
= close(kernel_tracer_fd
);
2756 modprobe_remove_lttng_control();
2759 WARN("No kernel tracer available");
2760 kernel_tracer_fd
= -1;
2762 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
2764 return LTTNG_ERR_KERN_NA
;
2770 * Copy consumer output from the tracing session to the domain session. The
2771 * function also applies the right modification on a per domain basis for the
2772 * trace files destination directory.
2774 * Should *NOT* be called with RCU read-side lock held.
2776 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2779 const char *dir_name
;
2780 struct consumer_output
*consumer
;
2783 assert(session
->consumer
);
2786 case LTTNG_DOMAIN_KERNEL
:
2787 DBG3("Copying tracing session consumer output in kernel session");
2789 * XXX: We should audit the session creation and what this function
2790 * does "extra" in order to avoid a destroy since this function is used
2791 * in the domain session creation (kernel and ust) only. Same for UST
2794 if (session
->kernel_session
->consumer
) {
2795 consumer_output_put(session
->kernel_session
->consumer
);
2797 session
->kernel_session
->consumer
=
2798 consumer_copy_output(session
->consumer
);
2799 /* Ease our life a bit for the next part */
2800 consumer
= session
->kernel_session
->consumer
;
2801 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2803 case LTTNG_DOMAIN_JUL
:
2804 case LTTNG_DOMAIN_LOG4J
:
2805 case LTTNG_DOMAIN_PYTHON
:
2806 case LTTNG_DOMAIN_UST
:
2807 DBG3("Copying tracing session consumer output in UST session");
2808 if (session
->ust_session
->consumer
) {
2809 consumer_output_put(session
->ust_session
->consumer
);
2811 session
->ust_session
->consumer
=
2812 consumer_copy_output(session
->consumer
);
2813 /* Ease our life a bit for the next part */
2814 consumer
= session
->ust_session
->consumer
;
2815 dir_name
= DEFAULT_UST_TRACE_DIR
;
2818 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2822 /* Append correct directory to subdir */
2823 strncat(consumer
->subdir
, dir_name
,
2824 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
2825 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2834 * Create an UST session and add it to the session ust list.
2836 * Should *NOT* be called with RCU read-side lock held.
2838 static int create_ust_session(struct ltt_session
*session
,
2839 struct lttng_domain
*domain
)
2842 struct ltt_ust_session
*lus
= NULL
;
2846 assert(session
->consumer
);
2848 switch (domain
->type
) {
2849 case LTTNG_DOMAIN_JUL
:
2850 case LTTNG_DOMAIN_LOG4J
:
2851 case LTTNG_DOMAIN_PYTHON
:
2852 case LTTNG_DOMAIN_UST
:
2855 ERR("Unknown UST domain on create session %d", domain
->type
);
2856 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2860 DBG("Creating UST session");
2862 lus
= trace_ust_create_session(session
->id
);
2864 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2868 lus
->uid
= session
->uid
;
2869 lus
->gid
= session
->gid
;
2870 lus
->output_traces
= session
->output_traces
;
2871 lus
->snapshot_mode
= session
->snapshot_mode
;
2872 lus
->live_timer_interval
= session
->live_timer
;
2873 session
->ust_session
= lus
;
2874 if (session
->shm_path
[0]) {
2875 strncpy(lus
->root_shm_path
, session
->shm_path
,
2876 sizeof(lus
->root_shm_path
));
2877 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
2878 strncpy(lus
->shm_path
, session
->shm_path
,
2879 sizeof(lus
->shm_path
));
2880 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
2881 strncat(lus
->shm_path
, "/ust",
2882 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
2884 /* Copy session output to the newly created UST session */
2885 ret
= copy_session_consumer(domain
->type
, session
);
2886 if (ret
!= LTTNG_OK
) {
2894 session
->ust_session
= NULL
;
2899 * Create a kernel tracer session then create the default channel.
2901 static int create_kernel_session(struct ltt_session
*session
)
2905 DBG("Creating kernel session");
2907 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2909 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2913 /* Code flow safety */
2914 assert(session
->kernel_session
);
2916 /* Copy session output to the newly created Kernel session */
2917 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2918 if (ret
!= LTTNG_OK
) {
2922 /* Create directory(ies) on local filesystem. */
2923 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2924 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2925 ret
= run_as_mkdir_recursive(
2926 session
->kernel_session
->consumer
->dst
.trace_path
,
2927 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2929 if (errno
!= EEXIST
) {
2930 ERR("Trace directory creation error");
2936 session
->kernel_session
->uid
= session
->uid
;
2937 session
->kernel_session
->gid
= session
->gid
;
2938 session
->kernel_session
->output_traces
= session
->output_traces
;
2939 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
2944 trace_kernel_destroy_session(session
->kernel_session
);
2945 session
->kernel_session
= NULL
;
2950 * Count number of session permitted by uid/gid.
2952 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2955 struct ltt_session
*session
;
2957 DBG("Counting number of available session for UID %d GID %d",
2959 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2961 * Only list the sessions the user can control.
2963 if (!session_access_ok(session
, uid
, gid
)) {
2972 * Process the command requested by the lttng client within the command
2973 * context structure. This function make sure that the return structure (llm)
2974 * is set and ready for transmission before returning.
2976 * Return any error encountered or 0 for success.
2978 * "sock" is only used for special-case var. len data.
2980 * Should *NOT* be called with RCU read-side lock held.
2982 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2986 int need_tracing_session
= 1;
2989 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2991 assert(!rcu_read_ongoing());
2995 switch (cmd_ctx
->lsm
->cmd_type
) {
2996 case LTTNG_CREATE_SESSION
:
2997 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2998 case LTTNG_CREATE_SESSION_LIVE
:
2999 case LTTNG_DESTROY_SESSION
:
3000 case LTTNG_LIST_SESSIONS
:
3001 case LTTNG_LIST_DOMAINS
:
3002 case LTTNG_START_TRACE
:
3003 case LTTNG_STOP_TRACE
:
3004 case LTTNG_DATA_PENDING
:
3005 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3006 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3007 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3008 case LTTNG_SNAPSHOT_RECORD
:
3009 case LTTNG_SAVE_SESSION
:
3010 case LTTNG_SET_SESSION_SHM_PATH
:
3017 if (opt_no_kernel
&& need_domain
3018 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3020 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3022 ret
= LTTNG_ERR_KERN_NA
;
3027 /* Deny register consumer if we already have a spawned consumer. */
3028 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
3029 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3030 if (kconsumer_data
.pid
> 0) {
3031 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3032 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3035 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3039 * Check for command that don't needs to allocate a returned payload. We do
3040 * this here so we don't have to make the call for no payload at each
3043 switch(cmd_ctx
->lsm
->cmd_type
) {
3044 case LTTNG_LIST_SESSIONS
:
3045 case LTTNG_LIST_TRACEPOINTS
:
3046 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3047 case LTTNG_LIST_DOMAINS
:
3048 case LTTNG_LIST_CHANNELS
:
3049 case LTTNG_LIST_EVENTS
:
3050 case LTTNG_LIST_SYSCALLS
:
3051 case LTTNG_LIST_TRACKER_PIDS
:
3054 /* Setup lttng message with no payload */
3055 ret
= setup_lttng_msg(cmd_ctx
, 0);
3057 /* This label does not try to unlock the session */
3058 goto init_setup_error
;
3062 /* Commands that DO NOT need a session. */
3063 switch (cmd_ctx
->lsm
->cmd_type
) {
3064 case LTTNG_CREATE_SESSION
:
3065 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3066 case LTTNG_CREATE_SESSION_LIVE
:
3067 case LTTNG_CALIBRATE
:
3068 case LTTNG_LIST_SESSIONS
:
3069 case LTTNG_LIST_TRACEPOINTS
:
3070 case LTTNG_LIST_SYSCALLS
:
3071 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3072 case LTTNG_SAVE_SESSION
:
3073 need_tracing_session
= 0;
3076 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3078 * We keep the session list lock across _all_ commands
3079 * for now, because the per-session lock does not
3080 * handle teardown properly.
3082 session_lock_list();
3083 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3084 if (cmd_ctx
->session
== NULL
) {
3085 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
3088 /* Acquire lock for the session */
3089 session_lock(cmd_ctx
->session
);
3095 * Commands that need a valid session but should NOT create one if none
3096 * exists. Instead of creating one and destroying it when the command is
3097 * handled, process that right before so we save some round trip in useless
3100 switch (cmd_ctx
->lsm
->cmd_type
) {
3101 case LTTNG_DISABLE_CHANNEL
:
3102 case LTTNG_DISABLE_EVENT
:
3103 switch (cmd_ctx
->lsm
->domain
.type
) {
3104 case LTTNG_DOMAIN_KERNEL
:
3105 if (!cmd_ctx
->session
->kernel_session
) {
3106 ret
= LTTNG_ERR_NO_CHANNEL
;
3110 case LTTNG_DOMAIN_JUL
:
3111 case LTTNG_DOMAIN_LOG4J
:
3112 case LTTNG_DOMAIN_PYTHON
:
3113 case LTTNG_DOMAIN_UST
:
3114 if (!cmd_ctx
->session
->ust_session
) {
3115 ret
= LTTNG_ERR_NO_CHANNEL
;
3120 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3132 * Check domain type for specific "pre-action".
3134 switch (cmd_ctx
->lsm
->domain
.type
) {
3135 case LTTNG_DOMAIN_KERNEL
:
3137 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3141 /* Kernel tracer check */
3142 if (kernel_tracer_fd
== -1) {
3143 /* Basically, load kernel tracer modules */
3144 ret
= init_kernel_tracer();
3150 /* Consumer is in an ERROR state. Report back to client */
3151 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3152 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3156 /* Need a session for kernel command */
3157 if (need_tracing_session
) {
3158 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3159 ret
= create_kernel_session(cmd_ctx
->session
);
3161 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
3166 /* Start the kernel consumer daemon */
3167 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3168 if (kconsumer_data
.pid
== 0 &&
3169 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3170 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3171 ret
= start_consumerd(&kconsumer_data
);
3173 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3176 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3178 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3182 * The consumer was just spawned so we need to add the socket to
3183 * the consumer output of the session if exist.
3185 ret
= consumer_create_socket(&kconsumer_data
,
3186 cmd_ctx
->session
->kernel_session
->consumer
);
3193 case LTTNG_DOMAIN_JUL
:
3194 case LTTNG_DOMAIN_LOG4J
:
3195 case LTTNG_DOMAIN_PYTHON
:
3196 case LTTNG_DOMAIN_UST
:
3198 if (!ust_app_supported()) {
3199 ret
= LTTNG_ERR_NO_UST
;
3202 /* Consumer is in an ERROR state. Report back to client */
3203 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3204 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3208 if (need_tracing_session
) {
3209 /* Create UST session if none exist. */
3210 if (cmd_ctx
->session
->ust_session
== NULL
) {
3211 ret
= create_ust_session(cmd_ctx
->session
,
3212 &cmd_ctx
->lsm
->domain
);
3213 if (ret
!= LTTNG_OK
) {
3218 /* Start the UST consumer daemons */
3220 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3221 if (consumerd64_bin
[0] != '\0' &&
3222 ustconsumer64_data
.pid
== 0 &&
3223 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3224 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3225 ret
= start_consumerd(&ustconsumer64_data
);
3227 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
3228 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
3232 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
3233 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3235 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3239 * Setup socket for consumer 64 bit. No need for atomic access
3240 * since it was set above and can ONLY be set in this thread.
3242 ret
= consumer_create_socket(&ustconsumer64_data
,
3243 cmd_ctx
->session
->ust_session
->consumer
);
3249 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
3250 if (consumerd32_bin
[0] != '\0' &&
3251 ustconsumer32_data
.pid
== 0 &&
3252 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3253 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3254 ret
= start_consumerd(&ustconsumer32_data
);
3256 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
3257 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
3261 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
3262 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3264 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3268 * Setup socket for consumer 64 bit. No need for atomic access
3269 * since it was set above and can ONLY be set in this thread.
3271 ret
= consumer_create_socket(&ustconsumer32_data
,
3272 cmd_ctx
->session
->ust_session
->consumer
);
3284 /* Validate consumer daemon state when start/stop trace command */
3285 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3286 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3287 switch (cmd_ctx
->lsm
->domain
.type
) {
3288 case LTTNG_DOMAIN_NONE
:
3290 case LTTNG_DOMAIN_JUL
:
3291 case LTTNG_DOMAIN_LOG4J
:
3292 case LTTNG_DOMAIN_PYTHON
:
3293 case LTTNG_DOMAIN_UST
:
3294 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3295 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3299 case LTTNG_DOMAIN_KERNEL
:
3300 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3301 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3306 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3312 * Check that the UID or GID match that of the tracing session.
3313 * The root user can interact with all sessions.
3315 if (need_tracing_session
) {
3316 if (!session_access_ok(cmd_ctx
->session
,
3317 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3318 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3319 ret
= LTTNG_ERR_EPERM
;
3325 * Send relayd information to consumer as soon as we have a domain and a
3328 if (cmd_ctx
->session
&& need_domain
) {
3330 * Setup relayd if not done yet. If the relayd information was already
3331 * sent to the consumer, this call will gracefully return.
3333 ret
= cmd_setup_relayd(cmd_ctx
->session
);
3334 if (ret
!= LTTNG_OK
) {
3339 /* Process by command type */
3340 switch (cmd_ctx
->lsm
->cmd_type
) {
3341 case LTTNG_ADD_CONTEXT
:
3343 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3344 cmd_ctx
->lsm
->u
.context
.channel_name
,
3345 &cmd_ctx
->lsm
->u
.context
.ctx
, kernel_poll_pipe
[1]);
3348 case LTTNG_DISABLE_CHANNEL
:
3350 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3351 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3354 case LTTNG_DISABLE_EVENT
:
3358 * FIXME: handle filter; for now we just receive the filter's
3359 * bytecode along with the filter expression which are sent by
3360 * liblttng-ctl and discard them.
3362 * This fixes an issue where the client may block while sending
3363 * the filter payload and encounter an error because the session
3364 * daemon closes the socket without ever handling this data.
3366 size_t count
= cmd_ctx
->lsm
->u
.disable
.expression_len
+
3367 cmd_ctx
->lsm
->u
.disable
.bytecode_len
;
3370 char data
[LTTNG_FILTER_MAX_LEN
];
3372 DBG("Discarding disable event command payload of size %zu", count
);
3374 ret
= lttcomm_recv_unix_sock(sock
, data
,
3375 count
> sizeof(data
) ? sizeof(data
) : count
);
3380 count
-= (size_t) ret
;
3383 /* FIXME: passing packed structure to non-packed pointer */
3384 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3385 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3386 &cmd_ctx
->lsm
->u
.disable
.event
);
3389 case LTTNG_ENABLE_CHANNEL
:
3391 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3392 &cmd_ctx
->lsm
->u
.channel
.chan
, kernel_poll_pipe
[1]);
3395 case LTTNG_TRACK_PID
:
3397 ret
= cmd_track_pid(cmd_ctx
->session
,
3398 cmd_ctx
->lsm
->domain
.type
,
3399 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3402 case LTTNG_UNTRACK_PID
:
3404 ret
= cmd_untrack_pid(cmd_ctx
->session
,
3405 cmd_ctx
->lsm
->domain
.type
,
3406 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3409 case LTTNG_ENABLE_EVENT
:
3411 struct lttng_event_exclusion
*exclusion
= NULL
;
3412 struct lttng_filter_bytecode
*bytecode
= NULL
;
3413 char *filter_expression
= NULL
;
3415 /* Handle exclusion events and receive it from the client. */
3416 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
3417 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
3419 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
3420 (count
* LTTNG_SYMBOL_NAME_LEN
));
3422 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
3426 DBG("Receiving var len exclusion event list from client ...");
3427 exclusion
->count
= count
;
3428 ret
= lttcomm_recv_unix_sock(sock
, exclusion
->names
,
3429 count
* LTTNG_SYMBOL_NAME_LEN
);
3431 DBG("Nothing recv() from client var len data... continuing");
3434 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
3439 /* Get filter expression from client. */
3440 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
3441 size_t expression_len
=
3442 cmd_ctx
->lsm
->u
.enable
.expression_len
;
3444 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
3445 ret
= LTTNG_ERR_FILTER_INVAL
;
3450 filter_expression
= zmalloc(expression_len
);
3451 if (!filter_expression
) {
3453 ret
= LTTNG_ERR_FILTER_NOMEM
;
3457 /* Receive var. len. data */
3458 DBG("Receiving var len filter's expression from client ...");
3459 ret
= lttcomm_recv_unix_sock(sock
, filter_expression
,
3462 DBG("Nothing recv() from client car len data... continuing");
3464 free(filter_expression
);
3466 ret
= LTTNG_ERR_FILTER_INVAL
;
3471 /* Handle filter and get bytecode from client. */
3472 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
3473 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
3475 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
3476 ret
= LTTNG_ERR_FILTER_INVAL
;
3477 free(filter_expression
);
3482 bytecode
= zmalloc(bytecode_len
);
3484 free(filter_expression
);
3486 ret
= LTTNG_ERR_FILTER_NOMEM
;
3490 /* Receive var. len. data */
3491 DBG("Receiving var len filter's bytecode from client ...");
3492 ret
= lttcomm_recv_unix_sock(sock
, bytecode
, bytecode_len
);
3494 DBG("Nothing recv() from client car len data... continuing");
3496 free(filter_expression
);
3499 ret
= LTTNG_ERR_FILTER_INVAL
;
3503 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
3504 free(filter_expression
);
3507 ret
= LTTNG_ERR_FILTER_INVAL
;
3512 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3513 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3514 &cmd_ctx
->lsm
->u
.enable
.event
,
3515 filter_expression
, bytecode
, exclusion
,
3516 kernel_poll_pipe
[1]);
3519 case LTTNG_LIST_TRACEPOINTS
:
3521 struct lttng_event
*events
;
3524 session_lock_list();
3525 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3526 session_unlock_list();
3527 if (nb_events
< 0) {
3528 /* Return value is a negative lttng_error_code. */
3534 * Setup lttng message with payload size set to the event list size in
3535 * bytes and then copy list into the llm payload.
3537 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3543 /* Copy event list into message payload */
3544 memcpy(cmd_ctx
->llm
->payload
, events
,
3545 sizeof(struct lttng_event
) * nb_events
);
3552 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3554 struct lttng_event_field
*fields
;
3557 session_lock_list();
3558 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
3560 session_unlock_list();
3561 if (nb_fields
< 0) {
3562 /* Return value is a negative lttng_error_code. */
3568 * Setup lttng message with payload size set to the event list size in
3569 * bytes and then copy list into the llm payload.
3571 ret
= setup_lttng_msg(cmd_ctx
,
3572 sizeof(struct lttng_event_field
) * nb_fields
);
3578 /* Copy event list into message payload */
3579 memcpy(cmd_ctx
->llm
->payload
, fields
,
3580 sizeof(struct lttng_event_field
) * nb_fields
);
3587 case LTTNG_LIST_SYSCALLS
:
3589 struct lttng_event
*events
;
3592 nb_events
= cmd_list_syscalls(&events
);
3593 if (nb_events
< 0) {
3594 /* Return value is a negative lttng_error_code. */
3600 * Setup lttng message with payload size set to the event list size in
3601 * bytes and then copy list into the llm payload.
3603 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3609 /* Copy event list into message payload */
3610 memcpy(cmd_ctx
->llm
->payload
, events
,
3611 sizeof(struct lttng_event
) * nb_events
);
3618 case LTTNG_LIST_TRACKER_PIDS
:
3620 int32_t *pids
= NULL
;
3623 nr_pids
= cmd_list_tracker_pids(cmd_ctx
->session
,
3624 cmd_ctx
->lsm
->domain
.type
, &pids
);
3626 /* Return value is a negative lttng_error_code. */
3632 * Setup lttng message with payload size set to the event list size in
3633 * bytes and then copy list into the llm payload.
3635 ret
= setup_lttng_msg(cmd_ctx
, sizeof(int32_t) * nr_pids
);
3641 /* Copy event list into message payload */
3642 memcpy(cmd_ctx
->llm
->payload
, pids
,
3643 sizeof(int) * nr_pids
);
3650 case LTTNG_SET_CONSUMER_URI
:
3653 struct lttng_uri
*uris
;
3655 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3656 len
= nb_uri
* sizeof(struct lttng_uri
);
3659 ret
= LTTNG_ERR_INVALID
;
3663 uris
= zmalloc(len
);
3665 ret
= LTTNG_ERR_FATAL
;
3669 /* Receive variable len data */
3670 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
3671 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3673 DBG("No URIs received from client... continuing");
3675 ret
= LTTNG_ERR_SESSION_FAIL
;
3680 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
3682 if (ret
!= LTTNG_OK
) {
3689 case LTTNG_START_TRACE
:
3691 ret
= cmd_start_trace(cmd_ctx
->session
);
3694 case LTTNG_STOP_TRACE
:
3696 ret
= cmd_stop_trace(cmd_ctx
->session
);
3699 case LTTNG_CREATE_SESSION
:
3702 struct lttng_uri
*uris
= NULL
;
3704 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3705 len
= nb_uri
* sizeof(struct lttng_uri
);
3708 uris
= zmalloc(len
);
3710 ret
= LTTNG_ERR_FATAL
;
3714 /* Receive variable len data */
3715 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3716 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3718 DBG("No URIs received from client... continuing");
3720 ret
= LTTNG_ERR_SESSION_FAIL
;
3725 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3726 DBG("Creating session with ONE network URI is a bad call");
3727 ret
= LTTNG_ERR_SESSION_FAIL
;
3733 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
3734 &cmd_ctx
->creds
, 0);
3740 case LTTNG_DESTROY_SESSION
:
3742 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
3744 /* Set session to NULL so we do not unlock it after free. */
3745 cmd_ctx
->session
= NULL
;
3748 case LTTNG_LIST_DOMAINS
:
3751 struct lttng_domain
*domains
= NULL
;
3753 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3755 /* Return value is a negative lttng_error_code. */
3760 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3766 /* Copy event list into message payload */
3767 memcpy(cmd_ctx
->llm
->payload
, domains
,
3768 nb_dom
* sizeof(struct lttng_domain
));
3775 case LTTNG_LIST_CHANNELS
:
3778 struct lttng_channel
*channels
= NULL
;
3780 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3781 cmd_ctx
->session
, &channels
);
3783 /* Return value is a negative lttng_error_code. */
3788 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3794 /* Copy event list into message payload */
3795 memcpy(cmd_ctx
->llm
->payload
, channels
,
3796 nb_chan
* sizeof(struct lttng_channel
));
3803 case LTTNG_LIST_EVENTS
:
3806 struct lttng_event
*events
= NULL
;
3808 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3809 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3811 /* Return value is a negative lttng_error_code. */
3816 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3822 /* Copy event list into message payload */
3823 memcpy(cmd_ctx
->llm
->payload
, events
,
3824 nb_event
* sizeof(struct lttng_event
));
3831 case LTTNG_LIST_SESSIONS
:
3833 unsigned int nr_sessions
;
3835 session_lock_list();
3836 nr_sessions
= lttng_sessions_count(
3837 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3838 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3840 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3842 session_unlock_list();
3846 /* Filled the session array */
3847 cmd_list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3848 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3849 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3851 session_unlock_list();
3856 case LTTNG_CALIBRATE
:
3858 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3859 &cmd_ctx
->lsm
->u
.calibrate
);
3862 case LTTNG_REGISTER_CONSUMER
:
3864 struct consumer_data
*cdata
;
3866 switch (cmd_ctx
->lsm
->domain
.type
) {
3867 case LTTNG_DOMAIN_KERNEL
:
3868 cdata
= &kconsumer_data
;
3871 ret
= LTTNG_ERR_UND
;
3875 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3876 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
3879 case LTTNG_DATA_PENDING
:
3881 ret
= cmd_data_pending(cmd_ctx
->session
);
3884 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3886 struct lttcomm_lttng_output_id reply
;
3888 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
3889 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
3890 if (ret
!= LTTNG_OK
) {
3894 ret
= setup_lttng_msg(cmd_ctx
, sizeof(reply
));
3899 /* Copy output list into message payload */
3900 memcpy(cmd_ctx
->llm
->payload
, &reply
, sizeof(reply
));
3904 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3906 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
3907 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
3910 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3913 struct lttng_snapshot_output
*outputs
= NULL
;
3915 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
3916 if (nb_output
< 0) {
3921 ret
= setup_lttng_msg(cmd_ctx
,
3922 nb_output
* sizeof(struct lttng_snapshot_output
));
3929 /* Copy output list into message payload */
3930 memcpy(cmd_ctx
->llm
->payload
, outputs
,
3931 nb_output
* sizeof(struct lttng_snapshot_output
));
3938 case LTTNG_SNAPSHOT_RECORD
:
3940 ret
= cmd_snapshot_record(cmd_ctx
->session
,
3941 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
3942 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
3945 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3948 struct lttng_uri
*uris
= NULL
;
3950 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3951 len
= nb_uri
* sizeof(struct lttng_uri
);
3954 uris
= zmalloc(len
);
3956 ret
= LTTNG_ERR_FATAL
;
3960 /* Receive variable len data */
3961 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3962 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3964 DBG("No URIs received from client... continuing");
3966 ret
= LTTNG_ERR_SESSION_FAIL
;
3971 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3972 DBG("Creating session with ONE network URI is a bad call");
3973 ret
= LTTNG_ERR_SESSION_FAIL
;
3979 ret
= cmd_create_session_snapshot(cmd_ctx
->lsm
->session
.name
, uris
,
3980 nb_uri
, &cmd_ctx
->creds
);
3984 case LTTNG_CREATE_SESSION_LIVE
:
3987 struct lttng_uri
*uris
= NULL
;
3989 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3990 len
= nb_uri
* sizeof(struct lttng_uri
);
3993 uris
= zmalloc(len
);
3995 ret
= LTTNG_ERR_FATAL
;
3999 /* Receive variable len data */
4000 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4001 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4003 DBG("No URIs received from client... continuing");
4005 ret
= LTTNG_ERR_SESSION_FAIL
;
4010 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4011 DBG("Creating session with ONE network URI is a bad call");
4012 ret
= LTTNG_ERR_SESSION_FAIL
;
4018 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
,
4019 nb_uri
, &cmd_ctx
->creds
, cmd_ctx
->lsm
->u
.session_live
.timer_interval
);
4023 case LTTNG_SAVE_SESSION
:
4025 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
4029 case LTTNG_SET_SESSION_SHM_PATH
:
4031 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
4032 cmd_ctx
->lsm
->u
.set_shm_path
.shm_path
);
4036 ret
= LTTNG_ERR_UND
;
4041 if (cmd_ctx
->llm
== NULL
) {
4042 DBG("Missing llm structure. Allocating one.");
4043 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
4047 /* Set return code */
4048 cmd_ctx
->llm
->ret_code
= ret
;
4050 if (cmd_ctx
->session
) {
4051 session_unlock(cmd_ctx
->session
);
4053 if (need_tracing_session
) {
4054 session_unlock_list();
4057 assert(!rcu_read_ongoing());
4062 * Thread managing health check socket.
4064 static void *thread_manage_health(void *data
)
4066 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
4067 uint32_t revents
, nb_fd
;
4068 struct lttng_poll_event events
;
4069 struct health_comm_msg msg
;
4070 struct health_comm_reply reply
;
4072 DBG("[thread] Manage health check started");
4074 rcu_register_thread();
4076 /* We might hit an error path before this is created. */
4077 lttng_poll_init(&events
);
4079 /* Create unix socket */
4080 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
4082 ERR("Unable to create health check Unix socket");
4088 /* lttng health client socket path permissions */
4089 ret
= chown(health_unix_sock_path
, 0,
4090 utils_get_group_id(tracing_group_name
));
4092 ERR("Unable to set group on %s", health_unix_sock_path
);
4098 ret
= chmod(health_unix_sock_path
,
4099 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4101 ERR("Unable to set permissions on %s", health_unix_sock_path
);
4109 * Set the CLOEXEC flag. Return code is useless because either way, the
4112 (void) utils_set_fd_cloexec(sock
);
4114 ret
= lttcomm_listen_unix_sock(sock
);
4120 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4121 * more will be added to this poll set.
4123 ret
= sessiond_set_thread_pollset(&events
, 2);
4128 /* Add the application registration socket */
4129 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
4134 sessiond_notify_ready();
4137 DBG("Health check ready");
4139 /* Inifinite blocking call, waiting for transmission */
4141 ret
= lttng_poll_wait(&events
, -1);
4144 * Restart interrupted system call.
4146 if (errno
== EINTR
) {
4154 for (i
= 0; i
< nb_fd
; i
++) {
4155 /* Fetch once the poll data */
4156 revents
= LTTNG_POLL_GETEV(&events
, i
);
4157 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4160 /* No activity for this FD (poll implementation). */
4164 /* Thread quit pipe has been closed. Killing thread. */
4165 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4171 /* Event on the registration socket */
4172 if (pollfd
== sock
) {
4173 if (revents
& LPOLLIN
) {
4175 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4176 ERR("Health socket poll error");
4179 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4185 new_sock
= lttcomm_accept_unix_sock(sock
);
4191 * Set the CLOEXEC flag. Return code is useless because either way, the
4194 (void) utils_set_fd_cloexec(new_sock
);
4196 DBG("Receiving data from client for health...");
4197 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
4199 DBG("Nothing recv() from client... continuing");
4200 ret
= close(new_sock
);
4208 rcu_thread_online();
4210 memset(&reply
, 0, sizeof(reply
));
4211 for (i
= 0; i
< NR_HEALTH_SESSIOND_TYPES
; i
++) {
4213 * health_check_state returns 0 if health is
4216 if (!health_check_state(health_sessiond
, i
)) {
4217 reply
.ret_code
|= 1ULL << i
;
4221 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
4223 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
4225 ERR("Failed to send health data back to client");
4228 /* End of transmission */
4229 ret
= close(new_sock
);
4239 ERR("Health error occurred in %s", __func__
);
4241 DBG("Health check thread dying");
4242 unlink(health_unix_sock_path
);
4250 lttng_poll_clean(&events
);
4252 rcu_unregister_thread();
4257 * This thread manage all clients request using the unix client socket for
4260 static void *thread_manage_clients(void *data
)
4262 int sock
= -1, ret
, i
, pollfd
, err
= -1;
4264 uint32_t revents
, nb_fd
;
4265 struct command_ctx
*cmd_ctx
= NULL
;
4266 struct lttng_poll_event events
;
4268 DBG("[thread] Manage client started");
4270 rcu_register_thread();
4272 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
4274 health_code_update();
4276 ret
= lttcomm_listen_unix_sock(client_sock
);
4282 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4283 * more will be added to this poll set.
4285 ret
= sessiond_set_thread_pollset(&events
, 2);
4287 goto error_create_poll
;
4290 /* Add the application registration socket */
4291 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
4296 sessiond_notify_ready();
4297 ret
= sem_post(&load_info
->message_thread_ready
);
4299 PERROR("sem_post message_thread_ready");
4303 /* This testpoint is after we signal readiness to the parent. */
4304 if (testpoint(sessiond_thread_manage_clients
)) {
4308 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
4312 health_code_update();
4315 DBG("Accepting client command ...");
4317 /* Inifinite blocking call, waiting for transmission */
4319 health_poll_entry();
4320 ret
= lttng_poll_wait(&events
, -1);
4324 * Restart interrupted system call.
4326 if (errno
== EINTR
) {
4334 for (i
= 0; i
< nb_fd
; i
++) {
4335 /* Fetch once the poll data */
4336 revents
= LTTNG_POLL_GETEV(&events
, i
);
4337 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4339 health_code_update();
4342 /* No activity for this FD (poll implementation). */
4346 /* Thread quit pipe has been closed. Killing thread. */
4347 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4353 /* Event on the registration socket */
4354 if (pollfd
== client_sock
) {
4355 if (revents
& LPOLLIN
) {
4357 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4358 ERR("Client socket poll error");
4361 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4367 DBG("Wait for client response");
4369 health_code_update();
4371 sock
= lttcomm_accept_unix_sock(client_sock
);
4377 * Set the CLOEXEC flag. Return code is useless because either way, the
4380 (void) utils_set_fd_cloexec(sock
);
4382 /* Set socket option for credentials retrieval */
4383 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
4388 /* Allocate context command to process the client request */
4389 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
4390 if (cmd_ctx
== NULL
) {
4391 PERROR("zmalloc cmd_ctx");
4395 /* Allocate data buffer for reception */
4396 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
4397 if (cmd_ctx
->lsm
== NULL
) {
4398 PERROR("zmalloc cmd_ctx->lsm");
4402 cmd_ctx
->llm
= NULL
;
4403 cmd_ctx
->session
= NULL
;
4405 health_code_update();
4408 * Data is received from the lttng client. The struct
4409 * lttcomm_session_msg (lsm) contains the command and data request of
4412 DBG("Receiving data from client ...");
4413 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
4414 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
4416 DBG("Nothing recv() from client... continuing");
4422 clean_command_ctx(&cmd_ctx
);
4426 health_code_update();
4428 // TODO: Validate cmd_ctx including sanity check for
4429 // security purpose.
4431 rcu_thread_online();
4433 * This function dispatch the work to the kernel or userspace tracer
4434 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4435 * informations for the client. The command context struct contains
4436 * everything this function may needs.
4438 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
4439 rcu_thread_offline();
4447 * TODO: Inform client somehow of the fatal error. At
4448 * this point, ret < 0 means that a zmalloc failed
4449 * (ENOMEM). Error detected but still accept
4450 * command, unless a socket error has been
4453 clean_command_ctx(&cmd_ctx
);
4457 health_code_update();
4459 DBG("Sending response (size: %d, retcode: %s)",
4460 cmd_ctx
->lttng_msg_size
,
4461 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
4462 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
4464 ERR("Failed to send data back to client");
4467 /* End of transmission */
4474 clean_command_ctx(&cmd_ctx
);
4476 health_code_update();
4488 lttng_poll_clean(&events
);
4489 clean_command_ctx(&cmd_ctx
);
4493 unlink(client_unix_sock_path
);
4494 if (client_sock
>= 0) {
4495 ret
= close(client_sock
);
4503 ERR("Health error occurred in %s", __func__
);
4506 health_unregister(health_sessiond
);
4508 DBG("Client thread dying");
4510 rcu_unregister_thread();
4513 * Since we are creating the consumer threads, we own them, so we need
4514 * to join them before our thread exits.
4516 ret
= join_consumer_thread(&kconsumer_data
);
4519 PERROR("join_consumer");
4522 ret
= join_consumer_thread(&ustconsumer32_data
);
4525 PERROR("join_consumer ust32");
4528 ret
= join_consumer_thread(&ustconsumer64_data
);
4531 PERROR("join_consumer ust64");
4538 * usage function on stderr
4540 static void usage(void)
4542 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
4543 fprintf(stderr
, " -h, --help Display this usage.\n");
4544 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
4545 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
4546 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
4547 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
4548 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
4549 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
4550 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
4551 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
4552 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
4553 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
4554 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
4555 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
4556 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
4557 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
4558 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
4559 fprintf(stderr
, " -V, --version Show version number.\n");
4560 fprintf(stderr
, " -S, --sig-parent Send SIGUSR1 to parent pid to notify readiness.\n");
4561 fprintf(stderr
, " -q, --quiet No output at all.\n");
4562 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
4563 fprintf(stderr
, " -p, --pidfile FILE Write a pid to FILE name overriding the default value.\n");
4564 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
4565 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
4566 fprintf(stderr
, " --agent-tcp-port Agent registration TCP port\n");
4567 fprintf(stderr
, " -f --config PATH Load daemon configuration file\n");
4568 fprintf(stderr
, " -l --load PATH Load session configuration\n");
4569 fprintf(stderr
, " --kmod-probes Specify kernel module probes to load\n");
4570 fprintf(stderr
, " --extra-kmod-probes Specify extra kernel module probes to load\n");
4573 static int string_match(const char *str1
, const char *str2
)
4575 return (str1
&& str2
) && !strcmp(str1
, str2
);
4579 * Take an option from the getopt output and set it in the right variable to be
4582 * Return 0 on success else a negative value.
4584 static int set_option(int opt
, const char *arg
, const char *optname
)
4588 if (string_match(optname
, "client-sock") || opt
== 'c') {
4589 if (!arg
|| *arg
== '\0') {
4593 if (lttng_is_setuid_setgid()) {
4594 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4595 "-c, --client-sock");
4597 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", arg
);
4599 } else if (string_match(optname
, "apps-sock") || opt
== 'a') {
4600 if (!arg
|| *arg
== '\0') {
4604 if (lttng_is_setuid_setgid()) {
4605 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4608 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", arg
);
4610 } else if (string_match(optname
, "daemonize") || opt
== 'd') {
4612 } else if (string_match(optname
, "background") || opt
== 'b') {
4614 } else if (string_match(optname
, "group") || opt
== 'g') {
4615 if (!arg
|| *arg
== '\0') {
4619 if (lttng_is_setuid_setgid()) {
4620 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4624 * If the override option is set, the pointer points to a
4625 * *non* const thus freeing it even though the variable type is
4628 if (tracing_group_name_override
) {
4629 free((void *) tracing_group_name
);
4631 tracing_group_name
= strdup(arg
);
4632 if (!tracing_group_name
) {
4636 tracing_group_name_override
= 1;
4638 } else if (string_match(optname
, "help") || opt
== 'h') {
4641 } else if (string_match(optname
, "version") || opt
== 'V') {
4642 fprintf(stdout
, "%s\n", VERSION
);
4644 } else if (string_match(optname
, "sig-parent") || opt
== 'S') {
4646 } else if (string_match(optname
, "kconsumerd-err-sock")) {
4647 if (!arg
|| *arg
== '\0') {
4651 if (lttng_is_setuid_setgid()) {
4652 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4653 "--kconsumerd-err-sock");
4655 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4657 } else if (string_match(optname
, "kconsumerd-cmd-sock")) {
4658 if (!arg
|| *arg
== '\0') {
4662 if (lttng_is_setuid_setgid()) {
4663 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4664 "--kconsumerd-cmd-sock");
4666 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4668 } else if (string_match(optname
, "ustconsumerd64-err-sock")) {
4669 if (!arg
|| *arg
== '\0') {
4673 if (lttng_is_setuid_setgid()) {
4674 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4675 "--ustconsumerd64-err-sock");
4677 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4679 } else if (string_match(optname
, "ustconsumerd64-cmd-sock")) {
4680 if (!arg
|| *arg
== '\0') {
4684 if (lttng_is_setuid_setgid()) {
4685 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4686 "--ustconsumerd64-cmd-sock");
4688 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4690 } else if (string_match(optname
, "ustconsumerd32-err-sock")) {
4691 if (!arg
|| *arg
== '\0') {
4695 if (lttng_is_setuid_setgid()) {
4696 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4697 "--ustconsumerd32-err-sock");
4699 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4701 } else if (string_match(optname
, "ustconsumerd32-cmd-sock")) {
4702 if (!arg
|| *arg
== '\0') {
4706 if (lttng_is_setuid_setgid()) {
4707 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4708 "--ustconsumerd32-cmd-sock");
4710 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4712 } else if (string_match(optname
, "no-kernel")) {
4714 } else if (string_match(optname
, "quiet") || opt
== 'q') {
4715 lttng_opt_quiet
= 1;
4716 } else if (string_match(optname
, "verbose") || opt
== 'v') {
4717 /* Verbose level can increase using multiple -v */
4719 /* Value obtained from config file */
4720 lttng_opt_verbose
= config_parse_value(arg
);
4722 /* -v used on command line */
4723 lttng_opt_verbose
++;
4725 /* Clamp value to [0, 3] */
4726 lttng_opt_verbose
= lttng_opt_verbose
< 0 ? 0 :
4727 (lttng_opt_verbose
<= 3 ? lttng_opt_verbose
: 3);
4728 } else if (string_match(optname
, "verbose-consumer")) {
4730 opt_verbose_consumer
= config_parse_value(arg
);
4732 opt_verbose_consumer
+= 1;
4734 } else if (string_match(optname
, "consumerd32-path")) {
4735 if (!arg
|| *arg
== '\0') {
4739 if (lttng_is_setuid_setgid()) {
4740 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4741 "--consumerd32-path");
4743 if (consumerd32_bin_override
) {
4744 free((void *) consumerd32_bin
);
4746 consumerd32_bin
= strdup(arg
);
4747 if (!consumerd32_bin
) {
4751 consumerd32_bin_override
= 1;
4753 } else if (string_match(optname
, "consumerd32-libdir")) {
4754 if (!arg
|| *arg
== '\0') {
4758 if (lttng_is_setuid_setgid()) {
4759 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4760 "--consumerd32-libdir");
4762 if (consumerd32_libdir_override
) {
4763 free((void *) consumerd32_libdir
);
4765 consumerd32_libdir
= strdup(arg
);
4766 if (!consumerd32_libdir
) {
4770 consumerd32_libdir_override
= 1;
4772 } else if (string_match(optname
, "consumerd64-path")) {
4773 if (!arg
|| *arg
== '\0') {
4777 if (lttng_is_setuid_setgid()) {
4778 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4779 "--consumerd64-path");
4781 if (consumerd64_bin_override
) {
4782 free((void *) consumerd64_bin
);
4784 consumerd64_bin
= strdup(arg
);
4785 if (!consumerd64_bin
) {
4789 consumerd64_bin_override
= 1;
4791 } else if (string_match(optname
, "consumerd64-libdir")) {
4792 if (!arg
|| *arg
== '\0') {
4796 if (lttng_is_setuid_setgid()) {
4797 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4798 "--consumerd64-libdir");
4800 if (consumerd64_libdir_override
) {
4801 free((void *) consumerd64_libdir
);
4803 consumerd64_libdir
= strdup(arg
);
4804 if (!consumerd64_libdir
) {
4808 consumerd64_libdir_override
= 1;
4810 } else if (string_match(optname
, "pidfile") || opt
== 'p') {
4811 if (!arg
|| *arg
== '\0') {
4815 if (lttng_is_setuid_setgid()) {
4816 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4820 opt_pidfile
= strdup(arg
);
4826 } else if (string_match(optname
, "agent-tcp-port")) {
4827 if (!arg
|| *arg
== '\0') {
4831 if (lttng_is_setuid_setgid()) {
4832 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4833 "--agent-tcp-port");
4842 v
= strtoul(arg
, NULL
, 0);
4843 if (errno
!= 0 || !isdigit(arg
[0])) {
4844 ERR("Wrong value in --agent-tcp-port parameter: %s", arg
);
4847 if (v
== 0 || v
>= 65535) {
4848 ERR("Port overflow in --agent-tcp-port parameter: %s", arg
);
4851 agent_tcp_port
= (uint32_t) v
;
4852 DBG3("Agent TCP port set to non default: %u", agent_tcp_port
);
4854 } else if (string_match(optname
, "load") || opt
== 'l') {
4855 if (!arg
|| *arg
== '\0') {
4859 if (lttng_is_setuid_setgid()) {
4860 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4863 free(opt_load_session_path
);
4864 opt_load_session_path
= strdup(arg
);
4865 if (!opt_load_session_path
) {
4870 } else if (string_match(optname
, "kmod-probes")) {
4871 if (!arg
|| *arg
== '\0') {
4875 if (lttng_is_setuid_setgid()) {
4876 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4879 free(kmod_probes_list
);
4880 kmod_probes_list
= strdup(arg
);
4881 if (!kmod_probes_list
) {
4886 } else if (string_match(optname
, "extra-kmod-probes")) {
4887 if (!arg
|| *arg
== '\0') {
4891 if (lttng_is_setuid_setgid()) {
4892 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4893 "--extra-kmod-probes");
4895 free(kmod_extra_probes_list
);
4896 kmod_extra_probes_list
= strdup(arg
);
4897 if (!kmod_extra_probes_list
) {
4902 } else if (string_match(optname
, "config") || opt
== 'f') {
4903 /* This is handled in set_options() thus silent skip. */
4906 /* Unknown option or other error.
4907 * Error is printed by getopt, just return */
4912 if (ret
== -EINVAL
) {
4913 const char *opt_name
= "unknown";
4916 for (i
= 0; i
< sizeof(long_options
) / sizeof(struct option
);
4918 if (opt
== long_options
[i
].val
) {
4919 opt_name
= long_options
[i
].name
;
4924 WARN("Invalid argument provided for option \"%s\", using default value.",
4932 * config_entry_handler_cb used to handle options read from a config file.
4933 * See config_entry_handler_cb comment in common/config/config.h for the
4934 * return value conventions.
4936 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
4940 if (!entry
|| !entry
->name
|| !entry
->value
) {
4945 /* Check if the option is to be ignored */
4946 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
4947 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
4952 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1;
4955 /* Ignore if not fully matched. */
4956 if (strcmp(entry
->name
, long_options
[i
].name
)) {
4961 * If the option takes no argument on the command line, we have to
4962 * check if the value is "true". We support non-zero numeric values,
4965 if (!long_options
[i
].has_arg
) {
4966 ret
= config_parse_value(entry
->value
);
4969 WARN("Invalid configuration value \"%s\" for option %s",
4970 entry
->value
, entry
->name
);
4972 /* False, skip boolean config option. */
4977 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
4981 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry
->name
);
4988 * daemon configuration loading and argument parsing
4990 static int set_options(int argc
, char **argv
)
4992 int ret
= 0, c
= 0, option_index
= 0;
4993 int orig_optopt
= optopt
, orig_optind
= optind
;
4995 const char *config_path
= NULL
;
4997 optstring
= utils_generate_optstring(long_options
,
4998 sizeof(long_options
) / sizeof(struct option
));
5004 /* Check for the --config option */
5005 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
5006 &option_index
)) != -1) {
5010 } else if (c
!= 'f') {
5011 /* if not equal to --config option. */
5015 if (lttng_is_setuid_setgid()) {
5016 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5019 config_path
= utils_expand_path(optarg
);
5021 ERR("Failed to resolve path: %s", optarg
);
5026 ret
= config_get_section_entries(config_path
, config_section_name
,
5027 config_entry_handler
, NULL
);
5030 ERR("Invalid configuration option at line %i", ret
);
5036 /* Reset getopt's global state */
5037 optopt
= orig_optopt
;
5038 optind
= orig_optind
;
5042 * getopt_long() will not set option_index if it encounters a
5045 c
= getopt_long(argc
, argv
, optstring
, long_options
,
5052 * Pass NULL as the long option name if popt left the index
5055 ret
= set_option(c
, optarg
,
5056 option_index
< 0 ? NULL
:
5057 long_options
[option_index
].name
);
5069 * Creates the two needed socket by the daemon.
5070 * apps_sock - The communication socket for all UST apps.
5071 * client_sock - The communication of the cli tool (lttng).
5073 static int init_daemon_socket(void)
5078 old_umask
= umask(0);
5080 /* Create client tool unix socket */
5081 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5082 if (client_sock
< 0) {
5083 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5088 /* Set the cloexec flag */
5089 ret
= utils_set_fd_cloexec(client_sock
);
5091 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
5092 "Continuing but note that the consumer daemon will have a "
5093 "reference to this socket on exec()", client_sock
);
5096 /* File permission MUST be 660 */
5097 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5099 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5104 /* Create the application unix socket */
5105 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5106 if (apps_sock
< 0) {
5107 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5112 /* Set the cloexec flag */
5113 ret
= utils_set_fd_cloexec(apps_sock
);
5115 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
5116 "Continuing but note that the consumer daemon will have a "
5117 "reference to this socket on exec()", apps_sock
);
5120 /* File permission MUST be 666 */
5121 ret
= chmod(apps_unix_sock_path
,
5122 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5124 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5129 DBG3("Session daemon client socket %d and application socket %d created",
5130 client_sock
, apps_sock
);
5138 * Check if the global socket is available, and if a daemon is answering at the
5139 * other side. If yes, error is returned.
5141 static int check_existing_daemon(void)
5143 /* Is there anybody out there ? */
5144 if (lttng_session_daemon_alive()) {
5152 * Set the tracing group gid onto the client socket.
5154 * Race window between mkdir and chown is OK because we are going from more
5155 * permissive (root.root) to less permissive (root.tracing).
5157 static int set_permissions(char *rundir
)
5162 gid
= utils_get_group_id(tracing_group_name
);
5164 /* Set lttng run dir */
5165 ret
= chown(rundir
, 0, gid
);
5167 ERR("Unable to set group on %s", rundir
);
5172 * Ensure all applications and tracing group can search the run
5173 * dir. Allow everyone to read the directory, since it does not
5174 * buy us anything to hide its content.
5176 ret
= chmod(rundir
, S_IRWXU
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
5178 ERR("Unable to set permissions on %s", rundir
);
5182 /* lttng client socket path */
5183 ret
= chown(client_unix_sock_path
, 0, gid
);
5185 ERR("Unable to set group on %s", client_unix_sock_path
);
5189 /* kconsumer error socket path */
5190 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, 0);
5192 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5196 /* 64-bit ustconsumer error socket path */
5197 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, 0);
5199 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5203 /* 32-bit ustconsumer compat32 error socket path */
5204 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, 0);
5206 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5210 DBG("All permissions are set");
5216 * Create the lttng run directory needed for all global sockets and pipe.
5218 static int create_lttng_rundir(const char *rundir
)
5222 DBG3("Creating LTTng run directory: %s", rundir
);
5224 ret
= mkdir(rundir
, S_IRWXU
);
5226 if (errno
!= EEXIST
) {
5227 ERR("Unable to create %s", rundir
);
5239 * Setup sockets and directory needed by the kconsumerd communication with the
5242 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5246 char path
[PATH_MAX
];
5248 switch (consumer_data
->type
) {
5249 case LTTNG_CONSUMER_KERNEL
:
5250 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5252 case LTTNG_CONSUMER64_UST
:
5253 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5255 case LTTNG_CONSUMER32_UST
:
5256 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5259 ERR("Consumer type unknown");
5264 DBG2("Creating consumer directory: %s", path
);
5266 ret
= mkdir(path
, S_IRWXU
| S_IRGRP
| S_IXGRP
);
5268 if (errno
!= EEXIST
) {
5270 ERR("Failed to create %s", path
);
5276 ret
= chown(path
, 0, utils_get_group_id(tracing_group_name
));
5278 ERR("Unable to set group on %s", path
);
5284 /* Create the kconsumerd error unix socket */
5285 consumer_data
->err_sock
=
5286 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5287 if (consumer_data
->err_sock
< 0) {
5288 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5294 * Set the CLOEXEC flag. Return code is useless because either way, the
5297 ret
= utils_set_fd_cloexec(consumer_data
->err_sock
);
5299 PERROR("utils_set_fd_cloexec");
5300 /* continue anyway */
5303 /* File permission MUST be 660 */
5304 ret
= chmod(consumer_data
->err_unix_sock_path
,
5305 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5307 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5317 * Signal handler for the daemon
5319 * Simply stop all worker threads, leaving main() return gracefully after
5320 * joining all threads and calling cleanup().
5322 static void sighandler(int sig
)
5326 DBG("SIGPIPE caught");
5329 DBG("SIGINT caught");
5333 DBG("SIGTERM caught");
5337 CMM_STORE_SHARED(recv_child_signal
, 1);
5345 * Setup signal handler for :
5346 * SIGINT, SIGTERM, SIGPIPE
5348 static int set_signal_handler(void)
5351 struct sigaction sa
;
5354 if ((ret
= sigemptyset(&sigset
)) < 0) {
5355 PERROR("sigemptyset");
5359 sa
.sa_handler
= sighandler
;
5360 sa
.sa_mask
= sigset
;
5362 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5363 PERROR("sigaction");
5367 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5368 PERROR("sigaction");
5372 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5373 PERROR("sigaction");
5377 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
5378 PERROR("sigaction");
5382 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
5388 * Set open files limit to unlimited. This daemon can open a large number of
5389 * file descriptors in order to consumer multiple kernel traces.
5391 static void set_ulimit(void)
5396 /* The kernel does not allowed an infinite limit for open files */
5397 lim
.rlim_cur
= 65535;
5398 lim
.rlim_max
= 65535;
5400 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5402 PERROR("failed to set open files limit");
5407 * Write pidfile using the rundir and opt_pidfile.
5409 static int write_pidfile(void)
5412 char pidfile_path
[PATH_MAX
];
5417 if (lttng_strncpy(pidfile_path
, opt_pidfile
, sizeof(pidfile_path
))) {
5422 /* Build pidfile path from rundir and opt_pidfile. */
5423 ret
= snprintf(pidfile_path
, sizeof(pidfile_path
), "%s/"
5424 DEFAULT_LTTNG_SESSIOND_PIDFILE
, rundir
);
5426 PERROR("snprintf pidfile path");
5432 * Create pid file in rundir.
5434 ret
= utils_create_pid_file(getpid(), pidfile_path
);
5440 * Create lockfile using the rundir and return its fd.
5442 static int create_lockfile(void)
5445 char lockfile_path
[PATH_MAX
];
5447 ret
= generate_lock_file_path(lockfile_path
, sizeof(lockfile_path
));
5452 ret
= utils_create_lock_file(lockfile_path
);
5458 * Write agent TCP port using the rundir.
5460 static int write_agent_port(void)
5463 char path
[PATH_MAX
];
5467 ret
= snprintf(path
, sizeof(path
), "%s/"
5468 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
, rundir
);
5470 PERROR("snprintf agent port path");
5475 * Create TCP agent port file in rundir.
5477 ret
= utils_create_pid_file(agent_tcp_port
, path
);
5486 int main(int argc
, char **argv
)
5488 int ret
= 0, retval
= 0;
5490 const char *home_path
, *env_app_timeout
;
5492 /* Initialize agent apps ht global variable */
5493 agent_apps_ht_by_sock
= NULL
;
5495 init_kernel_workarounds();
5497 rcu_register_thread();
5499 if (set_signal_handler()) {
5501 goto exit_set_signal_handler
;
5504 setup_consumerd_path();
5506 page_size
= sysconf(_SC_PAGESIZE
);
5507 if (page_size
< 0) {
5508 PERROR("sysconf _SC_PAGESIZE");
5509 page_size
= LONG_MAX
;
5510 WARN("Fallback page size to %ld", page_size
);
5514 * Parse arguments and load the daemon configuration file.
5516 * We have an exit_options exit path to free memory reserved by
5517 * set_options. This is needed because the rest of sessiond_cleanup()
5518 * depends on ht_cleanup_thread, which depends on lttng_daemonize, which
5519 * depends on set_options.
5522 if (set_options(argc
, argv
)) {
5528 if (opt_daemon
|| opt_background
) {
5531 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
5539 * We are in the child. Make sure all other file descriptors are
5540 * closed, in case we are called with more opened file
5541 * descriptors than the standard ones.
5543 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5548 if (run_as_create_worker(argv
[0]) < 0) {
5549 goto exit_create_run_as_worker_cleanup
;
5553 * Starting from here, we can create threads. This needs to be after
5554 * lttng_daemonize due to RCU.
5558 * Initialize the health check subsystem. This call should set the
5559 * appropriate time values.
5561 health_sessiond
= health_app_create(NR_HEALTH_SESSIOND_TYPES
);
5562 if (!health_sessiond
) {
5563 PERROR("health_app_create error");
5565 goto exit_health_sessiond_cleanup
;
5568 if (init_ht_cleanup_quit_pipe()) {
5570 goto exit_ht_cleanup_quit_pipe
;
5573 /* Setup the thread ht_cleanup communication pipe. */
5574 if (utils_create_pipe_cloexec(ht_cleanup_pipe
)) {
5576 goto exit_ht_cleanup_pipe
;
5579 /* Set up max poll set size */
5580 if (lttng_poll_set_max_size()) {
5582 goto exit_set_max_size
;
5585 /* Create thread to clean up RCU hash tables */
5586 ret
= pthread_create(&ht_cleanup_thread
, NULL
,
5587 thread_ht_cleanup
, (void *) NULL
);
5590 PERROR("pthread_create ht_cleanup");
5592 goto exit_ht_cleanup
;
5595 /* Create thread quit pipe */
5596 if (init_thread_quit_pipe()) {
5598 goto exit_init_data
;
5601 /* Check if daemon is UID = 0 */
5602 is_root
= !getuid();
5605 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5608 goto exit_init_data
;
5611 /* Create global run dir with root access */
5612 if (create_lttng_rundir(rundir
)) {
5614 goto exit_init_data
;
5617 if (strlen(apps_unix_sock_path
) == 0) {
5618 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5619 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5622 goto exit_init_data
;
5626 if (strlen(client_unix_sock_path
) == 0) {
5627 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5628 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5631 goto exit_init_data
;
5635 /* Set global SHM for ust */
5636 if (strlen(wait_shm_path
) == 0) {
5637 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5638 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5641 goto exit_init_data
;
5645 if (strlen(health_unix_sock_path
) == 0) {
5646 ret
= snprintf(health_unix_sock_path
,
5647 sizeof(health_unix_sock_path
),
5648 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5651 goto exit_init_data
;
5655 /* Setup kernel consumerd path */
5656 ret
= snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5657 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5660 goto exit_init_data
;
5662 ret
= snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5663 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5666 goto exit_init_data
;
5669 DBG2("Kernel consumer err path: %s",
5670 kconsumer_data
.err_unix_sock_path
);
5671 DBG2("Kernel consumer cmd path: %s",
5672 kconsumer_data
.cmd_unix_sock_path
);
5674 home_path
= utils_get_home_dir();
5675 if (home_path
== NULL
) {
5676 /* TODO: Add --socket PATH option */
5677 ERR("Can't get HOME directory for sockets creation.");
5679 goto exit_init_data
;
5683 * Create rundir from home path. This will create something like
5686 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5689 goto exit_init_data
;
5692 if (create_lttng_rundir(rundir
)) {
5694 goto exit_init_data
;
5697 if (strlen(apps_unix_sock_path
) == 0) {
5698 ret
= snprintf(apps_unix_sock_path
, PATH_MAX
,
5699 DEFAULT_HOME_APPS_UNIX_SOCK
,
5703 goto exit_init_data
;
5707 /* Set the cli tool unix socket path */
5708 if (strlen(client_unix_sock_path
) == 0) {
5709 ret
= snprintf(client_unix_sock_path
, PATH_MAX
,
5710 DEFAULT_HOME_CLIENT_UNIX_SOCK
,
5714 goto exit_init_data
;
5718 /* Set global SHM for ust */
5719 if (strlen(wait_shm_path
) == 0) {
5720 ret
= snprintf(wait_shm_path
, PATH_MAX
,
5721 DEFAULT_HOME_APPS_WAIT_SHM_PATH
,
5725 goto exit_init_data
;
5729 /* Set health check Unix path */
5730 if (strlen(health_unix_sock_path
) == 0) {
5731 ret
= snprintf(health_unix_sock_path
,
5732 sizeof(health_unix_sock_path
),
5733 DEFAULT_HOME_HEALTH_UNIX_SOCK
,
5737 goto exit_init_data
;
5742 lockfile_fd
= create_lockfile();
5743 if (lockfile_fd
< 0) {
5745 goto exit_init_data
;
5748 /* Set consumer initial state */
5749 kernel_consumerd_state
= CONSUMER_STOPPED
;
5750 ust_consumerd_state
= CONSUMER_STOPPED
;
5752 DBG("Client socket path %s", client_unix_sock_path
);
5753 DBG("Application socket path %s", apps_unix_sock_path
);
5754 DBG("Application wait path %s", wait_shm_path
);
5755 DBG("LTTng run directory path: %s", rundir
);
5757 /* 32 bits consumerd path setup */
5758 ret
= snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
5759 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
5761 PERROR("snprintf 32-bit consumer error socket path");
5763 goto exit_init_data
;
5765 ret
= snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
5766 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
5768 PERROR("snprintf 32-bit consumer command socket path");
5770 goto exit_init_data
;
5773 DBG2("UST consumer 32 bits err path: %s",
5774 ustconsumer32_data
.err_unix_sock_path
);
5775 DBG2("UST consumer 32 bits cmd path: %s",
5776 ustconsumer32_data
.cmd_unix_sock_path
);
5778 /* 64 bits consumerd path setup */
5779 ret
= snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
5780 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
5782 PERROR("snprintf 64-bit consumer error socket path");
5784 goto exit_init_data
;
5786 ret
= snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
5787 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
5789 PERROR("snprintf 64-bit consumer command socket path");
5791 goto exit_init_data
;
5794 DBG2("UST consumer 64 bits err path: %s",
5795 ustconsumer64_data
.err_unix_sock_path
);
5796 DBG2("UST consumer 64 bits cmd path: %s",
5797 ustconsumer64_data
.cmd_unix_sock_path
);
5800 * See if daemon already exist.
5802 if (check_existing_daemon()) {
5803 ERR("Already running daemon.\n");
5805 * We do not goto exit because we must not cleanup()
5806 * because a daemon is already running.
5809 goto exit_init_data
;
5813 * Init UST app hash table. Alloc hash table before this point since
5814 * cleanup() can get called after that point.
5816 if (ust_app_ht_alloc()) {
5817 ERR("Failed to allocate UST app hash table");
5819 goto exit_init_data
;
5823 * Initialize agent app hash table. We allocate the hash table here
5824 * since cleanup() can get called after this point.
5826 if (agent_app_ht_alloc()) {
5827 ERR("Failed to allocate Agent app hash table");
5829 goto exit_init_data
;
5833 * These actions must be executed as root. We do that *after* setting up
5834 * the sockets path because we MUST make the check for another daemon using
5835 * those paths *before* trying to set the kernel consumer sockets and init
5839 if (set_consumer_sockets(&kconsumer_data
, rundir
)) {
5841 goto exit_init_data
;
5844 /* Setup kernel tracer */
5845 if (!opt_no_kernel
) {
5846 init_kernel_tracer();
5847 if (kernel_tracer_fd
>= 0) {
5848 ret
= syscall_init_table();
5850 ERR("Unable to populate syscall table. "
5851 "Syscall tracing won't work "
5852 "for this session daemon.");
5857 /* Set ulimit for open files */
5860 /* init lttng_fd tracking must be done after set_ulimit. */
5863 if (set_consumer_sockets(&ustconsumer64_data
, rundir
)) {
5865 goto exit_init_data
;
5868 if (set_consumer_sockets(&ustconsumer32_data
, rundir
)) {
5870 goto exit_init_data
;
5873 /* Setup the needed unix socket */
5874 if (init_daemon_socket()) {
5876 goto exit_init_data
;
5879 /* Set credentials to socket */
5880 if (is_root
&& set_permissions(rundir
)) {
5882 goto exit_init_data
;
5885 /* Get parent pid if -S, --sig-parent is specified. */
5886 if (opt_sig_parent
) {
5890 /* Setup the kernel pipe for waking up the kernel thread */
5891 if (is_root
&& !opt_no_kernel
) {
5892 if (utils_create_pipe_cloexec(kernel_poll_pipe
)) {
5894 goto exit_init_data
;
5898 /* Setup the thread apps communication pipe. */
5899 if (utils_create_pipe_cloexec(apps_cmd_pipe
)) {
5901 goto exit_init_data
;
5904 /* Setup the thread apps notify communication pipe. */
5905 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe
)) {
5907 goto exit_init_data
;
5910 /* Initialize global buffer per UID and PID registry. */
5911 buffer_reg_init_uid_registry();
5912 buffer_reg_init_pid_registry();
5914 /* Init UST command queue. */
5915 cds_wfcq_init(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
5918 * Get session list pointer. This pointer MUST NOT be free'd. This list
5919 * is statically declared in session.c
5921 session_list_ptr
= session_get_list();
5925 /* Check for the application socket timeout env variable. */
5926 env_app_timeout
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
5927 if (env_app_timeout
) {
5928 app_socket_timeout
= atoi(env_app_timeout
);
5930 app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
;
5933 ret
= write_pidfile();
5935 ERR("Error in write_pidfile");
5937 goto exit_init_data
;
5939 ret
= write_agent_port();
5941 ERR("Error in write_agent_port");
5943 goto exit_init_data
;
5946 /* Initialize communication library */
5948 /* Initialize TCP timeout values */
5949 lttcomm_inet_init();
5951 if (load_session_init_data(&load_info
) < 0) {
5953 goto exit_init_data
;
5955 load_info
->path
= opt_load_session_path
;
5957 /* Create health-check thread */
5958 ret
= pthread_create(&health_thread
, NULL
,
5959 thread_manage_health
, (void *) NULL
);
5962 PERROR("pthread_create health");
5967 /* Create thread to manage the client socket */
5968 ret
= pthread_create(&client_thread
, NULL
,
5969 thread_manage_clients
, (void *) NULL
);
5972 PERROR("pthread_create clients");
5977 /* Create thread to dispatch registration */
5978 ret
= pthread_create(&dispatch_thread
, NULL
,
5979 thread_dispatch_ust_registration
, (void *) NULL
);
5982 PERROR("pthread_create dispatch");
5987 /* Create thread to manage application registration. */
5988 ret
= pthread_create(®_apps_thread
, NULL
,
5989 thread_registration_apps
, (void *) NULL
);
5992 PERROR("pthread_create registration");
5997 /* Create thread to manage application socket */
5998 ret
= pthread_create(&apps_thread
, NULL
,
5999 thread_manage_apps
, (void *) NULL
);
6002 PERROR("pthread_create apps");
6007 /* Create thread to manage application notify socket */
6008 ret
= pthread_create(&apps_notify_thread
, NULL
,
6009 ust_thread_manage_notify
, (void *) NULL
);
6012 PERROR("pthread_create notify");
6014 goto exit_apps_notify
;
6017 /* Create agent registration thread. */
6018 ret
= pthread_create(&agent_reg_thread
, NULL
,
6019 agent_thread_manage_registration
, (void *) NULL
);
6022 PERROR("pthread_create agent");
6024 goto exit_agent_reg
;
6027 /* Don't start this thread if kernel tracing is not requested nor root */
6028 if (is_root
&& !opt_no_kernel
) {
6029 /* Create kernel thread to manage kernel event */
6030 ret
= pthread_create(&kernel_thread
, NULL
,
6031 thread_manage_kernel
, (void *) NULL
);
6034 PERROR("pthread_create kernel");
6040 /* Create session loading thread. */
6041 ret
= pthread_create(&load_session_thread
, NULL
, thread_load_session
,
6045 PERROR("pthread_create load_session_thread");
6047 goto exit_load_session
;
6051 * This is where we start awaiting program completion (e.g. through
6052 * signal that asks threads to teardown).
6055 ret
= pthread_join(load_session_thread
, &status
);
6058 PERROR("pthread_join load_session_thread");
6063 if (is_root
&& !opt_no_kernel
) {
6064 ret
= pthread_join(kernel_thread
, &status
);
6067 PERROR("pthread_join");
6073 ret
= pthread_join(agent_reg_thread
, &status
);
6076 PERROR("pthread_join agent");
6081 ret
= pthread_join(apps_notify_thread
, &status
);
6084 PERROR("pthread_join apps notify");
6089 ret
= pthread_join(apps_thread
, &status
);
6092 PERROR("pthread_join apps");
6097 ret
= pthread_join(reg_apps_thread
, &status
);
6100 PERROR("pthread_join");
6106 * Join dispatch thread after joining reg_apps_thread to ensure
6107 * we don't leak applications in the queue.
6109 ret
= pthread_join(dispatch_thread
, &status
);
6112 PERROR("pthread_join");
6117 ret
= pthread_join(client_thread
, &status
);
6120 PERROR("pthread_join");
6125 ret
= pthread_join(health_thread
, &status
);
6128 PERROR("pthread_join health thread");
6135 * sessiond_cleanup() is called when no other thread is running, except
6136 * the ht_cleanup thread, which is needed to destroy the hash tables.
6138 rcu_thread_online();
6140 rcu_thread_offline();
6141 rcu_unregister_thread();
6143 ret
= notify_thread_pipe(ht_cleanup_quit_pipe
[1]);
6145 ERR("write error on ht_cleanup quit pipe");
6149 ret
= pthread_join(ht_cleanup_thread
, &status
);
6152 PERROR("pthread_join ht cleanup thread");
6158 utils_close_pipe(ht_cleanup_pipe
);
6159 exit_ht_cleanup_pipe
:
6162 * Close the ht_cleanup quit pipe.
6164 utils_close_pipe(ht_cleanup_quit_pipe
);
6165 exit_ht_cleanup_quit_pipe
:
6167 health_app_destroy(health_sessiond
);
6168 exit_health_sessiond_cleanup
:
6169 exit_create_run_as_worker_cleanup
:
6172 /* Ensure all prior call_rcu are done. */
6175 sessiond_cleanup_options();
6177 exit_set_signal_handler
: