2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
32 #include <sys/mount.h>
33 #include <sys/resource.h>
34 #include <sys/socket.h>
36 #include <sys/types.h>
38 #include <urcu/uatomic.h>
42 #include <common/common.h>
43 #include <common/compat/socket.h>
44 #include <common/compat/getenv.h>
45 #include <common/defaults.h>
46 #include <common/kernel-consumer/kernel-consumer.h>
47 #include <common/futex.h>
48 #include <common/relayd/relayd.h>
49 #include <common/utils.h>
50 #include <common/daemonize.h>
51 #include <common/config/session-config.h>
53 #include "lttng-sessiond.h"
54 #include "buffer-registry.h"
61 #include "kernel-consumer.h"
65 #include "ust-consumer.h"
68 #include "health-sessiond.h"
69 #include "testpoint.h"
70 #include "ust-thread.h"
71 #include "agent-thread.h"
73 #include "load-session-thread.h"
74 #include "notification-thread.h"
75 #include "notification-thread-commands.h"
78 #include "ht-cleanup.h"
79 #include "sessiond-config.h"
81 static const char *help_msg
=
82 #ifdef LTTNG_EMBED_HELP
83 #include <lttng-sessiond.8.h>
90 static pid_t ppid
; /* Parent PID for --sig-parent option */
91 static pid_t child_ppid
; /* Internal parent PID use with daemonize. */
92 static int lockfile_fd
= -1;
94 /* Set to 1 when a SIGUSR1 signal is received. */
95 static int recv_child_signal
;
98 * Consumer daemon specific control data. Every value not initialized here is
99 * set to 0 by the static definition.
101 static struct consumer_data kconsumer_data
= {
102 .type
= LTTNG_CONSUMER_KERNEL
,
105 .channel_monitor_pipe
= -1,
106 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
107 .lock
= PTHREAD_MUTEX_INITIALIZER
,
108 .cond
= PTHREAD_COND_INITIALIZER
,
109 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
111 static struct consumer_data ustconsumer64_data
= {
112 .type
= LTTNG_CONSUMER64_UST
,
115 .channel_monitor_pipe
= -1,
116 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
117 .lock
= PTHREAD_MUTEX_INITIALIZER
,
118 .cond
= PTHREAD_COND_INITIALIZER
,
119 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
121 static struct consumer_data ustconsumer32_data
= {
122 .type
= LTTNG_CONSUMER32_UST
,
125 .channel_monitor_pipe
= -1,
126 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
127 .lock
= PTHREAD_MUTEX_INITIALIZER
,
128 .cond
= PTHREAD_COND_INITIALIZER
,
129 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
132 /* Command line options */
133 static const struct option long_options
[] = {
134 { "client-sock", required_argument
, 0, 'c' },
135 { "apps-sock", required_argument
, 0, 'a' },
136 { "kconsumerd-cmd-sock", required_argument
, 0, '\0' },
137 { "kconsumerd-err-sock", required_argument
, 0, '\0' },
138 { "ustconsumerd32-cmd-sock", required_argument
, 0, '\0' },
139 { "ustconsumerd32-err-sock", required_argument
, 0, '\0' },
140 { "ustconsumerd64-cmd-sock", required_argument
, 0, '\0' },
141 { "ustconsumerd64-err-sock", required_argument
, 0, '\0' },
142 { "consumerd32-path", required_argument
, 0, '\0' },
143 { "consumerd32-libdir", required_argument
, 0, '\0' },
144 { "consumerd64-path", required_argument
, 0, '\0' },
145 { "consumerd64-libdir", required_argument
, 0, '\0' },
146 { "daemonize", no_argument
, 0, 'd' },
147 { "background", no_argument
, 0, 'b' },
148 { "sig-parent", no_argument
, 0, 'S' },
149 { "help", no_argument
, 0, 'h' },
150 { "group", required_argument
, 0, 'g' },
151 { "version", no_argument
, 0, 'V' },
152 { "quiet", no_argument
, 0, 'q' },
153 { "verbose", no_argument
, 0, 'v' },
154 { "verbose-consumer", no_argument
, 0, '\0' },
155 { "no-kernel", no_argument
, 0, '\0' },
156 { "pidfile", required_argument
, 0, 'p' },
157 { "agent-tcp-port", required_argument
, 0, '\0' },
158 { "config", required_argument
, 0, 'f' },
159 { "load", required_argument
, 0, 'l' },
160 { "kmod-probes", required_argument
, 0, '\0' },
161 { "extra-kmod-probes", required_argument
, 0, '\0' },
165 struct sessiond_config config
;
167 /* Command line options to ignore from configuration file */
168 static const char *config_ignore_options
[] = { "help", "version", "config" };
170 /* Shared between threads */
171 static int dispatch_thread_exit
;
173 /* Sockets and FDs */
174 static int client_sock
= -1;
175 static int apps_sock
= -1;
176 int kernel_tracer_fd
= -1;
177 static int kernel_poll_pipe
[2] = { -1, -1 };
180 * Quit pipe for all threads. This permits a single cancellation point
181 * for all threads when receiving an event on the pipe.
183 static int thread_quit_pipe
[2] = { -1, -1 };
186 * This pipe is used to inform the thread managing application communication
187 * that a command is queued and ready to be processed.
189 static int apps_cmd_pipe
[2] = { -1, -1 };
191 int apps_cmd_notify_pipe
[2] = { -1, -1 };
193 /* Pthread, Mutexes and Semaphores */
194 static pthread_t apps_thread
;
195 static pthread_t apps_notify_thread
;
196 static pthread_t reg_apps_thread
;
197 static pthread_t client_thread
;
198 static pthread_t kernel_thread
;
199 static pthread_t dispatch_thread
;
200 static pthread_t health_thread
;
201 static pthread_t ht_cleanup_thread
;
202 static pthread_t agent_reg_thread
;
203 static pthread_t load_session_thread
;
204 static pthread_t notification_thread
;
207 * UST registration command queue. This queue is tied with a futex and uses a N
208 * wakers / 1 waiter implemented and detailed in futex.c/.h
210 * The thread_registration_apps and thread_dispatch_ust_registration uses this
211 * queue along with the wait/wake scheme. The thread_manage_apps receives down
212 * the line new application socket and monitors it for any I/O error or clean
213 * close that triggers an unregistration of the application.
215 static struct ust_cmd_queue ust_cmd_queue
;
218 * Pointer initialized before thread creation.
220 * This points to the tracing session list containing the session count and a
221 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
222 * MUST NOT be taken if you call a public function in session.c.
224 * The lock is nested inside the structure: session_list_ptr->lock. Please use
225 * session_lock_list and session_unlock_list for lock acquisition.
227 static struct ltt_session_list
*session_list_ptr
;
229 int ust_consumerd64_fd
= -1;
230 int ust_consumerd32_fd
= -1;
232 static const char *module_proc_lttng
= "/proc/lttng";
235 * Consumer daemon state which is changed when spawning it, killing it or in
236 * case of a fatal error.
238 enum consumerd_state
{
239 CONSUMER_STARTED
= 1,
240 CONSUMER_STOPPED
= 2,
245 * This consumer daemon state is used to validate if a client command will be
246 * able to reach the consumer. If not, the client is informed. For instance,
247 * doing a "lttng start" when the consumer state is set to ERROR will return an
248 * error to the client.
250 * The following example shows a possible race condition of this scheme:
252 * consumer thread error happens
254 * client cmd checks state -> still OK
255 * consumer thread exit, sets error
256 * client cmd try to talk to consumer
259 * However, since the consumer is a different daemon, we have no way of making
260 * sure the command will reach it safely even with this state flag. This is why
261 * we consider that up to the state validation during command processing, the
262 * command is safe. After that, we can not guarantee the correctness of the
263 * client request vis-a-vis the consumer.
265 static enum consumerd_state ust_consumerd_state
;
266 static enum consumerd_state kernel_consumerd_state
;
268 /* Set in main() with the current page size. */
271 /* Application health monitoring */
272 struct health_app
*health_sessiond
;
274 /* Am I root or not. */
275 int is_root
; /* Set to 1 if the daemon is running as root */
277 const char * const config_section_name
= "sessiond";
279 /* Load session thread information to operate. */
280 struct load_session_thread_data
*load_info
;
282 /* Notification thread handle. */
283 struct notification_thread_handle
*notification_thread_handle
;
285 /* Global hash tables */
286 struct lttng_ht
*agent_apps_ht_by_sock
= NULL
;
289 * Whether sessiond is ready for commands/notification channel/health check
291 * NR_LTTNG_SESSIOND_READY must match the number of calls to
292 * sessiond_notify_ready().
294 #define NR_LTTNG_SESSIOND_READY 4
295 int lttng_sessiond_ready
= NR_LTTNG_SESSIOND_READY
;
297 int sessiond_check_thread_quit_pipe(int fd
, uint32_t events
)
299 return (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) ? 1 : 0;
302 /* Notify parents that we are ready for cmd and health check */
304 void sessiond_notify_ready(void)
306 if (uatomic_sub_return(<tng_sessiond_ready
, 1) == 0) {
308 * Notify parent pid that we are ready to accept command
309 * for client side. This ppid is the one from the
310 * external process that spawned us.
312 if (config
.sig_parent
) {
317 * Notify the parent of the fork() process that we are
320 if (config
.daemonize
|| config
.background
) {
321 kill(child_ppid
, SIGUSR1
);
327 int __sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
,
334 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
340 ret
= lttng_poll_add(events
, a_pipe
[0], LPOLLIN
| LPOLLERR
);
352 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
354 int sessiond_set_thread_pollset(struct lttng_poll_event
*events
, size_t size
)
356 return __sessiond_set_thread_pollset(events
, size
, thread_quit_pipe
);
360 * Init thread quit pipe.
362 * Return -1 on error or 0 if all pipes are created.
364 static int __init_thread_quit_pipe(int *a_pipe
)
370 PERROR("thread quit pipe");
374 for (i
= 0; i
< 2; i
++) {
375 ret
= fcntl(a_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
386 static int init_thread_quit_pipe(void)
388 return __init_thread_quit_pipe(thread_quit_pipe
);
392 * Stop all threads by closing the thread quit pipe.
394 static void stop_threads(void)
398 /* Stopping all threads */
399 DBG("Terminating all threads");
400 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
402 ERR("write error on thread quit pipe");
405 /* Dispatch thread */
406 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
407 futex_nto1_wake(&ust_cmd_queue
.futex
);
411 * Close every consumer sockets.
413 static void close_consumer_sockets(void)
417 if (kconsumer_data
.err_sock
>= 0) {
418 ret
= close(kconsumer_data
.err_sock
);
420 PERROR("kernel consumer err_sock close");
423 if (ustconsumer32_data
.err_sock
>= 0) {
424 ret
= close(ustconsumer32_data
.err_sock
);
426 PERROR("UST consumerd32 err_sock close");
429 if (ustconsumer64_data
.err_sock
>= 0) {
430 ret
= close(ustconsumer64_data
.err_sock
);
432 PERROR("UST consumerd64 err_sock close");
435 if (kconsumer_data
.cmd_sock
>= 0) {
436 ret
= close(kconsumer_data
.cmd_sock
);
438 PERROR("kernel consumer cmd_sock close");
441 if (ustconsumer32_data
.cmd_sock
>= 0) {
442 ret
= close(ustconsumer32_data
.cmd_sock
);
444 PERROR("UST consumerd32 cmd_sock close");
447 if (ustconsumer64_data
.cmd_sock
>= 0) {
448 ret
= close(ustconsumer64_data
.cmd_sock
);
450 PERROR("UST consumerd64 cmd_sock close");
453 if (kconsumer_data
.channel_monitor_pipe
>= 0) {
454 ret
= close(kconsumer_data
.channel_monitor_pipe
);
456 PERROR("kernel consumer channel monitor pipe close");
459 if (ustconsumer32_data
.channel_monitor_pipe
>= 0) {
460 ret
= close(ustconsumer32_data
.channel_monitor_pipe
);
462 PERROR("UST consumerd32 channel monitor pipe close");
465 if (ustconsumer64_data
.channel_monitor_pipe
>= 0) {
466 ret
= close(ustconsumer64_data
.channel_monitor_pipe
);
468 PERROR("UST consumerd64 channel monitor pipe close");
474 * Wait on consumer process termination.
476 * Need to be called with the consumer data lock held or from a context
477 * ensuring no concurrent access to data (e.g: cleanup).
479 static void wait_consumer(struct consumer_data
*consumer_data
)
484 if (consumer_data
->pid
<= 0) {
488 DBG("Waiting for complete teardown of consumerd (PID: %d)",
490 ret
= waitpid(consumer_data
->pid
, &status
, 0);
492 PERROR("consumerd waitpid pid: %d", consumer_data
->pid
)
493 } else if (!WIFEXITED(status
)) {
494 ERR("consumerd termination with error: %d",
497 consumer_data
->pid
= 0;
501 * Cleanup the session daemon's data structures.
503 static void sessiond_cleanup(void)
506 struct ltt_session
*sess
, *stmp
;
508 DBG("Cleanup sessiond");
511 * Close the thread quit pipe. It has already done its job,
512 * since we are now called.
514 utils_close_pipe(thread_quit_pipe
);
517 * If config.pid_file_path.value is undefined, the default file will be
518 * wiped when removing the rundir.
520 if (config
.pid_file_path
.value
) {
521 ret
= remove(config
.pid_file_path
.value
);
523 PERROR("remove pidfile %s", config
.pid_file_path
.value
);
527 DBG("Removing sessiond and consumerd content of directory %s",
528 config
.rundir
.value
);
531 DBG("Removing %s", config
.pid_file_path
.value
);
532 (void) unlink(config
.pid_file_path
.value
);
534 DBG("Removing %s", config
.agent_port_file_path
.value
);
535 (void) unlink(config
.agent_port_file_path
.value
);
538 DBG("Removing %s", kconsumer_data
.err_unix_sock_path
);
539 (void) unlink(kconsumer_data
.err_unix_sock_path
);
541 DBG("Removing directory %s", config
.kconsumerd_path
.value
);
542 (void) rmdir(config
.kconsumerd_path
.value
);
544 /* ust consumerd 32 */
545 DBG("Removing %s", config
.consumerd32_err_unix_sock_path
.value
);
546 (void) unlink(config
.consumerd32_err_unix_sock_path
.value
);
548 DBG("Removing directory %s", config
.consumerd32_path
.value
);
549 (void) rmdir(config
.consumerd32_path
.value
);
551 /* ust consumerd 64 */
552 DBG("Removing %s", config
.consumerd64_err_unix_sock_path
.value
);
553 (void) unlink(config
.consumerd64_err_unix_sock_path
.value
);
555 DBG("Removing directory %s", config
.consumerd64_path
.value
);
556 (void) rmdir(config
.consumerd64_path
.value
);
558 DBG("Cleaning up all sessions");
560 /* Destroy session list mutex */
561 if (session_list_ptr
!= NULL
) {
562 pthread_mutex_destroy(&session_list_ptr
->lock
);
564 /* Cleanup ALL session */
565 cds_list_for_each_entry_safe(sess
, stmp
,
566 &session_list_ptr
->head
, list
) {
567 cmd_destroy_session(sess
, kernel_poll_pipe
[1]);
571 wait_consumer(&kconsumer_data
);
572 wait_consumer(&ustconsumer64_data
);
573 wait_consumer(&ustconsumer32_data
);
575 DBG("Cleaning up all agent apps");
576 agent_app_ht_clean();
578 DBG("Closing all UST sockets");
579 ust_app_clean_list();
580 buffer_reg_destroy_registries();
582 if (is_root
&& !config
.no_kernel
) {
583 DBG2("Closing kernel fd");
584 if (kernel_tracer_fd
>= 0) {
585 ret
= close(kernel_tracer_fd
);
590 DBG("Unloading kernel modules");
591 modprobe_remove_lttng_all();
595 close_consumer_sockets();
598 load_session_destroy_data(load_info
);
603 * Cleanup lock file by deleting it and finaly closing it which will
604 * release the file system lock.
606 if (lockfile_fd
>= 0) {
607 ret
= remove(config
.lock_file_path
.value
);
609 PERROR("remove lock file");
611 ret
= close(lockfile_fd
);
613 PERROR("close lock file");
618 * We do NOT rmdir rundir because there are other processes
619 * using it, for instance lttng-relayd, which can start in
620 * parallel with this teardown.
625 * Cleanup the daemon's option data structures.
627 static void sessiond_cleanup_options(void)
629 DBG("Cleaning up options");
631 sessiond_config_fini(&config
);
633 run_as_destroy_worker();
637 * Send data on a unix socket using the liblttsessiondcomm API.
639 * Return lttcomm error code.
641 static int send_unix_sock(int sock
, void *buf
, size_t len
)
643 /* Check valid length */
648 return lttcomm_send_unix_sock(sock
, buf
, len
);
652 * Free memory of a command context structure.
654 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
656 DBG("Clean command context structure");
658 if ((*cmd_ctx
)->llm
) {
659 free((*cmd_ctx
)->llm
);
661 if ((*cmd_ctx
)->lsm
) {
662 free((*cmd_ctx
)->lsm
);
670 * Notify UST applications using the shm mmap futex.
672 static int notify_ust_apps(int active
)
676 DBG("Notifying applications of session daemon state: %d", active
);
678 /* See shm.c for this call implying mmap, shm and futex calls */
679 wait_shm_mmap
= shm_ust_get_mmap(config
.wait_shm_path
.value
, is_root
);
680 if (wait_shm_mmap
== NULL
) {
684 /* Wake waiting process */
685 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
687 /* Apps notified successfully */
695 * Setup the outgoing data buffer for the response (llm) by allocating the
696 * right amount of memory and copying the original information from the lsm
699 * Return 0 on success, negative value on error.
701 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
702 const void *payload_buf
, size_t payload_len
,
703 const void *cmd_header_buf
, size_t cmd_header_len
)
706 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
707 const size_t cmd_header_offset
= header_len
;
708 const size_t payload_offset
= cmd_header_offset
+ cmd_header_len
;
709 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
711 cmd_ctx
->llm
= zmalloc(total_msg_size
);
713 if (cmd_ctx
->llm
== NULL
) {
719 /* Copy common data */
720 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
721 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
722 cmd_ctx
->llm
->cmd_header_size
= cmd_header_len
;
723 cmd_ctx
->llm
->data_size
= payload_len
;
724 cmd_ctx
->lttng_msg_size
= total_msg_size
;
726 /* Copy command header */
727 if (cmd_header_len
) {
728 memcpy(((uint8_t *) cmd_ctx
->llm
) + cmd_header_offset
, cmd_header_buf
,
734 memcpy(((uint8_t *) cmd_ctx
->llm
) + payload_offset
, payload_buf
,
743 * Version of setup_lttng_msg() without command header.
745 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
746 void *payload_buf
, size_t payload_len
)
748 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
751 * Update the kernel poll set of all channel fd available over all tracing
752 * session. Add the wakeup pipe at the end of the set.
754 static int update_kernel_poll(struct lttng_poll_event
*events
)
757 struct ltt_session
*session
;
758 struct ltt_kernel_channel
*channel
;
760 DBG("Updating kernel poll set");
763 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
764 session_lock(session
);
765 if (session
->kernel_session
== NULL
) {
766 session_unlock(session
);
770 cds_list_for_each_entry(channel
,
771 &session
->kernel_session
->channel_list
.head
, list
) {
772 /* Add channel fd to the kernel poll set */
773 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
775 session_unlock(session
);
778 DBG("Channel fd %d added to kernel set", channel
->fd
);
780 session_unlock(session
);
782 session_unlock_list();
787 session_unlock_list();
792 * Find the channel fd from 'fd' over all tracing session. When found, check
793 * for new channel stream and send those stream fds to the kernel consumer.
795 * Useful for CPU hotplug feature.
797 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
800 struct ltt_session
*session
;
801 struct ltt_kernel_session
*ksess
;
802 struct ltt_kernel_channel
*channel
;
804 DBG("Updating kernel streams for channel fd %d", fd
);
807 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
808 session_lock(session
);
809 if (session
->kernel_session
== NULL
) {
810 session_unlock(session
);
813 ksess
= session
->kernel_session
;
815 cds_list_for_each_entry(channel
,
816 &ksess
->channel_list
.head
, list
) {
817 struct lttng_ht_iter iter
;
818 struct consumer_socket
*socket
;
820 if (channel
->fd
!= fd
) {
823 DBG("Channel found, updating kernel streams");
824 ret
= kernel_open_channel_stream(channel
);
828 /* Update the stream global counter */
829 ksess
->stream_count_global
+= ret
;
832 * Have we already sent fds to the consumer? If yes, it
833 * means that tracing is started so it is safe to send
834 * our updated stream fds.
836 if (ksess
->consumer_fds_sent
!= 1
837 || ksess
->consumer
== NULL
) {
843 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
844 &iter
.iter
, socket
, node
.node
) {
845 pthread_mutex_lock(socket
->lock
);
846 ret
= kernel_consumer_send_channel_stream(socket
,
848 session
->output_traces
? 1 : 0);
849 pthread_mutex_unlock(socket
->lock
);
857 session_unlock(session
);
859 session_unlock_list();
863 session_unlock(session
);
864 session_unlock_list();
869 * For each tracing session, update newly registered apps. The session list
870 * lock MUST be acquired before calling this.
872 static void update_ust_app(int app_sock
)
874 struct ltt_session
*sess
, *stmp
;
876 /* Consumer is in an ERROR state. Stop any application update. */
877 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
878 /* Stop the update process since the consumer is dead. */
882 /* For all tracing session(s) */
883 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
887 if (!sess
->ust_session
) {
892 assert(app_sock
>= 0);
893 app
= ust_app_find_by_sock(app_sock
);
896 * Application can be unregistered before so
897 * this is possible hence simply stopping the
900 DBG3("UST app update failed to find app sock %d",
904 ust_app_global_update(sess
->ust_session
, app
);
908 session_unlock(sess
);
913 * This thread manage event coming from the kernel.
915 * Features supported in this thread:
918 static void *thread_manage_kernel(void *data
)
920 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
921 uint32_t revents
, nb_fd
;
923 struct lttng_poll_event events
;
925 DBG("[thread] Thread manage kernel started");
927 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_KERNEL
);
930 * This first step of the while is to clean this structure which could free
931 * non NULL pointers so initialize it before the loop.
933 lttng_poll_init(&events
);
935 if (testpoint(sessiond_thread_manage_kernel
)) {
936 goto error_testpoint
;
939 health_code_update();
941 if (testpoint(sessiond_thread_manage_kernel_before_loop
)) {
942 goto error_testpoint
;
946 health_code_update();
948 if (update_poll_flag
== 1) {
949 /* Clean events object. We are about to populate it again. */
950 lttng_poll_clean(&events
);
952 ret
= sessiond_set_thread_pollset(&events
, 2);
954 goto error_poll_create
;
957 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
962 /* This will add the available kernel channel if any. */
963 ret
= update_kernel_poll(&events
);
967 update_poll_flag
= 0;
970 DBG("Thread kernel polling");
972 /* Poll infinite value of time */
975 ret
= lttng_poll_wait(&events
, -1);
976 DBG("Thread kernel return from poll on %d fds",
977 LTTNG_POLL_GETNB(&events
));
981 * Restart interrupted system call.
983 if (errno
== EINTR
) {
987 } else if (ret
== 0) {
988 /* Should not happen since timeout is infinite */
989 ERR("Return value of poll is 0 with an infinite timeout.\n"
990 "This should not have happened! Continuing...");
996 for (i
= 0; i
< nb_fd
; i
++) {
997 /* Fetch once the poll data */
998 revents
= LTTNG_POLL_GETEV(&events
, i
);
999 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1001 health_code_update();
1004 /* No activity for this FD (poll implementation). */
1008 /* Thread quit pipe has been closed. Killing thread. */
1009 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1015 /* Check for data on kernel pipe */
1016 if (revents
& LPOLLIN
) {
1017 if (pollfd
== kernel_poll_pipe
[0]) {
1018 (void) lttng_read(kernel_poll_pipe
[0],
1021 * Ret value is useless here, if this pipe gets any actions an
1022 * update is required anyway.
1024 update_poll_flag
= 1;
1028 * New CPU detected by the kernel. Adding kernel stream to
1029 * kernel session and updating the kernel consumer
1031 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
1037 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1038 update_poll_flag
= 1;
1041 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1049 lttng_poll_clean(&events
);
1052 utils_close_pipe(kernel_poll_pipe
);
1053 kernel_poll_pipe
[0] = kernel_poll_pipe
[1] = -1;
1056 ERR("Health error occurred in %s", __func__
);
1057 WARN("Kernel thread died unexpectedly. "
1058 "Kernel tracing can continue but CPU hotplug is disabled.");
1060 health_unregister(health_sessiond
);
1061 DBG("Kernel thread dying");
1066 * Signal pthread condition of the consumer data that the thread.
1068 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
1070 pthread_mutex_lock(&data
->cond_mutex
);
1073 * The state is set before signaling. It can be any value, it's the waiter
1074 * job to correctly interpret this condition variable associated to the
1075 * consumer pthread_cond.
1077 * A value of 0 means that the corresponding thread of the consumer data
1078 * was not started. 1 indicates that the thread has started and is ready
1079 * for action. A negative value means that there was an error during the
1082 data
->consumer_thread_is_ready
= state
;
1083 (void) pthread_cond_signal(&data
->cond
);
1085 pthread_mutex_unlock(&data
->cond_mutex
);
1089 * This thread manage the consumer error sent back to the session daemon.
1091 static void *thread_manage_consumer(void *data
)
1093 int sock
= -1, i
, ret
, pollfd
, err
= -1, should_quit
= 0;
1094 uint32_t revents
, nb_fd
;
1095 enum lttcomm_return_code code
;
1096 struct lttng_poll_event events
;
1097 struct consumer_data
*consumer_data
= data
;
1098 struct consumer_socket
*cmd_socket_wrapper
= NULL
;
1100 DBG("[thread] Manage consumer started");
1102 rcu_register_thread();
1103 rcu_thread_online();
1105 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CONSUMER
);
1107 health_code_update();
1110 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1111 * metadata_sock. Nothing more will be added to this poll set.
1113 ret
= sessiond_set_thread_pollset(&events
, 3);
1119 * The error socket here is already in a listening state which was done
1120 * just before spawning this thread to avoid a race between the consumer
1121 * daemon exec trying to connect and the listen() call.
1123 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
1128 health_code_update();
1130 /* Infinite blocking call, waiting for transmission */
1132 health_poll_entry();
1134 if (testpoint(sessiond_thread_manage_consumer
)) {
1138 ret
= lttng_poll_wait(&events
, -1);
1142 * Restart interrupted system call.
1144 if (errno
== EINTR
) {
1152 for (i
= 0; i
< nb_fd
; i
++) {
1153 /* Fetch once the poll data */
1154 revents
= LTTNG_POLL_GETEV(&events
, i
);
1155 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1157 health_code_update();
1160 /* No activity for this FD (poll implementation). */
1164 /* Thread quit pipe has been closed. Killing thread. */
1165 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1171 /* Event on the registration socket */
1172 if (pollfd
== consumer_data
->err_sock
) {
1173 if (revents
& LPOLLIN
) {
1175 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1176 ERR("consumer err socket poll error");
1179 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1185 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1191 * Set the CLOEXEC flag. Return code is useless because either way, the
1194 (void) utils_set_fd_cloexec(sock
);
1196 health_code_update();
1198 DBG2("Receiving code from consumer err_sock");
1200 /* Getting status code from kconsumerd */
1201 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1202 sizeof(enum lttcomm_return_code
));
1207 health_code_update();
1208 if (code
!= LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
1209 ERR("consumer error when waiting for SOCK_READY : %s",
1210 lttcomm_get_readable_code(-code
));
1214 /* Connect both command and metadata sockets. */
1215 consumer_data
->cmd_sock
=
1216 lttcomm_connect_unix_sock(
1217 consumer_data
->cmd_unix_sock_path
);
1218 consumer_data
->metadata_fd
=
1219 lttcomm_connect_unix_sock(
1220 consumer_data
->cmd_unix_sock_path
);
1221 if (consumer_data
->cmd_sock
< 0 || consumer_data
->metadata_fd
< 0) {
1222 PERROR("consumer connect cmd socket");
1223 /* On error, signal condition and quit. */
1224 signal_consumer_condition(consumer_data
, -1);
1228 consumer_data
->metadata_sock
.fd_ptr
= &consumer_data
->metadata_fd
;
1230 /* Create metadata socket lock. */
1231 consumer_data
->metadata_sock
.lock
= zmalloc(sizeof(pthread_mutex_t
));
1232 if (consumer_data
->metadata_sock
.lock
== NULL
) {
1233 PERROR("zmalloc pthread mutex");
1236 pthread_mutex_init(consumer_data
->metadata_sock
.lock
, NULL
);
1238 DBG("Consumer command socket ready (fd: %d", consumer_data
->cmd_sock
);
1239 DBG("Consumer metadata socket ready (fd: %d)",
1240 consumer_data
->metadata_fd
);
1243 * Remove the consumerd error sock since we've established a connection.
1245 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1250 /* Add new accepted error socket. */
1251 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1256 /* Add metadata socket that is successfully connected. */
1257 ret
= lttng_poll_add(&events
, consumer_data
->metadata_fd
,
1258 LPOLLIN
| LPOLLRDHUP
);
1263 health_code_update();
1266 * Transfer the write-end of the channel monitoring pipe to the
1267 * by issuing a SET_CHANNEL_MONITOR_PIPE command.
1269 cmd_socket_wrapper
= consumer_allocate_socket(&consumer_data
->cmd_sock
);
1270 if (!cmd_socket_wrapper
) {
1274 ret
= consumer_send_channel_monitor_pipe(cmd_socket_wrapper
,
1275 consumer_data
->channel_monitor_pipe
);
1279 /* Discard the socket wrapper as it is no longer needed. */
1280 consumer_destroy_socket(cmd_socket_wrapper
);
1281 cmd_socket_wrapper
= NULL
;
1283 /* The thread is completely initialized, signal that it is ready. */
1284 signal_consumer_condition(consumer_data
, 1);
1286 /* Infinite blocking call, waiting for transmission */
1289 health_code_update();
1291 /* Exit the thread because the thread quit pipe has been triggered. */
1293 /* Not a health error. */
1298 health_poll_entry();
1299 ret
= lttng_poll_wait(&events
, -1);
1303 * Restart interrupted system call.
1305 if (errno
== EINTR
) {
1313 for (i
= 0; i
< nb_fd
; i
++) {
1314 /* Fetch once the poll data */
1315 revents
= LTTNG_POLL_GETEV(&events
, i
);
1316 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1318 health_code_update();
1321 /* No activity for this FD (poll implementation). */
1326 * Thread quit pipe has been triggered, flag that we should stop
1327 * but continue the current loop to handle potential data from
1330 should_quit
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1332 if (pollfd
== sock
) {
1333 /* Event on the consumerd socket */
1334 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1335 && !(revents
& LPOLLIN
)) {
1336 ERR("consumer err socket second poll error");
1339 health_code_update();
1340 /* Wait for any kconsumerd error */
1341 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1342 sizeof(enum lttcomm_return_code
));
1344 ERR("consumer closed the command socket");
1348 ERR("consumer return code : %s",
1349 lttcomm_get_readable_code(-code
));
1352 } else if (pollfd
== consumer_data
->metadata_fd
) {
1353 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)
1354 && !(revents
& LPOLLIN
)) {
1355 ERR("consumer err metadata socket second poll error");
1358 /* UST metadata requests */
1359 ret
= ust_consumer_metadata_request(
1360 &consumer_data
->metadata_sock
);
1362 ERR("Handling metadata request");
1366 /* No need for an else branch all FDs are tested prior. */
1368 health_code_update();
1374 * We lock here because we are about to close the sockets and some other
1375 * thread might be using them so get exclusive access which will abort all
1376 * other consumer command by other threads.
1378 pthread_mutex_lock(&consumer_data
->lock
);
1380 /* Immediately set the consumerd state to stopped */
1381 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1382 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1383 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1384 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1385 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1387 /* Code flow error... */
1391 if (consumer_data
->err_sock
>= 0) {
1392 ret
= close(consumer_data
->err_sock
);
1396 consumer_data
->err_sock
= -1;
1398 if (consumer_data
->cmd_sock
>= 0) {
1399 ret
= close(consumer_data
->cmd_sock
);
1403 consumer_data
->cmd_sock
= -1;
1405 if (consumer_data
->metadata_sock
.fd_ptr
&&
1406 *consumer_data
->metadata_sock
.fd_ptr
>= 0) {
1407 ret
= close(*consumer_data
->metadata_sock
.fd_ptr
);
1419 unlink(consumer_data
->err_unix_sock_path
);
1420 unlink(consumer_data
->cmd_unix_sock_path
);
1421 pthread_mutex_unlock(&consumer_data
->lock
);
1423 /* Cleanup metadata socket mutex. */
1424 if (consumer_data
->metadata_sock
.lock
) {
1425 pthread_mutex_destroy(consumer_data
->metadata_sock
.lock
);
1426 free(consumer_data
->metadata_sock
.lock
);
1428 lttng_poll_clean(&events
);
1430 if (cmd_socket_wrapper
) {
1431 consumer_destroy_socket(cmd_socket_wrapper
);
1436 ERR("Health error occurred in %s", __func__
);
1438 health_unregister(health_sessiond
);
1439 DBG("consumer thread cleanup completed");
1441 rcu_thread_offline();
1442 rcu_unregister_thread();
1448 * This thread manage application communication.
1450 static void *thread_manage_apps(void *data
)
1452 int i
, ret
, pollfd
, err
= -1;
1454 uint32_t revents
, nb_fd
;
1455 struct lttng_poll_event events
;
1457 DBG("[thread] Manage application started");
1459 rcu_register_thread();
1460 rcu_thread_online();
1462 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_MANAGE
);
1464 if (testpoint(sessiond_thread_manage_apps
)) {
1465 goto error_testpoint
;
1468 health_code_update();
1470 ret
= sessiond_set_thread_pollset(&events
, 2);
1472 goto error_poll_create
;
1475 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1480 if (testpoint(sessiond_thread_manage_apps_before_loop
)) {
1484 health_code_update();
1487 DBG("Apps thread polling");
1489 /* Inifinite blocking call, waiting for transmission */
1491 health_poll_entry();
1492 ret
= lttng_poll_wait(&events
, -1);
1493 DBG("Apps thread return from poll on %d fds",
1494 LTTNG_POLL_GETNB(&events
));
1498 * Restart interrupted system call.
1500 if (errno
== EINTR
) {
1508 for (i
= 0; i
< nb_fd
; i
++) {
1509 /* Fetch once the poll data */
1510 revents
= LTTNG_POLL_GETEV(&events
, i
);
1511 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1513 health_code_update();
1516 /* No activity for this FD (poll implementation). */
1520 /* Thread quit pipe has been closed. Killing thread. */
1521 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
1527 /* Inspect the apps cmd pipe */
1528 if (pollfd
== apps_cmd_pipe
[0]) {
1529 if (revents
& LPOLLIN
) {
1533 size_ret
= lttng_read(apps_cmd_pipe
[0], &sock
, sizeof(sock
));
1534 if (size_ret
< sizeof(sock
)) {
1535 PERROR("read apps cmd pipe");
1539 health_code_update();
1542 * Since this is a command socket (write then read),
1543 * we only monitor the error events of the socket.
1545 ret
= lttng_poll_add(&events
, sock
,
1546 LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
1551 DBG("Apps with sock %d added to poll set", sock
);
1552 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1553 ERR("Apps command pipe error");
1556 ERR("Unknown poll events %u for sock %d", revents
, pollfd
);
1561 * At this point, we know that a registered application made
1562 * the event at poll_wait.
1564 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1565 /* Removing from the poll set */
1566 ret
= lttng_poll_del(&events
, pollfd
);
1571 /* Socket closed on remote end. */
1572 ust_app_unregister(pollfd
);
1574 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1579 health_code_update();
1585 lttng_poll_clean(&events
);
1588 utils_close_pipe(apps_cmd_pipe
);
1589 apps_cmd_pipe
[0] = apps_cmd_pipe
[1] = -1;
1592 * We don't clean the UST app hash table here since already registered
1593 * applications can still be controlled so let them be until the session
1594 * daemon dies or the applications stop.
1599 ERR("Health error occurred in %s", __func__
);
1601 health_unregister(health_sessiond
);
1602 DBG("Application communication apps thread cleanup complete");
1603 rcu_thread_offline();
1604 rcu_unregister_thread();
1609 * Send a socket to a thread This is called from the dispatch UST registration
1610 * thread once all sockets are set for the application.
1612 * The sock value can be invalid, we don't really care, the thread will handle
1613 * it and make the necessary cleanup if so.
1615 * On success, return 0 else a negative value being the errno message of the
1618 static int send_socket_to_thread(int fd
, int sock
)
1623 * It's possible that the FD is set as invalid with -1 concurrently just
1624 * before calling this function being a shutdown state of the thread.
1631 ret
= lttng_write(fd
, &sock
, sizeof(sock
));
1632 if (ret
< sizeof(sock
)) {
1633 PERROR("write apps pipe %d", fd
);
1640 /* All good. Don't send back the write positive ret value. */
1647 * Sanitize the wait queue of the dispatch registration thread meaning removing
1648 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1649 * notify socket is never received.
1651 static void sanitize_wait_queue(struct ust_reg_wait_queue
*wait_queue
)
1653 int ret
, nb_fd
= 0, i
;
1654 unsigned int fd_added
= 0;
1655 struct lttng_poll_event events
;
1656 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1660 lttng_poll_init(&events
);
1662 /* Just skip everything for an empty queue. */
1663 if (!wait_queue
->count
) {
1667 ret
= lttng_poll_create(&events
, wait_queue
->count
, LTTNG_CLOEXEC
);
1672 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1673 &wait_queue
->head
, head
) {
1674 assert(wait_node
->app
);
1675 ret
= lttng_poll_add(&events
, wait_node
->app
->sock
,
1676 LPOLLHUP
| LPOLLERR
);
1689 * Poll but don't block so we can quickly identify the faulty events and
1690 * clean them afterwards from the wait queue.
1692 ret
= lttng_poll_wait(&events
, 0);
1698 for (i
= 0; i
< nb_fd
; i
++) {
1699 /* Get faulty FD. */
1700 uint32_t revents
= LTTNG_POLL_GETEV(&events
, i
);
1701 int pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1704 /* No activity for this FD (poll implementation). */
1708 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1709 &wait_queue
->head
, head
) {
1710 if (pollfd
== wait_node
->app
->sock
&&
1711 (revents
& (LPOLLHUP
| LPOLLERR
))) {
1712 cds_list_del(&wait_node
->head
);
1713 wait_queue
->count
--;
1714 ust_app_destroy(wait_node
->app
);
1717 * Silence warning of use-after-free in
1718 * cds_list_for_each_entry_safe which uses
1719 * __typeof__(*wait_node).
1724 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
1731 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd
);
1735 lttng_poll_clean(&events
);
1739 lttng_poll_clean(&events
);
1741 ERR("Unable to sanitize wait queue");
1746 * Dispatch request from the registration threads to the application
1747 * communication thread.
1749 static void *thread_dispatch_ust_registration(void *data
)
1752 struct cds_wfcq_node
*node
;
1753 struct ust_command
*ust_cmd
= NULL
;
1754 struct ust_reg_wait_node
*wait_node
= NULL
, *tmp_wait_node
;
1755 struct ust_reg_wait_queue wait_queue
= {
1759 rcu_register_thread();
1761 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH
);
1763 if (testpoint(sessiond_thread_app_reg_dispatch
)) {
1764 goto error_testpoint
;
1767 health_code_update();
1769 CDS_INIT_LIST_HEAD(&wait_queue
.head
);
1771 DBG("[thread] Dispatch UST command started");
1774 health_code_update();
1776 /* Atomically prepare the queue futex */
1777 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1779 if (CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1784 struct ust_app
*app
= NULL
;
1788 * Make sure we don't have node(s) that have hung up before receiving
1789 * the notify socket. This is to clean the list in order to avoid
1790 * memory leaks from notify socket that are never seen.
1792 sanitize_wait_queue(&wait_queue
);
1794 health_code_update();
1795 /* Dequeue command for registration */
1796 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1798 DBG("Woken up but nothing in the UST command queue");
1799 /* Continue thread execution */
1803 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1805 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1806 " gid:%d sock:%d name:%s (version %d.%d)",
1807 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1808 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1809 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1810 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1812 if (ust_cmd
->reg_msg
.type
== USTCTL_SOCKET_CMD
) {
1813 wait_node
= zmalloc(sizeof(*wait_node
));
1815 PERROR("zmalloc wait_node dispatch");
1816 ret
= close(ust_cmd
->sock
);
1818 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1820 lttng_fd_put(LTTNG_FD_APPS
, 1);
1824 CDS_INIT_LIST_HEAD(&wait_node
->head
);
1826 /* Create application object if socket is CMD. */
1827 wait_node
->app
= ust_app_create(&ust_cmd
->reg_msg
,
1829 if (!wait_node
->app
) {
1830 ret
= close(ust_cmd
->sock
);
1832 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1834 lttng_fd_put(LTTNG_FD_APPS
, 1);
1840 * Add application to the wait queue so we can set the notify
1841 * socket before putting this object in the global ht.
1843 cds_list_add(&wait_node
->head
, &wait_queue
.head
);
1848 * We have to continue here since we don't have the notify
1849 * socket and the application MUST be added to the hash table
1850 * only at that moment.
1855 * Look for the application in the local wait queue and set the
1856 * notify socket if found.
1858 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1859 &wait_queue
.head
, head
) {
1860 health_code_update();
1861 if (wait_node
->app
->pid
== ust_cmd
->reg_msg
.pid
) {
1862 wait_node
->app
->notify_sock
= ust_cmd
->sock
;
1863 cds_list_del(&wait_node
->head
);
1865 app
= wait_node
->app
;
1867 DBG3("UST app notify socket %d is set", ust_cmd
->sock
);
1873 * With no application at this stage the received socket is
1874 * basically useless so close it before we free the cmd data
1875 * structure for good.
1878 ret
= close(ust_cmd
->sock
);
1880 PERROR("close ust sock dispatch %d", ust_cmd
->sock
);
1882 lttng_fd_put(LTTNG_FD_APPS
, 1);
1889 * @session_lock_list
1891 * Lock the global session list so from the register up to the
1892 * registration done message, no thread can see the application
1893 * and change its state.
1895 session_lock_list();
1899 * Add application to the global hash table. This needs to be
1900 * done before the update to the UST registry can locate the
1905 /* Set app version. This call will print an error if needed. */
1906 (void) ust_app_version(app
);
1908 /* Send notify socket through the notify pipe. */
1909 ret
= send_socket_to_thread(apps_cmd_notify_pipe
[1],
1913 session_unlock_list();
1915 * No notify thread, stop the UST tracing. However, this is
1916 * not an internal error of the this thread thus setting
1917 * the health error code to a normal exit.
1924 * Update newly registered application with the tracing
1925 * registry info already enabled information.
1927 update_ust_app(app
->sock
);
1930 * Don't care about return value. Let the manage apps threads
1931 * handle app unregistration upon socket close.
1933 (void) ust_app_register_done(app
);
1936 * Even if the application socket has been closed, send the app
1937 * to the thread and unregistration will take place at that
1940 ret
= send_socket_to_thread(apps_cmd_pipe
[1], app
->sock
);
1943 session_unlock_list();
1945 * No apps. thread, stop the UST tracing. However, this is
1946 * not an internal error of the this thread thus setting
1947 * the health error code to a normal exit.
1954 session_unlock_list();
1956 } while (node
!= NULL
);
1958 health_poll_entry();
1959 /* Futex wait on queue. Blocking call on futex() */
1960 futex_nto1_wait(&ust_cmd_queue
.futex
);
1963 /* Normal exit, no error */
1967 /* Clean up wait queue. */
1968 cds_list_for_each_entry_safe(wait_node
, tmp_wait_node
,
1969 &wait_queue
.head
, head
) {
1970 cds_list_del(&wait_node
->head
);
1975 /* Empty command queue. */
1977 /* Dequeue command for registration */
1978 node
= cds_wfcq_dequeue_blocking(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
1982 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1983 ret
= close(ust_cmd
->sock
);
1985 PERROR("close ust sock exit dispatch %d", ust_cmd
->sock
);
1987 lttng_fd_put(LTTNG_FD_APPS
, 1);
1992 DBG("Dispatch thread dying");
1995 ERR("Health error occurred in %s", __func__
);
1997 health_unregister(health_sessiond
);
1998 rcu_unregister_thread();
2003 * This thread manage application registration.
2005 static void *thread_registration_apps(void *data
)
2007 int sock
= -1, i
, ret
, pollfd
, err
= -1;
2008 uint32_t revents
, nb_fd
;
2009 struct lttng_poll_event events
;
2011 * Get allocated in this thread, enqueued to a global queue, dequeued and
2012 * freed in the manage apps thread.
2014 struct ust_command
*ust_cmd
= NULL
;
2016 DBG("[thread] Manage application registration started");
2018 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_APP_REG
);
2020 if (testpoint(sessiond_thread_registration_apps
)) {
2021 goto error_testpoint
;
2024 ret
= lttcomm_listen_unix_sock(apps_sock
);
2030 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
2031 * more will be added to this poll set.
2033 ret
= sessiond_set_thread_pollset(&events
, 2);
2035 goto error_create_poll
;
2038 /* Add the application registration socket */
2039 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
2041 goto error_poll_add
;
2044 /* Notify all applications to register */
2045 ret
= notify_ust_apps(1);
2047 ERR("Failed to notify applications or create the wait shared memory.\n"
2048 "Execution continues but there might be problem for already\n"
2049 "running applications that wishes to register.");
2053 DBG("Accepting application registration");
2055 /* Inifinite blocking call, waiting for transmission */
2057 health_poll_entry();
2058 ret
= lttng_poll_wait(&events
, -1);
2062 * Restart interrupted system call.
2064 if (errno
== EINTR
) {
2072 for (i
= 0; i
< nb_fd
; i
++) {
2073 health_code_update();
2075 /* Fetch once the poll data */
2076 revents
= LTTNG_POLL_GETEV(&events
, i
);
2077 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2080 /* No activity for this FD (poll implementation). */
2084 /* Thread quit pipe has been closed. Killing thread. */
2085 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
2091 /* Event on the registration socket */
2092 if (pollfd
== apps_sock
) {
2093 if (revents
& LPOLLIN
) {
2094 sock
= lttcomm_accept_unix_sock(apps_sock
);
2100 * Set socket timeout for both receiving and ending.
2101 * app_socket_timeout is in seconds, whereas
2102 * lttcomm_setsockopt_rcv_timeout and
2103 * lttcomm_setsockopt_snd_timeout expect msec as
2106 if (config
.app_socket_timeout
>= 0) {
2107 (void) lttcomm_setsockopt_rcv_timeout(sock
,
2108 config
.app_socket_timeout
* 1000);
2109 (void) lttcomm_setsockopt_snd_timeout(sock
,
2110 config
.app_socket_timeout
* 1000);
2114 * Set the CLOEXEC flag. Return code is useless because
2115 * either way, the show must go on.
2117 (void) utils_set_fd_cloexec(sock
);
2119 /* Create UST registration command for enqueuing */
2120 ust_cmd
= zmalloc(sizeof(struct ust_command
));
2121 if (ust_cmd
== NULL
) {
2122 PERROR("ust command zmalloc");
2131 * Using message-based transmissions to ensure we don't
2132 * have to deal with partially received messages.
2134 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2136 ERR("Exhausted file descriptors allowed for applications.");
2146 health_code_update();
2147 ret
= ust_app_recv_registration(sock
, &ust_cmd
->reg_msg
);
2150 /* Close socket of the application. */
2155 lttng_fd_put(LTTNG_FD_APPS
, 1);
2159 health_code_update();
2161 ust_cmd
->sock
= sock
;
2164 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2165 " gid:%d sock:%d name:%s (version %d.%d)",
2166 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
2167 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
2168 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
2169 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
2172 * Lock free enqueue the registration request. The red pill
2173 * has been taken! This apps will be part of the *system*.
2175 cds_wfcq_enqueue(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
, &ust_cmd
->node
);
2178 * Wake the registration queue futex. Implicit memory
2179 * barrier with the exchange in cds_wfcq_enqueue.
2181 futex_nto1_wake(&ust_cmd_queue
.futex
);
2182 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2183 ERR("Register apps socket poll error");
2186 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2195 /* Notify that the registration thread is gone */
2198 if (apps_sock
>= 0) {
2199 ret
= close(apps_sock
);
2209 lttng_fd_put(LTTNG_FD_APPS
, 1);
2211 unlink(config
.apps_unix_sock_path
.value
);
2214 lttng_poll_clean(&events
);
2218 DBG("UST Registration thread cleanup complete");
2221 ERR("Health error occurred in %s", __func__
);
2223 health_unregister(health_sessiond
);
2229 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2230 * exec or it will fails.
2232 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
2235 struct timespec timeout
;
2238 * Make sure we set the readiness flag to 0 because we are NOT ready.
2239 * This access to consumer_thread_is_ready does not need to be
2240 * protected by consumer_data.cond_mutex (yet) since the consumer
2241 * management thread has not been started at this point.
2243 consumer_data
->consumer_thread_is_ready
= 0;
2245 /* Setup pthread condition */
2246 ret
= pthread_condattr_init(&consumer_data
->condattr
);
2249 PERROR("pthread_condattr_init consumer data");
2254 * Set the monotonic clock in order to make sure we DO NOT jump in time
2255 * between the clock_gettime() call and the timedwait call. See bug #324
2256 * for a more details and how we noticed it.
2258 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
2261 PERROR("pthread_condattr_setclock consumer data");
2265 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
2268 PERROR("pthread_cond_init consumer data");
2272 ret
= pthread_create(&consumer_data
->thread
, default_pthread_attr(),
2273 thread_manage_consumer
, consumer_data
);
2276 PERROR("pthread_create consumer");
2281 /* We are about to wait on a pthread condition */
2282 pthread_mutex_lock(&consumer_data
->cond_mutex
);
2284 /* Get time for sem_timedwait absolute timeout */
2285 clock_ret
= lttng_clock_gettime(CLOCK_MONOTONIC
, &timeout
);
2287 * Set the timeout for the condition timed wait even if the clock gettime
2288 * call fails since we might loop on that call and we want to avoid to
2289 * increment the timeout too many times.
2291 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
2294 * The following loop COULD be skipped in some conditions so this is why we
2295 * set ret to 0 in order to make sure at least one round of the loop is
2301 * Loop until the condition is reached or when a timeout is reached. Note
2302 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2303 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2304 * possible. This loop does not take any chances and works with both of
2307 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
2308 if (clock_ret
< 0) {
2309 PERROR("clock_gettime spawn consumer");
2310 /* Infinite wait for the consumerd thread to be ready */
2311 ret
= pthread_cond_wait(&consumer_data
->cond
,
2312 &consumer_data
->cond_mutex
);
2314 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
2315 &consumer_data
->cond_mutex
, &timeout
);
2319 /* Release the pthread condition */
2320 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
2324 if (ret
== ETIMEDOUT
) {
2328 * Call has timed out so we kill the kconsumerd_thread and return
2331 ERR("Condition timed out. The consumer thread was never ready."
2333 pth_ret
= pthread_cancel(consumer_data
->thread
);
2335 PERROR("pthread_cancel consumer thread");
2338 PERROR("pthread_cond_wait failed consumer thread");
2340 /* Caller is expecting a negative value on failure. */
2345 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2346 if (consumer_data
->pid
== 0) {
2347 ERR("Consumerd did not start");
2348 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2351 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2360 * Join consumer thread
2362 static int join_consumer_thread(struct consumer_data
*consumer_data
)
2366 /* Consumer pid must be a real one. */
2367 if (consumer_data
->pid
> 0) {
2369 ret
= kill(consumer_data
->pid
, SIGTERM
);
2371 PERROR("Error killing consumer daemon");
2374 return pthread_join(consumer_data
->thread
, &status
);
2381 * Fork and exec a consumer daemon (consumerd).
2383 * Return pid if successful else -1.
2385 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
2389 const char *consumer_to_use
;
2390 const char *verbosity
;
2393 DBG("Spawning consumerd");
2400 if (config
.verbose_consumer
) {
2401 verbosity
= "--verbose";
2402 } else if (lttng_opt_quiet
) {
2403 verbosity
= "--quiet";
2408 switch (consumer_data
->type
) {
2409 case LTTNG_CONSUMER_KERNEL
:
2411 * Find out which consumerd to execute. We will first try the
2412 * 64-bit path, then the sessiond's installation directory, and
2413 * fallback on the 32-bit one,
2415 DBG3("Looking for a kernel consumer at these locations:");
2416 DBG3(" 1) %s", config
.consumerd64_bin_path
.value
? : "NULL");
2417 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
2418 DBG3(" 3) %s", config
.consumerd32_bin_path
.value
? : "NULL");
2419 if (stat(config
.consumerd64_bin_path
.value
, &st
) == 0) {
2420 DBG3("Found location #1");
2421 consumer_to_use
= config
.consumerd64_bin_path
.value
;
2422 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
2423 DBG3("Found location #2");
2424 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
2425 } else if (stat(config
.consumerd32_bin_path
.value
, &st
) == 0) {
2426 DBG3("Found location #3");
2427 consumer_to_use
= config
.consumerd32_bin_path
.value
;
2429 DBG("Could not find any valid consumerd executable");
2433 DBG("Using kernel consumer at: %s", consumer_to_use
);
2434 (void) execl(consumer_to_use
,
2435 "lttng-consumerd", verbosity
, "-k",
2436 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2437 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2438 "--group", config
.tracing_group_name
.value
,
2441 case LTTNG_CONSUMER64_UST
:
2443 if (config
.consumerd64_lib_dir
.value
) {
2448 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2452 tmplen
= strlen(config
.consumerd64_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
2453 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2458 strcat(tmpnew
, config
.consumerd64_lib_dir
.value
);
2459 if (tmp
[0] != '\0') {
2460 strcat(tmpnew
, ":");
2461 strcat(tmpnew
, tmp
);
2463 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
2470 DBG("Using 64-bit UST consumer at: %s", config
.consumerd64_bin_path
.value
);
2471 (void) execl(config
.consumerd64_bin_path
.value
, "lttng-consumerd", verbosity
, "-u",
2472 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2473 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2474 "--group", config
.tracing_group_name
.value
,
2478 case LTTNG_CONSUMER32_UST
:
2480 if (config
.consumerd32_lib_dir
.value
) {
2485 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
2489 tmplen
= strlen(config
.consumerd32_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
2490 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
2495 strcat(tmpnew
, config
.consumerd32_lib_dir
.value
);
2496 if (tmp
[0] != '\0') {
2497 strcat(tmpnew
, ":");
2498 strcat(tmpnew
, tmp
);
2500 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
2507 DBG("Using 32-bit UST consumer at: %s", config
.consumerd32_bin_path
.value
);
2508 (void) execl(config
.consumerd32_bin_path
.value
, "lttng-consumerd", verbosity
, "-u",
2509 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
2510 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
2511 "--group", config
.tracing_group_name
.value
,
2516 ERR("unknown consumer type");
2520 PERROR("Consumer execl()");
2522 /* Reaching this point, we got a failure on our execl(). */
2524 } else if (pid
> 0) {
2527 PERROR("start consumer fork");
2535 * Spawn the consumerd daemon and session daemon thread.
2537 static int start_consumerd(struct consumer_data
*consumer_data
)
2542 * Set the listen() state on the socket since there is a possible race
2543 * between the exec() of the consumer daemon and this call if place in the
2544 * consumer thread. See bug #366 for more details.
2546 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
2551 pthread_mutex_lock(&consumer_data
->pid_mutex
);
2552 if (consumer_data
->pid
!= 0) {
2553 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2557 ret
= spawn_consumerd(consumer_data
);
2559 ERR("Spawning consumerd failed");
2560 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2564 /* Setting up the consumer_data pid */
2565 consumer_data
->pid
= ret
;
2566 DBG2("Consumer pid %d", consumer_data
->pid
);
2567 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
2569 DBG2("Spawning consumer control thread");
2570 ret
= spawn_consumer_thread(consumer_data
);
2572 ERR("Fatal error spawning consumer control thread");
2580 /* Cleanup already created sockets on error. */
2581 if (consumer_data
->err_sock
>= 0) {
2584 err
= close(consumer_data
->err_sock
);
2586 PERROR("close consumer data error socket");
2593 * Setup necessary data for kernel tracer action.
2595 static int init_kernel_tracer(void)
2599 /* Modprobe lttng kernel modules */
2600 ret
= modprobe_lttng_control();
2605 /* Open debugfs lttng */
2606 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
2607 if (kernel_tracer_fd
< 0) {
2608 DBG("Failed to open %s", module_proc_lttng
);
2612 /* Validate kernel version */
2613 ret
= kernel_validate_version(kernel_tracer_fd
);
2618 ret
= modprobe_lttng_data();
2623 ret
= kernel_supports_ring_buffer_snapshot_sample_positions(
2630 WARN("Kernel tracer does not support buffer monitoring. "
2631 "The monitoring timer of channels in the kernel domain "
2632 "will be set to 0 (disabled).");
2635 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
2639 modprobe_remove_lttng_control();
2640 ret
= close(kernel_tracer_fd
);
2644 kernel_tracer_fd
= -1;
2645 return LTTNG_ERR_KERN_VERSION
;
2648 ret
= close(kernel_tracer_fd
);
2654 modprobe_remove_lttng_control();
2657 WARN("No kernel tracer available");
2658 kernel_tracer_fd
= -1;
2660 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
2662 return LTTNG_ERR_KERN_NA
;
2668 * Copy consumer output from the tracing session to the domain session. The
2669 * function also applies the right modification on a per domain basis for the
2670 * trace files destination directory.
2672 * Should *NOT* be called with RCU read-side lock held.
2674 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2677 const char *dir_name
;
2678 struct consumer_output
*consumer
;
2681 assert(session
->consumer
);
2684 case LTTNG_DOMAIN_KERNEL
:
2685 DBG3("Copying tracing session consumer output in kernel session");
2687 * XXX: We should audit the session creation and what this function
2688 * does "extra" in order to avoid a destroy since this function is used
2689 * in the domain session creation (kernel and ust) only. Same for UST
2692 if (session
->kernel_session
->consumer
) {
2693 consumer_output_put(session
->kernel_session
->consumer
);
2695 session
->kernel_session
->consumer
=
2696 consumer_copy_output(session
->consumer
);
2697 /* Ease our life a bit for the next part */
2698 consumer
= session
->kernel_session
->consumer
;
2699 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2701 case LTTNG_DOMAIN_JUL
:
2702 case LTTNG_DOMAIN_LOG4J
:
2703 case LTTNG_DOMAIN_PYTHON
:
2704 case LTTNG_DOMAIN_UST
:
2705 DBG3("Copying tracing session consumer output in UST session");
2706 if (session
->ust_session
->consumer
) {
2707 consumer_output_put(session
->ust_session
->consumer
);
2709 session
->ust_session
->consumer
=
2710 consumer_copy_output(session
->consumer
);
2711 /* Ease our life a bit for the next part */
2712 consumer
= session
->ust_session
->consumer
;
2713 dir_name
= DEFAULT_UST_TRACE_DIR
;
2716 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2720 /* Append correct directory to subdir */
2721 strncat(consumer
->subdir
, dir_name
,
2722 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
2723 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2732 * Create an UST session and add it to the session ust list.
2734 * Should *NOT* be called with RCU read-side lock held.
2736 static int create_ust_session(struct ltt_session
*session
,
2737 struct lttng_domain
*domain
)
2740 struct ltt_ust_session
*lus
= NULL
;
2744 assert(session
->consumer
);
2746 switch (domain
->type
) {
2747 case LTTNG_DOMAIN_JUL
:
2748 case LTTNG_DOMAIN_LOG4J
:
2749 case LTTNG_DOMAIN_PYTHON
:
2750 case LTTNG_DOMAIN_UST
:
2753 ERR("Unknown UST domain on create session %d", domain
->type
);
2754 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2758 DBG("Creating UST session");
2760 lus
= trace_ust_create_session(session
->id
);
2762 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2766 lus
->uid
= session
->uid
;
2767 lus
->gid
= session
->gid
;
2768 lus
->output_traces
= session
->output_traces
;
2769 lus
->snapshot_mode
= session
->snapshot_mode
;
2770 lus
->live_timer_interval
= session
->live_timer
;
2771 session
->ust_session
= lus
;
2772 if (session
->shm_path
[0]) {
2773 strncpy(lus
->root_shm_path
, session
->shm_path
,
2774 sizeof(lus
->root_shm_path
));
2775 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
2776 strncpy(lus
->shm_path
, session
->shm_path
,
2777 sizeof(lus
->shm_path
));
2778 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
2779 strncat(lus
->shm_path
, "/ust",
2780 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
2782 /* Copy session output to the newly created UST session */
2783 ret
= copy_session_consumer(domain
->type
, session
);
2784 if (ret
!= LTTNG_OK
) {
2792 session
->ust_session
= NULL
;
2797 * Create a kernel tracer session then create the default channel.
2799 static int create_kernel_session(struct ltt_session
*session
)
2803 DBG("Creating kernel session");
2805 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2807 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2811 /* Code flow safety */
2812 assert(session
->kernel_session
);
2814 /* Copy session output to the newly created Kernel session */
2815 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2816 if (ret
!= LTTNG_OK
) {
2820 /* Create directory(ies) on local filesystem. */
2821 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2822 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2823 ret
= run_as_mkdir_recursive(
2824 session
->kernel_session
->consumer
->dst
.trace_path
,
2825 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2827 if (errno
!= EEXIST
) {
2828 ERR("Trace directory creation error");
2834 session
->kernel_session
->uid
= session
->uid
;
2835 session
->kernel_session
->gid
= session
->gid
;
2836 session
->kernel_session
->output_traces
= session
->output_traces
;
2837 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
2842 trace_kernel_destroy_session(session
->kernel_session
);
2843 session
->kernel_session
= NULL
;
2848 * Count number of session permitted by uid/gid.
2850 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2853 struct ltt_session
*session
;
2855 DBG("Counting number of available session for UID %d GID %d",
2857 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2859 * Only list the sessions the user can control.
2861 if (!session_access_ok(session
, uid
, gid
)) {
2870 * Process the command requested by the lttng client within the command
2871 * context structure. This function make sure that the return structure (llm)
2872 * is set and ready for transmission before returning.
2874 * Return any error encountered or 0 for success.
2876 * "sock" is only used for special-case var. len data.
2878 * Should *NOT* be called with RCU read-side lock held.
2880 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2884 int need_tracing_session
= 1;
2887 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2889 assert(!rcu_read_ongoing());
2893 switch (cmd_ctx
->lsm
->cmd_type
) {
2894 case LTTNG_CREATE_SESSION
:
2895 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2896 case LTTNG_CREATE_SESSION_LIVE
:
2897 case LTTNG_DESTROY_SESSION
:
2898 case LTTNG_LIST_SESSIONS
:
2899 case LTTNG_LIST_DOMAINS
:
2900 case LTTNG_START_TRACE
:
2901 case LTTNG_STOP_TRACE
:
2902 case LTTNG_DATA_PENDING
:
2903 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2904 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2905 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2906 case LTTNG_SNAPSHOT_RECORD
:
2907 case LTTNG_SAVE_SESSION
:
2908 case LTTNG_SET_SESSION_SHM_PATH
:
2909 case LTTNG_REGENERATE_METADATA
:
2910 case LTTNG_REGENERATE_STATEDUMP
:
2911 case LTTNG_REGISTER_TRIGGER
:
2912 case LTTNG_UNREGISTER_TRIGGER
:
2919 if (config
.no_kernel
&& need_domain
2920 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
2922 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
2924 ret
= LTTNG_ERR_KERN_NA
;
2929 /* Deny register consumer if we already have a spawned consumer. */
2930 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
2931 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2932 if (kconsumer_data
.pid
> 0) {
2933 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2934 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2937 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2941 * Check for command that don't needs to allocate a returned payload. We do
2942 * this here so we don't have to make the call for no payload at each
2945 switch(cmd_ctx
->lsm
->cmd_type
) {
2946 case LTTNG_LIST_SESSIONS
:
2947 case LTTNG_LIST_TRACEPOINTS
:
2948 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2949 case LTTNG_LIST_DOMAINS
:
2950 case LTTNG_LIST_CHANNELS
:
2951 case LTTNG_LIST_EVENTS
:
2952 case LTTNG_LIST_SYSCALLS
:
2953 case LTTNG_LIST_TRACKER_PIDS
:
2954 case LTTNG_DATA_PENDING
:
2957 /* Setup lttng message with no payload */
2958 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
2960 /* This label does not try to unlock the session */
2961 goto init_setup_error
;
2965 /* Commands that DO NOT need a session. */
2966 switch (cmd_ctx
->lsm
->cmd_type
) {
2967 case LTTNG_CREATE_SESSION
:
2968 case LTTNG_CREATE_SESSION_SNAPSHOT
:
2969 case LTTNG_CREATE_SESSION_LIVE
:
2970 case LTTNG_LIST_SESSIONS
:
2971 case LTTNG_LIST_TRACEPOINTS
:
2972 case LTTNG_LIST_SYSCALLS
:
2973 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2974 case LTTNG_SAVE_SESSION
:
2975 case LTTNG_REGISTER_TRIGGER
:
2976 case LTTNG_UNREGISTER_TRIGGER
:
2977 need_tracing_session
= 0;
2980 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
2982 * We keep the session list lock across _all_ commands
2983 * for now, because the per-session lock does not
2984 * handle teardown properly.
2986 session_lock_list();
2987 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
2988 if (cmd_ctx
->session
== NULL
) {
2989 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
2992 /* Acquire lock for the session */
2993 session_lock(cmd_ctx
->session
);
2999 * Commands that need a valid session but should NOT create one if none
3000 * exists. Instead of creating one and destroying it when the command is
3001 * handled, process that right before so we save some round trip in useless
3004 switch (cmd_ctx
->lsm
->cmd_type
) {
3005 case LTTNG_DISABLE_CHANNEL
:
3006 case LTTNG_DISABLE_EVENT
:
3007 switch (cmd_ctx
->lsm
->domain
.type
) {
3008 case LTTNG_DOMAIN_KERNEL
:
3009 if (!cmd_ctx
->session
->kernel_session
) {
3010 ret
= LTTNG_ERR_NO_CHANNEL
;
3014 case LTTNG_DOMAIN_JUL
:
3015 case LTTNG_DOMAIN_LOG4J
:
3016 case LTTNG_DOMAIN_PYTHON
:
3017 case LTTNG_DOMAIN_UST
:
3018 if (!cmd_ctx
->session
->ust_session
) {
3019 ret
= LTTNG_ERR_NO_CHANNEL
;
3024 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3036 * Check domain type for specific "pre-action".
3038 switch (cmd_ctx
->lsm
->domain
.type
) {
3039 case LTTNG_DOMAIN_KERNEL
:
3041 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
3045 /* Kernel tracer check */
3046 if (kernel_tracer_fd
== -1) {
3047 /* Basically, load kernel tracer modules */
3048 ret
= init_kernel_tracer();
3054 /* Consumer is in an ERROR state. Report back to client */
3055 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3056 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3060 /* Need a session for kernel command */
3061 if (need_tracing_session
) {
3062 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3063 ret
= create_kernel_session(cmd_ctx
->session
);
3065 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
3070 /* Start the kernel consumer daemon */
3071 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3072 if (kconsumer_data
.pid
== 0 &&
3073 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3074 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3075 ret
= start_consumerd(&kconsumer_data
);
3077 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3080 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3082 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3086 * The consumer was just spawned so we need to add the socket to
3087 * the consumer output of the session if exist.
3089 ret
= consumer_create_socket(&kconsumer_data
,
3090 cmd_ctx
->session
->kernel_session
->consumer
);
3097 case LTTNG_DOMAIN_JUL
:
3098 case LTTNG_DOMAIN_LOG4J
:
3099 case LTTNG_DOMAIN_PYTHON
:
3100 case LTTNG_DOMAIN_UST
:
3102 if (!ust_app_supported()) {
3103 ret
= LTTNG_ERR_NO_UST
;
3106 /* Consumer is in an ERROR state. Report back to client */
3107 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3108 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3112 if (need_tracing_session
) {
3113 /* Create UST session if none exist. */
3114 if (cmd_ctx
->session
->ust_session
== NULL
) {
3115 ret
= create_ust_session(cmd_ctx
->session
,
3116 &cmd_ctx
->lsm
->domain
);
3117 if (ret
!= LTTNG_OK
) {
3122 /* Start the UST consumer daemons */
3124 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3125 if (config
.consumerd64_bin_path
.value
&&
3126 ustconsumer64_data
.pid
== 0 &&
3127 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3128 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3129 ret
= start_consumerd(&ustconsumer64_data
);
3131 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
3132 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
3136 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
3137 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3139 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3143 * Setup socket for consumer 64 bit. No need for atomic access
3144 * since it was set above and can ONLY be set in this thread.
3146 ret
= consumer_create_socket(&ustconsumer64_data
,
3147 cmd_ctx
->session
->ust_session
->consumer
);
3153 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
3154 if (config
.consumerd32_bin_path
.value
&&
3155 ustconsumer32_data
.pid
== 0 &&
3156 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3157 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3158 ret
= start_consumerd(&ustconsumer32_data
);
3160 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
3161 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
3165 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
3166 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3168 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3172 * Setup socket for consumer 64 bit. No need for atomic access
3173 * since it was set above and can ONLY be set in this thread.
3175 ret
= consumer_create_socket(&ustconsumer32_data
,
3176 cmd_ctx
->session
->ust_session
->consumer
);
3188 /* Validate consumer daemon state when start/stop trace command */
3189 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3190 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3191 switch (cmd_ctx
->lsm
->domain
.type
) {
3192 case LTTNG_DOMAIN_NONE
:
3194 case LTTNG_DOMAIN_JUL
:
3195 case LTTNG_DOMAIN_LOG4J
:
3196 case LTTNG_DOMAIN_PYTHON
:
3197 case LTTNG_DOMAIN_UST
:
3198 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3199 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
3203 case LTTNG_DOMAIN_KERNEL
:
3204 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3205 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
3210 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
3216 * Check that the UID or GID match that of the tracing session.
3217 * The root user can interact with all sessions.
3219 if (need_tracing_session
) {
3220 if (!session_access_ok(cmd_ctx
->session
,
3221 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3222 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3223 ret
= LTTNG_ERR_EPERM
;
3229 * Send relayd information to consumer as soon as we have a domain and a
3232 if (cmd_ctx
->session
&& need_domain
) {
3234 * Setup relayd if not done yet. If the relayd information was already
3235 * sent to the consumer, this call will gracefully return.
3237 ret
= cmd_setup_relayd(cmd_ctx
->session
);
3238 if (ret
!= LTTNG_OK
) {
3243 /* Process by command type */
3244 switch (cmd_ctx
->lsm
->cmd_type
) {
3245 case LTTNG_ADD_CONTEXT
:
3248 * An LTTNG_ADD_CONTEXT command might have a supplementary
3249 * payload if the context being added is an application context.
3251 if (cmd_ctx
->lsm
->u
.context
.ctx
.ctx
==
3252 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
3253 char *provider_name
= NULL
, *context_name
= NULL
;
3254 size_t provider_name_len
=
3255 cmd_ctx
->lsm
->u
.context
.provider_name_len
;
3256 size_t context_name_len
=
3257 cmd_ctx
->lsm
->u
.context
.context_name_len
;
3259 if (provider_name_len
== 0 || context_name_len
== 0) {
3261 * Application provider and context names MUST
3264 ret
= -LTTNG_ERR_INVALID
;
3268 provider_name
= zmalloc(provider_name_len
+ 1);
3269 if (!provider_name
) {
3270 ret
= -LTTNG_ERR_NOMEM
;
3273 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
=
3276 context_name
= zmalloc(context_name_len
+ 1);
3277 if (!context_name
) {
3278 ret
= -LTTNG_ERR_NOMEM
;
3279 goto error_add_context
;
3281 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
=
3284 ret
= lttcomm_recv_unix_sock(sock
, provider_name
,
3287 goto error_add_context
;
3290 ret
= lttcomm_recv_unix_sock(sock
, context_name
,
3293 goto error_add_context
;
3298 * cmd_add_context assumes ownership of the provider and context
3301 ret
= cmd_add_context(cmd_ctx
->session
,
3302 cmd_ctx
->lsm
->domain
.type
,
3303 cmd_ctx
->lsm
->u
.context
.channel_name
,
3304 &cmd_ctx
->lsm
->u
.context
.ctx
,
3305 kernel_poll_pipe
[1]);
3307 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
3308 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
3310 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
);
3311 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
);
3317 case LTTNG_DISABLE_CHANNEL
:
3319 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3320 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3323 case LTTNG_DISABLE_EVENT
:
3327 * FIXME: handle filter; for now we just receive the filter's
3328 * bytecode along with the filter expression which are sent by
3329 * liblttng-ctl and discard them.
3331 * This fixes an issue where the client may block while sending
3332 * the filter payload and encounter an error because the session
3333 * daemon closes the socket without ever handling this data.
3335 size_t count
= cmd_ctx
->lsm
->u
.disable
.expression_len
+
3336 cmd_ctx
->lsm
->u
.disable
.bytecode_len
;
3339 char data
[LTTNG_FILTER_MAX_LEN
];
3341 DBG("Discarding disable event command payload of size %zu", count
);
3343 ret
= lttcomm_recv_unix_sock(sock
, data
,
3344 count
> sizeof(data
) ? sizeof(data
) : count
);
3349 count
-= (size_t) ret
;
3352 /* FIXME: passing packed structure to non-packed pointer */
3353 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3354 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3355 &cmd_ctx
->lsm
->u
.disable
.event
);
3358 case LTTNG_ENABLE_CHANNEL
:
3360 cmd_ctx
->lsm
->u
.channel
.chan
.attr
.extended
.ptr
=
3361 (struct lttng_channel_extended
*) &cmd_ctx
->lsm
->u
.channel
.extended
;
3362 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3363 &cmd_ctx
->lsm
->u
.channel
.chan
,
3364 kernel_poll_pipe
[1]);
3367 case LTTNG_TRACK_PID
:
3369 ret
= cmd_track_pid(cmd_ctx
->session
,
3370 cmd_ctx
->lsm
->domain
.type
,
3371 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3374 case LTTNG_UNTRACK_PID
:
3376 ret
= cmd_untrack_pid(cmd_ctx
->session
,
3377 cmd_ctx
->lsm
->domain
.type
,
3378 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
3381 case LTTNG_ENABLE_EVENT
:
3383 struct lttng_event_exclusion
*exclusion
= NULL
;
3384 struct lttng_filter_bytecode
*bytecode
= NULL
;
3385 char *filter_expression
= NULL
;
3387 /* Handle exclusion events and receive it from the client. */
3388 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
3389 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
3391 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
3392 (count
* LTTNG_SYMBOL_NAME_LEN
));
3394 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
3398 DBG("Receiving var len exclusion event list from client ...");
3399 exclusion
->count
= count
;
3400 ret
= lttcomm_recv_unix_sock(sock
, exclusion
->names
,
3401 count
* LTTNG_SYMBOL_NAME_LEN
);
3403 DBG("Nothing recv() from client var len data... continuing");
3406 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
3411 /* Get filter expression from client. */
3412 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
3413 size_t expression_len
=
3414 cmd_ctx
->lsm
->u
.enable
.expression_len
;
3416 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
3417 ret
= LTTNG_ERR_FILTER_INVAL
;
3422 filter_expression
= zmalloc(expression_len
);
3423 if (!filter_expression
) {
3425 ret
= LTTNG_ERR_FILTER_NOMEM
;
3429 /* Receive var. len. data */
3430 DBG("Receiving var len filter's expression from client ...");
3431 ret
= lttcomm_recv_unix_sock(sock
, filter_expression
,
3434 DBG("Nothing recv() from client car len data... continuing");
3436 free(filter_expression
);
3438 ret
= LTTNG_ERR_FILTER_INVAL
;
3443 /* Handle filter and get bytecode from client. */
3444 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
3445 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
3447 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
3448 ret
= LTTNG_ERR_FILTER_INVAL
;
3449 free(filter_expression
);
3454 bytecode
= zmalloc(bytecode_len
);
3456 free(filter_expression
);
3458 ret
= LTTNG_ERR_FILTER_NOMEM
;
3462 /* Receive var. len. data */
3463 DBG("Receiving var len filter's bytecode from client ...");
3464 ret
= lttcomm_recv_unix_sock(sock
, bytecode
, bytecode_len
);
3466 DBG("Nothing recv() from client car len data... continuing");
3468 free(filter_expression
);
3471 ret
= LTTNG_ERR_FILTER_INVAL
;
3475 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
3476 free(filter_expression
);
3479 ret
= LTTNG_ERR_FILTER_INVAL
;
3484 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
3485 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3486 &cmd_ctx
->lsm
->u
.enable
.event
,
3487 filter_expression
, bytecode
, exclusion
,
3488 kernel_poll_pipe
[1]);
3491 case LTTNG_LIST_TRACEPOINTS
:
3493 struct lttng_event
*events
;
3496 session_lock_list();
3497 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3498 session_unlock_list();
3499 if (nb_events
< 0) {
3500 /* Return value is a negative lttng_error_code. */
3506 * Setup lttng message with payload size set to the event list size in
3507 * bytes and then copy list into the llm payload.
3509 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
3510 sizeof(struct lttng_event
) * nb_events
);
3520 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3522 struct lttng_event_field
*fields
;
3525 session_lock_list();
3526 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
3528 session_unlock_list();
3529 if (nb_fields
< 0) {
3530 /* Return value is a negative lttng_error_code. */
3536 * Setup lttng message with payload size set to the event list size in
3537 * bytes and then copy list into the llm payload.
3539 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
3540 sizeof(struct lttng_event_field
) * nb_fields
);
3550 case LTTNG_LIST_SYSCALLS
:
3552 struct lttng_event
*events
;
3555 nb_events
= cmd_list_syscalls(&events
);
3556 if (nb_events
< 0) {
3557 /* Return value is a negative lttng_error_code. */
3563 * Setup lttng message with payload size set to the event list size in
3564 * bytes and then copy list into the llm payload.
3566 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
3567 sizeof(struct lttng_event
) * nb_events
);
3577 case LTTNG_LIST_TRACKER_PIDS
:
3579 int32_t *pids
= NULL
;
3582 nr_pids
= cmd_list_tracker_pids(cmd_ctx
->session
,
3583 cmd_ctx
->lsm
->domain
.type
, &pids
);
3585 /* Return value is a negative lttng_error_code. */
3591 * Setup lttng message with payload size set to the event list size in
3592 * bytes and then copy list into the llm payload.
3594 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, pids
,
3595 sizeof(int32_t) * nr_pids
);
3605 case LTTNG_SET_CONSUMER_URI
:
3608 struct lttng_uri
*uris
;
3610 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3611 len
= nb_uri
* sizeof(struct lttng_uri
);
3614 ret
= LTTNG_ERR_INVALID
;
3618 uris
= zmalloc(len
);
3620 ret
= LTTNG_ERR_FATAL
;
3624 /* Receive variable len data */
3625 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
3626 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3628 DBG("No URIs received from client... continuing");
3630 ret
= LTTNG_ERR_SESSION_FAIL
;
3635 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
3637 if (ret
!= LTTNG_OK
) {
3644 case LTTNG_START_TRACE
:
3646 ret
= cmd_start_trace(cmd_ctx
->session
);
3649 case LTTNG_STOP_TRACE
:
3651 ret
= cmd_stop_trace(cmd_ctx
->session
);
3654 case LTTNG_CREATE_SESSION
:
3657 struct lttng_uri
*uris
= NULL
;
3659 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3660 len
= nb_uri
* sizeof(struct lttng_uri
);
3663 uris
= zmalloc(len
);
3665 ret
= LTTNG_ERR_FATAL
;
3669 /* Receive variable len data */
3670 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3671 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3673 DBG("No URIs received from client... continuing");
3675 ret
= LTTNG_ERR_SESSION_FAIL
;
3680 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3681 DBG("Creating session with ONE network URI is a bad call");
3682 ret
= LTTNG_ERR_SESSION_FAIL
;
3688 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
3689 &cmd_ctx
->creds
, 0);
3695 case LTTNG_DESTROY_SESSION
:
3697 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
3699 /* Set session to NULL so we do not unlock it after free. */
3700 cmd_ctx
->session
= NULL
;
3703 case LTTNG_LIST_DOMAINS
:
3706 struct lttng_domain
*domains
= NULL
;
3708 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3710 /* Return value is a negative lttng_error_code. */
3715 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
3716 nb_dom
* sizeof(struct lttng_domain
));
3726 case LTTNG_LIST_CHANNELS
:
3728 ssize_t payload_size
;
3729 struct lttng_channel
*channels
= NULL
;
3731 payload_size
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3732 cmd_ctx
->session
, &channels
);
3733 if (payload_size
< 0) {
3734 /* Return value is a negative lttng_error_code. */
3735 ret
= -payload_size
;
3739 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, channels
,
3750 case LTTNG_LIST_EVENTS
:
3753 struct lttng_event
*events
= NULL
;
3754 struct lttcomm_event_command_header cmd_header
;
3757 memset(&cmd_header
, 0, sizeof(cmd_header
));
3758 /* Extended infos are included at the end of events */
3759 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
,
3760 cmd_ctx
->session
, cmd_ctx
->lsm
->u
.list
.channel_name
,
3761 &events
, &total_size
);
3764 /* Return value is a negative lttng_error_code. */
3769 cmd_header
.nb_events
= nb_event
;
3770 ret
= setup_lttng_msg(cmd_ctx
, events
, total_size
,
3771 &cmd_header
, sizeof(cmd_header
));
3781 case LTTNG_LIST_SESSIONS
:
3783 unsigned int nr_sessions
;
3784 void *sessions_payload
;
3787 session_lock_list();
3788 nr_sessions
= lttng_sessions_count(
3789 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3790 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3791 payload_len
= sizeof(struct lttng_session
) * nr_sessions
;
3792 sessions_payload
= zmalloc(payload_len
);
3794 if (!sessions_payload
) {
3795 session_unlock_list();
3800 cmd_list_lttng_sessions(sessions_payload
,
3801 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3802 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3803 session_unlock_list();
3805 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
3807 free(sessions_payload
);
3816 case LTTNG_REGISTER_CONSUMER
:
3818 struct consumer_data
*cdata
;
3820 switch (cmd_ctx
->lsm
->domain
.type
) {
3821 case LTTNG_DOMAIN_KERNEL
:
3822 cdata
= &kconsumer_data
;
3825 ret
= LTTNG_ERR_UND
;
3829 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3830 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
3833 case LTTNG_DATA_PENDING
:
3836 uint8_t pending_ret_byte
;
3838 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
3843 * This function may returns 0 or 1 to indicate whether or not
3844 * there is data pending. In case of error, it should return an
3845 * LTTNG_ERR code. However, some code paths may still return
3846 * a nondescript error code, which we handle by returning an
3849 if (pending_ret
== 0 || pending_ret
== 1) {
3851 * ret will be set to LTTNG_OK at the end of
3854 } else if (pending_ret
< 0) {
3855 ret
= LTTNG_ERR_UNK
;
3862 pending_ret_byte
= (uint8_t) pending_ret
;
3864 /* 1 byte to return whether or not data is pending */
3865 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
3866 &pending_ret_byte
, 1);
3875 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
3877 struct lttcomm_lttng_output_id reply
;
3879 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
3880 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
3881 if (ret
!= LTTNG_OK
) {
3885 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
3891 /* Copy output list into message payload */
3895 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
3897 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
3898 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
3901 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
3904 struct lttng_snapshot_output
*outputs
= NULL
;
3906 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
3907 if (nb_output
< 0) {
3912 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
3913 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
3914 nb_output
* sizeof(struct lttng_snapshot_output
));
3924 case LTTNG_SNAPSHOT_RECORD
:
3926 ret
= cmd_snapshot_record(cmd_ctx
->session
,
3927 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
3928 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
3931 case LTTNG_CREATE_SESSION_SNAPSHOT
:
3934 struct lttng_uri
*uris
= NULL
;
3936 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3937 len
= nb_uri
* sizeof(struct lttng_uri
);
3940 uris
= zmalloc(len
);
3942 ret
= LTTNG_ERR_FATAL
;
3946 /* Receive variable len data */
3947 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3948 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3950 DBG("No URIs received from client... continuing");
3952 ret
= LTTNG_ERR_SESSION_FAIL
;
3957 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3958 DBG("Creating session with ONE network URI is a bad call");
3959 ret
= LTTNG_ERR_SESSION_FAIL
;
3965 ret
= cmd_create_session_snapshot(cmd_ctx
->lsm
->session
.name
, uris
,
3966 nb_uri
, &cmd_ctx
->creds
);
3970 case LTTNG_CREATE_SESSION_LIVE
:
3973 struct lttng_uri
*uris
= NULL
;
3975 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
3976 len
= nb_uri
* sizeof(struct lttng_uri
);
3979 uris
= zmalloc(len
);
3981 ret
= LTTNG_ERR_FATAL
;
3985 /* Receive variable len data */
3986 DBG("Waiting for %zu URIs from client ...", nb_uri
);
3987 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
3989 DBG("No URIs received from client... continuing");
3991 ret
= LTTNG_ERR_SESSION_FAIL
;
3996 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
3997 DBG("Creating session with ONE network URI is a bad call");
3998 ret
= LTTNG_ERR_SESSION_FAIL
;
4004 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
,
4005 nb_uri
, &cmd_ctx
->creds
, cmd_ctx
->lsm
->u
.session_live
.timer_interval
);
4009 case LTTNG_SAVE_SESSION
:
4011 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
4015 case LTTNG_SET_SESSION_SHM_PATH
:
4017 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
4018 cmd_ctx
->lsm
->u
.set_shm_path
.shm_path
);
4021 case LTTNG_REGENERATE_METADATA
:
4023 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
4026 case LTTNG_REGENERATE_STATEDUMP
:
4028 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
4031 case LTTNG_REGISTER_TRIGGER
:
4033 ret
= cmd_register_trigger(cmd_ctx
, sock
,
4034 notification_thread_handle
);
4037 case LTTNG_UNREGISTER_TRIGGER
:
4039 ret
= cmd_unregister_trigger(cmd_ctx
, sock
,
4040 notification_thread_handle
);
4044 ret
= LTTNG_ERR_UND
;
4049 if (cmd_ctx
->llm
== NULL
) {
4050 DBG("Missing llm structure. Allocating one.");
4051 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
4055 /* Set return code */
4056 cmd_ctx
->llm
->ret_code
= ret
;
4058 if (cmd_ctx
->session
) {
4059 session_unlock(cmd_ctx
->session
);
4061 if (need_tracing_session
) {
4062 session_unlock_list();
4065 assert(!rcu_read_ongoing());
4070 * Thread managing health check socket.
4072 static void *thread_manage_health(void *data
)
4074 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
4075 uint32_t revents
, nb_fd
;
4076 struct lttng_poll_event events
;
4077 struct health_comm_msg msg
;
4078 struct health_comm_reply reply
;
4080 DBG("[thread] Manage health check started");
4082 rcu_register_thread();
4084 /* We might hit an error path before this is created. */
4085 lttng_poll_init(&events
);
4087 /* Create unix socket */
4088 sock
= lttcomm_create_unix_sock(config
.health_unix_sock_path
.value
);
4090 ERR("Unable to create health check Unix socket");
4095 /* lttng health client socket path permissions */
4096 ret
= chown(config
.health_unix_sock_path
.value
, 0,
4097 utils_get_group_id(config
.tracing_group_name
.value
));
4099 ERR("Unable to set group on %s", config
.health_unix_sock_path
.value
);
4104 ret
= chmod(config
.health_unix_sock_path
.value
,
4105 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4107 ERR("Unable to set permissions on %s", config
.health_unix_sock_path
.value
);
4114 * Set the CLOEXEC flag. Return code is useless because either way, the
4117 (void) utils_set_fd_cloexec(sock
);
4119 ret
= lttcomm_listen_unix_sock(sock
);
4125 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4126 * more will be added to this poll set.
4128 ret
= sessiond_set_thread_pollset(&events
, 2);
4133 /* Add the application registration socket */
4134 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
4139 sessiond_notify_ready();
4142 DBG("Health check ready");
4144 /* Inifinite blocking call, waiting for transmission */
4146 ret
= lttng_poll_wait(&events
, -1);
4149 * Restart interrupted system call.
4151 if (errno
== EINTR
) {
4159 for (i
= 0; i
< nb_fd
; i
++) {
4160 /* Fetch once the poll data */
4161 revents
= LTTNG_POLL_GETEV(&events
, i
);
4162 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4165 /* No activity for this FD (poll implementation). */
4169 /* Thread quit pipe has been closed. Killing thread. */
4170 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4176 /* Event on the registration socket */
4177 if (pollfd
== sock
) {
4178 if (revents
& LPOLLIN
) {
4180 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4181 ERR("Health socket poll error");
4184 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4190 new_sock
= lttcomm_accept_unix_sock(sock
);
4196 * Set the CLOEXEC flag. Return code is useless because either way, the
4199 (void) utils_set_fd_cloexec(new_sock
);
4201 DBG("Receiving data from client for health...");
4202 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
4204 DBG("Nothing recv() from client... continuing");
4205 ret
= close(new_sock
);
4212 rcu_thread_online();
4214 memset(&reply
, 0, sizeof(reply
));
4215 for (i
= 0; i
< NR_HEALTH_SESSIOND_TYPES
; i
++) {
4217 * health_check_state returns 0 if health is
4220 if (!health_check_state(health_sessiond
, i
)) {
4221 reply
.ret_code
|= 1ULL << i
;
4225 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
4227 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
4229 ERR("Failed to send health data back to client");
4232 /* End of transmission */
4233 ret
= close(new_sock
);
4242 ERR("Health error occurred in %s", __func__
);
4244 DBG("Health check thread dying");
4245 unlink(config
.health_unix_sock_path
.value
);
4253 lttng_poll_clean(&events
);
4255 rcu_unregister_thread();
4260 * This thread manage all clients request using the unix client socket for
4263 static void *thread_manage_clients(void *data
)
4265 int sock
= -1, ret
, i
, pollfd
, err
= -1;
4267 uint32_t revents
, nb_fd
;
4268 struct command_ctx
*cmd_ctx
= NULL
;
4269 struct lttng_poll_event events
;
4271 DBG("[thread] Manage client started");
4273 rcu_register_thread();
4275 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
4277 health_code_update();
4279 ret
= lttcomm_listen_unix_sock(client_sock
);
4285 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4286 * more will be added to this poll set.
4288 ret
= sessiond_set_thread_pollset(&events
, 2);
4290 goto error_create_poll
;
4293 /* Add the application registration socket */
4294 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
4299 sessiond_notify_ready();
4300 ret
= sem_post(&load_info
->message_thread_ready
);
4302 PERROR("sem_post message_thread_ready");
4306 /* This testpoint is after we signal readiness to the parent. */
4307 if (testpoint(sessiond_thread_manage_clients
)) {
4311 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
4315 health_code_update();
4318 DBG("Accepting client command ...");
4320 /* Inifinite blocking call, waiting for transmission */
4322 health_poll_entry();
4323 ret
= lttng_poll_wait(&events
, -1);
4327 * Restart interrupted system call.
4329 if (errno
== EINTR
) {
4337 for (i
= 0; i
< nb_fd
; i
++) {
4338 /* Fetch once the poll data */
4339 revents
= LTTNG_POLL_GETEV(&events
, i
);
4340 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4342 health_code_update();
4345 /* No activity for this FD (poll implementation). */
4349 /* Thread quit pipe has been closed. Killing thread. */
4350 ret
= sessiond_check_thread_quit_pipe(pollfd
, revents
);
4356 /* Event on the registration socket */
4357 if (pollfd
== client_sock
) {
4358 if (revents
& LPOLLIN
) {
4360 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4361 ERR("Client socket poll error");
4364 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
4370 DBG("Wait for client response");
4372 health_code_update();
4374 sock
= lttcomm_accept_unix_sock(client_sock
);
4380 * Set the CLOEXEC flag. Return code is useless because either way, the
4383 (void) utils_set_fd_cloexec(sock
);
4385 /* Set socket option for credentials retrieval */
4386 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
4391 /* Allocate context command to process the client request */
4392 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
4393 if (cmd_ctx
== NULL
) {
4394 PERROR("zmalloc cmd_ctx");
4398 /* Allocate data buffer for reception */
4399 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
4400 if (cmd_ctx
->lsm
== NULL
) {
4401 PERROR("zmalloc cmd_ctx->lsm");
4405 cmd_ctx
->llm
= NULL
;
4406 cmd_ctx
->session
= NULL
;
4408 health_code_update();
4411 * Data is received from the lttng client. The struct
4412 * lttcomm_session_msg (lsm) contains the command and data request of
4415 DBG("Receiving data from client ...");
4416 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
4417 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
4419 DBG("Nothing recv() from client... continuing");
4425 clean_command_ctx(&cmd_ctx
);
4429 health_code_update();
4431 // TODO: Validate cmd_ctx including sanity check for
4432 // security purpose.
4434 rcu_thread_online();
4436 * This function dispatch the work to the kernel or userspace tracer
4437 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4438 * informations for the client. The command context struct contains
4439 * everything this function may needs.
4441 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
4442 rcu_thread_offline();
4450 * TODO: Inform client somehow of the fatal error. At
4451 * this point, ret < 0 means that a zmalloc failed
4452 * (ENOMEM). Error detected but still accept
4453 * command, unless a socket error has been
4456 clean_command_ctx(&cmd_ctx
);
4460 health_code_update();
4462 DBG("Sending response (size: %d, retcode: %s (%d))",
4463 cmd_ctx
->lttng_msg_size
,
4464 lttng_strerror(-cmd_ctx
->llm
->ret_code
),
4465 cmd_ctx
->llm
->ret_code
);
4466 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
4468 ERR("Failed to send data back to client");
4471 /* End of transmission */
4478 clean_command_ctx(&cmd_ctx
);
4480 health_code_update();
4492 lttng_poll_clean(&events
);
4493 clean_command_ctx(&cmd_ctx
);
4497 unlink(config
.client_unix_sock_path
.value
);
4498 if (client_sock
>= 0) {
4499 ret
= close(client_sock
);
4507 ERR("Health error occurred in %s", __func__
);
4510 health_unregister(health_sessiond
);
4512 DBG("Client thread dying");
4514 rcu_unregister_thread();
4517 * Since we are creating the consumer threads, we own them, so we need
4518 * to join them before our thread exits.
4520 ret
= join_consumer_thread(&kconsumer_data
);
4523 PERROR("join_consumer");
4526 ret
= join_consumer_thread(&ustconsumer32_data
);
4529 PERROR("join_consumer ust32");
4532 ret
= join_consumer_thread(&ustconsumer64_data
);
4535 PERROR("join_consumer ust64");
4540 static int string_match(const char *str1
, const char *str2
)
4542 return (str1
&& str2
) && !strcmp(str1
, str2
);
4546 * Take an option from the getopt output and set it in the right variable to be
4549 * Return 0 on success else a negative value.
4551 static int set_option(int opt
, const char *arg
, const char *optname
)
4555 if (string_match(optname
, "client-sock") || opt
== 'c') {
4556 if (!arg
|| *arg
== '\0') {
4560 if (lttng_is_setuid_setgid()) {
4561 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4562 "-c, --client-sock");
4564 config_string_set(&config
.client_unix_sock_path
,
4566 if (!config
.client_unix_sock_path
.value
) {
4571 } else if (string_match(optname
, "apps-sock") || opt
== 'a') {
4572 if (!arg
|| *arg
== '\0') {
4576 if (lttng_is_setuid_setgid()) {
4577 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4580 config_string_set(&config
.apps_unix_sock_path
,
4582 if (!config
.apps_unix_sock_path
.value
) {
4587 } else if (string_match(optname
, "daemonize") || opt
== 'd') {
4588 config
.daemonize
= true;
4589 } else if (string_match(optname
, "background") || opt
== 'b') {
4590 config
.background
= true;
4591 } else if (string_match(optname
, "group") || opt
== 'g') {
4592 if (!arg
|| *arg
== '\0') {
4596 if (lttng_is_setuid_setgid()) {
4597 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4600 config_string_set(&config
.tracing_group_name
,
4602 if (!config
.tracing_group_name
.value
) {
4607 } else if (string_match(optname
, "help") || opt
== 'h') {
4608 ret
= utils_show_help(8, "lttng-sessiond", help_msg
);
4610 ERR("Cannot show --help for `lttng-sessiond`");
4613 exit(ret
? EXIT_FAILURE
: EXIT_SUCCESS
);
4614 } else if (string_match(optname
, "version") || opt
== 'V') {
4615 fprintf(stdout
, "%s\n", VERSION
);
4617 } else if (string_match(optname
, "sig-parent") || opt
== 'S') {
4618 config
.sig_parent
= true;
4619 } else if (string_match(optname
, "kconsumerd-err-sock")) {
4620 if (!arg
|| *arg
== '\0') {
4624 if (lttng_is_setuid_setgid()) {
4625 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4626 "--kconsumerd-err-sock");
4628 config_string_set(&config
.kconsumerd_err_unix_sock_path
,
4630 if (!config
.kconsumerd_err_unix_sock_path
.value
) {
4635 } else if (string_match(optname
, "kconsumerd-cmd-sock")) {
4636 if (!arg
|| *arg
== '\0') {
4640 if (lttng_is_setuid_setgid()) {
4641 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4642 "--kconsumerd-cmd-sock");
4644 config_string_set(&config
.kconsumerd_cmd_unix_sock_path
,
4646 if (!config
.kconsumerd_cmd_unix_sock_path
.value
) {
4651 } else if (string_match(optname
, "ustconsumerd64-err-sock")) {
4652 if (!arg
|| *arg
== '\0') {
4656 if (lttng_is_setuid_setgid()) {
4657 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4658 "--ustconsumerd64-err-sock");
4660 config_string_set(&config
.consumerd64_err_unix_sock_path
,
4662 if (!config
.consumerd64_err_unix_sock_path
.value
) {
4667 } else if (string_match(optname
, "ustconsumerd64-cmd-sock")) {
4668 if (!arg
|| *arg
== '\0') {
4672 if (lttng_is_setuid_setgid()) {
4673 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4674 "--ustconsumerd64-cmd-sock");
4676 config_string_set(&config
.consumerd64_cmd_unix_sock_path
,
4678 if (!config
.consumerd64_cmd_unix_sock_path
.value
) {
4683 } else if (string_match(optname
, "ustconsumerd32-err-sock")) {
4684 if (!arg
|| *arg
== '\0') {
4688 if (lttng_is_setuid_setgid()) {
4689 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4690 "--ustconsumerd32-err-sock");
4692 config_string_set(&config
.consumerd32_err_unix_sock_path
,
4694 if (!config
.consumerd32_err_unix_sock_path
.value
) {
4699 } else if (string_match(optname
, "ustconsumerd32-cmd-sock")) {
4700 if (!arg
|| *arg
== '\0') {
4704 if (lttng_is_setuid_setgid()) {
4705 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4706 "--ustconsumerd32-cmd-sock");
4708 config_string_set(&config
.consumerd32_cmd_unix_sock_path
,
4710 if (!config
.consumerd32_cmd_unix_sock_path
.value
) {
4715 } else if (string_match(optname
, "no-kernel")) {
4716 config
.no_kernel
= true;
4717 } else if (string_match(optname
, "quiet") || opt
== 'q') {
4718 lttng_opt_quiet
= true;
4719 } else if (string_match(optname
, "verbose") || opt
== 'v') {
4720 /* Verbose level can increase using multiple -v */
4722 /* Value obtained from config file */
4723 config
.verbose
= config_parse_value(arg
);
4725 /* -v used on command line */
4728 /* Clamp value to [0, 3] */
4729 config
.verbose
= config
.verbose
< 0 ? 0 :
4730 (config
.verbose
<= 3 ? config
.verbose
: 3);
4731 } else if (string_match(optname
, "verbose-consumer")) {
4733 config
.verbose_consumer
= config_parse_value(arg
);
4735 config
.verbose_consumer
++;
4737 } else if (string_match(optname
, "consumerd32-path")) {
4738 if (!arg
|| *arg
== '\0') {
4742 if (lttng_is_setuid_setgid()) {
4743 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4744 "--consumerd32-path");
4746 config_string_set(&config
.consumerd32_bin_path
,
4748 if (!config
.consumerd32_bin_path
.value
) {
4753 } else if (string_match(optname
, "consumerd32-libdir")) {
4754 if (!arg
|| *arg
== '\0') {
4758 if (lttng_is_setuid_setgid()) {
4759 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4760 "--consumerd32-libdir");
4762 config_string_set(&config
.consumerd32_lib_dir
,
4764 if (!config
.consumerd32_lib_dir
.value
) {
4769 } else if (string_match(optname
, "consumerd64-path")) {
4770 if (!arg
|| *arg
== '\0') {
4774 if (lttng_is_setuid_setgid()) {
4775 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4776 "--consumerd64-path");
4778 config_string_set(&config
.consumerd64_bin_path
,
4780 if (!config
.consumerd64_bin_path
.value
) {
4785 } else if (string_match(optname
, "consumerd64-libdir")) {
4786 if (!arg
|| *arg
== '\0') {
4790 if (lttng_is_setuid_setgid()) {
4791 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4792 "--consumerd64-libdir");
4794 config_string_set(&config
.consumerd64_lib_dir
,
4796 if (!config
.consumerd64_lib_dir
.value
) {
4801 } else if (string_match(optname
, "pidfile") || opt
== 'p') {
4802 if (!arg
|| *arg
== '\0') {
4806 if (lttng_is_setuid_setgid()) {
4807 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4810 config_string_set(&config
.pid_file_path
, strdup(arg
));
4811 if (!config
.pid_file_path
.value
) {
4816 } else if (string_match(optname
, "agent-tcp-port")) {
4817 if (!arg
|| *arg
== '\0') {
4821 if (lttng_is_setuid_setgid()) {
4822 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4823 "--agent-tcp-port");
4828 v
= strtoul(arg
, NULL
, 0);
4829 if (errno
!= 0 || !isdigit(arg
[0])) {
4830 ERR("Wrong value in --agent-tcp-port parameter: %s", arg
);
4833 if (v
== 0 || v
>= 65535) {
4834 ERR("Port overflow in --agent-tcp-port parameter: %s", arg
);
4837 config
.agent_tcp_port
= (uint32_t) v
;
4838 DBG3("Agent TCP port set to non default: %u", config
.agent_tcp_port
);
4840 } else if (string_match(optname
, "load") || opt
== 'l') {
4841 if (!arg
|| *arg
== '\0') {
4845 if (lttng_is_setuid_setgid()) {
4846 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4849 config_string_set(&config
.load_session_path
, strdup(arg
));
4850 if (!config
.load_session_path
.value
) {
4855 } else if (string_match(optname
, "kmod-probes")) {
4856 if (!arg
|| *arg
== '\0') {
4860 if (lttng_is_setuid_setgid()) {
4861 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4864 config_string_set(&config
.kmod_probes_list
, strdup(arg
));
4865 if (!config
.kmod_probes_list
.value
) {
4870 } else if (string_match(optname
, "extra-kmod-probes")) {
4871 if (!arg
|| *arg
== '\0') {
4875 if (lttng_is_setuid_setgid()) {
4876 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4877 "--extra-kmod-probes");
4879 config_string_set(&config
.kmod_extra_probes_list
,
4881 if (!config
.kmod_extra_probes_list
.value
) {
4886 } else if (string_match(optname
, "config") || opt
== 'f') {
4887 /* This is handled in set_options() thus silent skip. */
4890 /* Unknown option or other error.
4891 * Error is printed by getopt, just return */
4896 if (ret
== -EINVAL
) {
4897 const char *opt_name
= "unknown";
4900 for (i
= 0; i
< sizeof(long_options
) / sizeof(struct option
);
4902 if (opt
== long_options
[i
].val
) {
4903 opt_name
= long_options
[i
].name
;
4908 WARN("Invalid argument provided for option \"%s\", using default value.",
4916 * config_entry_handler_cb used to handle options read from a config file.
4917 * See config_entry_handler_cb comment in common/config/session-config.h for the
4918 * return value conventions.
4920 static int config_entry_handler(const struct config_entry
*entry
, void *unused
)
4924 if (!entry
|| !entry
->name
|| !entry
->value
) {
4929 /* Check if the option is to be ignored */
4930 for (i
= 0; i
< sizeof(config_ignore_options
) / sizeof(char *); i
++) {
4931 if (!strcmp(entry
->name
, config_ignore_options
[i
])) {
4936 for (i
= 0; i
< (sizeof(long_options
) / sizeof(struct option
)) - 1;
4939 /* Ignore if not fully matched. */
4940 if (strcmp(entry
->name
, long_options
[i
].name
)) {
4945 * If the option takes no argument on the command line, we have to
4946 * check if the value is "true". We support non-zero numeric values,
4949 if (!long_options
[i
].has_arg
) {
4950 ret
= config_parse_value(entry
->value
);
4953 WARN("Invalid configuration value \"%s\" for option %s",
4954 entry
->value
, entry
->name
);
4956 /* False, skip boolean config option. */
4961 ret
= set_option(long_options
[i
].val
, entry
->value
, entry
->name
);
4965 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry
->name
);
4972 * daemon configuration loading and argument parsing
4974 static int set_options(int argc
, char **argv
)
4976 int ret
= 0, c
= 0, option_index
= 0;
4977 int orig_optopt
= optopt
, orig_optind
= optind
;
4979 const char *config_path
= NULL
;
4981 optstring
= utils_generate_optstring(long_options
,
4982 sizeof(long_options
) / sizeof(struct option
));
4988 /* Check for the --config option */
4989 while ((c
= getopt_long(argc
, argv
, optstring
, long_options
,
4990 &option_index
)) != -1) {
4994 } else if (c
!= 'f') {
4995 /* if not equal to --config option. */
4999 if (lttng_is_setuid_setgid()) {
5000 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5003 config_path
= utils_expand_path(optarg
);
5005 ERR("Failed to resolve path: %s", optarg
);
5010 ret
= config_get_section_entries(config_path
, config_section_name
,
5011 config_entry_handler
, NULL
);
5014 ERR("Invalid configuration option at line %i", ret
);
5020 /* Reset getopt's global state */
5021 optopt
= orig_optopt
;
5022 optind
= orig_optind
;
5026 * getopt_long() will not set option_index if it encounters a
5029 c
= getopt_long(argc
, argv
, optstring
, long_options
,
5036 * Pass NULL as the long option name if popt left the index
5039 ret
= set_option(c
, optarg
,
5040 option_index
< 0 ? NULL
:
5041 long_options
[option_index
].name
);
5053 * Creates the two needed socket by the daemon.
5054 * apps_sock - The communication socket for all UST apps.
5055 * client_sock - The communication of the cli tool (lttng).
5057 static int init_daemon_socket(void)
5062 old_umask
= umask(0);
5064 /* Create client tool unix socket */
5065 client_sock
= lttcomm_create_unix_sock(config
.client_unix_sock_path
.value
);
5066 if (client_sock
< 0) {
5067 ERR("Create unix sock failed: %s", config
.client_unix_sock_path
.value
);
5072 /* Set the cloexec flag */
5073 ret
= utils_set_fd_cloexec(client_sock
);
5075 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
5076 "Continuing but note that the consumer daemon will have a "
5077 "reference to this socket on exec()", client_sock
);
5080 /* File permission MUST be 660 */
5081 ret
= chmod(config
.client_unix_sock_path
.value
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5083 ERR("Set file permissions failed: %s", config
.client_unix_sock_path
.value
);
5088 /* Create the application unix socket */
5089 apps_sock
= lttcomm_create_unix_sock(config
.apps_unix_sock_path
.value
);
5090 if (apps_sock
< 0) {
5091 ERR("Create unix sock failed: %s", config
.apps_unix_sock_path
.value
);
5096 /* Set the cloexec flag */
5097 ret
= utils_set_fd_cloexec(apps_sock
);
5099 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
5100 "Continuing but note that the consumer daemon will have a "
5101 "reference to this socket on exec()", apps_sock
);
5104 /* File permission MUST be 666 */
5105 ret
= chmod(config
.apps_unix_sock_path
.value
,
5106 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5108 ERR("Set file permissions failed: %s", config
.apps_unix_sock_path
.value
);
5113 DBG3("Session daemon client socket %d and application socket %d created",
5114 client_sock
, apps_sock
);
5122 * Check if the global socket is available, and if a daemon is answering at the
5123 * other side. If yes, error is returned.
5125 static int check_existing_daemon(void)
5127 /* Is there anybody out there ? */
5128 if (lttng_session_daemon_alive()) {
5136 * Set the tracing group gid onto the client socket.
5138 * Race window between mkdir and chown is OK because we are going from more
5139 * permissive (root.root) to less permissive (root.tracing).
5141 static int set_permissions(char *rundir
)
5146 gid
= utils_get_group_id(config
.tracing_group_name
.value
);
5148 /* Set lttng run dir */
5149 ret
= chown(rundir
, 0, gid
);
5151 ERR("Unable to set group on %s", rundir
);
5156 * Ensure all applications and tracing group can search the run
5157 * dir. Allow everyone to read the directory, since it does not
5158 * buy us anything to hide its content.
5160 ret
= chmod(rundir
, S_IRWXU
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
5162 ERR("Unable to set permissions on %s", rundir
);
5166 /* lttng client socket path */
5167 ret
= chown(config
.client_unix_sock_path
.value
, 0, gid
);
5169 ERR("Unable to set group on %s", config
.client_unix_sock_path
.value
);
5173 /* kconsumer error socket path */
5174 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, 0);
5176 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5180 /* 64-bit ustconsumer error socket path */
5181 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, 0);
5183 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5187 /* 32-bit ustconsumer compat32 error socket path */
5188 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, 0);
5190 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5194 DBG("All permissions are set");
5200 * Create the lttng run directory needed for all global sockets and pipe.
5202 static int create_lttng_rundir(void)
5206 DBG3("Creating LTTng run directory: %s", config
.rundir
.value
);
5208 ret
= mkdir(config
.rundir
.value
, S_IRWXU
);
5210 if (errno
!= EEXIST
) {
5211 ERR("Unable to create %s", config
.rundir
.value
);
5223 * Setup sockets and directory needed by the consumerds' communication with the
5226 static int set_consumer_sockets(struct consumer_data
*consumer_data
)
5231 switch (consumer_data
->type
) {
5232 case LTTNG_CONSUMER_KERNEL
:
5233 path
= config
.kconsumerd_path
.value
;
5235 case LTTNG_CONSUMER64_UST
:
5236 path
= config
.consumerd64_path
.value
;
5238 case LTTNG_CONSUMER32_UST
:
5239 path
= config
.consumerd32_path
.value
;
5242 ERR("Consumer type unknown");
5248 DBG2("Creating consumer directory: %s", path
);
5250 ret
= mkdir(path
, S_IRWXU
| S_IRGRP
| S_IXGRP
);
5251 if (ret
< 0 && errno
!= EEXIST
) {
5253 ERR("Failed to create %s", path
);
5257 ret
= chown(path
, 0, utils_get_group_id(config
.tracing_group_name
.value
));
5259 ERR("Unable to set group on %s", path
);
5265 /* Create the consumerd error unix socket */
5266 consumer_data
->err_sock
=
5267 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5268 if (consumer_data
->err_sock
< 0) {
5269 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5275 * Set the CLOEXEC flag. Return code is useless because either way, the
5278 ret
= utils_set_fd_cloexec(consumer_data
->err_sock
);
5280 PERROR("utils_set_fd_cloexec");
5281 /* continue anyway */
5284 /* File permission MUST be 660 */
5285 ret
= chmod(consumer_data
->err_unix_sock_path
,
5286 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5288 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5298 * Signal handler for the daemon
5300 * Simply stop all worker threads, leaving main() return gracefully after
5301 * joining all threads and calling cleanup().
5303 static void sighandler(int sig
)
5307 DBG("SIGINT caught");
5311 DBG("SIGTERM caught");
5315 CMM_STORE_SHARED(recv_child_signal
, 1);
5323 * Setup signal handler for :
5324 * SIGINT, SIGTERM, SIGPIPE
5326 static int set_signal_handler(void)
5329 struct sigaction sa
;
5332 if ((ret
= sigemptyset(&sigset
)) < 0) {
5333 PERROR("sigemptyset");
5337 sa
.sa_mask
= sigset
;
5340 sa
.sa_handler
= sighandler
;
5341 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5342 PERROR("sigaction");
5346 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5347 PERROR("sigaction");
5351 if ((ret
= sigaction(SIGUSR1
, &sa
, NULL
)) < 0) {
5352 PERROR("sigaction");
5356 sa
.sa_handler
= SIG_IGN
;
5357 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5358 PERROR("sigaction");
5362 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
5368 * Set open files limit to unlimited. This daemon can open a large number of
5369 * file descriptors in order to consume multiple kernel traces.
5371 static void set_ulimit(void)
5376 /* The kernel does not allow an infinite limit for open files */
5377 lim
.rlim_cur
= 65535;
5378 lim
.rlim_max
= 65535;
5380 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5382 PERROR("failed to set open files limit");
5386 static int write_pidfile(void)
5388 return utils_create_pid_file(getpid(), config
.pid_file_path
.value
);
5392 * Create lockfile using the rundir and return its fd.
5394 static int create_lockfile(void)
5396 return utils_create_lock_file(config
.lock_file_path
.value
);
5400 * Write agent TCP port using the rundir.
5402 static int write_agent_port(void)
5404 return utils_create_pid_file(config
.agent_tcp_port
,
5405 config
.agent_port_file_path
.value
);
5408 static int set_clock_plugin_env(void)
5411 char *env_value
= NULL
;
5413 if (!config
.lttng_ust_clock_plugin
.value
) {
5417 ret
= asprintf(&env_value
, "LTTNG_UST_CLOCK_PLUGIN=%s",
5418 config
.lttng_ust_clock_plugin
.value
);
5424 ret
= putenv(env_value
);
5427 PERROR("putenv of LTTNG_UST_CLOCK_PLUGIN");
5431 DBG("Updated LTTNG_UST_CLOCK_PLUGIN environment variable to \"%s\"",
5432 config
.lttng_ust_clock_plugin
.value
);
5440 int main(int argc
, char **argv
)
5442 int ret
= 0, retval
= 0;
5444 const char *env_app_timeout
;
5445 struct lttng_pipe
*ust32_channel_monitor_pipe
= NULL
,
5446 *ust64_channel_monitor_pipe
= NULL
,
5447 *kernel_channel_monitor_pipe
= NULL
;
5448 bool notification_thread_running
= false;
5450 init_kernel_workarounds();
5452 rcu_register_thread();
5454 if (set_signal_handler()) {
5456 goto exit_set_signal_handler
;
5459 page_size
= sysconf(_SC_PAGESIZE
);
5460 if (page_size
< 0) {
5461 PERROR("sysconf _SC_PAGESIZE");
5462 page_size
= LONG_MAX
;
5463 WARN("Fallback page size to %ld", page_size
);
5466 ret
= sessiond_config_init(&config
);
5469 goto exit_set_signal_handler
;
5473 * Parse arguments and load the daemon configuration file.
5475 * We have an exit_options exit path to free memory reserved by
5476 * set_options. This is needed because the rest of sessiond_cleanup()
5477 * depends on ht_cleanup_thread, which depends on lttng_daemonize, which
5478 * depends on set_options.
5481 if (set_options(argc
, argv
)) {
5486 /* Init config from environment variables. */
5487 sessiond_config_apply_env_config(&config
);
5490 * Resolve all paths received as arguments, configuration option, or
5491 * through environment variable as absolute paths. This is necessary
5492 * since daemonizing causes the sessiond's current working directory
5495 ret
= sessiond_config_resolve_paths(&config
);
5501 lttng_opt_verbose
= config
.verbose
;
5502 lttng_opt_quiet
= config
.quiet
;
5503 kconsumer_data
.err_unix_sock_path
=
5504 config
.kconsumerd_err_unix_sock_path
.value
;
5505 kconsumer_data
.cmd_unix_sock_path
=
5506 config
.kconsumerd_cmd_unix_sock_path
.value
;
5507 ustconsumer32_data
.err_unix_sock_path
=
5508 config
.consumerd32_err_unix_sock_path
.value
;
5509 ustconsumer32_data
.cmd_unix_sock_path
=
5510 config
.consumerd32_cmd_unix_sock_path
.value
;
5511 ustconsumer64_data
.err_unix_sock_path
=
5512 config
.consumerd64_err_unix_sock_path
.value
;
5513 ustconsumer64_data
.cmd_unix_sock_path
=
5514 config
.consumerd64_cmd_unix_sock_path
.value
;
5515 set_clock_plugin_env();
5517 sessiond_config_log(&config
);
5520 if (config
.daemonize
|| config
.background
) {
5523 ret
= lttng_daemonize(&child_ppid
, &recv_child_signal
,
5524 !config
.background
);
5531 * We are in the child. Make sure all other file descriptors are
5532 * closed, in case we are called with more opened file
5533 * descriptors than the standard ones.
5535 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5540 if (run_as_create_worker(argv
[0]) < 0) {
5541 goto exit_create_run_as_worker_cleanup
;
5545 * Starting from here, we can create threads. This needs to be after
5546 * lttng_daemonize due to RCU.
5550 * Initialize the health check subsystem. This call should set the
5551 * appropriate time values.
5553 health_sessiond
= health_app_create(NR_HEALTH_SESSIOND_TYPES
);
5554 if (!health_sessiond
) {
5555 PERROR("health_app_create error");
5557 goto exit_health_sessiond_cleanup
;
5560 /* Create thread to clean up RCU hash tables */
5561 if (init_ht_cleanup_thread(&ht_cleanup_thread
)) {
5563 goto exit_ht_cleanup
;
5566 /* Create thread quit pipe */
5567 if (init_thread_quit_pipe()) {
5569 goto exit_init_data
;
5572 /* Check if daemon is UID = 0 */
5573 is_root
= !getuid();
5575 if (create_lttng_rundir()) {
5577 goto exit_init_data
;
5581 /* Create global run dir with root access */
5583 kernel_channel_monitor_pipe
= lttng_pipe_open(0);
5584 if (!kernel_channel_monitor_pipe
) {
5585 ERR("Failed to create kernel consumer channel monitor pipe");
5587 goto exit_init_data
;
5589 kconsumer_data
.channel_monitor_pipe
=
5590 lttng_pipe_release_writefd(
5591 kernel_channel_monitor_pipe
);
5592 if (kconsumer_data
.channel_monitor_pipe
< 0) {
5594 goto exit_init_data
;
5598 lockfile_fd
= create_lockfile();
5599 if (lockfile_fd
< 0) {
5601 goto exit_init_data
;
5604 /* Set consumer initial state */
5605 kernel_consumerd_state
= CONSUMER_STOPPED
;
5606 ust_consumerd_state
= CONSUMER_STOPPED
;
5608 ust32_channel_monitor_pipe
= lttng_pipe_open(0);
5609 if (!ust32_channel_monitor_pipe
) {
5610 ERR("Failed to create 32-bit user space consumer channel monitor pipe");
5612 goto exit_init_data
;
5614 ustconsumer32_data
.channel_monitor_pipe
= lttng_pipe_release_writefd(
5615 ust32_channel_monitor_pipe
);
5616 if (ustconsumer32_data
.channel_monitor_pipe
< 0) {
5618 goto exit_init_data
;
5621 ust64_channel_monitor_pipe
= lttng_pipe_open(0);
5622 if (!ust64_channel_monitor_pipe
) {
5623 ERR("Failed to create 64-bit user space consumer channel monitor pipe");
5625 goto exit_init_data
;
5627 ustconsumer64_data
.channel_monitor_pipe
= lttng_pipe_release_writefd(
5628 ust64_channel_monitor_pipe
);
5629 if (ustconsumer64_data
.channel_monitor_pipe
< 0) {
5631 goto exit_init_data
;
5635 * See if daemon already exist.
5637 if (check_existing_daemon()) {
5638 ERR("Already running daemon.\n");
5640 * We do not goto exit because we must not cleanup()
5641 * because a daemon is already running.
5644 goto exit_init_data
;
5648 * Init UST app hash table. Alloc hash table before this point since
5649 * cleanup() can get called after that point.
5651 if (ust_app_ht_alloc()) {
5652 ERR("Failed to allocate UST app hash table");
5654 goto exit_init_data
;
5658 * Initialize agent app hash table. We allocate the hash table here
5659 * since cleanup() can get called after this point.
5661 if (agent_app_ht_alloc()) {
5662 ERR("Failed to allocate Agent app hash table");
5664 goto exit_init_data
;
5668 * These actions must be executed as root. We do that *after* setting up
5669 * the sockets path because we MUST make the check for another daemon using
5670 * those paths *before* trying to set the kernel consumer sockets and init
5674 if (set_consumer_sockets(&kconsumer_data
)) {
5676 goto exit_init_data
;
5679 /* Setup kernel tracer */
5680 if (!config
.no_kernel
) {
5681 init_kernel_tracer();
5682 if (kernel_tracer_fd
>= 0) {
5683 ret
= syscall_init_table();
5685 ERR("Unable to populate syscall table. "
5686 "Syscall tracing won't work "
5687 "for this session daemon.");
5692 /* Set ulimit for open files */
5695 /* init lttng_fd tracking must be done after set_ulimit. */
5698 if (set_consumer_sockets(&ustconsumer64_data
)) {
5700 goto exit_init_data
;
5703 if (set_consumer_sockets(&ustconsumer32_data
)) {
5705 goto exit_init_data
;
5708 /* Setup the needed unix socket */
5709 if (init_daemon_socket()) {
5711 goto exit_init_data
;
5714 /* Set credentials to socket */
5715 if (is_root
&& set_permissions(config
.rundir
.value
)) {
5717 goto exit_init_data
;
5720 /* Get parent pid if -S, --sig-parent is specified. */
5721 if (config
.sig_parent
) {
5725 /* Setup the kernel pipe for waking up the kernel thread */
5726 if (is_root
&& !config
.no_kernel
) {
5727 if (utils_create_pipe_cloexec(kernel_poll_pipe
)) {
5729 goto exit_init_data
;
5733 /* Setup the thread apps communication pipe. */
5734 if (utils_create_pipe_cloexec(apps_cmd_pipe
)) {
5736 goto exit_init_data
;
5739 /* Setup the thread apps notify communication pipe. */
5740 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe
)) {
5742 goto exit_init_data
;
5745 /* Initialize global buffer per UID and PID registry. */
5746 buffer_reg_init_uid_registry();
5747 buffer_reg_init_pid_registry();
5749 /* Init UST command queue. */
5750 cds_wfcq_init(&ust_cmd_queue
.head
, &ust_cmd_queue
.tail
);
5753 * Get session list pointer. This pointer MUST NOT be free'd. This list
5754 * is statically declared in session.c
5756 session_list_ptr
= session_get_list();
5760 /* Check for the application socket timeout env variable. */
5761 env_app_timeout
= getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV
);
5762 if (env_app_timeout
) {
5763 config
.app_socket_timeout
= atoi(env_app_timeout
);
5765 config
.app_socket_timeout
= DEFAULT_APP_SOCKET_RW_TIMEOUT
;
5768 ret
= write_pidfile();
5770 ERR("Error in write_pidfile");
5772 goto exit_init_data
;
5774 ret
= write_agent_port();
5776 ERR("Error in write_agent_port");
5778 goto exit_init_data
;
5781 /* Initialize communication library */
5783 /* Initialize TCP timeout values */
5784 lttcomm_inet_init();
5786 if (load_session_init_data(&load_info
) < 0) {
5788 goto exit_init_data
;
5790 load_info
->path
= config
.load_session_path
.value
;
5792 /* Create health-check thread. */
5793 ret
= pthread_create(&health_thread
, default_pthread_attr(),
5794 thread_manage_health
, (void *) NULL
);
5797 PERROR("pthread_create health");
5802 /* notification_thread_data acquires the pipes' read side. */
5803 notification_thread_handle
= notification_thread_handle_create(
5804 ust32_channel_monitor_pipe
,
5805 ust64_channel_monitor_pipe
,
5806 kernel_channel_monitor_pipe
);
5807 if (!notification_thread_handle
) {
5809 ERR("Failed to create notification thread shared data");
5811 goto exit_notification
;
5814 /* Create notification thread. */
5815 ret
= pthread_create(¬ification_thread
, default_pthread_attr(),
5816 thread_notification
, notification_thread_handle
);
5819 PERROR("pthread_create notification");
5822 goto exit_notification
;
5824 notification_thread_running
= true;
5826 /* Create thread to manage the client socket */
5827 ret
= pthread_create(&client_thread
, default_pthread_attr(),
5828 thread_manage_clients
, (void *) NULL
);
5831 PERROR("pthread_create clients");
5837 /* Create thread to dispatch registration */
5838 ret
= pthread_create(&dispatch_thread
, default_pthread_attr(),
5839 thread_dispatch_ust_registration
, (void *) NULL
);
5842 PERROR("pthread_create dispatch");
5848 /* Create thread to manage application registration. */
5849 ret
= pthread_create(®_apps_thread
, default_pthread_attr(),
5850 thread_registration_apps
, (void *) NULL
);
5853 PERROR("pthread_create registration");
5859 /* Create thread to manage application socket */
5860 ret
= pthread_create(&apps_thread
, default_pthread_attr(),
5861 thread_manage_apps
, (void *) NULL
);
5864 PERROR("pthread_create apps");
5870 /* Create thread to manage application notify socket */
5871 ret
= pthread_create(&apps_notify_thread
, default_pthread_attr(),
5872 ust_thread_manage_notify
, (void *) NULL
);
5875 PERROR("pthread_create notify");
5878 goto exit_apps_notify
;
5881 /* Create agent registration thread. */
5882 ret
= pthread_create(&agent_reg_thread
, default_pthread_attr(),
5883 agent_thread_manage_registration
, (void *) NULL
);
5886 PERROR("pthread_create agent");
5889 goto exit_agent_reg
;
5892 /* Don't start this thread if kernel tracing is not requested nor root */
5893 if (is_root
&& !config
.no_kernel
) {
5894 /* Create kernel thread to manage kernel event */
5895 ret
= pthread_create(&kernel_thread
, default_pthread_attr(),
5896 thread_manage_kernel
, (void *) NULL
);
5899 PERROR("pthread_create kernel");
5906 /* Create session loading thread. */
5907 ret
= pthread_create(&load_session_thread
, default_pthread_attr(),
5908 thread_load_session
, load_info
);
5911 PERROR("pthread_create load_session_thread");
5914 goto exit_load_session
;
5918 * This is where we start awaiting program completion (e.g. through
5919 * signal that asks threads to teardown).
5922 ret
= pthread_join(load_session_thread
, &status
);
5925 PERROR("pthread_join load_session_thread");
5930 if (is_root
&& !config
.no_kernel
) {
5931 ret
= pthread_join(kernel_thread
, &status
);
5934 PERROR("pthread_join");
5940 ret
= pthread_join(agent_reg_thread
, &status
);
5943 PERROR("pthread_join agent");
5948 ret
= pthread_join(apps_notify_thread
, &status
);
5951 PERROR("pthread_join apps notify");
5956 ret
= pthread_join(apps_thread
, &status
);
5959 PERROR("pthread_join apps");
5964 ret
= pthread_join(reg_apps_thread
, &status
);
5967 PERROR("pthread_join");
5973 * Join dispatch thread after joining reg_apps_thread to ensure
5974 * we don't leak applications in the queue.
5976 ret
= pthread_join(dispatch_thread
, &status
);
5979 PERROR("pthread_join");
5984 ret
= pthread_join(client_thread
, &status
);
5987 PERROR("pthread_join");
5993 ret
= pthread_join(health_thread
, &status
);
5996 PERROR("pthread_join health thread");
6003 * Wait for all pending call_rcu work to complete before tearing
6004 * down data structures. call_rcu worker may be trying to
6005 * perform lookups in those structures.
6009 * sessiond_cleanup() is called when no other thread is running, except
6010 * the ht_cleanup thread, which is needed to destroy the hash tables.
6012 rcu_thread_online();
6016 * Ensure all prior call_rcu are done. call_rcu callbacks may push
6017 * hash tables to the ht_cleanup thread. Therefore, we ensure that
6018 * the queue is empty before shutting down the clean-up thread.
6023 * The teardown of the notification system is performed after the
6024 * session daemon's teardown in order to allow it to be notified
6025 * of the active session and channels at the moment of the teardown.
6027 if (notification_thread_handle
) {
6028 if (notification_thread_running
) {
6029 notification_thread_command_quit(
6030 notification_thread_handle
);
6031 ret
= pthread_join(notification_thread
, &status
);
6034 PERROR("pthread_join notification thread");
6038 notification_thread_handle_destroy(notification_thread_handle
);
6041 rcu_thread_offline();
6042 rcu_unregister_thread();
6044 ret
= fini_ht_cleanup_thread(&ht_cleanup_thread
);
6048 lttng_pipe_destroy(ust32_channel_monitor_pipe
);
6049 lttng_pipe_destroy(ust64_channel_monitor_pipe
);
6050 lttng_pipe_destroy(kernel_channel_monitor_pipe
);
6053 health_app_destroy(health_sessiond
);
6054 exit_health_sessiond_cleanup
:
6055 exit_create_run_as_worker_cleanup
:
6058 sessiond_cleanup_options();
6060 exit_set_signal_handler
: