2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <sys/mount.h>
30 #include <sys/resource.h>
31 #include <sys/socket.h>
33 #include <sys/types.h>
35 #include <urcu/uatomic.h>
39 #include <common/common.h>
40 #include <common/compat/poll.h>
41 #include <common/compat/socket.h>
42 #include <common/defaults.h>
43 #include <common/kernel-consumer/kernel-consumer.h>
44 #include <common/futex.h>
45 #include <common/relayd/relayd.h>
46 #include <common/utils.h>
48 #include "lttng-sessiond.h"
55 #include "kernel-consumer.h"
59 #include "ust-consumer.h"
64 #include "testpoint.h"
66 #define CONSUMERD_FILE "lttng-consumerd"
69 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
70 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
71 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
72 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
75 const char *opt_tracing_group
;
76 static int opt_sig_parent
;
77 static int opt_verbose_consumer
;
78 static int opt_daemon
;
79 static int opt_no_kernel
;
80 static int is_root
; /* Set to 1 if the daemon is running as root */
81 static pid_t ppid
; /* Parent PID for --sig-parent option */
85 * Consumer daemon specific control data. Every value not initialized here is
86 * set to 0 by the static definition.
88 static struct consumer_data kconsumer_data
= {
89 .type
= LTTNG_CONSUMER_KERNEL
,
90 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
91 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
94 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
95 .lock
= PTHREAD_MUTEX_INITIALIZER
,
96 .cond
= PTHREAD_COND_INITIALIZER
,
97 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
99 static struct consumer_data ustconsumer64_data
= {
100 .type
= LTTNG_CONSUMER64_UST
,
101 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
102 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
105 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
106 .lock
= PTHREAD_MUTEX_INITIALIZER
,
107 .cond
= PTHREAD_COND_INITIALIZER
,
108 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
110 static struct consumer_data ustconsumer32_data
= {
111 .type
= LTTNG_CONSUMER32_UST
,
112 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
113 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
116 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
117 .lock
= PTHREAD_MUTEX_INITIALIZER
,
118 .cond
= PTHREAD_COND_INITIALIZER
,
119 .cond_mutex
= PTHREAD_MUTEX_INITIALIZER
,
122 /* Shared between threads */
123 static int dispatch_thread_exit
;
125 /* Global application Unix socket path */
126 static char apps_unix_sock_path
[PATH_MAX
];
127 /* Global client Unix socket path */
128 static char client_unix_sock_path
[PATH_MAX
];
129 /* global wait shm path for UST */
130 static char wait_shm_path
[PATH_MAX
];
131 /* Global health check unix path */
132 static char health_unix_sock_path
[PATH_MAX
];
134 /* Sockets and FDs */
135 static int client_sock
= -1;
136 static int apps_sock
= -1;
137 int kernel_tracer_fd
= -1;
138 static int kernel_poll_pipe
[2] = { -1, -1 };
141 * Quit pipe for all threads. This permits a single cancellation point
142 * for all threads when receiving an event on the pipe.
144 static int thread_quit_pipe
[2] = { -1, -1 };
147 * This pipe is used to inform the thread managing application communication
148 * that a command is queued and ready to be processed.
150 static int apps_cmd_pipe
[2] = { -1, -1 };
152 /* Pthread, Mutexes and Semaphores */
153 static pthread_t apps_thread
;
154 static pthread_t reg_apps_thread
;
155 static pthread_t client_thread
;
156 static pthread_t kernel_thread
;
157 static pthread_t dispatch_thread
;
158 static pthread_t health_thread
;
161 * UST registration command queue. This queue is tied with a futex and uses a N
162 * wakers / 1 waiter implemented and detailed in futex.c/.h
164 * The thread_manage_apps and thread_dispatch_ust_registration interact with
165 * this queue and the wait/wake scheme.
167 static struct ust_cmd_queue ust_cmd_queue
;
170 * Pointer initialized before thread creation.
172 * This points to the tracing session list containing the session count and a
173 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
174 * MUST NOT be taken if you call a public function in session.c.
176 * The lock is nested inside the structure: session_list_ptr->lock. Please use
177 * session_lock_list and session_unlock_list for lock acquisition.
179 static struct ltt_session_list
*session_list_ptr
;
181 int ust_consumerd64_fd
= -1;
182 int ust_consumerd32_fd
= -1;
184 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
185 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
186 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
187 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
189 static const char *module_proc_lttng
= "/proc/lttng";
192 * Consumer daemon state which is changed when spawning it, killing it or in
193 * case of a fatal error.
195 enum consumerd_state
{
196 CONSUMER_STARTED
= 1,
197 CONSUMER_STOPPED
= 2,
202 * This consumer daemon state is used to validate if a client command will be
203 * able to reach the consumer. If not, the client is informed. For instance,
204 * doing a "lttng start" when the consumer state is set to ERROR will return an
205 * error to the client.
207 * The following example shows a possible race condition of this scheme:
209 * consumer thread error happens
211 * client cmd checks state -> still OK
212 * consumer thread exit, sets error
213 * client cmd try to talk to consumer
216 * However, since the consumer is a different daemon, we have no way of making
217 * sure the command will reach it safely even with this state flag. This is why
218 * we consider that up to the state validation during command processing, the
219 * command is safe. After that, we can not guarantee the correctness of the
220 * client request vis-a-vis the consumer.
222 static enum consumerd_state ust_consumerd_state
;
223 static enum consumerd_state kernel_consumerd_state
;
225 /* Used for the health monitoring of the session daemon. See health.h */
226 struct health_state health_thread_cmd
;
227 struct health_state health_thread_app_manage
;
228 struct health_state health_thread_app_reg
;
229 struct health_state health_thread_kernel
;
232 void setup_consumerd_path(void)
234 const char *bin
, *libdir
;
237 * Allow INSTALL_BIN_PATH to be used as a target path for the
238 * native architecture size consumer if CONFIG_CONSUMER*_PATH
239 * has not been defined.
241 #if (CAA_BITS_PER_LONG == 32)
242 if (!consumerd32_bin
[0]) {
243 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
245 if (!consumerd32_libdir
[0]) {
246 consumerd32_libdir
= INSTALL_LIB_PATH
;
248 #elif (CAA_BITS_PER_LONG == 64)
249 if (!consumerd64_bin
[0]) {
250 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
252 if (!consumerd64_libdir
[0]) {
253 consumerd64_libdir
= INSTALL_LIB_PATH
;
256 #error "Unknown bitness"
260 * runtime env. var. overrides the build default.
262 bin
= getenv("LTTNG_CONSUMERD32_BIN");
264 consumerd32_bin
= bin
;
266 bin
= getenv("LTTNG_CONSUMERD64_BIN");
268 consumerd64_bin
= bin
;
270 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
272 consumerd32_libdir
= libdir
;
274 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
276 consumerd64_libdir
= libdir
;
281 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
283 static int create_thread_poll_set(struct lttng_poll_event
*events
,
288 if (events
== NULL
|| size
== 0) {
293 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
299 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
311 * Check if the thread quit pipe was triggered.
313 * Return 1 if it was triggered else 0;
315 static int check_thread_quit_pipe(int fd
, uint32_t events
)
317 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
325 * Return group ID of the tracing group or -1 if not found.
327 static gid_t
allowed_group(void)
331 if (opt_tracing_group
) {
332 grp
= getgrnam(opt_tracing_group
);
334 grp
= getgrnam(default_tracing_group
);
344 * Init thread quit pipe.
346 * Return -1 on error or 0 if all pipes are created.
348 static int init_thread_quit_pipe(void)
352 ret
= pipe(thread_quit_pipe
);
354 PERROR("thread quit pipe");
358 for (i
= 0; i
< 2; i
++) {
359 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
371 * Stop all threads by closing the thread quit pipe.
373 static void stop_threads(void)
377 /* Stopping all threads */
378 DBG("Terminating all threads");
379 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
381 ERR("write error on thread quit pipe");
384 /* Dispatch thread */
385 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
386 futex_nto1_wake(&ust_cmd_queue
.futex
);
392 static void cleanup(void)
396 struct ltt_session
*sess
, *stmp
;
400 /* First thing first, stop all threads */
401 utils_close_pipe(thread_quit_pipe
);
403 DBG("Removing %s directory", rundir
);
404 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
406 ERR("asprintf failed. Something is really wrong!");
409 /* Remove lttng run directory */
412 ERR("Unable to clean %s", rundir
);
417 DBG("Cleaning up all sessions");
419 /* Destroy session list mutex */
420 if (session_list_ptr
!= NULL
) {
421 pthread_mutex_destroy(&session_list_ptr
->lock
);
423 /* Cleanup ALL session */
424 cds_list_for_each_entry_safe(sess
, stmp
,
425 &session_list_ptr
->head
, list
) {
426 cmd_destroy_session(sess
, kernel_poll_pipe
[1]);
430 DBG("Closing all UST sockets");
431 ust_app_clean_list();
433 if (is_root
&& !opt_no_kernel
) {
434 DBG2("Closing kernel fd");
435 if (kernel_tracer_fd
>= 0) {
436 ret
= close(kernel_tracer_fd
);
441 DBG("Unloading kernel modules");
442 modprobe_remove_lttng_all();
445 utils_close_pipe(kernel_poll_pipe
);
446 utils_close_pipe(apps_cmd_pipe
);
449 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
450 "Matthew, BEET driven development works!%c[%dm",
451 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
456 * Send data on a unix socket using the liblttsessiondcomm API.
458 * Return lttcomm error code.
460 static int send_unix_sock(int sock
, void *buf
, size_t len
)
462 /* Check valid length */
467 return lttcomm_send_unix_sock(sock
, buf
, len
);
471 * Free memory of a command context structure.
473 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
475 DBG("Clean command context structure");
477 if ((*cmd_ctx
)->llm
) {
478 free((*cmd_ctx
)->llm
);
480 if ((*cmd_ctx
)->lsm
) {
481 free((*cmd_ctx
)->lsm
);
489 * Notify UST applications using the shm mmap futex.
491 static int notify_ust_apps(int active
)
495 DBG("Notifying applications of session daemon state: %d", active
);
497 /* See shm.c for this call implying mmap, shm and futex calls */
498 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
499 if (wait_shm_mmap
== NULL
) {
503 /* Wake waiting process */
504 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
506 /* Apps notified successfully */
514 * Setup the outgoing data buffer for the response (llm) by allocating the
515 * right amount of memory and copying the original information from the lsm
518 * Return total size of the buffer pointed by buf.
520 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
526 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
527 if (cmd_ctx
->llm
== NULL
) {
533 /* Copy common data */
534 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
535 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
537 cmd_ctx
->llm
->data_size
= size
;
538 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
547 * Update the kernel poll set of all channel fd available over all tracing
548 * session. Add the wakeup pipe at the end of the set.
550 static int update_kernel_poll(struct lttng_poll_event
*events
)
553 struct ltt_session
*session
;
554 struct ltt_kernel_channel
*channel
;
556 DBG("Updating kernel poll set");
559 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
560 session_lock(session
);
561 if (session
->kernel_session
== NULL
) {
562 session_unlock(session
);
566 cds_list_for_each_entry(channel
,
567 &session
->kernel_session
->channel_list
.head
, list
) {
568 /* Add channel fd to the kernel poll set */
569 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
571 session_unlock(session
);
574 DBG("Channel fd %d added to kernel set", channel
->fd
);
576 session_unlock(session
);
578 session_unlock_list();
583 session_unlock_list();
588 * Find the channel fd from 'fd' over all tracing session. When found, check
589 * for new channel stream and send those stream fds to the kernel consumer.
591 * Useful for CPU hotplug feature.
593 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
596 struct ltt_session
*session
;
597 struct ltt_kernel_session
*ksess
;
598 struct ltt_kernel_channel
*channel
;
600 DBG("Updating kernel streams for channel fd %d", fd
);
603 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
604 session_lock(session
);
605 if (session
->kernel_session
== NULL
) {
606 session_unlock(session
);
609 ksess
= session
->kernel_session
;
611 cds_list_for_each_entry(channel
, &ksess
->channel_list
.head
, list
) {
612 if (channel
->fd
== fd
) {
613 DBG("Channel found, updating kernel streams");
614 ret
= kernel_open_channel_stream(channel
);
620 * Have we already sent fds to the consumer? If yes, it means
621 * that tracing is started so it is safe to send our updated
624 if (ksess
->consumer_fds_sent
== 1 && ksess
->consumer
!= NULL
) {
625 struct lttng_ht_iter iter
;
626 struct consumer_socket
*socket
;
629 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
630 &iter
.iter
, socket
, node
.node
) {
631 /* Code flow error */
632 assert(socket
->fd
>= 0);
634 pthread_mutex_lock(socket
->lock
);
635 ret
= kernel_consumer_send_channel_stream(socket
->fd
,
637 pthread_mutex_unlock(socket
->lock
);
646 session_unlock(session
);
648 session_unlock_list();
652 session_unlock(session
);
653 session_unlock_list();
658 * For each tracing session, update newly registered apps.
660 static void update_ust_app(int app_sock
)
662 struct ltt_session
*sess
, *stmp
;
666 /* For all tracing session(s) */
667 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
669 if (sess
->ust_session
) {
670 ust_app_global_update(sess
->ust_session
, app_sock
);
672 session_unlock(sess
);
675 session_unlock_list();
679 * This thread manage event coming from the kernel.
681 * Features supported in this thread:
684 static void *thread_manage_kernel(void *data
)
686 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
687 uint32_t revents
, nb_fd
;
689 struct lttng_poll_event events
;
691 DBG("Thread manage kernel started");
693 testpoint(thread_manage_kernel
);
695 health_code_update(&health_thread_kernel
);
697 testpoint(thread_manage_kernel_before_loop
);
699 ret
= create_thread_poll_set(&events
, 2);
701 goto error_poll_create
;
704 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
710 health_code_update(&health_thread_kernel
);
712 if (update_poll_flag
== 1) {
714 * Reset number of fd in the poll set. Always 2 since there is the thread
715 * quit pipe and the kernel pipe.
719 ret
= update_kernel_poll(&events
);
723 update_poll_flag
= 0;
726 nb_fd
= LTTNG_POLL_GETNB(&events
);
728 DBG("Thread kernel polling on %d fds", nb_fd
);
730 /* Zeroed the poll events */
731 lttng_poll_reset(&events
);
733 /* Poll infinite value of time */
735 health_poll_update(&health_thread_kernel
);
736 ret
= lttng_poll_wait(&events
, -1);
737 health_poll_update(&health_thread_kernel
);
740 * Restart interrupted system call.
742 if (errno
== EINTR
) {
746 } else if (ret
== 0) {
747 /* Should not happen since timeout is infinite */
748 ERR("Return value of poll is 0 with an infinite timeout.\n"
749 "This should not have happened! Continuing...");
753 for (i
= 0; i
< nb_fd
; i
++) {
754 /* Fetch once the poll data */
755 revents
= LTTNG_POLL_GETEV(&events
, i
);
756 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
758 health_code_update(&health_thread_kernel
);
760 /* Thread quit pipe has been closed. Killing thread. */
761 ret
= check_thread_quit_pipe(pollfd
, revents
);
767 /* Check for data on kernel pipe */
768 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
769 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
770 update_poll_flag
= 1;
774 * New CPU detected by the kernel. Adding kernel stream to
775 * kernel session and updating the kernel consumer
777 if (revents
& LPOLLIN
) {
778 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
784 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
785 * and unregister kernel stream at this point.
794 lttng_poll_clean(&events
);
797 health_error(&health_thread_kernel
);
798 ERR("Health error occurred in %s", __func__
);
800 health_exit(&health_thread_kernel
);
801 DBG("Kernel thread dying");
806 * Signal pthread condition of the consumer data that the thread.
808 static void signal_consumer_condition(struct consumer_data
*data
, int state
)
810 pthread_mutex_lock(&data
->cond_mutex
);
813 * The state is set before signaling. It can be any value, it's the waiter
814 * job to correctly interpret this condition variable associated to the
815 * consumer pthread_cond.
817 * A value of 0 means that the corresponding thread of the consumer data
818 * was not started. 1 indicates that the thread has started and is ready
819 * for action. A negative value means that there was an error during the
822 data
->consumer_thread_is_ready
= state
;
823 (void) pthread_cond_signal(&data
->cond
);
825 pthread_mutex_unlock(&data
->cond_mutex
);
829 * This thread manage the consumer error sent back to the session daemon.
831 static void *thread_manage_consumer(void *data
)
833 int sock
= -1, i
, ret
, pollfd
, err
= -1;
834 uint32_t revents
, nb_fd
;
835 enum lttcomm_return_code code
;
836 struct lttng_poll_event events
;
837 struct consumer_data
*consumer_data
= data
;
839 DBG("[thread] Manage consumer started");
842 * Since the consumer thread can be spawned at any moment in time, we init
843 * the health to a poll status (1, which is a valid health over time).
844 * When the thread starts, we update here the health to a "code" path being
845 * an even value so this thread, when reaching a poll wait, does not
846 * trigger an error with an even value.
848 * Here is the use case we avoid.
850 * +1: the first poll update during initialization (main())
851 * +2 * x: multiple code update once in this thread.
852 * +1: poll wait in this thread (being a good health state).
853 * == even number which after the wait period shows as a bad health.
855 * In a nutshell, the following poll update to the health state brings back
856 * the state to an even value meaning a code path.
858 health_poll_update(&consumer_data
->health
);
860 health_code_update(&consumer_data
->health
);
862 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
868 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
869 * Nothing more will be added to this poll set.
871 ret
= create_thread_poll_set(&events
, 2);
876 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
881 nb_fd
= LTTNG_POLL_GETNB(&events
);
883 health_code_update(&consumer_data
->health
);
885 /* Inifinite blocking call, waiting for transmission */
887 health_poll_update(&consumer_data
->health
);
889 testpoint(thread_manage_consumer
);
891 ret
= lttng_poll_wait(&events
, -1);
892 health_poll_update(&consumer_data
->health
);
895 * Restart interrupted system call.
897 if (errno
== EINTR
) {
903 for (i
= 0; i
< nb_fd
; i
++) {
904 /* Fetch once the poll data */
905 revents
= LTTNG_POLL_GETEV(&events
, i
);
906 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
908 health_code_update(&consumer_data
->health
);
910 /* Thread quit pipe has been closed. Killing thread. */
911 ret
= check_thread_quit_pipe(pollfd
, revents
);
917 /* Event on the registration socket */
918 if (pollfd
== consumer_data
->err_sock
) {
919 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
920 ERR("consumer err socket poll error");
926 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
932 * Set the CLOEXEC flag. Return code is useless because either way, the
935 (void) utils_set_fd_cloexec(sock
);
937 health_code_update(&consumer_data
->health
);
939 DBG2("Receiving code from consumer err_sock");
941 /* Getting status code from kconsumerd */
942 ret
= lttcomm_recv_unix_sock(sock
, &code
,
943 sizeof(enum lttcomm_return_code
));
948 health_code_update(&consumer_data
->health
);
950 if (code
== LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
) {
951 consumer_data
->cmd_sock
=
952 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
953 if (consumer_data
->cmd_sock
< 0) {
954 /* On error, signal condition and quit. */
955 signal_consumer_condition(consumer_data
, -1);
956 PERROR("consumer connect");
959 signal_consumer_condition(consumer_data
, 1);
960 DBG("Consumer command socket ready");
962 ERR("consumer error when waiting for SOCK_READY : %s",
963 lttcomm_get_readable_code(-code
));
967 /* Remove the kconsumerd error sock since we've established a connexion */
968 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
973 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
978 health_code_update(&consumer_data
->health
);
980 /* Update number of fd */
981 nb_fd
= LTTNG_POLL_GETNB(&events
);
983 /* Inifinite blocking call, waiting for transmission */
985 health_poll_update(&consumer_data
->health
);
986 ret
= lttng_poll_wait(&events
, -1);
987 health_poll_update(&consumer_data
->health
);
990 * Restart interrupted system call.
992 if (errno
== EINTR
) {
998 for (i
= 0; i
< nb_fd
; i
++) {
999 /* Fetch once the poll data */
1000 revents
= LTTNG_POLL_GETEV(&events
, i
);
1001 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1003 health_code_update(&consumer_data
->health
);
1005 /* Thread quit pipe has been closed. Killing thread. */
1006 ret
= check_thread_quit_pipe(pollfd
, revents
);
1012 /* Event on the kconsumerd socket */
1013 if (pollfd
== sock
) {
1014 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1015 ERR("consumer err socket second poll error");
1021 health_code_update(&consumer_data
->health
);
1023 /* Wait for any kconsumerd error */
1024 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1025 sizeof(enum lttcomm_return_code
));
1027 ERR("consumer closed the command socket");
1031 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1035 /* Immediately set the consumerd state to stopped */
1036 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1037 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1038 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1039 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1040 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1042 /* Code flow error... */
1046 if (consumer_data
->err_sock
>= 0) {
1047 ret
= close(consumer_data
->err_sock
);
1052 if (consumer_data
->cmd_sock
>= 0) {
1053 ret
= close(consumer_data
->cmd_sock
);
1065 unlink(consumer_data
->err_unix_sock_path
);
1066 unlink(consumer_data
->cmd_unix_sock_path
);
1067 consumer_data
->pid
= 0;
1069 lttng_poll_clean(&events
);
1073 health_error(&consumer_data
->health
);
1074 ERR("Health error occurred in %s", __func__
);
1076 health_exit(&consumer_data
->health
);
1077 DBG("consumer thread cleanup completed");
1083 * This thread manage application communication.
1085 static void *thread_manage_apps(void *data
)
1087 int i
, ret
, pollfd
, err
= -1;
1088 uint32_t revents
, nb_fd
;
1089 struct ust_command ust_cmd
;
1090 struct lttng_poll_event events
;
1092 DBG("[thread] Manage application started");
1094 testpoint(thread_manage_apps
);
1096 rcu_register_thread();
1097 rcu_thread_online();
1099 health_code_update(&health_thread_app_manage
);
1101 ret
= create_thread_poll_set(&events
, 2);
1103 goto error_poll_create
;
1106 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1111 testpoint(thread_manage_apps_before_loop
);
1113 health_code_update(&health_thread_app_manage
);
1116 /* Zeroed the events structure */
1117 lttng_poll_reset(&events
);
1119 nb_fd
= LTTNG_POLL_GETNB(&events
);
1121 DBG("Apps thread polling on %d fds", nb_fd
);
1123 /* Inifinite blocking call, waiting for transmission */
1125 health_poll_update(&health_thread_app_manage
);
1126 ret
= lttng_poll_wait(&events
, -1);
1127 health_poll_update(&health_thread_app_manage
);
1130 * Restart interrupted system call.
1132 if (errno
== EINTR
) {
1138 for (i
= 0; i
< nb_fd
; i
++) {
1139 /* Fetch once the poll data */
1140 revents
= LTTNG_POLL_GETEV(&events
, i
);
1141 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1143 health_code_update(&health_thread_app_manage
);
1145 /* Thread quit pipe has been closed. Killing thread. */
1146 ret
= check_thread_quit_pipe(pollfd
, revents
);
1152 /* Inspect the apps cmd pipe */
1153 if (pollfd
== apps_cmd_pipe
[0]) {
1154 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1155 ERR("Apps command pipe error");
1157 } else if (revents
& LPOLLIN
) {
1159 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1160 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1161 PERROR("read apps cmd pipe");
1165 health_code_update(&health_thread_app_manage
);
1167 /* Register applicaton to the session daemon */
1168 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1170 if (ret
== -ENOMEM
) {
1172 } else if (ret
< 0) {
1176 health_code_update(&health_thread_app_manage
);
1179 * Validate UST version compatibility.
1181 ret
= ust_app_validate_version(ust_cmd
.sock
);
1184 * Add channel(s) and event(s) to newly registered apps
1185 * from lttng global UST domain.
1187 update_ust_app(ust_cmd
.sock
);
1190 health_code_update(&health_thread_app_manage
);
1192 ret
= ust_app_register_done(ust_cmd
.sock
);
1195 * If the registration is not possible, we simply
1196 * unregister the apps and continue
1198 ust_app_unregister(ust_cmd
.sock
);
1201 * We only monitor the error events of the socket. This
1202 * thread does not handle any incoming data from UST
1205 ret
= lttng_poll_add(&events
, ust_cmd
.sock
,
1206 LPOLLERR
& LPOLLHUP
& LPOLLRDHUP
);
1211 DBG("Apps with sock %d added to poll set",
1215 health_code_update(&health_thread_app_manage
);
1221 * At this point, we know that a registered application made
1222 * the event at poll_wait.
1224 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1225 /* Removing from the poll set */
1226 ret
= lttng_poll_del(&events
, pollfd
);
1231 /* Socket closed on remote end. */
1232 ust_app_unregister(pollfd
);
1237 health_code_update(&health_thread_app_manage
);
1243 lttng_poll_clean(&events
);
1246 health_error(&health_thread_app_manage
);
1247 ERR("Health error occurred in %s", __func__
);
1249 health_exit(&health_thread_app_manage
);
1250 DBG("Application communication apps thread cleanup complete");
1251 rcu_thread_offline();
1252 rcu_unregister_thread();
1257 * Dispatch request from the registration threads to the application
1258 * communication thread.
1260 static void *thread_dispatch_ust_registration(void *data
)
1263 struct cds_wfq_node
*node
;
1264 struct ust_command
*ust_cmd
= NULL
;
1266 DBG("[thread] Dispatch UST command started");
1268 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1269 /* Atomically prepare the queue futex */
1270 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1273 /* Dequeue command for registration */
1274 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1276 DBG("Woken up but nothing in the UST command queue");
1277 /* Continue thread execution */
1281 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1283 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1284 " gid:%d sock:%d name:%s (version %d.%d)",
1285 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1286 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1287 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1288 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1290 * Inform apps thread of the new application registration. This
1291 * call is blocking so we can be assured that the data will be read
1292 * at some point in time or wait to the end of the world :)
1294 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1295 sizeof(struct ust_command
));
1297 PERROR("write apps cmd pipe");
1298 if (errno
== EBADF
) {
1300 * We can't inform the application thread to process
1301 * registration. We will exit or else application
1302 * registration will not occur and tracing will never
1309 } while (node
!= NULL
);
1311 /* Futex wait on queue. Blocking call on futex() */
1312 futex_nto1_wait(&ust_cmd_queue
.futex
);
1316 DBG("Dispatch thread dying");
1321 * This thread manage application registration.
1323 static void *thread_registration_apps(void *data
)
1325 int sock
= -1, i
, ret
, pollfd
, err
= -1;
1326 uint32_t revents
, nb_fd
;
1327 struct lttng_poll_event events
;
1329 * Get allocated in this thread, enqueued to a global queue, dequeued and
1330 * freed in the manage apps thread.
1332 struct ust_command
*ust_cmd
= NULL
;
1334 DBG("[thread] Manage application registration started");
1336 testpoint(thread_registration_apps
);
1338 ret
= lttcomm_listen_unix_sock(apps_sock
);
1344 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1345 * more will be added to this poll set.
1347 ret
= create_thread_poll_set(&events
, 2);
1349 goto error_create_poll
;
1352 /* Add the application registration socket */
1353 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1355 goto error_poll_add
;
1358 /* Notify all applications to register */
1359 ret
= notify_ust_apps(1);
1361 ERR("Failed to notify applications or create the wait shared memory.\n"
1362 "Execution continues but there might be problem for already\n"
1363 "running applications that wishes to register.");
1367 DBG("Accepting application registration");
1369 nb_fd
= LTTNG_POLL_GETNB(&events
);
1371 /* Inifinite blocking call, waiting for transmission */
1373 health_poll_update(&health_thread_app_reg
);
1374 ret
= lttng_poll_wait(&events
, -1);
1375 health_poll_update(&health_thread_app_reg
);
1378 * Restart interrupted system call.
1380 if (errno
== EINTR
) {
1386 for (i
= 0; i
< nb_fd
; i
++) {
1387 health_code_update(&health_thread_app_reg
);
1389 /* Fetch once the poll data */
1390 revents
= LTTNG_POLL_GETEV(&events
, i
);
1391 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1393 /* Thread quit pipe has been closed. Killing thread. */
1394 ret
= check_thread_quit_pipe(pollfd
, revents
);
1400 /* Event on the registration socket */
1401 if (pollfd
== apps_sock
) {
1402 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1403 ERR("Register apps socket poll error");
1405 } else if (revents
& LPOLLIN
) {
1406 sock
= lttcomm_accept_unix_sock(apps_sock
);
1412 * Set the CLOEXEC flag. Return code is useless because
1413 * either way, the show must go on.
1415 (void) utils_set_fd_cloexec(sock
);
1417 /* Create UST registration command for enqueuing */
1418 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1419 if (ust_cmd
== NULL
) {
1420 PERROR("ust command zmalloc");
1425 * Using message-based transmissions to ensure we don't
1426 * have to deal with partially received messages.
1428 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1430 ERR("Exhausted file descriptors allowed for applications.");
1439 health_code_update(&health_thread_app_reg
);
1440 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1441 sizeof(struct ust_register_msg
));
1442 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1444 PERROR("lttcomm_recv_unix_sock register apps");
1446 ERR("Wrong size received on apps register");
1453 lttng_fd_put(LTTNG_FD_APPS
, 1);
1457 health_code_update(&health_thread_app_reg
);
1459 ust_cmd
->sock
= sock
;
1462 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1463 " gid:%d sock:%d name:%s (version %d.%d)",
1464 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1465 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1466 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1467 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1470 * Lock free enqueue the registration request. The red pill
1471 * has been taken! This apps will be part of the *system*.
1473 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1476 * Wake the registration queue futex. Implicit memory
1477 * barrier with the exchange in cds_wfq_enqueue.
1479 futex_nto1_wake(&ust_cmd_queue
.futex
);
1488 health_error(&health_thread_app_reg
);
1489 ERR("Health error occurred in %s", __func__
);
1491 health_exit(&health_thread_app_reg
);
1493 /* Notify that the registration thread is gone */
1496 if (apps_sock
>= 0) {
1497 ret
= close(apps_sock
);
1507 lttng_fd_put(LTTNG_FD_APPS
, 1);
1509 unlink(apps_unix_sock_path
);
1512 lttng_poll_clean(&events
);
1515 DBG("UST Registration thread cleanup complete");
1521 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1522 * exec or it will fails.
1524 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1527 struct timespec timeout
;
1529 /* Make sure we set the readiness flag to 0 because we are NOT ready */
1530 consumer_data
->consumer_thread_is_ready
= 0;
1532 /* Setup pthread condition */
1533 ret
= pthread_condattr_init(&consumer_data
->condattr
);
1536 PERROR("pthread_condattr_init consumer data");
1541 * Set the monotonic clock in order to make sure we DO NOT jump in time
1542 * between the clock_gettime() call and the timedwait call. See bug #324
1543 * for a more details and how we noticed it.
1545 ret
= pthread_condattr_setclock(&consumer_data
->condattr
, CLOCK_MONOTONIC
);
1548 PERROR("pthread_condattr_setclock consumer data");
1552 ret
= pthread_cond_init(&consumer_data
->cond
, &consumer_data
->condattr
);
1555 PERROR("pthread_cond_init consumer data");
1559 ret
= pthread_create(&consumer_data
->thread
, NULL
, thread_manage_consumer
,
1562 PERROR("pthread_create consumer");
1567 /* We are about to wait on a pthread condition */
1568 pthread_mutex_lock(&consumer_data
->cond_mutex
);
1570 /* Get time for sem_timedwait absolute timeout */
1571 clock_ret
= clock_gettime(CLOCK_MONOTONIC
, &timeout
);
1573 * Set the timeout for the condition timed wait even if the clock gettime
1574 * call fails since we might loop on that call and we want to avoid to
1575 * increment the timeout too many times.
1577 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1580 * The following loop COULD be skipped in some conditions so this is why we
1581 * set ret to 0 in order to make sure at least one round of the loop is
1587 * Loop until the condition is reached or when a timeout is reached. Note
1588 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
1589 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
1590 * possible. This loop does not take any chances and works with both of
1593 while (!consumer_data
->consumer_thread_is_ready
&& ret
!= ETIMEDOUT
) {
1594 if (clock_ret
< 0) {
1595 PERROR("clock_gettime spawn consumer");
1596 /* Infinite wait for the consumerd thread to be ready */
1597 ret
= pthread_cond_wait(&consumer_data
->cond
,
1598 &consumer_data
->cond_mutex
);
1600 ret
= pthread_cond_timedwait(&consumer_data
->cond
,
1601 &consumer_data
->cond_mutex
, &timeout
);
1605 /* Release the pthread condition */
1606 pthread_mutex_unlock(&consumer_data
->cond_mutex
);
1610 if (ret
== ETIMEDOUT
) {
1612 * Call has timed out so we kill the kconsumerd_thread and return
1615 ERR("Condition timed out. The consumer thread was never ready."
1617 ret
= pthread_cancel(consumer_data
->thread
);
1619 PERROR("pthread_cancel consumer thread");
1622 PERROR("pthread_cond_wait failed consumer thread");
1627 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1628 if (consumer_data
->pid
== 0) {
1629 ERR("Consumerd did not start");
1630 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1633 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1642 * Join consumer thread
1644 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1649 /* Consumer pid must be a real one. */
1650 if (consumer_data
->pid
> 0) {
1651 ret
= kill(consumer_data
->pid
, SIGTERM
);
1653 ERR("Error killing consumer daemon");
1656 return pthread_join(consumer_data
->thread
, &status
);
1663 * Fork and exec a consumer daemon (consumerd).
1665 * Return pid if successful else -1.
1667 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1671 const char *consumer_to_use
;
1672 const char *verbosity
;
1675 DBG("Spawning consumerd");
1682 if (opt_verbose_consumer
) {
1683 verbosity
= "--verbose";
1685 verbosity
= "--quiet";
1687 switch (consumer_data
->type
) {
1688 case LTTNG_CONSUMER_KERNEL
:
1690 * Find out which consumerd to execute. We will first try the
1691 * 64-bit path, then the sessiond's installation directory, and
1692 * fallback on the 32-bit one,
1694 DBG3("Looking for a kernel consumer at these locations:");
1695 DBG3(" 1) %s", consumerd64_bin
);
1696 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1697 DBG3(" 3) %s", consumerd32_bin
);
1698 if (stat(consumerd64_bin
, &st
) == 0) {
1699 DBG3("Found location #1");
1700 consumer_to_use
= consumerd64_bin
;
1701 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1702 DBG3("Found location #2");
1703 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1704 } else if (stat(consumerd32_bin
, &st
) == 0) {
1705 DBG3("Found location #3");
1706 consumer_to_use
= consumerd32_bin
;
1708 DBG("Could not find any valid consumerd executable");
1711 DBG("Using kernel consumer at: %s", consumer_to_use
);
1712 execl(consumer_to_use
,
1713 "lttng-consumerd", verbosity
, "-k",
1714 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1715 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1718 case LTTNG_CONSUMER64_UST
:
1720 char *tmpnew
= NULL
;
1722 if (consumerd64_libdir
[0] != '\0') {
1726 tmp
= getenv("LD_LIBRARY_PATH");
1730 tmplen
= strlen("LD_LIBRARY_PATH=")
1731 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1732 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1737 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1738 strcat(tmpnew
, consumerd64_libdir
);
1739 if (tmp
[0] != '\0') {
1740 strcat(tmpnew
, ":");
1741 strcat(tmpnew
, tmp
);
1743 ret
= putenv(tmpnew
);
1749 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1750 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1751 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1752 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1754 if (consumerd64_libdir
[0] != '\0') {
1762 case LTTNG_CONSUMER32_UST
:
1764 char *tmpnew
= NULL
;
1766 if (consumerd32_libdir
[0] != '\0') {
1770 tmp
= getenv("LD_LIBRARY_PATH");
1774 tmplen
= strlen("LD_LIBRARY_PATH=")
1775 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1776 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1781 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1782 strcat(tmpnew
, consumerd32_libdir
);
1783 if (tmp
[0] != '\0') {
1784 strcat(tmpnew
, ":");
1785 strcat(tmpnew
, tmp
);
1787 ret
= putenv(tmpnew
);
1793 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1794 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1795 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1796 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1798 if (consumerd32_libdir
[0] != '\0') {
1807 PERROR("unknown consumer type");
1811 PERROR("kernel start consumer exec");
1814 } else if (pid
> 0) {
1817 PERROR("start consumer fork");
1825 * Spawn the consumerd daemon and session daemon thread.
1827 static int start_consumerd(struct consumer_data
*consumer_data
)
1831 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1832 if (consumer_data
->pid
!= 0) {
1833 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1837 ret
= spawn_consumerd(consumer_data
);
1839 ERR("Spawning consumerd failed");
1840 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1844 /* Setting up the consumer_data pid */
1845 consumer_data
->pid
= ret
;
1846 DBG2("Consumer pid %d", consumer_data
->pid
);
1847 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1849 DBG2("Spawning consumer control thread");
1850 ret
= spawn_consumer_thread(consumer_data
);
1852 ERR("Fatal error spawning consumer control thread");
1864 * Compute health status of each consumer. If one of them is zero (bad
1865 * state), we return 0.
1867 static int check_consumer_health(void)
1871 ret
= health_check_state(&kconsumer_data
.health
) &&
1872 health_check_state(&ustconsumer32_data
.health
) &&
1873 health_check_state(&ustconsumer64_data
.health
);
1875 DBG3("Health consumer check %d", ret
);
1881 * Setup necessary data for kernel tracer action.
1883 static int init_kernel_tracer(void)
1887 /* Modprobe lttng kernel modules */
1888 ret
= modprobe_lttng_control();
1893 /* Open debugfs lttng */
1894 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1895 if (kernel_tracer_fd
< 0) {
1896 DBG("Failed to open %s", module_proc_lttng
);
1901 /* Validate kernel version */
1902 ret
= kernel_validate_version(kernel_tracer_fd
);
1907 ret
= modprobe_lttng_data();
1912 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1916 modprobe_remove_lttng_control();
1917 ret
= close(kernel_tracer_fd
);
1921 kernel_tracer_fd
= -1;
1922 return LTTNG_ERR_KERN_VERSION
;
1925 ret
= close(kernel_tracer_fd
);
1931 modprobe_remove_lttng_control();
1934 WARN("No kernel tracer available");
1935 kernel_tracer_fd
= -1;
1937 return LTTNG_ERR_NEED_ROOT_SESSIOND
;
1939 return LTTNG_ERR_KERN_NA
;
1945 * Copy consumer output from the tracing session to the domain session. The
1946 * function also applies the right modification on a per domain basis for the
1947 * trace files destination directory.
1949 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
1952 const char *dir_name
;
1953 struct consumer_output
*consumer
;
1956 assert(session
->consumer
);
1959 case LTTNG_DOMAIN_KERNEL
:
1960 DBG3("Copying tracing session consumer output in kernel session");
1962 * XXX: We should audit the session creation and what this function
1963 * does "extra" in order to avoid a destroy since this function is used
1964 * in the domain session creation (kernel and ust) only. Same for UST
1967 if (session
->kernel_session
->consumer
) {
1968 consumer_destroy_output(session
->kernel_session
->consumer
);
1970 session
->kernel_session
->consumer
=
1971 consumer_copy_output(session
->consumer
);
1972 /* Ease our life a bit for the next part */
1973 consumer
= session
->kernel_session
->consumer
;
1974 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
1976 case LTTNG_DOMAIN_UST
:
1977 DBG3("Copying tracing session consumer output in UST session");
1978 if (session
->ust_session
->consumer
) {
1979 consumer_destroy_output(session
->ust_session
->consumer
);
1981 session
->ust_session
->consumer
=
1982 consumer_copy_output(session
->consumer
);
1983 /* Ease our life a bit for the next part */
1984 consumer
= session
->ust_session
->consumer
;
1985 dir_name
= DEFAULT_UST_TRACE_DIR
;
1988 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1992 /* Append correct directory to subdir */
1993 strncat(consumer
->subdir
, dir_name
,
1994 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
1995 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2004 * Create an UST session and add it to the session ust list.
2006 static int create_ust_session(struct ltt_session
*session
,
2007 struct lttng_domain
*domain
)
2010 struct ltt_ust_session
*lus
= NULL
;
2014 assert(session
->consumer
);
2016 switch (domain
->type
) {
2017 case LTTNG_DOMAIN_UST
:
2020 ERR("Unknown UST domain on create session %d", domain
->type
);
2021 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
2025 DBG("Creating UST session");
2027 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
2029 ret
= LTTNG_ERR_UST_SESS_FAIL
;
2033 lus
->uid
= session
->uid
;
2034 lus
->gid
= session
->gid
;
2035 session
->ust_session
= lus
;
2037 /* Copy session output to the newly created UST session */
2038 ret
= copy_session_consumer(domain
->type
, session
);
2039 if (ret
!= LTTNG_OK
) {
2047 session
->ust_session
= NULL
;
2052 * Create a kernel tracer session then create the default channel.
2054 static int create_kernel_session(struct ltt_session
*session
)
2058 DBG("Creating kernel session");
2060 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2062 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2066 /* Code flow safety */
2067 assert(session
->kernel_session
);
2069 /* Copy session output to the newly created Kernel session */
2070 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2071 if (ret
!= LTTNG_OK
) {
2075 /* Create directory(ies) on local filesystem. */
2076 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2077 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2078 ret
= run_as_mkdir_recursive(
2079 session
->kernel_session
->consumer
->dst
.trace_path
,
2080 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2082 if (ret
!= -EEXIST
) {
2083 ERR("Trace directory creation error");
2089 session
->kernel_session
->uid
= session
->uid
;
2090 session
->kernel_session
->gid
= session
->gid
;
2095 trace_kernel_destroy_session(session
->kernel_session
);
2096 session
->kernel_session
= NULL
;
2101 * Count number of session permitted by uid/gid.
2103 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2106 struct ltt_session
*session
;
2108 DBG("Counting number of available session for UID %d GID %d",
2110 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2112 * Only list the sessions the user can control.
2114 if (!session_access_ok(session
, uid
, gid
)) {
2123 * Process the command requested by the lttng client within the command
2124 * context structure. This function make sure that the return structure (llm)
2125 * is set and ready for transmission before returning.
2127 * Return any error encountered or 0 for success.
2129 * "sock" is only used for special-case var. len data.
2131 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
2135 int need_tracing_session
= 1;
2138 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2142 switch (cmd_ctx
->lsm
->cmd_type
) {
2143 case LTTNG_CREATE_SESSION
:
2144 case LTTNG_DESTROY_SESSION
:
2145 case LTTNG_LIST_SESSIONS
:
2146 case LTTNG_LIST_DOMAINS
:
2147 case LTTNG_START_TRACE
:
2148 case LTTNG_STOP_TRACE
:
2149 case LTTNG_DATA_PENDING
:
2156 if (opt_no_kernel
&& need_domain
2157 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
2159 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
2161 ret
= LTTNG_ERR_KERN_NA
;
2166 /* Deny register consumer if we already have a spawned consumer. */
2167 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
2168 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2169 if (kconsumer_data
.pid
> 0) {
2170 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2171 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2174 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2178 * Check for command that don't needs to allocate a returned payload. We do
2179 * this here so we don't have to make the call for no payload at each
2182 switch(cmd_ctx
->lsm
->cmd_type
) {
2183 case LTTNG_LIST_SESSIONS
:
2184 case LTTNG_LIST_TRACEPOINTS
:
2185 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2186 case LTTNG_LIST_DOMAINS
:
2187 case LTTNG_LIST_CHANNELS
:
2188 case LTTNG_LIST_EVENTS
:
2191 /* Setup lttng message with no payload */
2192 ret
= setup_lttng_msg(cmd_ctx
, 0);
2194 /* This label does not try to unlock the session */
2195 goto init_setup_error
;
2199 /* Commands that DO NOT need a session. */
2200 switch (cmd_ctx
->lsm
->cmd_type
) {
2201 case LTTNG_CREATE_SESSION
:
2202 case LTTNG_CALIBRATE
:
2203 case LTTNG_LIST_SESSIONS
:
2204 case LTTNG_LIST_TRACEPOINTS
:
2205 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2206 need_tracing_session
= 0;
2209 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
2211 * We keep the session list lock across _all_ commands
2212 * for now, because the per-session lock does not
2213 * handle teardown properly.
2215 session_lock_list();
2216 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
2217 if (cmd_ctx
->session
== NULL
) {
2218 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
2219 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
2221 /* If no session name specified */
2222 ret
= LTTNG_ERR_SELECT_SESS
;
2226 /* Acquire lock for the session */
2227 session_lock(cmd_ctx
->session
);
2237 * Check domain type for specific "pre-action".
2239 switch (cmd_ctx
->lsm
->domain
.type
) {
2240 case LTTNG_DOMAIN_KERNEL
:
2242 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
2246 /* Kernel tracer check */
2247 if (kernel_tracer_fd
== -1) {
2248 /* Basically, load kernel tracer modules */
2249 ret
= init_kernel_tracer();
2255 /* Consumer is in an ERROR state. Report back to client */
2256 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
2257 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
2261 /* Need a session for kernel command */
2262 if (need_tracing_session
) {
2263 if (cmd_ctx
->session
->kernel_session
== NULL
) {
2264 ret
= create_kernel_session(cmd_ctx
->session
);
2266 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
2271 /* Start the kernel consumer daemon */
2272 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2273 if (kconsumer_data
.pid
== 0 &&
2274 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
2275 cmd_ctx
->session
->start_consumer
) {
2276 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2277 ret
= start_consumerd(&kconsumer_data
);
2279 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2282 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
2284 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2288 * The consumer was just spawned so we need to add the socket to
2289 * the consumer output of the session if exist.
2291 ret
= consumer_create_socket(&kconsumer_data
,
2292 cmd_ctx
->session
->kernel_session
->consumer
);
2299 case LTTNG_DOMAIN_UST
:
2301 /* Consumer is in an ERROR state. Report back to client */
2302 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
2303 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
2307 if (need_tracing_session
) {
2308 /* Create UST session if none exist. */
2309 if (cmd_ctx
->session
->ust_session
== NULL
) {
2310 ret
= create_ust_session(cmd_ctx
->session
,
2311 &cmd_ctx
->lsm
->domain
);
2312 if (ret
!= LTTNG_OK
) {
2317 /* Start the UST consumer daemons */
2319 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
2320 if (consumerd64_bin
[0] != '\0' &&
2321 ustconsumer64_data
.pid
== 0 &&
2322 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
2323 cmd_ctx
->session
->start_consumer
) {
2324 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
2325 ret
= start_consumerd(&ustconsumer64_data
);
2327 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
2328 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
2332 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
2333 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
2335 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
2339 * Setup socket for consumer 64 bit. No need for atomic access
2340 * since it was set above and can ONLY be set in this thread.
2342 ret
= consumer_create_socket(&ustconsumer64_data
,
2343 cmd_ctx
->session
->ust_session
->consumer
);
2349 if (consumerd32_bin
[0] != '\0' &&
2350 ustconsumer32_data
.pid
== 0 &&
2351 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
2352 cmd_ctx
->session
->start_consumer
) {
2353 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
2354 ret
= start_consumerd(&ustconsumer32_data
);
2356 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
2357 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
2361 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
2362 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
2364 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
2368 * Setup socket for consumer 64 bit. No need for atomic access
2369 * since it was set above and can ONLY be set in this thread.
2371 ret
= consumer_create_socket(&ustconsumer32_data
,
2372 cmd_ctx
->session
->ust_session
->consumer
);
2384 /* Validate consumer daemon state when start/stop trace command */
2385 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
2386 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
2387 switch (cmd_ctx
->lsm
->domain
.type
) {
2388 case LTTNG_DOMAIN_UST
:
2389 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
2390 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
2394 case LTTNG_DOMAIN_KERNEL
:
2395 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
2396 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
2404 * Check that the UID or GID match that of the tracing session.
2405 * The root user can interact with all sessions.
2407 if (need_tracing_session
) {
2408 if (!session_access_ok(cmd_ctx
->session
,
2409 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2410 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
2411 ret
= LTTNG_ERR_EPERM
;
2416 /* Process by command type */
2417 switch (cmd_ctx
->lsm
->cmd_type
) {
2418 case LTTNG_ADD_CONTEXT
:
2420 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2421 cmd_ctx
->lsm
->u
.context
.channel_name
,
2422 cmd_ctx
->lsm
->u
.context
.event_name
,
2423 &cmd_ctx
->lsm
->u
.context
.ctx
, kernel_poll_pipe
[1]);
2426 case LTTNG_DISABLE_CHANNEL
:
2428 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2429 cmd_ctx
->lsm
->u
.disable
.channel_name
);
2432 case LTTNG_DISABLE_EVENT
:
2434 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2435 cmd_ctx
->lsm
->u
.disable
.channel_name
,
2436 cmd_ctx
->lsm
->u
.disable
.name
);
2439 case LTTNG_DISABLE_ALL_EVENT
:
2441 DBG("Disabling all events");
2443 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2444 cmd_ctx
->lsm
->u
.disable
.channel_name
);
2447 case LTTNG_DISABLE_CONSUMER
:
2449 ret
= cmd_disable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
2452 case LTTNG_ENABLE_CHANNEL
:
2454 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2455 &cmd_ctx
->lsm
->u
.channel
.chan
, kernel_poll_pipe
[1]);
2458 case LTTNG_ENABLE_CONSUMER
:
2461 * XXX: 0 means that this URI should be applied on the session. Should
2462 * be a DOMAIN enuam.
2464 ret
= cmd_enable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
2465 if (ret
!= LTTNG_OK
) {
2469 if (cmd_ctx
->lsm
->domain
.type
== 0) {
2470 /* Add the URI for the UST session if a consumer is present. */
2471 if (cmd_ctx
->session
->ust_session
&&
2472 cmd_ctx
->session
->ust_session
->consumer
) {
2473 ret
= cmd_enable_consumer(LTTNG_DOMAIN_UST
, cmd_ctx
->session
);
2474 } else if (cmd_ctx
->session
->kernel_session
&&
2475 cmd_ctx
->session
->kernel_session
->consumer
) {
2476 ret
= cmd_enable_consumer(LTTNG_DOMAIN_KERNEL
,
2482 case LTTNG_ENABLE_EVENT
:
2484 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2485 cmd_ctx
->lsm
->u
.enable
.channel_name
,
2486 &cmd_ctx
->lsm
->u
.enable
.event
, kernel_poll_pipe
[1]);
2489 case LTTNG_ENABLE_ALL_EVENT
:
2491 DBG("Enabling all events");
2493 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2494 cmd_ctx
->lsm
->u
.enable
.channel_name
,
2495 cmd_ctx
->lsm
->u
.enable
.event
.type
, kernel_poll_pipe
[1]);
2498 case LTTNG_LIST_TRACEPOINTS
:
2500 struct lttng_event
*events
;
2503 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
2504 if (nb_events
< 0) {
2505 /* Return value is a negative lttng_error_code. */
2511 * Setup lttng message with payload size set to the event list size in
2512 * bytes and then copy list into the llm payload.
2514 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
2520 /* Copy event list into message payload */
2521 memcpy(cmd_ctx
->llm
->payload
, events
,
2522 sizeof(struct lttng_event
) * nb_events
);
2529 case LTTNG_LIST_TRACEPOINT_FIELDS
:
2531 struct lttng_event_field
*fields
;
2534 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
2536 if (nb_fields
< 0) {
2537 /* Return value is a negative lttng_error_code. */
2543 * Setup lttng message with payload size set to the event list size in
2544 * bytes and then copy list into the llm payload.
2546 ret
= setup_lttng_msg(cmd_ctx
,
2547 sizeof(struct lttng_event_field
) * nb_fields
);
2553 /* Copy event list into message payload */
2554 memcpy(cmd_ctx
->llm
->payload
, fields
,
2555 sizeof(struct lttng_event_field
) * nb_fields
);
2562 case LTTNG_SET_CONSUMER_URI
:
2565 struct lttng_uri
*uris
;
2567 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
2568 len
= nb_uri
* sizeof(struct lttng_uri
);
2571 ret
= LTTNG_ERR_INVALID
;
2575 uris
= zmalloc(len
);
2577 ret
= LTTNG_ERR_FATAL
;
2581 /* Receive variable len data */
2582 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
2583 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
2585 DBG("No URIs received from client... continuing");
2587 ret
= LTTNG_ERR_SESSION_FAIL
;
2592 ret
= cmd_set_consumer_uri(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
2594 if (ret
!= LTTNG_OK
) {
2600 * XXX: 0 means that this URI should be applied on the session. Should
2601 * be a DOMAIN enuam.
2603 if (cmd_ctx
->lsm
->domain
.type
== 0) {
2604 /* Add the URI for the UST session if a consumer is present. */
2605 if (cmd_ctx
->session
->ust_session
&&
2606 cmd_ctx
->session
->ust_session
->consumer
) {
2607 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_UST
, cmd_ctx
->session
,
2609 } else if (cmd_ctx
->session
->kernel_session
&&
2610 cmd_ctx
->session
->kernel_session
->consumer
) {
2611 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_KERNEL
,
2612 cmd_ctx
->session
, nb_uri
, uris
);
2620 case LTTNG_START_TRACE
:
2622 ret
= cmd_start_trace(cmd_ctx
->session
);
2625 case LTTNG_STOP_TRACE
:
2627 ret
= cmd_stop_trace(cmd_ctx
->session
);
2630 case LTTNG_CREATE_SESSION
:
2633 struct lttng_uri
*uris
= NULL
;
2635 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
2636 len
= nb_uri
* sizeof(struct lttng_uri
);
2639 uris
= zmalloc(len
);
2641 ret
= LTTNG_ERR_FATAL
;
2645 /* Receive variable len data */
2646 DBG("Waiting for %zu URIs from client ...", nb_uri
);
2647 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
2649 DBG("No URIs received from client... continuing");
2651 ret
= LTTNG_ERR_SESSION_FAIL
;
2656 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
2657 DBG("Creating session with ONE network URI is a bad call");
2658 ret
= LTTNG_ERR_SESSION_FAIL
;
2664 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
2671 case LTTNG_DESTROY_SESSION
:
2673 ret
= cmd_destroy_session(cmd_ctx
->session
, kernel_poll_pipe
[1]);
2675 /* Set session to NULL so we do not unlock it after free. */
2676 cmd_ctx
->session
= NULL
;
2679 case LTTNG_LIST_DOMAINS
:
2682 struct lttng_domain
*domains
;
2684 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
2686 /* Return value is a negative lttng_error_code. */
2691 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
2696 /* Copy event list into message payload */
2697 memcpy(cmd_ctx
->llm
->payload
, domains
,
2698 nb_dom
* sizeof(struct lttng_domain
));
2705 case LTTNG_LIST_CHANNELS
:
2708 struct lttng_channel
*channels
;
2710 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
2711 cmd_ctx
->session
, &channels
);
2713 /* Return value is a negative lttng_error_code. */
2718 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
2723 /* Copy event list into message payload */
2724 memcpy(cmd_ctx
->llm
->payload
, channels
,
2725 nb_chan
* sizeof(struct lttng_channel
));
2732 case LTTNG_LIST_EVENTS
:
2735 struct lttng_event
*events
= NULL
;
2737 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
2738 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
2740 /* Return value is a negative lttng_error_code. */
2745 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
2750 /* Copy event list into message payload */
2751 memcpy(cmd_ctx
->llm
->payload
, events
,
2752 nb_event
* sizeof(struct lttng_event
));
2759 case LTTNG_LIST_SESSIONS
:
2761 unsigned int nr_sessions
;
2763 session_lock_list();
2764 nr_sessions
= lttng_sessions_count(
2765 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2766 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
2768 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
2770 session_unlock_list();
2774 /* Filled the session array */
2775 cmd_list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
2776 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2777 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
2779 session_unlock_list();
2784 case LTTNG_CALIBRATE
:
2786 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
2787 &cmd_ctx
->lsm
->u
.calibrate
);
2790 case LTTNG_REGISTER_CONSUMER
:
2792 struct consumer_data
*cdata
;
2794 switch (cmd_ctx
->lsm
->domain
.type
) {
2795 case LTTNG_DOMAIN_KERNEL
:
2796 cdata
= &kconsumer_data
;
2799 ret
= LTTNG_ERR_UND
;
2803 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2804 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
2807 case LTTNG_SET_FILTER
:
2809 struct lttng_filter_bytecode
*bytecode
;
2811 if (cmd_ctx
->lsm
->u
.filter
.bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
2812 ret
= LTTNG_ERR_FILTER_INVAL
;
2815 bytecode
= zmalloc(cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
2817 ret
= LTTNG_ERR_FILTER_NOMEM
;
2820 /* Receive var. len. data */
2821 DBG("Receiving var len data from client ...");
2822 ret
= lttcomm_recv_unix_sock(sock
, bytecode
,
2823 cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
2825 DBG("Nothing recv() from client var len data... continuing");
2827 ret
= LTTNG_ERR_FILTER_INVAL
;
2831 if (bytecode
->len
+ sizeof(*bytecode
)
2832 != cmd_ctx
->lsm
->u
.filter
.bytecode_len
) {
2834 ret
= LTTNG_ERR_FILTER_INVAL
;
2838 ret
= cmd_set_filter(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2839 cmd_ctx
->lsm
->u
.filter
.channel_name
,
2840 cmd_ctx
->lsm
->u
.filter
.event_name
,
2844 case LTTNG_DATA_PENDING
:
2846 ret
= cmd_data_pending(cmd_ctx
->session
);
2850 ret
= LTTNG_ERR_UND
;
2855 if (cmd_ctx
->llm
== NULL
) {
2856 DBG("Missing llm structure. Allocating one.");
2857 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
2861 /* Set return code */
2862 cmd_ctx
->llm
->ret_code
= ret
;
2864 if (cmd_ctx
->session
) {
2865 session_unlock(cmd_ctx
->session
);
2867 if (need_tracing_session
) {
2868 session_unlock_list();
2875 * Thread managing health check socket.
2877 static void *thread_manage_health(void *data
)
2879 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
2880 uint32_t revents
, nb_fd
;
2881 struct lttng_poll_event events
;
2882 struct lttcomm_health_msg msg
;
2883 struct lttcomm_health_data reply
;
2885 DBG("[thread] Manage health check started");
2887 rcu_register_thread();
2889 /* Create unix socket */
2890 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
2892 ERR("Unable to create health check Unix socket");
2898 * Set the CLOEXEC flag. Return code is useless because either way, the
2901 (void) utils_set_fd_cloexec(sock
);
2903 ret
= lttcomm_listen_unix_sock(sock
);
2909 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2910 * more will be added to this poll set.
2912 ret
= create_thread_poll_set(&events
, 2);
2917 /* Add the application registration socket */
2918 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
2924 DBG("Health check ready");
2926 nb_fd
= LTTNG_POLL_GETNB(&events
);
2928 /* Inifinite blocking call, waiting for transmission */
2930 ret
= lttng_poll_wait(&events
, -1);
2933 * Restart interrupted system call.
2935 if (errno
== EINTR
) {
2941 for (i
= 0; i
< nb_fd
; i
++) {
2942 /* Fetch once the poll data */
2943 revents
= LTTNG_POLL_GETEV(&events
, i
);
2944 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2946 /* Thread quit pipe has been closed. Killing thread. */
2947 ret
= check_thread_quit_pipe(pollfd
, revents
);
2953 /* Event on the registration socket */
2954 if (pollfd
== sock
) {
2955 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2956 ERR("Health socket poll error");
2962 new_sock
= lttcomm_accept_unix_sock(sock
);
2968 * Set the CLOEXEC flag. Return code is useless because either way, the
2971 (void) utils_set_fd_cloexec(new_sock
);
2973 DBG("Receiving data from client for health...");
2974 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
2976 DBG("Nothing recv() from client... continuing");
2977 ret
= close(new_sock
);
2985 rcu_thread_online();
2987 switch (msg
.component
) {
2988 case LTTNG_HEALTH_CMD
:
2989 reply
.ret_code
= health_check_state(&health_thread_cmd
);
2991 case LTTNG_HEALTH_APP_MANAGE
:
2992 reply
.ret_code
= health_check_state(&health_thread_app_manage
);
2994 case LTTNG_HEALTH_APP_REG
:
2995 reply
.ret_code
= health_check_state(&health_thread_app_reg
);
2997 case LTTNG_HEALTH_KERNEL
:
2998 reply
.ret_code
= health_check_state(&health_thread_kernel
);
3000 case LTTNG_HEALTH_CONSUMER
:
3001 reply
.ret_code
= check_consumer_health();
3003 case LTTNG_HEALTH_ALL
:
3005 health_check_state(&health_thread_app_manage
) &&
3006 health_check_state(&health_thread_app_reg
) &&
3007 health_check_state(&health_thread_cmd
) &&
3008 health_check_state(&health_thread_kernel
) &&
3009 check_consumer_health();
3012 reply
.ret_code
= LTTNG_ERR_UND
;
3017 * Flip ret value since 0 is a success and 1 indicates a bad health for
3018 * the client where in the sessiond it is the opposite. Again, this is
3019 * just to make things easier for us poor developer which enjoy a lot
3022 if (reply
.ret_code
== 0 || reply
.ret_code
== 1) {
3023 reply
.ret_code
= !reply
.ret_code
;
3026 DBG2("Health check return value %d", reply
.ret_code
);
3028 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
3030 ERR("Failed to send health data back to client");
3033 /* End of transmission */
3034 ret
= close(new_sock
);
3044 ERR("Health error occurred in %s", __func__
);
3046 DBG("Health check thread dying");
3047 unlink(health_unix_sock_path
);
3054 if (new_sock
>= 0) {
3055 ret
= close(new_sock
);
3061 lttng_poll_clean(&events
);
3063 rcu_unregister_thread();
3068 * This thread manage all clients request using the unix client socket for
3071 static void *thread_manage_clients(void *data
)
3073 int sock
= -1, ret
, i
, pollfd
, err
= -1;
3075 uint32_t revents
, nb_fd
;
3076 struct command_ctx
*cmd_ctx
= NULL
;
3077 struct lttng_poll_event events
;
3079 DBG("[thread] Manage client started");
3081 testpoint(thread_manage_clients
);
3083 rcu_register_thread();
3085 health_code_update(&health_thread_cmd
);
3087 ret
= lttcomm_listen_unix_sock(client_sock
);
3093 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3094 * more will be added to this poll set.
3096 ret
= create_thread_poll_set(&events
, 2);
3101 /* Add the application registration socket */
3102 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3108 * Notify parent pid that we are ready to accept command for client side.
3110 if (opt_sig_parent
) {
3111 kill(ppid
, SIGUSR1
);
3114 testpoint(thread_manage_clients_before_loop
);
3116 health_code_update(&health_thread_cmd
);
3119 DBG("Accepting client command ...");
3121 nb_fd
= LTTNG_POLL_GETNB(&events
);
3123 /* Inifinite blocking call, waiting for transmission */
3125 health_poll_update(&health_thread_cmd
);
3126 ret
= lttng_poll_wait(&events
, -1);
3127 health_poll_update(&health_thread_cmd
);
3130 * Restart interrupted system call.
3132 if (errno
== EINTR
) {
3138 for (i
= 0; i
< nb_fd
; i
++) {
3139 /* Fetch once the poll data */
3140 revents
= LTTNG_POLL_GETEV(&events
, i
);
3141 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3143 health_code_update(&health_thread_cmd
);
3145 /* Thread quit pipe has been closed. Killing thread. */
3146 ret
= check_thread_quit_pipe(pollfd
, revents
);
3152 /* Event on the registration socket */
3153 if (pollfd
== client_sock
) {
3154 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3155 ERR("Client socket poll error");
3161 DBG("Wait for client response");
3163 health_code_update(&health_thread_cmd
);
3165 sock
= lttcomm_accept_unix_sock(client_sock
);
3171 * Set the CLOEXEC flag. Return code is useless because either way, the
3174 (void) utils_set_fd_cloexec(sock
);
3176 /* Set socket option for credentials retrieval */
3177 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3182 /* Allocate context command to process the client request */
3183 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3184 if (cmd_ctx
== NULL
) {
3185 PERROR("zmalloc cmd_ctx");
3189 /* Allocate data buffer for reception */
3190 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3191 if (cmd_ctx
->lsm
== NULL
) {
3192 PERROR("zmalloc cmd_ctx->lsm");
3196 cmd_ctx
->llm
= NULL
;
3197 cmd_ctx
->session
= NULL
;
3199 health_code_update(&health_thread_cmd
);
3202 * Data is received from the lttng client. The struct
3203 * lttcomm_session_msg (lsm) contains the command and data request of
3206 DBG("Receiving data from client ...");
3207 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3208 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3210 DBG("Nothing recv() from client... continuing");
3216 clean_command_ctx(&cmd_ctx
);
3220 health_code_update(&health_thread_cmd
);
3222 // TODO: Validate cmd_ctx including sanity check for
3223 // security purpose.
3225 rcu_thread_online();
3227 * This function dispatch the work to the kernel or userspace tracer
3228 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3229 * informations for the client. The command context struct contains
3230 * everything this function may needs.
3232 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
3233 rcu_thread_offline();
3243 * TODO: Inform client somehow of the fatal error. At
3244 * this point, ret < 0 means that a zmalloc failed
3245 * (ENOMEM). Error detected but still accept
3246 * command, unless a socket error has been
3249 clean_command_ctx(&cmd_ctx
);
3253 health_code_update(&health_thread_cmd
);
3255 DBG("Sending response (size: %d, retcode: %s)",
3256 cmd_ctx
->lttng_msg_size
,
3257 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3258 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3260 ERR("Failed to send data back to client");
3263 /* End of transmission */
3270 clean_command_ctx(&cmd_ctx
);
3272 health_code_update(&health_thread_cmd
);
3278 health_error(&health_thread_cmd
);
3279 ERR("Health error occurred in %s", __func__
);
3281 health_exit(&health_thread_cmd
);
3283 DBG("Client thread dying");
3284 unlink(client_unix_sock_path
);
3285 if (client_sock
>= 0) {
3286 ret
= close(client_sock
);
3298 lttng_poll_clean(&events
);
3299 clean_command_ctx(&cmd_ctx
);
3301 rcu_unregister_thread();
3307 * usage function on stderr
3309 static void usage(void)
3311 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3312 fprintf(stderr
, " -h, --help Display this usage.\n");
3313 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3314 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3315 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3316 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3317 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3318 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3319 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3320 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3321 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3322 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3323 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3324 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3325 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3326 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3327 fprintf(stderr
, " -V, --version Show version number.\n");
3328 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3329 fprintf(stderr
, " -q, --quiet No output at all.\n");
3330 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3331 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3332 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3336 * daemon argument parsing
3338 static int parse_args(int argc
, char **argv
)
3342 static struct option long_options
[] = {
3343 { "client-sock", 1, 0, 'c' },
3344 { "apps-sock", 1, 0, 'a' },
3345 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3346 { "kconsumerd-err-sock", 1, 0, 'E' },
3347 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3348 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3349 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3350 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3351 { "consumerd32-path", 1, 0, 'u' },
3352 { "consumerd32-libdir", 1, 0, 'U' },
3353 { "consumerd64-path", 1, 0, 't' },
3354 { "consumerd64-libdir", 1, 0, 'T' },
3355 { "daemonize", 0, 0, 'd' },
3356 { "sig-parent", 0, 0, 'S' },
3357 { "help", 0, 0, 'h' },
3358 { "group", 1, 0, 'g' },
3359 { "version", 0, 0, 'V' },
3360 { "quiet", 0, 0, 'q' },
3361 { "verbose", 0, 0, 'v' },
3362 { "verbose-consumer", 0, 0, 'Z' },
3363 { "no-kernel", 0, 0, 'N' },
3368 int option_index
= 0;
3369 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3370 long_options
, &option_index
);
3377 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3379 fprintf(stderr
, " with arg %s\n", optarg
);
3383 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3386 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3392 opt_tracing_group
= optarg
;
3398 fprintf(stdout
, "%s\n", VERSION
);
3404 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3407 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3410 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3413 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3416 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3419 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3425 lttng_opt_quiet
= 1;
3428 /* Verbose level can increase using multiple -v */
3429 lttng_opt_verbose
+= 1;
3432 opt_verbose_consumer
+= 1;
3435 consumerd32_bin
= optarg
;
3438 consumerd32_libdir
= optarg
;
3441 consumerd64_bin
= optarg
;
3444 consumerd64_libdir
= optarg
;
3447 /* Unknown option or other error.
3448 * Error is printed by getopt, just return */
3457 * Creates the two needed socket by the daemon.
3458 * apps_sock - The communication socket for all UST apps.
3459 * client_sock - The communication of the cli tool (lttng).
3461 static int init_daemon_socket(void)
3466 old_umask
= umask(0);
3468 /* Create client tool unix socket */
3469 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3470 if (client_sock
< 0) {
3471 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3476 /* Set the cloexec flag */
3477 ret
= utils_set_fd_cloexec(client_sock
);
3479 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
3480 "Continuing but note that the consumer daemon will have a "
3481 "reference to this socket on exec()", client_sock
);
3484 /* File permission MUST be 660 */
3485 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3487 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3492 /* Create the application unix socket */
3493 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3494 if (apps_sock
< 0) {
3495 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3500 /* Set the cloexec flag */
3501 ret
= utils_set_fd_cloexec(apps_sock
);
3503 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
3504 "Continuing but note that the consumer daemon will have a "
3505 "reference to this socket on exec()", apps_sock
);
3508 /* File permission MUST be 666 */
3509 ret
= chmod(apps_unix_sock_path
,
3510 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3512 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3517 DBG3("Session daemon client socket %d and application socket %d created",
3518 client_sock
, apps_sock
);
3526 * Check if the global socket is available, and if a daemon is answering at the
3527 * other side. If yes, error is returned.
3529 static int check_existing_daemon(void)
3531 /* Is there anybody out there ? */
3532 if (lttng_session_daemon_alive()) {
3540 * Set the tracing group gid onto the client socket.
3542 * Race window between mkdir and chown is OK because we are going from more
3543 * permissive (root.root) to less permissive (root.tracing).
3545 static int set_permissions(char *rundir
)
3550 ret
= allowed_group();
3552 WARN("No tracing group detected");
3559 /* Set lttng run dir */
3560 ret
= chown(rundir
, 0, gid
);
3562 ERR("Unable to set group on %s", rundir
);
3566 /* Ensure tracing group can search the run dir */
3567 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
3569 ERR("Unable to set permissions on %s", rundir
);
3573 /* lttng client socket path */
3574 ret
= chown(client_unix_sock_path
, 0, gid
);
3576 ERR("Unable to set group on %s", client_unix_sock_path
);
3580 /* kconsumer error socket path */
3581 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3583 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3587 /* 64-bit ustconsumer error socket path */
3588 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3590 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3594 /* 32-bit ustconsumer compat32 error socket path */
3595 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3597 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
3601 DBG("All permissions are set");
3608 * Create the lttng run directory needed for all global sockets and pipe.
3610 static int create_lttng_rundir(const char *rundir
)
3614 DBG3("Creating LTTng run directory: %s", rundir
);
3616 ret
= mkdir(rundir
, S_IRWXU
);
3618 if (errno
!= EEXIST
) {
3619 ERR("Unable to create %s", rundir
);
3631 * Setup sockets and directory needed by the kconsumerd communication with the
3634 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
3638 char path
[PATH_MAX
];
3640 switch (consumer_data
->type
) {
3641 case LTTNG_CONSUMER_KERNEL
:
3642 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
3644 case LTTNG_CONSUMER64_UST
:
3645 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
3647 case LTTNG_CONSUMER32_UST
:
3648 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
3651 ERR("Consumer type unknown");
3656 DBG2("Creating consumer directory: %s", path
);
3658 ret
= mkdir(path
, S_IRWXU
);
3660 if (errno
!= EEXIST
) {
3662 ERR("Failed to create %s", path
);
3668 /* Create the kconsumerd error unix socket */
3669 consumer_data
->err_sock
=
3670 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
3671 if (consumer_data
->err_sock
< 0) {
3672 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
3677 /* File permission MUST be 660 */
3678 ret
= chmod(consumer_data
->err_unix_sock_path
,
3679 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3681 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
3691 * Signal handler for the daemon
3693 * Simply stop all worker threads, leaving main() return gracefully after
3694 * joining all threads and calling cleanup().
3696 static void sighandler(int sig
)
3700 DBG("SIGPIPE caught");
3703 DBG("SIGINT caught");
3707 DBG("SIGTERM caught");
3716 * Setup signal handler for :
3717 * SIGINT, SIGTERM, SIGPIPE
3719 static int set_signal_handler(void)
3722 struct sigaction sa
;
3725 if ((ret
= sigemptyset(&sigset
)) < 0) {
3726 PERROR("sigemptyset");
3730 sa
.sa_handler
= sighandler
;
3731 sa
.sa_mask
= sigset
;
3733 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
3734 PERROR("sigaction");
3738 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
3739 PERROR("sigaction");
3743 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
3744 PERROR("sigaction");
3748 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3754 * Set open files limit to unlimited. This daemon can open a large number of
3755 * file descriptors in order to consumer multiple kernel traces.
3757 static void set_ulimit(void)
3762 /* The kernel does not allowed an infinite limit for open files */
3763 lim
.rlim_cur
= 65535;
3764 lim
.rlim_max
= 65535;
3766 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
3768 PERROR("failed to set open files limit");
3775 int main(int argc
, char **argv
)
3779 const char *home_path
;
3781 init_kernel_workarounds();
3783 rcu_register_thread();
3785 setup_consumerd_path();
3787 /* Parse arguments */
3789 if ((ret
= parse_args(argc
, argv
) < 0)) {
3799 * child: setsid, close FD 0, 1, 2, chdir /
3800 * parent: exit (if fork is successful)
3808 * We are in the child. Make sure all other file
3809 * descriptors are closed, in case we are called with
3810 * more opened file descriptors than the standard ones.
3812 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
3817 /* Create thread quit pipe */
3818 if ((ret
= init_thread_quit_pipe()) < 0) {
3822 /* Check if daemon is UID = 0 */
3823 is_root
= !getuid();
3826 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
3828 /* Create global run dir with root access */
3829 ret
= create_lttng_rundir(rundir
);
3834 if (strlen(apps_unix_sock_path
) == 0) {
3835 snprintf(apps_unix_sock_path
, PATH_MAX
,
3836 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
3839 if (strlen(client_unix_sock_path
) == 0) {
3840 snprintf(client_unix_sock_path
, PATH_MAX
,
3841 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
3844 /* Set global SHM for ust */
3845 if (strlen(wait_shm_path
) == 0) {
3846 snprintf(wait_shm_path
, PATH_MAX
,
3847 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
3850 if (strlen(health_unix_sock_path
) == 0) {
3851 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
3852 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
3855 /* Setup kernel consumerd path */
3856 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
3857 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
3858 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
3859 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
3861 DBG2("Kernel consumer err path: %s",
3862 kconsumer_data
.err_unix_sock_path
);
3863 DBG2("Kernel consumer cmd path: %s",
3864 kconsumer_data
.cmd_unix_sock_path
);
3866 home_path
= get_home_dir();
3867 if (home_path
== NULL
) {
3868 /* TODO: Add --socket PATH option */
3869 ERR("Can't get HOME directory for sockets creation.");
3875 * Create rundir from home path. This will create something like
3878 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
3884 ret
= create_lttng_rundir(rundir
);
3889 if (strlen(apps_unix_sock_path
) == 0) {
3890 snprintf(apps_unix_sock_path
, PATH_MAX
,
3891 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
3894 /* Set the cli tool unix socket path */
3895 if (strlen(client_unix_sock_path
) == 0) {
3896 snprintf(client_unix_sock_path
, PATH_MAX
,
3897 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
3900 /* Set global SHM for ust */
3901 if (strlen(wait_shm_path
) == 0) {
3902 snprintf(wait_shm_path
, PATH_MAX
,
3903 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
3906 /* Set health check Unix path */
3907 if (strlen(health_unix_sock_path
) == 0) {
3908 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
3909 DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
3913 /* Set consumer initial state */
3914 kernel_consumerd_state
= CONSUMER_STOPPED
;
3915 ust_consumerd_state
= CONSUMER_STOPPED
;
3917 DBG("Client socket path %s", client_unix_sock_path
);
3918 DBG("Application socket path %s", apps_unix_sock_path
);
3919 DBG("LTTng run directory path: %s", rundir
);
3921 /* 32 bits consumerd path setup */
3922 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
3923 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
3924 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
3925 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
3927 DBG2("UST consumer 32 bits err path: %s",
3928 ustconsumer32_data
.err_unix_sock_path
);
3929 DBG2("UST consumer 32 bits cmd path: %s",
3930 ustconsumer32_data
.cmd_unix_sock_path
);
3932 /* 64 bits consumerd path setup */
3933 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
3934 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
3935 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
3936 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
3938 DBG2("UST consumer 64 bits err path: %s",
3939 ustconsumer64_data
.err_unix_sock_path
);
3940 DBG2("UST consumer 64 bits cmd path: %s",
3941 ustconsumer64_data
.cmd_unix_sock_path
);
3944 * See if daemon already exist.
3946 if ((ret
= check_existing_daemon()) < 0) {
3947 ERR("Already running daemon.\n");
3949 * We do not goto exit because we must not cleanup()
3950 * because a daemon is already running.
3956 * Init UST app hash table. Alloc hash table before this point since
3957 * cleanup() can get called after that point.
3961 /* After this point, we can safely call cleanup() with "goto exit" */
3964 * These actions must be executed as root. We do that *after* setting up
3965 * the sockets path because we MUST make the check for another daemon using
3966 * those paths *before* trying to set the kernel consumer sockets and init
3970 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
3975 /* Setup kernel tracer */
3976 if (!opt_no_kernel
) {
3977 init_kernel_tracer();
3980 /* Set ulimit for open files */
3983 /* init lttng_fd tracking must be done after set_ulimit. */
3986 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
3991 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
3996 if ((ret
= set_signal_handler()) < 0) {
4000 /* Setup the needed unix socket */
4001 if ((ret
= init_daemon_socket()) < 0) {
4005 /* Set credentials to socket */
4006 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4010 /* Get parent pid if -S, --sig-parent is specified. */
4011 if (opt_sig_parent
) {
4015 /* Setup the kernel pipe for waking up the kernel thread */
4016 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
4020 /* Setup the thread apps communication pipe. */
4021 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
4025 /* Init UST command queue. */
4026 cds_wfq_init(&ust_cmd_queue
.queue
);
4029 * Get session list pointer. This pointer MUST NOT be free(). This list is
4030 * statically declared in session.c
4032 session_list_ptr
= session_get_list();
4034 /* Set up max poll set size */
4035 lttng_poll_set_max_size();
4039 /* Init all health thread counters. */
4040 health_init(&health_thread_cmd
);
4041 health_init(&health_thread_kernel
);
4042 health_init(&health_thread_app_manage
);
4043 health_init(&health_thread_app_reg
);
4046 * Init health counters of the consumer thread. We do a quick hack here to
4047 * the state of the consumer health is fine even if the thread is not
4048 * started. Once the thread starts, the health state is updated with a poll
4049 * value to set a health code path. This is simply to ease our life and has
4050 * no cost what so ever.
4052 health_init(&kconsumer_data
.health
);
4053 health_poll_update(&kconsumer_data
.health
);
4054 health_init(&ustconsumer32_data
.health
);
4055 health_poll_update(&ustconsumer32_data
.health
);
4056 health_init(&ustconsumer64_data
.health
);
4057 health_poll_update(&ustconsumer64_data
.health
);
4059 /* Create thread to manage the client socket */
4060 ret
= pthread_create(&health_thread
, NULL
,
4061 thread_manage_health
, (void *) NULL
);
4063 PERROR("pthread_create health");
4067 /* Create thread to manage the client socket */
4068 ret
= pthread_create(&client_thread
, NULL
,
4069 thread_manage_clients
, (void *) NULL
);
4071 PERROR("pthread_create clients");
4075 /* Create thread to dispatch registration */
4076 ret
= pthread_create(&dispatch_thread
, NULL
,
4077 thread_dispatch_ust_registration
, (void *) NULL
);
4079 PERROR("pthread_create dispatch");
4083 /* Create thread to manage application registration. */
4084 ret
= pthread_create(®_apps_thread
, NULL
,
4085 thread_registration_apps
, (void *) NULL
);
4087 PERROR("pthread_create registration");
4091 /* Create thread to manage application socket */
4092 ret
= pthread_create(&apps_thread
, NULL
,
4093 thread_manage_apps
, (void *) NULL
);
4095 PERROR("pthread_create apps");
4099 /* Create kernel thread to manage kernel event */
4100 ret
= pthread_create(&kernel_thread
, NULL
,
4101 thread_manage_kernel
, (void *) NULL
);
4103 PERROR("pthread_create kernel");
4107 ret
= pthread_join(kernel_thread
, &status
);
4109 PERROR("pthread_join");
4110 goto error
; /* join error, exit without cleanup */
4114 ret
= pthread_join(apps_thread
, &status
);
4116 PERROR("pthread_join");
4117 goto error
; /* join error, exit without cleanup */
4121 ret
= pthread_join(reg_apps_thread
, &status
);
4123 PERROR("pthread_join");
4124 goto error
; /* join error, exit without cleanup */
4128 ret
= pthread_join(dispatch_thread
, &status
);
4130 PERROR("pthread_join");
4131 goto error
; /* join error, exit without cleanup */
4135 ret
= pthread_join(client_thread
, &status
);
4137 PERROR("pthread_join");
4138 goto error
; /* join error, exit without cleanup */
4141 ret
= join_consumer_thread(&kconsumer_data
);
4143 PERROR("join_consumer");
4144 goto error
; /* join error, exit without cleanup */
4147 ret
= join_consumer_thread(&ustconsumer32_data
);
4149 PERROR("join_consumer ust32");
4150 goto error
; /* join error, exit without cleanup */
4153 ret
= join_consumer_thread(&ustconsumer64_data
);
4155 PERROR("join_consumer ust64");
4156 goto error
; /* join error, exit without cleanup */
4160 ret
= pthread_join(health_thread
, &status
);
4162 PERROR("pthread_join health thread");
4163 goto error
; /* join error, exit without cleanup */
4169 * cleanup() is called when no other thread is running.
4171 rcu_thread_online();
4173 rcu_thread_offline();
4174 rcu_unregister_thread();