2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
32 #include <sys/mount.h>
33 #include <sys/resource.h>
34 #include <sys/socket.h>
36 #include <sys/types.h>
38 #include <urcu/uatomic.h>
42 #include <common/common.h>
43 #include <common/compat/socket.h>
44 #include <common/defaults.h>
45 #include <common/kernel-consumer/kernel-consumer.h>
46 #include <common/futex.h>
47 #include <common/relayd/relayd.h>
48 #include <common/utils.h>
49 #include <common/daemonize.h>
50 #include <common/config/config.h>
52 #include "lttng-sessiond.h"
53 #include "buffer-registry.h"
60 #include "kernel-consumer.h"
64 #include "ust-consumer.h"
67 #include "health-sessiond.h"
68 #include "testpoint.h"
69 #include "ust-thread.h"
70 #include "agent-thread.h"
72 #include "load-session-thread.h"
74 #define CONSUMERD_FILE "lttng-consumerd"
77 static const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
78 static int tracing_group_name_override
;
79 static char *opt_pidfile
;
80 static int opt_sig_parent
;
81 static int opt_verbose_consumer
;
82 static int opt_daemon
, opt_background
;
83 static int opt_no_kernel
;
84 static char *opt_load_session_path
;
85 static pid_t ppid
; /* Parent PID for --sig-parent option */
86 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
88 static int lockfile_fd
= -1;
90 /* Set to 1 when a SIGUSR1 signal is received. */
91 static int recv_child_signal
;
94 * Consumer daemon specific control data. Every value not initialized here is
95 * set to 0 by the static definition.
97 static struct consumer_data kconsumer_data
= {
98 .type
= LTTNG_CONSUMER_KERNEL
,
99 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
100 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
103 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
104 .lock
= PTHREAD_MUTEX_INITIALIZER
,
105 .cond
= PTHREAD_COND_INITIALIZER
,
106 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
108 static struct consumer_data ustconsumer64_data
= {
109 .type
= LTTNG_CONSUMER64_UST
,
110 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
111 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
114 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
115 .lock
= PTHREAD_MUTEX_INITIALIZER
,
116 .cond
= PTHREAD_COND_INITIALIZER
,
117 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
119 static struct consumer_data ustconsumer32_data
= {
120 .type
= LTTNG_CONSUMER32_UST
,
121 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
122 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
125 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
126 .lock
= PTHREAD_MUTEX_INITIALIZER
,
127 .cond
= PTHREAD_COND_INITIALIZER
,
128 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
131 /* Command line options */
132 static const struct option long_options
[] = {
133 { "client-sock", 1, 0, 'c' },
134 { "apps-sock", 1, 0, 'a' },
135 { "kconsumerd-cmd-sock", 1, 0, 'C' },
136 { "kconsumerd-err-sock", 1, 0, 'E' },
137 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
138 { "ustconsumerd32-err-sock", 1, 0, 'H' },
139 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
140 { "ustconsumerd64-err-sock", 1, 0, 'F' },
141 { "consumerd32-path", 1, 0, 'u' },
142 { "consumerd32-libdir", 1, 0, 'U' },
143 { "consumerd64-path", 1, 0, 't' },
144 { "consumerd64-libdir", 1, 0, 'T' },
145 { "daemonize", 0, 0, 'd' },
146 { "background", 0, 0, 'b' },
147 { "sig-parent", 0, 0, 'S' },
148 { "help", 0, 0, 'h' },
149 { "group", 1, 0, 'g' },
150 { "version", 0, 0, 'V' },
151 { "quiet", 0, 0, 'q' },
152 { "verbose", 0, 0, 'v' },
153 { "verbose-consumer", 0, 0, 'Z' },
154 { "no-kernel", 0, 0, 'N' },
155 { "pidfile", 1, 0, 'p' },
156 { "agent-tcp-port", 1, 0, 'J' },
157 { "config", 1, 0, 'f' },
158 { "load", 1, 0, 'l' },
159 { "kmod-probes", 1, 0, 'P' },
160 { "extra-kmod-probes", 1, 0, 'e' },
164 /* Command line options to ignore from configuration file */
165 static const char *config_ignore_options
[] = { "help", "version", "config" };
167 /* Shared between threads */
168 static int dispatch_thread_exit
;
170 /* Global application Unix socket path */
171 static char apps_unix_sock_path
[PATH_MAX
];
172 /* Global client Unix socket path */
173 static char client_unix_sock_path
[PATH_MAX
];
174 /* global wait shm path for UST */
175 static char wait_shm_path
[PATH_MAX
];
176 /* Global health check unix path */
177 static char health_unix_sock_path
[PATH_MAX
];
179 /* Sockets and FDs */
180 static int client_sock
= -1;
181 static int apps_sock
= -1;
182 int kernel_tracer_fd
= -1;
183 static int kernel_poll_pipe
[2] = { -1, -1 };
186 * Quit pipe for all threads. This permits a single cancellation point
187 * for all threads when receiving an event on the pipe.
189 static int thread_quit_pipe
[2] = { -1, -1 };
192 * This pipe is used to inform the thread managing application communication
193 * that a command is queued and ready to be processed.
195 static int apps_cmd_pipe
[2] = { -1, -1 };
197 int apps_cmd_notify_pipe
[2] = { -1, -1 };
199 /* Pthread, Mutexes and Semaphores */
200 static pthread_t apps_thread
;
201 static pthread_t apps_notify_thread
;
202 static pthread_t reg_apps_thread
;
203 static pthread_t client_thread
;
204 static pthread_t kernel_thread
;
205 static pthread_t dispatch_thread
;
206 static pthread_t health_thread
;
207 static pthread_t ht_cleanup_thread
;
208 static pthread_t agent_reg_thread
;
209 static pthread_t load_session_thread
;
212 * UST registration command queue. This queue is tied with a futex and uses a N
213 * wakers / 1 waiter implemented and detailed in futex.c/.h
215 * The thread_registration_apps and thread_dispatch_ust_registration uses this
216 * queue along with the wait/wake scheme. The thread_manage_apps receives down
217 * the line new application socket and monitors it for any I/O error or clean
218 * close that triggers an unregistration of the application.
220 static struct ust_cmd_queue ust_cmd_queue
;
223 * Pointer initialized before thread creation.
225 * This points to the tracing session list containing the session count and a
226 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
227 * MUST NOT be taken if you call a public function in session.c.
229 * The lock is nested inside the structure: session_list_ptr->lock. Please use
230 * session_lock_list and session_unlock_list for lock acquisition.
232 static struct ltt_session_list
*session_list_ptr
;
234 int ust_consumerd64_fd
= -1;
235 int ust_consumerd32_fd
= -1;
237 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
238 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
239 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
240 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
241 static int consumerd32_bin_override
;
242 static int consumerd64_bin_override
;
243 static int consumerd32_libdir_override
;
244 static int consumerd64_libdir_override
;
246 static const char *module_proc_lttng
= "/proc/lttng";
249 * Consumer daemon state which is changed when spawning it, killing it or in
250 * case of a fatal error.
252 enum consumerd_state
{
253 CONSUMER_STARTED
= 1,
254 CONSUMER_STOPPED
= 2,
259 * This consumer daemon state is used to validate if a client command will be
260 * able to reach the consumer. If not, the client is informed. For instance,
261 * doing a "lttng start" when the consumer state is set to ERROR will return an
262 * error to the client.
264 * The following example shows a possible race condition of this scheme:
266 * consumer thread error happens
268 * client cmd checks state -> still OK
269 * consumer thread exit, sets error
270 * client cmd try to talk to consumer
273 * However, since the consumer is a different daemon, we have no way of making
274 * sure the command will reach it safely even with this state flag. This is why
275 * we consider that up to the state validation during command processing, the
276 * command is safe. After that, we can not guarantee the correctness of the
277 * client request vis-a-vis the consumer.
279 static enum consumerd_state ust_consumerd_state
;
280 static enum consumerd_state kernel_consumerd_state
;
283 * Socket timeout for receiving and sending in seconds.
285 static int app_socket_timeout
;
287 /* Set in main() with the current page size. */
290 /* Application health monitoring */
291 struct health_app
*health_sessiond
;
293 /* Agent TCP port for registration. Used by the agent thread. */
294 unsigned int agent_tcp_port
= DEFAULT_AGENT_TCP_PORT
;
296 /* Am I root or not. */
297 int is_root
; /* Set to 1 if the daemon is running as root */
299 const char * const config_section_name
= "sessiond";
301 /* Load session thread information to operate. */
302 struct load_session_thread_data
*load_info
;
305 * Whether sessiond is ready for commands/health check requests.
306 * NR_LTTNG_SESSIOND_READY must match the number of calls to
307 * sessiond_notify_ready().
309 #define NR_LTTNG_SESSIOND_READY 3
310 int lttng_sessiond_ready
= NR_LTTNG_SESSIOND_READY
;
312 /* Notify parents that we are ready for cmd and health check */
314 void sessiond_notify_ready(void)
316 if (uatomic_sub_return(<tng_sessiond_ready
, 1) == 0) {
318 * Notify parent pid that we are ready to accept command
319 * for client side. This ppid is the one from the
320 * external process that spawned us.
322 if (opt_sig_parent
) {
327 * Notify the parent of the fork() process that we are
330 if (opt_daemon
|| opt_background
) {
331 kill(child_ppid
, SIGUSR1
);
337 void setup_consumerd_path(void)
339 const char *bin
, *libdir
;
342 * Allow INSTALL_BIN_PATH to be used as a target path for the
343 * native architecture size consumer if CONFIG_CONSUMER*_PATH
344 * has not been defined.
346 #if (CAA_BITS_PER_LONG == 32)
347 if (!consumerd32_bin
[0]) {
348 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
350 if (!consumerd32_libdir
[0]) {
351 consumerd32_libdir
= INSTALL_LIB_PATH
;
353 #elif (CAA_BITS_PER_LONG == 64)
354 if (!consumerd64_bin
[0]) {
355 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
357 if (!consumerd64_libdir
[0]) {
358 consumerd64_libdir
= INSTALL_LIB_PATH
;
361 #error "Unknown bitness"
365 * runtime env. var. overrides the build default.
367 bin
= getenv("LTTNG_CONSUMERD32_BIN");
369 consumerd32_bin
= bin
;
371 bin
= getenv("LTTNG_CONSUMERD64_BIN");
373 consumerd64_bin
= bin
;
375 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
377 consumerd32_libdir
= libdir
;
379 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
381 consumerd64_libdir
= libdir
;
386 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
388 int sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
)
394 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
400 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
| LPOLLERR
);
412 * Check if the thread quit pipe was triggered.
414 * Return 1 if it was triggered else 0;
416 int sessiond_check_thread_quit_pipe(int fd
, uint32_t events
)
418 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
426 * Init thread quit pipe.
428 * Return -1 on error or 0 if all pipes are created.
430 static int init_thread_quit_pipe(void)
434 ret
= pipe(thread_quit_pipe
);
436 PERROR("thread quit pipe");
440 for (i
= 0; i
< 2; i
++) {
441 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
453 * Stop all threads by closing the thread quit pipe.
455 static void stop_threads(void)
459 /* Stopping all threads */
460 DBG("Terminating all threads");
461 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
463 ERR("write error on thread quit pipe");
466 /* Dispatch thread */
467 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
468 futex_nto1_wake(&ust_cmd_queue
.futex
);
472 * Close every consumer sockets.
474 static void close_consumer_sockets(void)
478 if (kconsumer_data
.err_sock
>= 0) {
479 ret
= close(kconsumer_data
.err_sock
);
481 PERROR("kernel consumer err_sock close");
484 if (ustconsumer32_data
.err_sock
>= 0) {
485 ret
= close(ustconsumer32_data
.err_sock
);
487 PERROR("UST consumerd32 err_sock close");
490 if (ustconsumer64_data
.err_sock
>= 0) {
491 ret
= close(ustconsumer64_data
.err_sock
);
493 PERROR("UST consumerd64 err_sock close");
496 if (kconsumer_data
.cmd_sock
>= 0) {
497 ret
= close(kconsumer_data
.cmd_sock
);
499 PERROR("kernel consumer cmd_sock close");
502 if (ustconsumer32_data
.cmd_sock
>= 0) {
503 ret
= close(ustconsumer32_data
.cmd_sock
);
505 PERROR("UST consumerd32 cmd_sock close");
508 if (ustconsumer64_data
.cmd_sock
>= 0) {
509 ret
= close(ustconsumer64_data
.cmd_sock
);
511 PERROR("UST consumerd64 cmd_sock close");
517 * Generate the full lock file path using the rundir.
519 * Return the snprintf() return value thus a negative value is an error.
521 static int generate_lock_file_path(char *path
, size_t len
)
528 /* Build lockfile path from rundir. */
529 ret
= snprintf(path
, len
, "%s/" DEFAULT_LTTNG_SESSIOND_LOCKFILE
, rundir
);
531 PERROR("snprintf lockfile path");
540 static void cleanup(void)
543 struct ltt_session
*sess
, *stmp
;
549 * Close the thread quit pipe. It has already done its job,
550 * since we are now called.
552 utils_close_pipe(thread_quit_pipe
);
555 * If opt_pidfile is undefined, the default file will be wiped when
556 * removing the rundir.
559 ret
= remove(opt_pidfile
);
561 PERROR("remove pidfile %s", opt_pidfile
);
565 DBG("Removing sessiond and consumerd content of directory %s", rundir
);
568 snprintf(path
, PATH_MAX
,
570 rundir
, DEFAULT_LTTNG_SESSIOND_PIDFILE
);
571 DBG("Removing %s", path
);
574 snprintf(path
, PATH_MAX
, "%s/%s", rundir
,
575 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
);
576 DBG("Removing %s", path
);
580 snprintf(path
, PATH_MAX
,
581 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
583 DBG("Removing %s", path
);
586 snprintf(path
, PATH_MAX
,
587 DEFAULT_KCONSUMERD_PATH
,
589 DBG("Removing directory %s", path
);
592 /* ust consumerd 32 */
593 snprintf(path
, PATH_MAX
,
594 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
596 DBG("Removing %s", path
);
599 snprintf(path
, PATH_MAX
,
600 DEFAULT_USTCONSUMERD32_PATH
,
602 DBG("Removing directory %s", path
);
605 /* ust consumerd 64 */
606 snprintf(path
, PATH_MAX
,
607 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
609 DBG("Removing %s", path
);
612 snprintf(path
, PATH_MAX
,
613 DEFAULT_USTCONSUMERD64_PATH
,
615 DBG("Removing directory %s", path
);
618 DBG("Cleaning up all sessions");
620 /* Destroy session list mutex */
621 if (session_list_ptr
!= NULL
) {
622 pthread_mutex_destroy(&session_list_ptr
->lock
);
624 /* Cleanup ALL session */
625 cds_list_for_each_entry_safe(sess
, stmp
,
626 &session_list_ptr
->head
, list
) {
627 cmd_destroy_session(sess
, kernel_poll_pipe
[1]);
631 DBG("Closing all UST sockets");
632 ust_app_clean_list();
633 buffer_reg_destroy_registries();
635 if (is_root
&& !opt_no_kernel
) {
636 DBG2("Closing kernel fd");
637 if (kernel_tracer_fd
>= 0) {
638 ret
= close(kernel_tracer_fd
);
643 DBG("Unloading kernel modules");
644 modprobe_remove_lttng_all();
647 close_consumer_sockets();
650 * If the override option is set, the pointer points to a *non* const thus
651 * freeing it even though the variable type is set to const.
653 if (tracing_group_name_override
) {
654 free((void *) tracing_group_name
);
656 if (consumerd32_bin_override
) {
657 free((void *) consumerd32_bin
);
659 if (consumerd64_bin_override
) {
660 free((void *) consumerd64_bin
);
662 if (consumerd32_libdir_override
) {
663 free((void *) consumerd32_libdir
);
665 if (consumerd64_libdir_override
) {
666 free((void *) consumerd64_libdir
);
673 if (opt_load_session_path
) {
674 free(opt_load_session_path
);
678 load_session_destroy_data(load_info
);
683 * Cleanup lock file by deleting it and finaly closing it which will
684 * release the file system lock.
686 if (lockfile_fd
>= 0) {
687 char lockfile_path
[PATH_MAX
];
689 ret
= generate_lock_file_path(lockfile_path
, sizeof(lockfile_path
));
691 ret
= remove(lockfile_path
);
693 PERROR("remove lock file");
695 ret
= close(lockfile_fd
);
697 PERROR("close lock file");
703 * We do NOT rmdir rundir because there are other processes
704 * using it, for instance lttng-relayd, which can start in
705 * parallel with this teardown.
711 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
712 "Matthew, BEET driven development works!%c[%dm",
713 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
718 * Send data on a unix socket using the liblttsessiondcomm API.
720 * Return lttcomm error code.
722 static int send_unix_sock(int sock
, void *buf
, size_t len
)
724 /* Check valid length */
729 return lttcomm_send_unix_sock(sock
, buf
, len
);
733 * Free memory of a command context structure.
735 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
737 DBG("Clean command context structure");
739 if ((*cmd_ctx
)->llm
) {
740 free((*cmd_ctx
)->llm
);
742 if ((*cmd_ctx
)->lsm
) {
743 free((*cmd_ctx
)->lsm
);
751 * Notify UST applications using the shm mmap futex.
753 static int notify_ust_apps(int active
)
757 DBG("Notifying applications of session daemon state: %d", active
);
759 /* See shm.c for this call implying mmap, shm and futex calls */
760 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
761 if (wait_shm_mmap
== NULL
) {
765 /* Wake waiting process */
766 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
768 /* Apps notified successfully */
776 * Setup the outgoing data buffer for the response (llm) by allocating the
777 * right amount of memory and copying the original information from the lsm
780 * Return total size of the buffer pointed by buf.
782 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
788 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
789 if (cmd_ctx
->llm
== NULL
) {
795 /* Copy common data */
796 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
797 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
799 cmd_ctx
->llm
->data_size
= size
;
800 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
809 * Update the kernel poll set of all channel fd available over all tracing
810 * session. Add the wakeup pipe at the end of the set.
812 static int update_kernel_poll(struct lttng_poll_event
*events
)
815 struct ltt_session
*session
;
816 struct ltt_kernel_channel
*channel
;
818 DBG("Updating kernel poll set");
821 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
822 session_lock(session
);
823 if (session
->kernel_session
== NULL
) {
824 session_unlock(session
);
828 cds_list_for_each_entry(channel
,
829 &session
->kernel_session
->channel_list
.head
, list
) {
830 /* Add channel fd to the kernel poll set */
831 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
833 session_unlock(session
);
836 DBG("Channel fd %d added to kernel set", channel
->fd
);
838 session_unlock(session
);
840 session_unlock_list();
845 session_unlock_list();
850 * Find the channel fd from 'fd' over all tracing session. When found, check
851 * for new channel stream and send those stream fds to the kernel consumer.
853 * Useful for CPU hotplug feature.
855 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
858 struct ltt_session
*session
;
859 struct ltt_kernel_session
*ksess
;
860 struct ltt_kernel_channel
*channel
;
862 DBG("Updating kernel streams for channel fd %d", fd
);
865 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
866 session_lock(session
);
867 if (session
->kernel_session
== NULL
) {
868 session_unlock(session
);
871 ksess
= session
->kernel_session
;
873 cds_list_for_each_entry(channel
, &ksess
->channel_list
.head
, list
) {
874 if (channel
->fd
== fd
) {
875 DBG("Channel found, updating kernel streams");
876 ret
= kernel_open_channel_stream(channel
);
880 /* Update the stream global counter */
881 ksess
->stream_count_global
+= ret
;
884 * Have we already sent fds to the consumer? If yes, it means
885 * that tracing is started so it is safe to send our updated
888 if (ksess
->consumer_fds_sent
== 1 && ksess
->consumer
!= NULL
) {
889 struct lttng_ht_iter iter
;
890 struct consumer_socket
*socket
;
893 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
894 &iter
.iter
, socket
, node
.node
) {
895 pthread_mutex_lock(socket
->lock
);
896 ret
= kernel_consumer_send_channel_stream(socket
,
898 session
->output_traces
? 1 : 0);
899 pthread_mutex_unlock(socket
->lock
);
910 session_unlock(session
);
912 session_unlock_list();
916 session_unlock(session
);
917 session_unlock_list();
922 * For each tracing session, update newly registered apps. The session list
923 * lock MUST be acquired before calling this.
925 static void update_ust_app(int app_sock
)
927 struct ltt_session
*sess
, *stmp
;
929 /* Consumer is in an ERROR state. Stop any application update. */
930 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
931 /* Stop the update process since the consumer is dead. */
935 /* For all tracing session(s) */
936 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
938 if (sess
->ust_session
) {
939 ust_app_global_update(sess
->ust_session
, app_sock
);
941 session_unlock(sess
);
946 * This thread manage event coming from the kernel.
948 * Features supported in this thread:
951 static void *thread_manage_kernel(void *data
)
953 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
954 uint32_t revents
, nb_fd
;
956 struct lttng_poll_event events
;
958 DBG("[thread] Thread manage kernel started");
960 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_KERNEL
);
963 * This first step of the while is to clean this structure which could free
964 * non NULL pointers so initialize it before the loop.
966 lttng_poll_init(&events
);
968 if (testpoint(sessiond_thread_manage_kernel
)) {
969 goto error_testpoint
;
972 health_code_update();
974 if (testpoint(sessiond_thread_manage_kernel_before_loop
)) {
975 goto error_testpoint
;
979 health_code_update();
981 if (update_poll_flag
== 1) {
982 /* Clean events object. We are about to populate it again. */
983 lttng_poll_clean(&events
);
985 ret
= sessiond_set_thread_pollset(&events
, 2);
987 goto error_poll_create
;
990 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
995 /* This will add the available kernel channel if any. */
996 ret
= update_kernel_poll(&events
);
1000 update_poll_flag
= 0;
1003 DBG("Thread kernel polling on %d fds", LTTNG_POLL_GETNB(&events
));
1005 /* Poll infinite value of time */
1007 health_poll_entry();
1008 ret
= lttng_poll_wait(&events
, -1);
1012 * Restart interrupted system call.
1014 if (errno
== EINTR
) {
1018 } else if (ret
== 0) {
1019 /* Should not happen since timeout is infinite */
1020 ERR("Return value of poll is 0 with an infinite timeout.\n"
1021 "This should not have happened! Continuing...");
1027 for (i
= 0; i
< nb_fd
; i
++) {
1028 /* Fetch once the poll data */
1029 revents
= LTTNG_POLL_GETEV(&events
, i
);
1030 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1032 health_code_update();
1034 /* Thread quit pipe has been closed. Killing thread. */
1035 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1041 /* Check for data on kernel pipe */
1042 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
1043 (void) lttng_read(kernel_poll_pipe
[0],
1046 * Ret value is useless here, if this pipe gets any actions an
1047 * update is required anyway.
1049 update_poll_flag
= 1;
1053 * New CPU detected by the kernel. Adding kernel stream to
1054 * kernel session and updating the kernel consumer
1056 if (revents
& LPOLLIN
) {
1057 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
1063 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
1064 * and unregister kernel stream at this point.
1073 lttng_poll_clean(&events
);
1076 utils_close_pipe(kernel_poll_pipe
);
1077 kernel_poll_pipe
[0] = kernel_poll_pipe
[1] = -1;
1080 ERR("Health error occurred in %s", __func__
);
1081 WARN("Kernel thread died unexpectedly. "
1082 "Kernel tracing can continue but CPU hotplug is disabled.");
1084 health_unregister(health_sessiond
);
1085 DBG("Kernel thread dying");
1090 * Signal pthread condition of the consumer data that the thread.
1092 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
1094 pthread_mutex_lock(&data
->cond_mutex
);
1097 * The state is set before signaling. It can be any value, it's the waiter
1098 * job to correctly interpret this condition variable associated to the
1099 * consumer pthread_cond.
1101 * A value of 0 means that the corresponding thread of the consumer data
1102 * was not started. 1 indicates that the thread has started and is ready
1103 * for action. A negative value means that there was an error during the
1106 data
->consumer_thread_is_ready
= state
;
1107 (void) pthread_cond_signal(&data
->cond
);
1109 pthread_mutex_unlock(&data
->cond_mutex
);
1113 * This thread manage the consumer error sent back to the session daemon.
1115 static void *thread_manage_consumer(void *data
)
1117 int sock
= -1, i
, ret
, pollfd
, err
= -1;
1118 uint32_t revents
, nb_fd
;
1119 enum lttcomm_return_code code
;
1120 struct lttng_poll_event events
;
1121 struct consumer_data
*consumer_data
= data
;
1123 DBG("[thread] Manage consumer started");
1125 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CONSUMER
);
1127 health_code_update();
1130 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1131 * metadata_sock. Nothing more will be added to this poll set.
1133 ret
= sessiond_set_thread_pollset(&events
, 3);
1139 * The error socket here is already in a listening state which was done
1140 * just before spawning this thread to avoid a race between the consumer
1141 * daemon exec trying to connect and the listen() call.
1143 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
1148 health_code_update();
1150 /* Infinite blocking call, waiting for transmission */
1152 health_poll_entry();
1154 if (testpoint(sessiond_thread_manage_consumer
)) {
1158 ret
= lttng_poll_wait(&events
, -1);
1162 * Restart interrupted system call.
1164 if (errno
== EINTR
) {
1172 for (i
= 0; i
< nb_fd
; i
++) {
1173 /* Fetch once the poll data */
1174 revents
= LTTNG_POLL_GETEV(&events
, i
);
1175 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1177 health_code_update();
1179 /* Thread quit pipe has been closed. Killing thread. */
1180 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1186 /* Event on the registration socket */
1187 if (pollfd
== consumer_data
->err_sock
) {
1188 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1189 ERR("consumer err socket poll error");
1195 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1201 * Set the CLOEXEC flag. Return code is useless because either way, the
1204 (void) utils_set_fd_cloexec(sock
);
1206 health_code_update();
1208 DBG2("Receiving code from consumer err_sock");
1210 /* Getting status code from kconsumerd */
1211 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1212 sizeof(enum lttcomm_return_code
));
1217 health_code_update();
1218 if (code
== LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
1219 /* Connect both socket, command and metadata. */
1220 consumer_data
->cmd_sock
=
1221 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1222 consumer_data
->metadata_fd
=
1223 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1224 if (consumer_data
->cmd_sock
< 0
1225 || consumer_data
->metadata_fd
< 0) {
1226 PERROR("consumer connect cmd socket");
1227 /* On error, signal condition and quit. */
1228 signal_consumer_condition(consumer_data
, -1);
1231 consumer_data
->metadata_sock
.fd_ptr
= &consumer_data
->metadata_fd
;
1232 /* Create metadata socket lock. */
1233 consumer_data
->metadata_sock
.lock
= zmalloc(sizeof(pthread_mutex_t
));
1234 if (consumer_data
->metadata_sock
.lock
== NULL
) {
1235 PERROR("zmalloc pthread mutex");
1239 pthread_mutex_init(consumer_data
->metadata_sock
.lock
, NULL
);
1241 signal_consumer_condition(consumer_data
, 1);
1242 DBG("Consumer command socket ready (fd: %d", consumer_data
->cmd_sock
);
1243 DBG("Consumer metadata socket ready (fd: %d)",
1244 consumer_data
->metadata_fd
);
1246 ERR("consumer error when waiting for SOCK_READY : %s",
1247 lttcomm_get_readable_code(-code
));
1251 /* Remove the consumerd error sock since we've established a connexion */
1252 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1257 /* Add new accepted error socket. */
1258 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1263 /* Add metadata socket that is successfully connected. */
1264 ret
= lttng_poll_add(&events
, consumer_data
->metadata_fd
,
1265 LPOLLIN
| LPOLLRDHUP
);
1270 health_code_update();
1272 /* Infinite blocking call, waiting for transmission */
1275 health_poll_entry();
1276 ret
= lttng_poll_wait(&events
, -1);
1280 * Restart interrupted system call.
1282 if (errno
== EINTR
) {
1290 for (i
= 0; i
< nb_fd
; i
++) {
1291 /* Fetch once the poll data */
1292 revents
= LTTNG_POLL_GETEV(&events
, i
);
1293 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1295 health_code_update();
1297 /* Thread quit pipe has been closed. Killing thread. */
1298 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1304 if (pollfd
== sock
) {
1305 /* Event on the consumerd socket */
1306 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1307 ERR("consumer err socket second poll error");
1310 health_code_update();
1311 /* Wait for any kconsumerd error */
1312 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1313 sizeof(enum lttcomm_return_code
));
1315 ERR("consumer closed the command socket");
1319 ERR("consumer return code : %s",
1320 lttcomm_get_readable_code(-code
));
1323 } else if (pollfd
== consumer_data
->metadata_fd
) {
1324 /* UST metadata requests */
1325 ret
= ust_consumer_metadata_request(
1326 &consumer_data
->metadata_sock
);
1328 ERR("Handling metadata request");
1333 ERR("Unknown pollfd");
1337 health_code_update();
1343 * We lock here because we are about to close the sockets and some other
1344 * thread might be using them so get exclusive access which will abort all
1345 * other consumer command by other threads.
1347 pthread_mutex_lock(&consumer_data
->lock
);
1349 /* Immediately set the consumerd state to stopped */
1350 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1351 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1352 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1353 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1354 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1356 /* Code flow error... */
1360 if (consumer_data
->err_sock
>= 0) {
1361 ret
= close(consumer_data
->err_sock
);
1365 consumer_data
->err_sock
= -1;
1367 if (consumer_data
->cmd_sock
>= 0) {
1368 ret
= close(consumer_data
->cmd_sock
);
1372 consumer_data
->cmd_sock
= -1;
1374 if (consumer_data
->metadata_sock
.fd_ptr
&&
1375 *consumer_data
->metadata_sock
.fd_ptr
>= 0) {
1376 ret
= close(*consumer_data
->metadata_sock
.fd_ptr
);
1388 unlink(consumer_data
->err_unix_sock_path
);
1389 unlink(consumer_data
->cmd_unix_sock_path
);
1390 consumer_data
->pid
= 0;
1391 pthread_mutex_unlock(&consumer_data
->lock
);
1393 /* Cleanup metadata socket mutex. */
1394 if (consumer_data
->metadata_sock
.lock
) {
1395 pthread_mutex_destroy(consumer_data
->metadata_sock
.lock
);
1396 free(consumer_data
->metadata_sock
.lock
);
1398 lttng_poll_clean(&events
);
1402 ERR("Health error occurred in %s", __func__
);
1404 health_unregister(health_sessiond
);
1405 DBG("consumer thread cleanup completed");
1411 * This thread manage application communication.
1413 static void *thread_manage_apps(void *data
)
1415 int i
, ret
, pollfd
, err
= -1;
1417 uint32_t revents
, nb_fd
;
1418 struct lttng_poll_event events
;
1420 DBG("[thread] Manage application started");
1422 rcu_register_thread();
1423 rcu_thread_online();
1425 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_MANAGE
);
1427 if (testpoint(sessiond_thread_manage_apps
)) {
1428 goto error_testpoint
;
1431 health_code_update();
1433 ret
= sessiond_set_thread_pollset(&events
, 2);
1435 goto error_poll_create
;
1438 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1443 if (testpoint(sessiond_thread_manage_apps_before_loop
)) {
1447 health_code_update();
1450 DBG("Apps thread polling on %d fds", LTTNG_POLL_GETNB(&events
));
1452 /* Inifinite blocking call, waiting for transmission */
1454 health_poll_entry();
1455 ret
= lttng_poll_wait(&events
, -1);
1459 * Restart interrupted system call.
1461 if (errno
== EINTR
) {
1469 for (i
= 0; i
< nb_fd
; i
++) {
1470 /* Fetch once the poll data */
1471 revents
= LTTNG_POLL_GETEV(&events
, i
);
1472 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1474 health_code_update();
1476 /* Thread quit pipe has been closed. Killing thread. */
1477 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1483 /* Inspect the apps cmd pipe */
1484 if (pollfd
== apps_cmd_pipe
[0]) {
1485 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1486 ERR("Apps command pipe error");
1488 } else if (revents
& LPOLLIN
) {
1492 size_ret
= lttng_read(apps_cmd_pipe
[0], &sock
, sizeof(sock
));
1493 if (size_ret
< sizeof(sock
)) {
1494 PERROR("read apps cmd pipe");
1498 health_code_update();
1501 * We only monitor the error events of the socket. This
1502 * thread does not handle any incoming data from UST
1505 ret
= lttng_poll_add(&events
, sock
,
1506 LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
1511 DBG("Apps with sock %d added to poll set", sock
);
1515 * At this point, we know that a registered application made
1516 * the event at poll_wait.
1518 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1519 /* Removing from the poll set */
1520 ret
= lttng_poll_del(&events
, pollfd
);
1525 /* Socket closed on remote end. */
1526 ust_app_unregister(pollfd
);
1530 health_code_update();
1536 lttng_poll_clean(&events
);
1539 utils_close_pipe(apps_cmd_pipe
);
1540 apps_cmd_pipe
[0] = apps_cmd_pipe
[1] = -1;
1543 * We don't clean the UST app hash table here since already registered
1544 * applications can still be controlled so let them be until the session
1545 * daemon dies or the applications stop.
1550 ERR("Health error occurred in %s", __func__
);
1552 health_unregister(health_sessiond
);
1553 DBG("Application communication apps thread cleanup complete");
1554 rcu_thread_offline();
1555 rcu_unregister_thread();
1560 * Send a socket to a thread This is called from the dispatch UST registration
1561 * thread once all sockets are set for the application.
1563 * The sock value can be invalid, we don't really care, the thread will handle
1564 * it and make the necessary cleanup if so.
1566 * On success, return 0 else a negative value being the errno message of the
1569 static int send_socket_to_thread(int fd
, int sock
)
1574 * It's possible that the FD is set as invalid with -1 concurrently just
1575 * before calling this function being a shutdown state of the thread.
1582 ret
= lttng_write(fd
, &sock
, sizeof(sock
));
1583 if (ret
< sizeof(sock
)) {
1584 PERROR("write apps pipe %d", fd
);
1591 /* All good. Don't send back the write positive ret value. */
1598 * Sanitize the wait queue of the dispatch registration thread meaning removing
1599 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1600 * notify socket is never received.
1602 static void sanitize_wait_queue(struct ust_reg_wait_queue
*wait_queue
)
1604 int ret
, nb_fd
= 0, i
;
1605 unsigned int fd_added
= 0;
1606 struct lttng_poll_event events
;
1607 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1611 lttng_poll_init(&events
);
1613 /* Just skip everything for an empty queue. */
1614 if (!wait_queue
->count
) {
1618 ret
= lttng_poll_create(&events
, wait_queue
->count
, LTTNG_CLOEXEC
);
1623 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1624 &wait_queue
->head
, head
) {
1625 assert(wait_node
->app
);
1626 ret
= lttng_poll_add(&events
, wait_node
->app
->sock
,
1627 LPOLLHUP
| LPOLLERR
);
1640 * Poll but don't block so we can quickly identify the faulty events and
1641 * clean them afterwards from the wait queue.
1643 ret
= lttng_poll_wait(&events
, 0);
1649 for (i
= 0; i
< nb_fd
; i
++) {
1650 /* Get faulty FD. */
1651 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1652 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1654 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1655 &wait_queue
->head
, head
) {
1656 if (pollfd
== wait_node
->app
->sock
&&
1657 (revents
& (LPOLLHUP
| LPOLLERR
))) {
1658 cds_list_del(&wait_node
->head
);
1659 wait_queue
->count
--;
1660 ust_app_destroy(wait_node
->app
);
1668 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd
);
1672 lttng_poll_clean(&events
);
1676 lttng_poll_clean(&events
);
1678 ERR("Unable to sanitize wait queue");
1683 * Dispatch request from the registration threads to the application
1684 * communication thread.
1686 static void *thread_dispatch_ust_registration(void *data
)
1689 struct cds_wfcq_node
*node
;
1690 struct ust_command
*ust_cmd
= NULL
;
1691 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1692 struct ust_reg_wait_queue wait_queue
= {
1696 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH
);
1698 if (testpoint(sessiond_thread_app_reg_dispatch
)) {
1699 goto error_testpoint
;
1702 health_code_update();
1704 CDS_INIT_LIST_HEAD(&wait_queue
.head
);
1706 DBG("[thread] Dispatch UST command started");
1708 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1709 health_code_update();
1711 /* Atomically prepare the queue futex */
1712 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1715 struct ust_app
*app
= NULL
;
1719 * Make sure we don't have node(s) that have hung up before receiving
1720 * the notify socket. This is to clean the list in order to avoid
1721 * memory leaks from notify socket that are never seen.
1723 sanitize_wait_queue(&wait_queue
);
1725 health_code_update();
1726 /* Dequeue command for registration */
1727 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1729 DBG("Woken up but nothing in the UST command queue");
1730 /* Continue thread execution */
1734 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1736 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1737 " gid:%d sock:%d name:%s (version %d.%d)",
1738 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1739 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1740 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1741 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1743 if (ust_cmd
->reg_msg
.type
== USTCTL_SOCKET_CMD
) {
1744 wait_node
= zmalloc(sizeof(*wait_node
));
1746 PERROR("zmalloc wait_node dispatch");
1747 ret
= close(ust_cmd
->sock
);
1749 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1751 lttng_fd_put(LTTNG_FD_APPS
, 1);
1755 CDS_INIT_LIST_HEAD(&wait_node
->head
);
1757 /* Create application object if socket is CMD. */
1758 wait_node
->app
= ust_app_create(&ust_cmd
->reg_msg
,
1760 if (!wait_node
->app
) {
1761 ret
= close(ust_cmd
->sock
);
1763 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1765 lttng_fd_put(LTTNG_FD_APPS
, 1);
1771 * Add application to the wait queue so we can set the notify
1772 * socket before putting this object in the global ht.
1774 cds_list_add(&wait_node
->head
, &wait_queue
.head
);
1779 * We have to continue here since we don't have the notify
1780 * socket and the application MUST be added to the hash table
1781 * only at that moment.
1786 * Look for the application in the local wait queue and set the
1787 * notify socket if found.
1789 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1790 &wait_queue
.head
, head
) {
1791 health_code_update();
1792 if (wait_node
->app
->pid
== ust_cmd
->reg_msg
.pid
) {
1793 wait_node
->app
->notify_sock
= ust_cmd
->sock
;
1794 cds_list_del(&wait_node
->head
);
1796 app
= wait_node
->app
;
1798 DBG3("UST app notify socket %d is set", ust_cmd
->sock
);
1804 * With no application at this stage the received socket is
1805 * basically useless so close it before we free the cmd data
1806 * structure for good.
1809 ret
= close(ust_cmd
->sock
);
1811 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1813 lttng_fd_put(LTTNG_FD_APPS
, 1);
1820 * @session_lock_list
1822 * Lock the global session list so from the register up to the
1823 * registration done message, no thread can see the application
1824 * and change its state.
1826 session_lock_list();
1830 * Add application to the global hash table. This needs to be
1831 * done before the update to the UST registry can locate the
1836 /* Set app version. This call will print an error if needed. */
1837 (void) ust_app_version(app
);
1839 /* Send notify socket through the notify pipe. */
1840 ret
= send_socket_to_thread(apps_cmd_notify_pipe
[1],
1844 session_unlock_list();
1846 * No notify thread, stop the UST tracing. However, this is
1847 * not an internal error of the this thread thus setting
1848 * the health error code to a normal exit.
1855 * Update newly registered application with the tracing
1856 * registry info already enabled information.
1858 update_ust_app(app
->sock
);
1861 * Don't care about return value. Let the manage apps threads
1862 * handle app unregistration upon socket close.
1864 (void) ust_app_register_done(app
->sock
);
1867 * Even if the application socket has been closed, send the app
1868 * to the thread and unregistration will take place at that
1871 ret
= send_socket_to_thread(apps_cmd_pipe
[1], app
->sock
);
1874 session_unlock_list();
1876 * No apps. thread, stop the UST tracing. However, this is
1877 * not an internal error of the this thread thus setting
1878 * the health error code to a normal exit.
1885 session_unlock_list();
1887 } while (node
!= NULL
);
1889 health_poll_entry();
1890 /* Futex wait on queue. Blocking call on futex() */
1891 futex_nto1_wait(&ust_cmd_queue
.futex
);
1894 /* Normal exit, no error */
1898 /* Clean up wait queue. */
1899 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1900 &wait_queue
.head
, head
) {
1901 cds_list_del(&wait_node
->head
);
1907 DBG("Dispatch thread dying");
1910 ERR("Health error occurred in %s", __func__
);
1912 health_unregister(health_sessiond
);
1917 * This thread manage application registration.
1919 static void *thread_registration_apps(void *data
)
1921 int sock
= -1, i
, ret
, pollfd
, err
= -1;
1922 uint32_t revents
, nb_fd
;
1923 struct lttng_poll_event events
;
1925 * Get allocated in this thread, enqueued to a global queue, dequeued and
1926 * freed in the manage apps thread.
1928 struct ust_command
*ust_cmd
= NULL
;
1930 DBG("[thread] Manage application registration started");
1932 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG
);
1934 if (testpoint(sessiond_thread_registration_apps
)) {
1935 goto error_testpoint
;
1938 ret
= lttcomm_listen_unix_sock(apps_sock
);
1944 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1945 * more will be added to this poll set.
1947 ret
= sessiond_set_thread_pollset(&events
, 2);
1949 goto error_create_poll
;
1952 /* Add the application registration socket */
1953 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1955 goto error_poll_add
;
1958 /* Notify all applications to register */
1959 ret
= notify_ust_apps(1);
1961 ERR("Failed to notify applications or create the wait shared memory.\n"
1962 "Execution continues but there might be problem for already\n"
1963 "running applications that wishes to register.");
1967 DBG("Accepting application registration");
1969 /* Inifinite blocking call, waiting for transmission */
1971 health_poll_entry();
1972 ret
= lttng_poll_wait(&events
, -1);
1976 * Restart interrupted system call.
1978 if (errno
== EINTR
) {
1986 for (i
= 0; i
< nb_fd
; i
++) {
1987 health_code_update();
1989 /* Fetch once the poll data */
1990 revents
= LTTNG_POLL_GETEV(&events
, i
);
1991 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1993 /* Thread quit pipe has been closed. Killing thread. */
1994 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
2000 /* Event on the registration socket */
2001 if (pollfd
== apps_sock
) {
2002 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2003 ERR("Register apps socket poll error");
2005 } else if (revents
& LPOLLIN
) {
2006 sock
= lttcomm_accept_unix_sock(apps_sock
);
2012 * Set socket timeout for both receiving and ending.
2013 * app_socket_timeout is in seconds, whereas
2014 * lttcomm_setsockopt_rcv_timeout and
2015 * lttcomm_setsockopt_snd_timeout expect msec as
2018 (void) lttcomm_setsockopt_rcv_timeout(sock
,
2019 app_socket_timeout
* 1000);
2020 (void) lttcomm_setsockopt_snd_timeout(sock
,
2021 app_socket_timeout
* 1000);
2024 * Set the CLOEXEC flag. Return code is useless because
2025 * either way, the show must go on.
2027 (void) utils_set_fd_cloexec(sock
);
2029 /* Create UST registration command for enqueuing */
2030 ust_cmd
= zmalloc(sizeof(struct ust_command
));
2031 if (ust_cmd
== NULL
) {
2032 PERROR("ust command zmalloc");
2037 * Using message-based transmissions to ensure we don't
2038 * have to deal with partially received messages.
2040 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2042 ERR("Exhausted file descriptors allowed for applications.");
2052 health_code_update();
2053 ret
= ust_app_recv_registration(sock
, &ust_cmd
->reg_msg
);
2056 /* Close socket of the application. */
2061 lttng_fd_put(LTTNG_FD_APPS
, 1);
2065 health_code_update();
2067 ust_cmd
->sock
= sock
;
2070 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2071 " gid:%d sock:%d name:%s (version %d.%d)",
2072 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
2073 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
2074 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
2075 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
2078 * Lock free enqueue the registration request. The red pill
2079 * has been taken! This apps will be part of the *system*.
2081 cds_wfcq_enqueue(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
, &ust_cmd
->node
);
2084 * Wake the registration queue futex. Implicit memory
2085 * barrier with the exchange in cds_wfcq_enqueue.
2087 futex_nto1_wake(&ust_cmd_queue
.futex
);
2095 /* Notify that the registration thread is gone */
2098 if (apps_sock
>= 0) {
2099 ret
= close(apps_sock
);
2109 lttng_fd_put(LTTNG_FD_APPS
, 1);
2111 unlink(apps_unix_sock_path
);
2114 lttng_poll_clean(&events
);
2118 DBG("UST Registration thread cleanup complete");
2121 ERR("Health error occurred in %s", __func__
);
2123 health_unregister(health_sessiond
);
2129 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2130 * exec or it will fails.
2132 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
2135 struct timespec timeout
;
2137 /* Make sure we set the readiness flag to 0 because we are NOT ready */
2138 consumer_data
->consumer_thread_is_ready
= 0;
2140 /* Setup pthread condition */
2141 ret
= pthread_condattr_init(&consumer_data
->condattr
);
2144 PERROR("pthread_condattr_init consumer data");
2149 * Set the monotonic clock in order to make sure we DO NOT jump in time
2150 * between the clock_gettime() call and the timedwait call. See bug #324
2151 * for a more details and how we noticed it.
2153 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
2156 PERROR("pthread_condattr_setclock consumer data");
2160 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
2163 PERROR("pthread_cond_init consumer data");
2167 ret
= pthread_create(&consumer_data
->thread
, NULL
, thread_manage_consumer
,
2170 PERROR("pthread_create consumer");
2175 /* We are about to wait on a pthread condition */
2176 pthread_mutex_lock(&consumer_data
->cond_mutex
);
2178 /* Get time for sem_timedwait absolute timeout */
2179 clock_ret
= clock_gettime(CLOCK_MONOTONIC
, &timeout
);
2181 * Set the timeout for the condition timed wait even if the clock gettime
2182 * call fails since we might loop on that call and we want to avoid to
2183 * increment the timeout too many times.
2185 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
2188 * The following loop COULD be skipped in some conditions so this is why we
2189 * set ret to 0 in order to make sure at least one round of the loop is
2195 * Loop until the condition is reached or when a timeout is reached. Note
2196 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2197 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2198 * possible. This loop does not take any chances and works with both of
2201 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
2202 if (clock_ret
< 0) {
2203 PERROR("clock_gettime spawn consumer");
2204 /* Infinite wait for the consumerd thread to be ready */
2205 ret
= pthread_cond_wait(&consumer_data
->cond
,
2206 &consumer_data
->cond_mutex
);
2208 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
2209 &consumer_data
->cond_mutex
, &timeout
);
2213 /* Release the pthread condition */
2214 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
2218 if (ret
== ETIMEDOUT
) {
2222 * Call has timed out so we kill the kconsumerd_thread and return
2225 ERR("Condition timed out. The consumer thread was never ready."
2227 pth_ret
= pthread_cancel(consumer_data
->thread
);
2229 PERROR("pthread_cancel consumer thread");
2232 PERROR("pthread_cond_wait failed consumer thread");
2234 /* Caller is expecting a negative value on failure. */
2239 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2240 if (consumer_data
->pid
== 0) {
2241 ERR("Consumerd did not start");
2242 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2245 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2254 * Join consumer thread
2256 static int join_consumer_thread(struct consumer_data
*consumer_data
)
2260 /* Consumer pid must be a real one. */
2261 if (consumer_data
->pid
> 0) {
2263 ret
= kill(consumer_data
->pid
, SIGTERM
);
2265 ERR("Error killing consumer daemon");
2268 return pthread_join(consumer_data
->thread
, &status
);
2275 * Fork and exec a consumer daemon (consumerd).
2277 * Return pid if successful else -1.
2279 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
2283 const char *consumer_to_use
;
2284 const char *verbosity
;
2287 DBG("Spawning consumerd");
2294 if (opt_verbose_consumer
) {
2295 verbosity
= "--verbose";
2296 } else if (lttng_opt_quiet
) {
2297 verbosity
= "--quiet";
2302 switch (consumer_data
->type
) {
2303 case LTTNG_CONSUMER_KERNEL
:
2305 * Find out which consumerd to execute. We will first try the
2306 * 64-bit path, then the sessiond's installation directory, and
2307 * fallback on the 32-bit one,
2309 DBG3("Looking for a kernel consumer at these locations:");
2310 DBG3(" 1) %s", consumerd64_bin
);
2311 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
2312 DBG3(" 3) %s", consumerd32_bin
);
2313 if (stat(consumerd64_bin
, &st
) == 0) {
2314 DBG3("Found location #1");
2315 consumer_to_use
= consumerd64_bin
;
2316 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
2317 DBG3("Found location #2");
2318 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
2319 } else if (stat(consumerd32_bin
, &st
) == 0) {
2320 DBG3("Found location #3");
2321 consumer_to_use
= consumerd32_bin
;
2323 DBG("Could not find any valid consumerd executable");
2327 DBG("Using kernel consumer at: %s", consumer_to_use
);
2328 ret
= execl(consumer_to_use
,
2329 "lttng-consumerd", verbosity
, "-k",
2330 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2331 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2332 "--group", tracing_group_name
,
2335 case LTTNG_CONSUMER64_UST
:
2337 char *tmpnew
= NULL
;
2339 if (consumerd64_libdir
[0] != '\0') {
2343 tmp
= getenv("LD_LIBRARY_PATH");
2347 tmplen
= strlen("LD_LIBRARY_PATH=")
2348 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
2349 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2354 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2355 strcat(tmpnew
, consumerd64_libdir
);
2356 if (tmp
[0] != '\0') {
2357 strcat(tmpnew
, ":");
2358 strcat(tmpnew
, tmp
);
2360 ret
= putenv(tmpnew
);
2367 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
2368 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
2369 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2370 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2371 "--group", tracing_group_name
,
2373 if (consumerd64_libdir
[0] != '\0') {
2378 case LTTNG_CONSUMER32_UST
:
2380 char *tmpnew
= NULL
;
2382 if (consumerd32_libdir
[0] != '\0') {
2386 tmp
= getenv("LD_LIBRARY_PATH");
2390 tmplen
= strlen("LD_LIBRARY_PATH=")
2391 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
2392 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2397 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
2398 strcat(tmpnew
, consumerd32_libdir
);
2399 if (tmp
[0] != '\0') {
2400 strcat(tmpnew
, ":");
2401 strcat(tmpnew
, tmp
);
2403 ret
= putenv(tmpnew
);
2410 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
2411 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
2412 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2413 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2414 "--group", tracing_group_name
,
2416 if (consumerd32_libdir
[0] != '\0') {
2422 PERROR("unknown consumer type");
2426 PERROR("Consumer execl()");
2428 /* Reaching this point, we got a failure on our execl(). */
2430 } else if (pid
> 0) {
2433 PERROR("start consumer fork");
2441 * Spawn the consumerd daemon and session daemon thread.
2443 static int start_consumerd(struct consumer_data
*consumer_data
)
2448 * Set the listen() state on the socket since there is a possible race
2449 * between the exec() of the consumer daemon and this call if place in the
2450 * consumer thread. See bug #366 for more details.
2452 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
2457 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2458 if (consumer_data
->pid
!= 0) {
2459 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2463 ret
= spawn_consumerd(consumer_data
);
2465 ERR("Spawning consumerd failed");
2466 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2470 /* Setting up the consumer_data pid */
2471 consumer_data
->pid
= ret
;
2472 DBG2("Consumer pid %d", consumer_data
->pid
);
2473 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2475 DBG2("Spawning consumer control thread");
2476 ret
= spawn_consumer_thread(consumer_data
);
2478 ERR("Fatal error spawning consumer control thread");
2486 /* Cleanup already created sockets on error. */
2487 if (consumer_data
->err_sock
>= 0) {
2490 err
= close(consumer_data
->err_sock
);
2492 PERROR("close consumer data error socket");
2499 * Setup necessary data for kernel tracer action.
2501 static int init_kernel_tracer(void)
2505 /* Modprobe lttng kernel modules */
2506 ret
= modprobe_lttng_control();
2511 /* Open debugfs lttng */
2512 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
2513 if (kernel_tracer_fd
< 0) {
2514 DBG("Failed to open %s", module_proc_lttng
);
2519 /* Validate kernel version */
2520 ret
= kernel_validate_version(kernel_tracer_fd
);
2525 ret
= modprobe_lttng_data();
2530 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
2534 modprobe_remove_lttng_control();
2535 ret
= close(kernel_tracer_fd
);
2539 kernel_tracer_fd
= -1;
2540 return LTTNG_ERR_KERN_VERSION
;
2543 ret
= close(kernel_tracer_fd
);
2549 modprobe_remove_lttng_control();
2552 WARN("No kernel tracer available");
2553 kernel_tracer_fd
= -1;
2555 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
2557 return LTTNG_ERR_KERN_NA
;
2563 * Copy consumer output from the tracing session to the domain session. The
2564 * function also applies the right modification on a per domain basis for the
2565 * trace files destination directory.
2567 * Should *NOT* be called with RCU read-side lock held.
2569 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2572 const char *dir_name
;
2573 struct consumer_output
*consumer
;
2576 assert(session
->consumer
);
2579 case LTTNG_DOMAIN_KERNEL
:
2580 DBG3("Copying tracing session consumer output in kernel session");
2582 * XXX: We should audit the session creation and what this function
2583 * does "extra" in order to avoid a destroy since this function is used
2584 * in the domain session creation (kernel and ust) only. Same for UST
2587 if (session
->kernel_session
->consumer
) {
2588 consumer_destroy_output(session
->kernel_session
->consumer
);
2590 session
->kernel_session
->consumer
=
2591 consumer_copy_output(session
->consumer
);
2592 /* Ease our life a bit for the next part */
2593 consumer
= session
->kernel_session
->consumer
;
2594 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2596 case LTTNG_DOMAIN_JUL
:
2597 case LTTNG_DOMAIN_LOG4J
:
2598 case LTTNG_DOMAIN_UST
:
2599 DBG3("Copying tracing session consumer output in UST session");
2600 if (session
->ust_session
->consumer
) {
2601 consumer_destroy_output(session
->ust_session
->consumer
);
2603 session
->ust_session
->consumer
=
2604 consumer_copy_output(session
->consumer
);
2605 /* Ease our life a bit for the next part */
2606 consumer
= session
->ust_session
->consumer
;
2607 dir_name
= DEFAULT_UST_TRACE_DIR
;
2610 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2614 /* Append correct directory to subdir */
2615 strncat(consumer
->subdir
, dir_name
,
2616 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
2617 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2626 * Create an UST session and add it to the session ust list.
2628 * Should *NOT* be called with RCU read-side lock held.
2630 static int create_ust_session(struct ltt_session
*session
,
2631 struct lttng_domain
*domain
)
2634 struct ltt_ust_session
*lus
= NULL
;
2638 assert(session
->consumer
);
2640 switch (domain
->type
) {
2641 case LTTNG_DOMAIN_JUL
:
2642 case LTTNG_DOMAIN_LOG4J
:
2643 case LTTNG_DOMAIN_UST
:
2646 ERR("Unknown UST domain on create session %d", domain
->type
);
2647 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2651 DBG("Creating UST session");
2653 lus
= trace_ust_create_session(session
->id
);
2655 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2659 lus
->uid
= session
->uid
;
2660 lus
->gid
= session
->gid
;
2661 lus
->output_traces
= session
->output_traces
;
2662 lus
->snapshot_mode
= session
->snapshot_mode
;
2663 lus
->live_timer_interval
= session
->live_timer
;
2664 session
->ust_session
= lus
;
2666 /* Copy session output to the newly created UST session */
2667 ret
= copy_session_consumer(domain
->type
, session
);
2668 if (ret
!= LTTNG_OK
) {
2676 session
->ust_session
= NULL
;
2681 * Create a kernel tracer session then create the default channel.
2683 static int create_kernel_session(struct ltt_session
*session
)
2687 DBG("Creating kernel session");
2689 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2691 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2695 /* Code flow safety */
2696 assert(session
->kernel_session
);
2698 /* Copy session output to the newly created Kernel session */
2699 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2700 if (ret
!= LTTNG_OK
) {
2704 /* Create directory(ies) on local filesystem. */
2705 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2706 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2707 ret
= run_as_mkdir_recursive(
2708 session
->kernel_session
->consumer
->dst
.trace_path
,
2709 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2711 if (ret
!= -EEXIST
) {
2712 ERR("Trace directory creation error");
2718 session
->kernel_session
->uid
= session
->uid
;
2719 session
->kernel_session
->gid
= session
->gid
;
2720 session
->kernel_session
->output_traces
= session
->output_traces
;
2721 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
2726 trace_kernel_destroy_session(session
->kernel_session
);
2727 session
->kernel_session
= NULL
;
2732 * Count number of session permitted by uid/gid.
2734 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2737 struct ltt_session
*session
;
2739 DBG("Counting number of available session for UID %d GID %d",
2741 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2743 * Only list the sessions the user can control.
2745 if (!session_access_ok(session
, uid
, gid
)) {
2754 * Process the command requested by the lttng client within the command
2755 * context structure. This function make sure that the return structure (llm)
2756 * is set and ready for transmission before returning.
2758 * Return any error encountered or 0 for success.
2760 * "sock" is only used for special-case var. len data.
2762 * Should *NOT* be called with RCU read-side lock held.
2764 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2768 int need_tracing_session
= 1;
2771 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2775 switch (cmd_ctx
->lsm
->cmd_type
) {
2776 case LTTNG_CREATE_SESSION
:
2777 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2778 case LTTNG_CREATE_SESSION_LIVE
:
2779 case LTTNG_DESTROY_SESSION
:
2780 case LTTNG_LIST_SESSIONS
:
2781 case LTTNG_LIST_DOMAINS
:
2782 case LTTNG_START_TRACE
:
2783 case LTTNG_STOP_TRACE
:
2784 case LTTNG_DATA_PENDING
:
2785 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2786 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2787 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2788 case LTTNG_SNAPSHOT_RECORD
:
2789 case LTTNG_SAVE_SESSION
:
2796 if (opt_no_kernel
&& need_domain
2797 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
2799 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
2801 ret
= LTTNG_ERR_KERN_NA
;
2806 /* Deny register consumer if we already have a spawned consumer. */
2807 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
2808 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2809 if (kconsumer_data
.pid
> 0) {
2810 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2811 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2814 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2818 * Check for command that don't needs to allocate a returned payload. We do
2819 * this here so we don't have to make the call for no payload at each
2822 switch(cmd_ctx
->lsm
->cmd_type
) {
2823 case LTTNG_LIST_SESSIONS
:
2824 case LTTNG_LIST_TRACEPOINTS
:
2825 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2826 case LTTNG_LIST_DOMAINS
:
2827 case LTTNG_LIST_CHANNELS
:
2828 case LTTNG_LIST_EVENTS
:
2831 /* Setup lttng message with no payload */
2832 ret
= setup_lttng_msg(cmd_ctx
, 0);
2834 /* This label does not try to unlock the session */
2835 goto init_setup_error
;
2839 /* Commands that DO NOT need a session. */
2840 switch (cmd_ctx
->lsm
->cmd_type
) {
2841 case LTTNG_CREATE_SESSION
:
2842 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2843 case LTTNG_CREATE_SESSION_LIVE
:
2844 case LTTNG_CALIBRATE
:
2845 case LTTNG_LIST_SESSIONS
:
2846 case LTTNG_LIST_TRACEPOINTS
:
2847 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2848 case LTTNG_SAVE_SESSION
:
2849 need_tracing_session
= 0;
2852 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
2854 * We keep the session list lock across _all_ commands
2855 * for now, because the per-session lock does not
2856 * handle teardown properly.
2858 session_lock_list();
2859 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
2860 if (cmd_ctx
->session
== NULL
) {
2861 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
2864 /* Acquire lock for the session */
2865 session_lock(cmd_ctx
->session
);
2871 * Commands that need a valid session but should NOT create one if none
2872 * exists. Instead of creating one and destroying it when the command is
2873 * handled, process that right before so we save some round trip in useless
2876 switch (cmd_ctx
->lsm
->cmd_type
) {
2877 case LTTNG_DISABLE_CHANNEL
:
2878 case LTTNG_DISABLE_EVENT
:
2879 switch (cmd_ctx
->lsm
->domain
.type
) {
2880 case LTTNG_DOMAIN_KERNEL
:
2881 if (!cmd_ctx
->session
->kernel_session
) {
2882 ret
= LTTNG_ERR_NO_CHANNEL
;
2886 case LTTNG_DOMAIN_JUL
:
2887 case LTTNG_DOMAIN_LOG4J
:
2888 case LTTNG_DOMAIN_UST
:
2889 if (!cmd_ctx
->session
->ust_session
) {
2890 ret
= LTTNG_ERR_NO_CHANNEL
;
2895 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2907 * Check domain type for specific "pre-action".
2909 switch (cmd_ctx
->lsm
->domain
.type
) {
2910 case LTTNG_DOMAIN_KERNEL
:
2912 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
2916 /* Kernel tracer check */
2917 if (kernel_tracer_fd
== -1) {
2918 /* Basically, load kernel tracer modules */
2919 ret
= init_kernel_tracer();
2925 /* Consumer is in an ERROR state. Report back to client */
2926 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
2927 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
2931 /* Need a session for kernel command */
2932 if (need_tracing_session
) {
2933 if (cmd_ctx
->session
->kernel_session
== NULL
) {
2934 ret
= create_kernel_session(cmd_ctx
->session
);
2936 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2941 /* Start the kernel consumer daemon */
2942 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2943 if (kconsumer_data
.pid
== 0 &&
2944 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
2945 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2946 ret
= start_consumerd(&kconsumer_data
);
2948 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2951 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
2953 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2957 * The consumer was just spawned so we need to add the socket to
2958 * the consumer output of the session if exist.
2960 ret
= consumer_create_socket(&kconsumer_data
,
2961 cmd_ctx
->session
->kernel_session
->consumer
);
2968 case LTTNG_DOMAIN_JUL
:
2969 case LTTNG_DOMAIN_LOG4J
:
2970 case LTTNG_DOMAIN_UST
:
2972 if (!ust_app_supported()) {
2973 ret
= LTTNG_ERR_NO_UST
;
2976 /* Consumer is in an ERROR state. Report back to client */
2977 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
2978 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
2982 if (need_tracing_session
) {
2983 /* Create UST session if none exist. */
2984 if (cmd_ctx
->session
->ust_session
== NULL
) {
2985 ret
= create_ust_session(cmd_ctx
->session
,
2986 &cmd_ctx
->lsm
->domain
);
2987 if (ret
!= LTTNG_OK
) {
2992 /* Start the UST consumer daemons */
2994 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
2995 if (consumerd64_bin
[0] != '\0' &&
2996 ustconsumer64_data
.pid
== 0 &&
2997 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
2998 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
2999 ret
= start_consumerd(&ustconsumer64_data
);
3001 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
3002 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
3006 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
3007 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3009 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3013 * Setup socket for consumer 64 bit. No need for atomic access
3014 * since it was set above and can ONLY be set in this thread.
3016 ret
= consumer_create_socket(&ustconsumer64_data
,
3017 cmd_ctx
->session
->ust_session
->consumer
);
3023 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
3024 if (consumerd32_bin
[0] != '\0' &&
3025 ustconsumer32_data
.pid
== 0 &&
3026 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3027 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3028 ret
= start_consumerd(&ustconsumer32_data
);
3030 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
3031 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
3035 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
3036 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3038 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3042 * Setup socket for consumer 64 bit. No need for atomic access
3043 * since it was set above and can ONLY be set in this thread.
3045 ret
= consumer_create_socket(&ustconsumer32_data
,
3046 cmd_ctx
->session
->ust_session
->consumer
);
3058 /* Validate consumer daemon state when start/stop trace command */
3059 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3060 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3061 switch (cmd_ctx
->lsm
->domain
.type
) {
3062 case LTTNG_DOMAIN_JUL
:
3063 case LTTNG_DOMAIN_LOG4J
:
3064 case LTTNG_DOMAIN_UST
:
3065 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3066 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3070 case LTTNG_DOMAIN_KERNEL
:
3071 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3072 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3080 * Check that the UID or GID match that of the tracing session.
3081 * The root user can interact with all sessions.
3083 if (need_tracing_session
) {
3084 if (!session_access_ok(cmd_ctx
->session
,
3085 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3086 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3087 ret
= LTTNG_ERR_EPERM
;
3093 * Send relayd information to consumer as soon as we have a domain and a
3096 if (cmd_ctx
->session
&& need_domain
) {
3098 * Setup relayd if not done yet. If the relayd information was already
3099 * sent to the consumer, this call will gracefully return.
3101 ret
= cmd_setup_relayd(cmd_ctx
->session
);
3102 if (ret
!= LTTNG_OK
) {
3107 /* Process by command type */
3108 switch (cmd_ctx
->lsm
->cmd_type
) {
3109 case LTTNG_ADD_CONTEXT
:
3111 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3112 cmd_ctx
->lsm
->u
.context
.channel_name
,
3113 &cmd_ctx
->lsm
->u
.context
.ctx
, kernel_poll_pipe
[1]);
3116 case LTTNG_DISABLE_CHANNEL
:
3118 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3119 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3122 case LTTNG_DISABLE_EVENT
:
3124 /* FIXME: passing packed structure to non-packed pointer */
3125 /* TODO: handle filter */
3126 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3127 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3128 &cmd_ctx
->lsm
->u
.disable
.event
);
3131 case LTTNG_ENABLE_CHANNEL
:
3133 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3134 &cmd_ctx
->lsm
->u
.channel
.chan
, kernel_poll_pipe
[1]);
3137 case LTTNG_ENABLE_EVENT
:
3139 struct lttng_event_exclusion
*exclusion
= NULL
;
3140 struct lttng_filter_bytecode
*bytecode
= NULL
;
3141 char *filter_expression
= NULL
;
3143 /* Handle exclusion events and receive it from the client. */
3144 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
3145 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
3147 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
3148 (count
* LTTNG_SYMBOL_NAME_LEN
));
3150 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
3154 DBG("Receiving var len exclusion event list from client ...");
3155 exclusion
->count
= count
;
3156 ret
= lttcomm_recv_unix_sock(sock
, exclusion
->names
,
3157 count
* LTTNG_SYMBOL_NAME_LEN
);
3159 DBG("Nothing recv() from client var len data... continuing");
3162 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
3167 /* Get filter expression from client. */
3168 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
3169 size_t expression_len
=
3170 cmd_ctx
->lsm
->u
.enable
.expression_len
;
3172 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
3173 ret
= LTTNG_ERR_FILTER_INVAL
;
3178 filter_expression
= zmalloc(expression_len
);
3179 if (!filter_expression
) {
3181 ret
= LTTNG_ERR_FILTER_NOMEM
;
3185 /* Receive var. len. data */
3186 DBG("Receiving var len filter's expression from client ...");
3187 ret
= lttcomm_recv_unix_sock(sock
, filter_expression
,
3190 DBG("Nothing recv() from client car len data... continuing");
3192 free(filter_expression
);
3194 ret
= LTTNG_ERR_FILTER_INVAL
;
3199 /* Handle filter and get bytecode from client. */
3200 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
3201 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
3203 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
3204 ret
= LTTNG_ERR_FILTER_INVAL
;
3209 bytecode
= zmalloc(bytecode_len
);
3212 ret
= LTTNG_ERR_FILTER_NOMEM
;
3216 /* Receive var. len. data */
3217 DBG("Receiving var len filter's bytecode from client ...");
3218 ret
= lttcomm_recv_unix_sock(sock
, bytecode
, bytecode_len
);
3220 DBG("Nothing recv() from client car len data... continuing");
3224 ret
= LTTNG_ERR_FILTER_INVAL
;
3228 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
3231 ret
= LTTNG_ERR_FILTER_INVAL
;
3236 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3237 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3238 &cmd_ctx
->lsm
->u
.enable
.event
,
3239 filter_expression
, bytecode
, exclusion
,
3240 kernel_poll_pipe
[1]);
3243 case LTTNG_LIST_TRACEPOINTS
:
3245 struct lttng_event
*events
;
3248 session_lock_list();
3249 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3250 session_unlock_list();
3251 if (nb_events
< 0) {
3252 /* Return value is a negative lttng_error_code. */
3258 * Setup lttng message with payload size set to the event list size in
3259 * bytes and then copy list into the llm payload.
3261 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3267 /* Copy event list into message payload */
3268 memcpy(cmd_ctx
->llm
->payload
, events
,
3269 sizeof(struct lttng_event
) * nb_events
);
3276 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3278 struct lttng_event_field
*fields
;
3281 session_lock_list();
3282 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
3284 session_unlock_list();
3285 if (nb_fields
< 0) {
3286 /* Return value is a negative lttng_error_code. */
3292 * Setup lttng message with payload size set to the event list size in
3293 * bytes and then copy list into the llm payload.
3295 ret
= setup_lttng_msg(cmd_ctx
,
3296 sizeof(struct lttng_event_field
) * nb_fields
);
3302 /* Copy event list into message payload */
3303 memcpy(cmd_ctx
->llm
->payload
, fields
,
3304 sizeof(struct lttng_event_field
) * nb_fields
);
3311 case LTTNG_SET_CONSUMER_URI
:
3314 struct lttng_uri
*uris
;
3316 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3317 len
= nb_uri
* sizeof(struct lttng_uri
);
3320 ret
= LTTNG_ERR_INVALID
;
3324 uris
= zmalloc(len
);
3326 ret
= LTTNG_ERR_FATAL
;
3330 /* Receive variable len data */
3331 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
3332 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3334 DBG("No URIs received from client... continuing");
3336 ret
= LTTNG_ERR_SESSION_FAIL
;
3341 ret
= cmd_set_consumer_uri(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3343 if (ret
!= LTTNG_OK
) {
3349 * XXX: 0 means that this URI should be applied on the session. Should
3350 * be a DOMAIN enuam.
3352 if (cmd_ctx
->lsm
->domain
.type
== 0) {
3353 /* Add the URI for the UST session if a consumer is present. */
3354 if (cmd_ctx
->session
->ust_session
&&
3355 cmd_ctx
->session
->ust_session
->consumer
) {
3356 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_UST
, cmd_ctx
->session
,
3358 } else if (cmd_ctx
->session
->kernel_session
&&
3359 cmd_ctx
->session
->kernel_session
->consumer
) {
3360 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_KERNEL
,
3361 cmd_ctx
->session
, nb_uri
, uris
);
3369 case LTTNG_START_TRACE
:
3371 ret
= cmd_start_trace(cmd_ctx
->session
);
3374 case LTTNG_STOP_TRACE
:
3376 ret
= cmd_stop_trace(cmd_ctx
->session
);
3379 case LTTNG_CREATE_SESSION
:
3382 struct lttng_uri
*uris
= NULL
;
3384 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3385 len
= nb_uri
* sizeof(struct lttng_uri
);
3388 uris
= zmalloc(len
);
3390 ret
= LTTNG_ERR_FATAL
;
3394 /* Receive variable len data */
3395 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3396 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3398 DBG("No URIs received from client... continuing");
3400 ret
= LTTNG_ERR_SESSION_FAIL
;
3405 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3406 DBG("Creating session with ONE network URI is a bad call");
3407 ret
= LTTNG_ERR_SESSION_FAIL
;
3413 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
3414 &cmd_ctx
->creds
, 0);
3420 case LTTNG_DESTROY_SESSION
:
3422 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
3424 /* Set session to NULL so we do not unlock it after free. */
3425 cmd_ctx
->session
= NULL
;
3428 case LTTNG_LIST_DOMAINS
:
3431 struct lttng_domain
*domains
;
3433 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3435 /* Return value is a negative lttng_error_code. */
3440 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3446 /* Copy event list into message payload */
3447 memcpy(cmd_ctx
->llm
->payload
, domains
,
3448 nb_dom
* sizeof(struct lttng_domain
));
3455 case LTTNG_LIST_CHANNELS
:
3458 struct lttng_channel
*channels
;
3460 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3461 cmd_ctx
->session
, &channels
);
3463 /* Return value is a negative lttng_error_code. */
3468 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3474 /* Copy event list into message payload */
3475 memcpy(cmd_ctx
->llm
->payload
, channels
,
3476 nb_chan
* sizeof(struct lttng_channel
));
3483 case LTTNG_LIST_EVENTS
:
3486 struct lttng_event
*events
= NULL
;
3488 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3489 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3491 /* Return value is a negative lttng_error_code. */
3496 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3502 /* Copy event list into message payload */
3503 memcpy(cmd_ctx
->llm
->payload
, events
,
3504 nb_event
* sizeof(struct lttng_event
));
3511 case LTTNG_LIST_SESSIONS
:
3513 unsigned int nr_sessions
;
3515 session_lock_list();
3516 nr_sessions
= lttng_sessions_count(
3517 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3518 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3520 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3522 session_unlock_list();
3526 /* Filled the session array */
3527 cmd_list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3528 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3529 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3531 session_unlock_list();
3536 case LTTNG_CALIBRATE
:
3538 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3539 &cmd_ctx
->lsm
->u
.calibrate
);
3542 case LTTNG_REGISTER_CONSUMER
:
3544 struct consumer_data
*cdata
;
3546 switch (cmd_ctx
->lsm
->domain
.type
) {
3547 case LTTNG_DOMAIN_KERNEL
:
3548 cdata
= &kconsumer_data
;
3551 ret
= LTTNG_ERR_UND
;
3555 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3556 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
3559 case LTTNG_DATA_PENDING
:
3561 ret
= cmd_data_pending(cmd_ctx
->session
);
3564 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3566 struct lttcomm_lttng_output_id reply
;
3568 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
3569 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
3570 if (ret
!= LTTNG_OK
) {
3574 ret
= setup_lttng_msg(cmd_ctx
, sizeof(reply
));
3579 /* Copy output list into message payload */
3580 memcpy(cmd_ctx
->llm
->payload
, &reply
, sizeof(reply
));
3584 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3586 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
3587 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
3590 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3593 struct lttng_snapshot_output
*outputs
= NULL
;
3595 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
3596 if (nb_output
< 0) {
3601 ret
= setup_lttng_msg(cmd_ctx
,
3602 nb_output
* sizeof(struct lttng_snapshot_output
));
3609 /* Copy output list into message payload */
3610 memcpy(cmd_ctx
->llm
->payload
, outputs
,
3611 nb_output
* sizeof(struct lttng_snapshot_output
));
3618 case LTTNG_SNAPSHOT_RECORD
:
3620 ret
= cmd_snapshot_record(cmd_ctx
->session
,
3621 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
3622 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
3625 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3628 struct lttng_uri
*uris
= NULL
;
3630 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3631 len
= nb_uri
* sizeof(struct lttng_uri
);
3634 uris
= zmalloc(len
);
3636 ret
= LTTNG_ERR_FATAL
;
3640 /* Receive variable len data */
3641 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3642 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3644 DBG("No URIs received from client... continuing");
3646 ret
= LTTNG_ERR_SESSION_FAIL
;
3651 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3652 DBG("Creating session with ONE network URI is a bad call");
3653 ret
= LTTNG_ERR_SESSION_FAIL
;
3659 ret
= cmd_create_session_snapshot(cmd_ctx
->lsm
->session
.name
, uris
,
3660 nb_uri
, &cmd_ctx
->creds
);
3664 case LTTNG_CREATE_SESSION_LIVE
:
3667 struct lttng_uri
*uris
= NULL
;
3669 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3670 len
= nb_uri
* sizeof(struct lttng_uri
);
3673 uris
= zmalloc(len
);
3675 ret
= LTTNG_ERR_FATAL
;
3679 /* Receive variable len data */
3680 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3681 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3683 DBG("No URIs received from client... continuing");
3685 ret
= LTTNG_ERR_SESSION_FAIL
;
3690 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3691 DBG("Creating session with ONE network URI is a bad call");
3692 ret
= LTTNG_ERR_SESSION_FAIL
;
3698 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
,
3699 nb_uri
, &cmd_ctx
->creds
, cmd_ctx
->lsm
->u
.session_live
.timer_interval
);
3703 case LTTNG_SAVE_SESSION
:
3705 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
3710 ret
= LTTNG_ERR_UND
;
3715 if (cmd_ctx
->llm
== NULL
) {
3716 DBG("Missing llm structure. Allocating one.");
3717 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3721 /* Set return code */
3722 cmd_ctx
->llm
->ret_code
= ret
;
3724 if (cmd_ctx
->session
) {
3725 session_unlock(cmd_ctx
->session
);
3727 if (need_tracing_session
) {
3728 session_unlock_list();
3735 * Thread managing health check socket.
3737 static void *thread_manage_health(void *data
)
3739 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
3740 uint32_t revents
, nb_fd
;
3741 struct lttng_poll_event events
;
3742 struct health_comm_msg msg
;
3743 struct health_comm_reply reply
;
3745 DBG("[thread] Manage health check started");
3747 rcu_register_thread();
3749 /* We might hit an error path before this is created. */
3750 lttng_poll_init(&events
);
3752 /* Create unix socket */
3753 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
3755 ERR("Unable to create health check Unix socket");
3761 /* lttng health client socket path permissions */
3762 ret
= chown(health_unix_sock_path
, 0,
3763 utils_get_group_id(tracing_group_name
));
3765 ERR("Unable to set group on %s", health_unix_sock_path
);
3771 ret
= chmod(health_unix_sock_path
,
3772 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3774 ERR("Unable to set permissions on %s", health_unix_sock_path
);
3782 * Set the CLOEXEC flag. Return code is useless because either way, the
3785 (void) utils_set_fd_cloexec(sock
);
3787 ret
= lttcomm_listen_unix_sock(sock
);
3793 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3794 * more will be added to this poll set.
3796 ret
= sessiond_set_thread_pollset(&events
, 2);
3801 /* Add the application registration socket */
3802 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
3807 sessiond_notify_ready();
3810 DBG("Health check ready");
3812 /* Inifinite blocking call, waiting for transmission */
3814 ret
= lttng_poll_wait(&events
, -1);
3817 * Restart interrupted system call.
3819 if (errno
== EINTR
) {
3827 for (i
= 0; i
< nb_fd
; i
++) {
3828 /* Fetch once the poll data */
3829 revents
= LTTNG_POLL_GETEV(&events
, i
);
3830 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3832 /* Thread quit pipe has been closed. Killing thread. */
3833 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
3839 /* Event on the registration socket */
3840 if (pollfd
== sock
) {
3841 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3842 ERR("Health socket poll error");
3848 new_sock
= lttcomm_accept_unix_sock(sock
);
3854 * Set the CLOEXEC flag. Return code is useless because either way, the
3857 (void) utils_set_fd_cloexec(new_sock
);
3859 DBG("Receiving data from client for health...");
3860 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
3862 DBG("Nothing recv() from client... continuing");
3863 ret
= close(new_sock
);
3871 rcu_thread_online();
3873 memset(&reply
, 0, sizeof(reply
));
3874 for (i
= 0; i
< NR_HEALTH_SESSIOND_TYPES
; i
++) {
3876 * health_check_state returns 0 if health is
3879 if (!health_check_state(health_sessiond
, i
)) {
3880 reply
.ret_code
|= 1ULL << i
;
3884 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
3886 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
3888 ERR("Failed to send health data back to client");
3891 /* End of transmission */
3892 ret
= close(new_sock
);
3902 ERR("Health error occurred in %s", __func__
);
3904 DBG("Health check thread dying");
3905 unlink(health_unix_sock_path
);
3913 lttng_poll_clean(&events
);
3915 rcu_unregister_thread();
3920 * This thread manage all clients request using the unix client socket for
3923 static void *thread_manage_clients(void *data
)
3925 int sock
= -1, ret
, i
, pollfd
, err
= -1;
3927 uint32_t revents
, nb_fd
;
3928 struct command_ctx
*cmd_ctx
= NULL
;
3929 struct lttng_poll_event events
;
3931 DBG("[thread] Manage client started");
3933 rcu_register_thread();
3935 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
3937 health_code_update();
3939 ret
= lttcomm_listen_unix_sock(client_sock
);
3945 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3946 * more will be added to this poll set.
3948 ret
= sessiond_set_thread_pollset(&events
, 2);
3950 goto error_create_poll
;
3953 /* Add the application registration socket */
3954 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3959 sessiond_notify_ready();
3960 ret
= sem_post(&load_info
->message_thread_ready
);
3962 PERROR("sem_post message_thread_ready");
3966 /* This testpoint is after we signal readiness to the parent. */
3967 if (testpoint(sessiond_thread_manage_clients
)) {
3971 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
3975 health_code_update();
3978 DBG("Accepting client command ...");
3980 /* Inifinite blocking call, waiting for transmission */
3982 health_poll_entry();
3983 ret
= lttng_poll_wait(&events
, -1);
3987 * Restart interrupted system call.
3989 if (errno
== EINTR
) {
3997 for (i
= 0; i
< nb_fd
; i
++) {
3998 /* Fetch once the poll data */
3999 revents
= LTTNG_POLL_GETEV(&events
, i
);
4000 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4002 health_code_update();
4004 /* Thread quit pipe has been closed. Killing thread. */
4005 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4011 /* Event on the registration socket */
4012 if (pollfd
== client_sock
) {
4013 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4014 ERR("Client socket poll error");
4020 DBG("Wait for client response");
4022 health_code_update();
4024 sock
= lttcomm_accept_unix_sock(client_sock
);
4030 * Set the CLOEXEC flag. Return code is useless because either way, the
4033 (void) utils_set_fd_cloexec(sock
);
4035 /* Set socket option for credentials retrieval */
4036 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
4041 /* Allocate context command to process the client request */
4042 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
4043 if (cmd_ctx
== NULL
) {
4044 PERROR("zmalloc cmd_ctx");
4048 /* Allocate data buffer for reception */
4049 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
4050 if (cmd_ctx
->lsm
== NULL
) {
4051 PERROR("zmalloc cmd_ctx->lsm");
4055 cmd_ctx
->llm
= NULL
;
4056 cmd_ctx
->session
= NULL
;
4058 health_code_update();
4061 * Data is received from the lttng client. The struct
4062 * lttcomm_session_msg (lsm) contains the command and data request of
4065 DBG("Receiving data from client ...");
4066 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
4067 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
4069 DBG("Nothing recv() from client... continuing");
4075 clean_command_ctx(&cmd_ctx
);
4079 health_code_update();
4081 // TODO: Validate cmd_ctx including sanity check for
4082 // security purpose.
4084 rcu_thread_online();
4086 * This function dispatch the work to the kernel or userspace tracer
4087 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4088 * informations for the client. The command context struct contains
4089 * everything this function may needs.
4091 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
4092 rcu_thread_offline();
4100 * TODO: Inform client somehow of the fatal error. At
4101 * this point, ret < 0 means that a zmalloc failed
4102 * (ENOMEM). Error detected but still accept
4103 * command, unless a socket error has been
4106 clean_command_ctx(&cmd_ctx
);
4110 health_code_update();
4112 DBG("Sending response (size: %d, retcode: %s)",
4113 cmd_ctx
->lttng_msg_size
,
4114 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
4115 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
4117 ERR("Failed to send data back to client");
4120 /* End of transmission */
4127 clean_command_ctx(&cmd_ctx
);
4129 health_code_update();
4141 lttng_poll_clean(&events
);
4142 clean_command_ctx(&cmd_ctx
);
4146 unlink(client_unix_sock_path
);
4147 if (client_sock
>= 0) {
4148 ret
= close(client_sock
);
4156 ERR("Health error occurred in %s", __func__
);
4159 health_unregister(health_sessiond
);
4161 DBG("Client thread dying");
4163 rcu_unregister_thread();
4169 * usage function on stderr
4171 static void usage(void)
4173 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
4174 fprintf(stderr
, " -h, --help Display this usage.\n");
4175 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
4176 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
4177 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
4178 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
4179 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
4180 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
4181 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
4182 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
4183 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
4184 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
4185 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
4186 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
4187 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
4188 fprintf(stderr
, " -b, --background Start as a daemon, keeping console open.\n");
4189 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
4190 fprintf(stderr
, " -V, --version Show version number.\n");
4191 fprintf(stderr
, " -S, --sig-parent Send SIGUSR1 to parent pid to notify readiness.\n");
4192 fprintf(stderr
, " -q, --quiet No output at all.\n");
4193 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
4194 fprintf(stderr
, " -p, --pidfile FILE Write a pid to FILE name overriding the default value.\n");
4195 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
4196 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
4197 fprintf(stderr
, " --agent-tcp-port Agent registration TCP port\n");
4198 fprintf(stderr
, " -f --config Load daemon configuration file\n");
4199 fprintf(stderr
, " -l --load PATH Load session configuration\n");
4200 fprintf(stderr
, " --kmod-probes Specify kernel module probes to load\n");
4201 fprintf(stderr
, " --extra-kmod-probes Specify extra kernel module probes to load\n");
4205 * Take an option from the getopt output and set it in the right variable to be
4208 * Return 0 on success else a negative value.
4210 static int set_option(int opt
, const char *arg
, const char *optname
)
4216 fprintf(stderr
, "option %s", optname
);
4218 fprintf(stderr
, " with arg %s\n", arg
);
4222 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", arg
);
4225 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", arg
);
4235 * If the override option is set, the pointer points to a
4236 * *non* const thus freeing it even though the variable type is
4239 if (tracing_group_name_override
) {
4240 free((void *) tracing_group_name
);
4242 tracing_group_name
= strdup(arg
);
4243 if (!tracing_group_name
) {
4247 tracing_group_name_override
= 1;
4253 fprintf(stdout
, "%s\n", VERSION
);
4259 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4262 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4265 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4268 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4271 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", arg
);
4274 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", arg
);
4280 lttng_opt_quiet
= 1;
4283 /* Verbose level can increase using multiple -v */
4285 /* Value obtained from config file */
4286 lttng_opt_verbose
= config_parse_value(arg
);
4288 /* -v used on command line */
4289 lttng_opt_verbose
++;
4291 /* Clamp value to [0, 3] */
4292 lttng_opt_verbose
= lttng_opt_verbose
< 0 ? 0 :
4293 (lttng_opt_verbose
<= 3 ? lttng_opt_verbose
: 3);
4297 opt_verbose_consumer
= config_parse_value(arg
);
4299 opt_verbose_consumer
+= 1;
4303 if (consumerd32_bin_override
) {
4304 free((void *) consumerd32_bin
);
4306 consumerd32_bin
= strdup(arg
);
4307 if (!consumerd32_bin
) {
4311 consumerd32_bin_override
= 1;
4314 if (consumerd32_libdir_override
) {
4315 free((void *) consumerd32_libdir
);
4317 consumerd32_libdir
= strdup(arg
);
4318 if (!consumerd32_libdir
) {
4322 consumerd32_libdir_override
= 1;
4325 if (consumerd64_bin_override
) {
4326 free((void *) consumerd64_bin
);
4328 consumerd64_bin
= strdup(arg
);
4329 if (!consumerd64_bin
) {
4333 consumerd64_bin_override
= 1;
4336 if (consumerd64_libdir_override
) {
4337 free((void *) consumerd64_libdir
);
4339 consumerd64_libdir
= strdup(arg
);
4340 if (!consumerd64_libdir
) {
4344 consumerd64_libdir_override
= 1;
4348 opt_pidfile
= strdup(arg
);
4354 case 'J': /* Agent TCP port. */
4359 v
= strtoul(arg
, NULL
, 0);
4360 if (errno
!= 0 || !isdigit(arg
[0])) {
4361 ERR("Wrong value in --agent-tcp-port parameter: %s", arg
);
4364 if (v
== 0 || v
>= 65535) {
4365 ERR("Port overflow in --agent-tcp-port parameter: %s", arg
);
4368 agent_tcp_port
= (uint32_t) v
;
4369 DBG3("Agent TCP port set to non default: %u", agent_tcp_port
);
4373 free(opt_load_session_path
);
4374 opt_load_session_path
= strdup(arg
);
4375 if (!opt_load_session_path
) {
4380 case 'P': /* probe modules list */
4381 free(kmod_probes_list
);
4382 kmod_probes_list
= strdup(arg
);
4383 if (!kmod_probes_list
) {
4389 free(kmod_extra_probes_list
);
4390 kmod_extra_probes_list
= strdup(arg
);
4391 if (!kmod_extra_probes_list
) {
4397 /* This is handled in set_options() thus silent break. */
4400 /* Unknown option or other error.
4401 * Error is printed by getopt, just return */
4409 * config_entry_handler_cb used to handle options read from a config file.
4410 * See config_entry_handler_cb comment in common/config/config.h for the
4411 * return value conventions.
4413 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
4417 if (!entry
|| !entry
->name
|| !entry
->value
) {
4422 /* Check if the option is to be ignored */
4423 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
4424 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
4429 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1;
4432 /* Ignore if not fully matched. */
4433 if (strcmp(entry
->name
, long_options
[i
].name
)) {
4438 * If the option takes no argument on the command line, we have to
4439 * check if the value is "true". We support non-zero numeric values,
4442 if (!long_options
[i
].has_arg
) {
4443 ret
= config_parse_value(entry
->value
);
4446 WARN("Invalid configuration value \"%s\" for option %s",
4447 entry
->value
, entry
->name
);
4449 /* False, skip boolean config option. */
4454 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
4458 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry
->name
);
4465 * daemon configuration loading and argument parsing
4467 static int set_options(int argc
, char **argv
)
4469 int ret
= 0, c
= 0, option_index
= 0;
4470 int orig_optopt
= optopt
, orig_optind
= optind
;
4472 const char *config_path
= NULL
;
4474 optstring
= utils_generate_optstring(long_options
,
4475 sizeof(long_options
) / sizeof(struct option
));
4481 /* Check for the --config option */
4482 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
4483 &option_index
)) != -1) {
4487 } else if (c
!= 'f') {
4488 /* if not equal to --config option. */
4492 config_path
= utils_expand_path(optarg
);
4494 ERR("Failed to resolve path: %s", optarg
);
4498 ret
= config_get_section_entries(config_path
, config_section_name
,
4499 config_entry_handler
, NULL
);
4502 ERR("Invalid configuration option at line %i", ret
);
4508 /* Reset getopt's global state */
4509 optopt
= orig_optopt
;
4510 optind
= orig_optind
;
4512 c
= getopt_long(argc
, argv
, optstring
, long_options
, &option_index
);
4517 ret
= set_option(c
, optarg
, long_options
[option_index
].name
);
4529 * Creates the two needed socket by the daemon.
4530 * apps_sock - The communication socket for all UST apps.
4531 * client_sock - The communication of the cli tool (lttng).
4533 static int init_daemon_socket(void)
4538 old_umask
= umask(0);
4540 /* Create client tool unix socket */
4541 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4542 if (client_sock
< 0) {
4543 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4548 /* Set the cloexec flag */
4549 ret
= utils_set_fd_cloexec(client_sock
);
4551 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
4552 "Continuing but note that the consumer daemon will have a "
4553 "reference to this socket on exec()", client_sock
);
4556 /* File permission MUST be 660 */
4557 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4559 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4564 /* Create the application unix socket */
4565 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4566 if (apps_sock
< 0) {
4567 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4572 /* Set the cloexec flag */
4573 ret
= utils_set_fd_cloexec(apps_sock
);
4575 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
4576 "Continuing but note that the consumer daemon will have a "
4577 "reference to this socket on exec()", apps_sock
);
4580 /* File permission MUST be 666 */
4581 ret
= chmod(apps_unix_sock_path
,
4582 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4584 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4589 DBG3("Session daemon client socket %d and application socket %d created",
4590 client_sock
, apps_sock
);
4598 * Check if the global socket is available, and if a daemon is answering at the
4599 * other side. If yes, error is returned.
4601 static int check_existing_daemon(void)
4603 /* Is there anybody out there ? */
4604 if (lttng_session_daemon_alive()) {
4612 * Set the tracing group gid onto the client socket.
4614 * Race window between mkdir and chown is OK because we are going from more
4615 * permissive (root.root) to less permissive (root.tracing).
4617 static int set_permissions(char *rundir
)
4622 gid
= utils_get_group_id(tracing_group_name
);
4624 /* Set lttng run dir */
4625 ret
= chown(rundir
, 0, gid
);
4627 ERR("Unable to set group on %s", rundir
);
4632 * Ensure all applications and tracing group can search the run
4633 * dir. Allow everyone to read the directory, since it does not
4634 * buy us anything to hide its content.
4636 ret
= chmod(rundir
, S_IRWXU
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
4638 ERR("Unable to set permissions on %s", rundir
);
4642 /* lttng client socket path */
4643 ret
= chown(client_unix_sock_path
, 0, gid
);
4645 ERR("Unable to set group on %s", client_unix_sock_path
);
4649 /* kconsumer error socket path */
4650 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, 0);
4652 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4656 /* 64-bit ustconsumer error socket path */
4657 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, 0);
4659 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4663 /* 32-bit ustconsumer compat32 error socket path */
4664 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, 0);
4666 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4670 DBG("All permissions are set");
4676 * Create the lttng run directory needed for all global sockets and pipe.
4678 static int create_lttng_rundir(const char *rundir
)
4682 DBG3("Creating LTTng run directory: %s", rundir
);
4684 ret
= mkdir(rundir
, S_IRWXU
);
4686 if (errno
!= EEXIST
) {
4687 ERR("Unable to create %s", rundir
);
4699 * Setup sockets and directory needed by the kconsumerd communication with the
4702 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4706 char path
[PATH_MAX
];
4708 switch (consumer_data
->type
) {
4709 case LTTNG_CONSUMER_KERNEL
:
4710 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4712 case LTTNG_CONSUMER64_UST
:
4713 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4715 case LTTNG_CONSUMER32_UST
:
4716 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4719 ERR("Consumer type unknown");
4724 DBG2("Creating consumer directory: %s", path
);
4726 ret
= mkdir(path
, S_IRWXU
| S_IRGRP
| S_IXGRP
);
4728 if (errno
!= EEXIST
) {
4730 ERR("Failed to create %s", path
);
4736 ret
= chown(path
, 0, utils_get_group_id(tracing_group_name
));
4738 ERR("Unable to set group on %s", path
);
4744 /* Create the kconsumerd error unix socket */
4745 consumer_data
->err_sock
=
4746 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4747 if (consumer_data
->err_sock
< 0) {
4748 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4754 * Set the CLOEXEC flag. Return code is useless because either way, the
4757 ret
= utils_set_fd_cloexec(consumer_data
->err_sock
);
4759 PERROR("utils_set_fd_cloexec");
4760 /* continue anyway */
4763 /* File permission MUST be 660 */
4764 ret
= chmod(consumer_data
->err_unix_sock_path
,
4765 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4767 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4777 * Signal handler for the daemon
4779 * Simply stop all worker threads, leaving main() return gracefully after
4780 * joining all threads and calling cleanup().
4782 static void sighandler(int sig
)
4786 DBG("SIGPIPE caught");
4789 DBG("SIGINT caught");
4793 DBG("SIGTERM caught");
4797 CMM_STORE_SHARED(recv_child_signal
, 1);
4805 * Setup signal handler for :
4806 * SIGINT, SIGTERM, SIGPIPE
4808 static int set_signal_handler(void)
4811 struct sigaction sa
;
4814 if ((ret
= sigemptyset(&sigset
)) < 0) {
4815 PERROR("sigemptyset");
4819 sa
.sa_handler
= sighandler
;
4820 sa
.sa_mask
= sigset
;
4822 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4823 PERROR("sigaction");
4827 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4828 PERROR("sigaction");
4832 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4833 PERROR("sigaction");
4837 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
4838 PERROR("sigaction");
4842 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
4848 * Set open files limit to unlimited. This daemon can open a large number of
4849 * file descriptors in order to consumer multiple kernel traces.
4851 static void set_ulimit(void)
4856 /* The kernel does not allowed an infinite limit for open files */
4857 lim
.rlim_cur
= 65535;
4858 lim
.rlim_max
= 65535;
4860 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4862 PERROR("failed to set open files limit");
4867 * Write pidfile using the rundir and opt_pidfile.
4869 static void write_pidfile(void)
4872 char pidfile_path
[PATH_MAX
];
4877 strncpy(pidfile_path
, opt_pidfile
, sizeof(pidfile_path
));
4879 /* Build pidfile path from rundir and opt_pidfile. */
4880 ret
= snprintf(pidfile_path
, sizeof(pidfile_path
), "%s/"
4881 DEFAULT_LTTNG_SESSIOND_PIDFILE
, rundir
);
4883 PERROR("snprintf pidfile path");
4889 * Create pid file in rundir. Return value is of no importance. The
4890 * execution will continue even though we are not able to write the file.
4892 (void) utils_create_pid_file(getpid(), pidfile_path
);
4899 * Create lockfile using the rundir and return its fd.
4901 static int create_lockfile(void)
4904 char lockfile_path
[PATH_MAX
];
4906 ret
= generate_lock_file_path(lockfile_path
, sizeof(lockfile_path
));
4911 ret
= utils_create_lock_file(lockfile_path
);
4917 * Write agent TCP port using the rundir.
4919 static void write_agent_port(void)
4922 char path
[PATH_MAX
];
4926 ret
= snprintf(path
, sizeof(path
), "%s/"
4927 DEFAULT_LTTNG_SESSIOND_AGENTPORT_FILE
, rundir
);
4929 PERROR("snprintf agent port path");
4934 * Create TCP agent port file in rundir. Return value is of no importance.
4935 * The execution will continue even though we are not able to write the
4938 (void) utils_create_pid_file(agent_tcp_port
, path
);
4945 * Start the load session thread and dettach from it so the main thread can
4946 * continue. This does not return a value since whatever the outcome, the main
4947 * thread will continue.
4949 static void start_load_session_thread(void)
4953 /* Create session loading thread. */
4954 ret
= pthread_create(&load_session_thread
, NULL
, thread_load_session
,
4957 PERROR("pthread_create load_session_thread");
4961 ret
= pthread_detach(load_session_thread
);
4963 PERROR("pthread_detach load_session_thread");
4966 /* Everything went well so don't cleanup anything. */
4969 /* The cleanup() function will destroy the load_info data. */
4976 int main(int argc
, char **argv
)
4980 const char *home_path
, *env_app_timeout
;
4982 init_kernel_workarounds();
4984 rcu_register_thread();
4986 if ((ret
= set_signal_handler()) < 0) {
4990 setup_consumerd_path();
4992 page_size
= sysconf(_SC_PAGESIZE
);
4993 if (page_size
< 0) {
4994 PERROR("sysconf _SC_PAGESIZE");
4995 page_size
= LONG_MAX
;
4996 WARN("Fallback page size to %ld", page_size
);
4999 /* Parse arguments and load the daemon configuration file */
5001 if ((ret
= set_options(argc
, argv
)) < 0) {
5006 if (opt_daemon
|| opt_background
) {
5009 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
5016 * We are in the child. Make sure all other file descriptors are
5017 * closed, in case we are called with more opened file descriptors than
5018 * the standard ones.
5020 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5025 /* Create thread quit pipe */
5026 if ((ret
= init_thread_quit_pipe()) < 0) {
5030 /* Check if daemon is UID = 0 */
5031 is_root
= !getuid();
5034 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5036 /* Create global run dir with root access */
5037 ret
= create_lttng_rundir(rundir
);
5042 if (strlen(apps_unix_sock_path
) == 0) {
5043 snprintf(apps_unix_sock_path
, PATH_MAX
,
5044 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5047 if (strlen(client_unix_sock_path
) == 0) {
5048 snprintf(client_unix_sock_path
, PATH_MAX
,
5049 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5052 /* Set global SHM for ust */
5053 if (strlen(wait_shm_path
) == 0) {
5054 snprintf(wait_shm_path
, PATH_MAX
,
5055 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5058 if (strlen(health_unix_sock_path
) == 0) {
5059 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
5060 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5063 /* Setup kernel consumerd path */
5064 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5065 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5066 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5067 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5069 DBG2("Kernel consumer err path: %s",
5070 kconsumer_data
.err_unix_sock_path
);
5071 DBG2("Kernel consumer cmd path: %s",
5072 kconsumer_data
.cmd_unix_sock_path
);
5074 home_path
= utils_get_home_dir();
5075 if (home_path
== NULL
) {
5076 /* TODO: Add --socket PATH option */
5077 ERR("Can't get HOME directory for sockets creation.");
5083 * Create rundir from home path. This will create something like
5086 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5092 ret
= create_lttng_rundir(rundir
);
5097 if (strlen(apps_unix_sock_path
) == 0) {
5098 snprintf(apps_unix_sock_path
, PATH_MAX
,
5099 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
5102 /* Set the cli tool unix socket path */
5103 if (strlen(client_unix_sock_path
) == 0) {
5104 snprintf(client_unix_sock_path
, PATH_MAX
,
5105 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
5108 /* Set global SHM for ust */
5109 if (strlen(wait_shm_path
) == 0) {
5110 snprintf(wait_shm_path
, PATH_MAX
,
5111 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, getuid());
5114 /* Set health check Unix path */
5115 if (strlen(health_unix_sock_path
) == 0) {
5116 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
5117 DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
5121 lockfile_fd
= create_lockfile();
5122 if (lockfile_fd
< 0) {
5126 /* Set consumer initial state */
5127 kernel_consumerd_state
= CONSUMER_STOPPED
;
5128 ust_consumerd_state
= CONSUMER_STOPPED
;
5130 DBG("Client socket path %s", client_unix_sock_path
);
5131 DBG("Application socket path %s", apps_unix_sock_path
);
5132 DBG("Application wait path %s", wait_shm_path
);
5133 DBG("LTTng run directory path: %s", rundir
);
5135 /* 32 bits consumerd path setup */
5136 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
5137 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
5138 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
5139 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
5141 DBG2("UST consumer 32 bits err path: %s",
5142 ustconsumer32_data
.err_unix_sock_path
);
5143 DBG2("UST consumer 32 bits cmd path: %s",
5144 ustconsumer32_data
.cmd_unix_sock_path
);
5146 /* 64 bits consumerd path setup */
5147 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
5148 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
5149 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
5150 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
5152 DBG2("UST consumer 64 bits err path: %s",
5153 ustconsumer64_data
.err_unix_sock_path
);
5154 DBG2("UST consumer 64 bits cmd path: %s",
5155 ustconsumer64_data
.cmd_unix_sock_path
);
5158 * See if daemon already exist.
5160 if ((ret
= check_existing_daemon()) < 0) {
5161 ERR("Already running daemon.\n");
5163 * We do not goto exit because we must not cleanup()
5164 * because a daemon is already running.
5170 * Init UST app hash table. Alloc hash table before this point since
5171 * cleanup() can get called after that point.
5175 /* Initialize agent domain subsystem. */
5176 if ((ret
= agent_setup()) < 0) {
5177 /* ENOMEM at this point. */
5181 /* After this point, we can safely call cleanup() with "goto exit" */
5184 * These actions must be executed as root. We do that *after* setting up
5185 * the sockets path because we MUST make the check for another daemon using
5186 * those paths *before* trying to set the kernel consumer sockets and init
5190 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
5195 /* Setup kernel tracer */
5196 if (!opt_no_kernel
) {
5197 init_kernel_tracer();
5200 /* Set ulimit for open files */
5203 /* init lttng_fd tracking must be done after set_ulimit. */
5206 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
5211 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
5216 /* Setup the needed unix socket */
5217 if ((ret
= init_daemon_socket()) < 0) {
5221 /* Set credentials to socket */
5222 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
5226 /* Get parent pid if -S, --sig-parent is specified. */
5227 if (opt_sig_parent
) {
5231 /* Setup the kernel pipe for waking up the kernel thread */
5232 if (is_root
&& !opt_no_kernel
) {
5233 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
5238 /* Setup the thread ht_cleanup communication pipe. */
5239 if (utils_create_pipe_cloexec(ht_cleanup_pipe
) < 0) {
5243 /* Setup the thread apps communication pipe. */
5244 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
5248 /* Setup the thread apps notify communication pipe. */
5249 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe
) < 0) {
5253 /* Initialize global buffer per UID and PID registry. */
5254 buffer_reg_init_uid_registry();
5255 buffer_reg_init_pid_registry();
5257 /* Init UST command queue. */
5258 cds_wfcq_init(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
5261 * Get session list pointer. This pointer MUST NOT be free(). This list is
5262 * statically declared in session.c
5264 session_list_ptr
= session_get_list();
5266 /* Set up max poll set size */
5267 lttng_poll_set_max_size();
5271 /* Check for the application socket timeout env variable. */
5272 env_app_timeout
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
5273 if (env_app_timeout
) {
5274 app_socket_timeout
= atoi(env_app_timeout
);
5276 app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
;
5282 /* Initialize communication library */
5284 /* This is to get the TCP timeout value. */
5285 lttcomm_inet_init();
5287 if (load_session_init_data(&load_info
) < 0) {
5290 load_info
->path
= opt_load_session_path
;
5293 * Initialize the health check subsystem. This call should set the
5294 * appropriate time values.
5296 health_sessiond
= health_app_create(NR_HEALTH_SESSIOND_TYPES
);
5297 if (!health_sessiond
) {
5298 PERROR("health_app_create error");
5299 goto exit_health_sessiond_cleanup
;
5302 /* Create thread to clean up RCU hash tables */
5303 ret
= pthread_create(&ht_cleanup_thread
, NULL
,
5304 thread_ht_cleanup
, (void *) NULL
);
5306 PERROR("pthread_create ht_cleanup");
5307 goto exit_ht_cleanup
;
5310 /* Create health-check thread */
5311 ret
= pthread_create(&health_thread
, NULL
,
5312 thread_manage_health
, (void *) NULL
);
5314 PERROR("pthread_create health");
5318 /* Create thread to manage the client socket */
5319 ret
= pthread_create(&client_thread
, NULL
,
5320 thread_manage_clients
, (void *) NULL
);
5322 PERROR("pthread_create clients");
5326 /* Create thread to dispatch registration */
5327 ret
= pthread_create(&dispatch_thread
, NULL
,
5328 thread_dispatch_ust_registration
, (void *) NULL
);
5330 PERROR("pthread_create dispatch");
5334 /* Create thread to manage application registration. */
5335 ret
= pthread_create(®_apps_thread
, NULL
,
5336 thread_registration_apps
, (void *) NULL
);
5338 PERROR("pthread_create registration");
5342 /* Create thread to manage application socket */
5343 ret
= pthread_create(&apps_thread
, NULL
,
5344 thread_manage_apps
, (void *) NULL
);
5346 PERROR("pthread_create apps");
5350 /* Create thread to manage application notify socket */
5351 ret
= pthread_create(&apps_notify_thread
, NULL
,
5352 ust_thread_manage_notify
, (void *) NULL
);
5354 PERROR("pthread_create notify");
5355 goto exit_apps_notify
;
5358 /* Create agent registration thread. */
5359 ret
= pthread_create(&agent_reg_thread
, NULL
,
5360 agent_thread_manage_registration
, (void *) NULL
);
5362 PERROR("pthread_create agent");
5363 goto exit_agent_reg
;
5366 /* Don't start this thread if kernel tracing is not requested nor root */
5367 if (is_root
&& !opt_no_kernel
) {
5368 /* Create kernel thread to manage kernel event */
5369 ret
= pthread_create(&kernel_thread
, NULL
,
5370 thread_manage_kernel
, (void *) NULL
);
5372 PERROR("pthread_create kernel");
5377 /* Load possible session(s). */
5378 start_load_session_thread();
5380 if (is_root
&& !opt_no_kernel
) {
5381 ret
= pthread_join(kernel_thread
, &status
);
5383 PERROR("pthread_join");
5384 goto error
; /* join error, exit without cleanup */
5389 ret
= pthread_join(agent_reg_thread
, &status
);
5391 PERROR("pthread_join agent");
5392 goto error
; /* join error, exit without cleanup */
5396 ret
= pthread_join(apps_notify_thread
, &status
);
5398 PERROR("pthread_join apps notify");
5399 goto error
; /* join error, exit without cleanup */
5403 ret
= pthread_join(apps_thread
, &status
);
5405 PERROR("pthread_join apps");
5406 goto error
; /* join error, exit without cleanup */
5411 ret
= pthread_join(reg_apps_thread
, &status
);
5413 PERROR("pthread_join");
5414 goto error
; /* join error, exit without cleanup */
5418 ret
= pthread_join(dispatch_thread
, &status
);
5420 PERROR("pthread_join");
5421 goto error
; /* join error, exit without cleanup */
5425 ret
= pthread_join(client_thread
, &status
);
5427 PERROR("pthread_join");
5428 goto error
; /* join error, exit without cleanup */
5431 ret
= join_consumer_thread(&kconsumer_data
);
5433 PERROR("join_consumer");
5434 goto error
; /* join error, exit without cleanup */
5437 ret
= join_consumer_thread(&ustconsumer32_data
);
5439 PERROR("join_consumer ust32");
5440 goto error
; /* join error, exit without cleanup */
5443 ret
= join_consumer_thread(&ustconsumer64_data
);
5445 PERROR("join_consumer ust64");
5446 goto error
; /* join error, exit without cleanup */
5450 ret
= pthread_join(health_thread
, &status
);
5452 PERROR("pthread_join health thread");
5453 goto error
; /* join error, exit without cleanup */
5457 ret
= pthread_join(ht_cleanup_thread
, &status
);
5459 PERROR("pthread_join ht cleanup thread");
5460 goto error
; /* join error, exit without cleanup */
5463 health_app_destroy(health_sessiond
);
5464 exit_health_sessiond_cleanup
:
5467 * cleanup() is called when no other thread is running.
5469 rcu_thread_online();
5471 rcu_thread_offline();
5472 rcu_unregister_thread();