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.
24 #include <semaphore.h>
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
36 #include <urcu/uatomic.h>
40 #include <common/common.h>
41 #include <common/compat/poll.h>
42 #include <common/compat/socket.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/futex.h>
46 #include <common/relayd/relayd.h>
47 #include <common/utils.h>
49 #include "lttng-sessiond.h"
55 #include "kernel-consumer.h"
59 #include "ust-consumer.h"
65 #define CONSUMERD_FILE "lttng-consumerd"
68 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
69 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
70 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
71 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
74 const char *opt_tracing_group
;
75 static int opt_sig_parent
;
76 static int opt_verbose_consumer
;
77 static int opt_daemon
;
78 static int opt_no_kernel
;
79 static int is_root
; /* Set to 1 if the daemon is running as root */
80 static pid_t ppid
; /* Parent PID for --sig-parent option */
83 /* Consumer daemon specific control data */
84 static struct consumer_data kconsumer_data
= {
85 .type
= LTTNG_CONSUMER_KERNEL
,
86 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
87 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
90 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
91 .lock
= PTHREAD_MUTEX_INITIALIZER
,
93 static struct consumer_data ustconsumer64_data
= {
94 .type
= LTTNG_CONSUMER64_UST
,
95 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
96 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
99 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
100 .lock
= PTHREAD_MUTEX_INITIALIZER
,
102 static struct consumer_data ustconsumer32_data
= {
103 .type
= LTTNG_CONSUMER32_UST
,
104 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
105 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
108 .pid_mutex
= PTHREAD_MUTEX_INITIALIZER
,
109 .lock
= PTHREAD_MUTEX_INITIALIZER
,
112 /* Shared between threads */
113 static int dispatch_thread_exit
;
115 /* Global application Unix socket path */
116 static char apps_unix_sock_path
[PATH_MAX
];
117 /* Global client Unix socket path */
118 static char client_unix_sock_path
[PATH_MAX
];
119 /* global wait shm path for UST */
120 static char wait_shm_path
[PATH_MAX
];
121 /* Global health check unix path */
122 static char health_unix_sock_path
[PATH_MAX
];
124 /* Sockets and FDs */
125 static int client_sock
= -1;
126 static int apps_sock
= -1;
127 static int kernel_tracer_fd
= -1;
128 static int kernel_poll_pipe
[2] = { -1, -1 };
131 * Quit pipe for all threads. This permits a single cancellation point
132 * for all threads when receiving an event on the pipe.
134 static int thread_quit_pipe
[2] = { -1, -1 };
137 * This pipe is used to inform the thread managing application communication
138 * that a command is queued and ready to be processed.
140 static int apps_cmd_pipe
[2] = { -1, -1 };
142 /* Pthread, Mutexes and Semaphores */
143 static pthread_t apps_thread
;
144 static pthread_t reg_apps_thread
;
145 static pthread_t client_thread
;
146 static pthread_t kernel_thread
;
147 static pthread_t dispatch_thread
;
148 static pthread_t health_thread
;
151 * UST registration command queue. This queue is tied with a futex and uses a N
152 * wakers / 1 waiter implemented and detailed in futex.c/.h
154 * The thread_manage_apps and thread_dispatch_ust_registration interact with
155 * this queue and the wait/wake scheme.
157 static struct ust_cmd_queue ust_cmd_queue
;
160 * Pointer initialized before thread creation.
162 * This points to the tracing session list containing the session count and a
163 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
164 * MUST NOT be taken if you call a public function in session.c.
166 * The lock is nested inside the structure: session_list_ptr->lock. Please use
167 * session_lock_list and session_unlock_list for lock acquisition.
169 static struct ltt_session_list
*session_list_ptr
;
171 int ust_consumerd64_fd
= -1;
172 int ust_consumerd32_fd
= -1;
174 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
175 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
176 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
177 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
180 * Consumer daemon state which is changed when spawning it, killing it or in
181 * case of a fatal error.
183 enum consumerd_state
{
184 CONSUMER_STARTED
= 1,
185 CONSUMER_STOPPED
= 2,
190 * This consumer daemon state is used to validate if a client command will be
191 * able to reach the consumer. If not, the client is informed. For instance,
192 * doing a "lttng start" when the consumer state is set to ERROR will return an
193 * error to the client.
195 * The following example shows a possible race condition of this scheme:
197 * consumer thread error happens
199 * client cmd checks state -> still OK
200 * consumer thread exit, sets error
201 * client cmd try to talk to consumer
204 * However, since the consumer is a different daemon, we have no way of making
205 * sure the command will reach it safely even with this state flag. This is why
206 * we consider that up to the state validation during command processing, the
207 * command is safe. After that, we can not guarantee the correctness of the
208 * client request vis-a-vis the consumer.
210 static enum consumerd_state ust_consumerd_state
;
211 static enum consumerd_state kernel_consumerd_state
;
214 * Used to keep a unique index for each relayd socket created where this value
215 * is associated with streams on the consumer so it can match the right relayd
218 * This value should be incremented atomically for safety purposes and future
219 * possible concurrent access.
221 static unsigned int relayd_net_seq_idx
;
223 /* Used for the health monitoring of the session daemon. See health.h */
224 struct health_state health_thread_cmd
;
225 struct health_state health_thread_app_manage
;
226 struct health_state health_thread_app_reg
;
227 struct health_state health_thread_kernel
;
230 void setup_consumerd_path(void)
232 const char *bin
, *libdir
;
235 * Allow INSTALL_BIN_PATH to be used as a target path for the
236 * native architecture size consumer if CONFIG_CONSUMER*_PATH
237 * has not been defined.
239 #if (CAA_BITS_PER_LONG == 32)
240 if (!consumerd32_bin
[0]) {
241 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
243 if (!consumerd32_libdir
[0]) {
244 consumerd32_libdir
= INSTALL_LIB_PATH
;
246 #elif (CAA_BITS_PER_LONG == 64)
247 if (!consumerd64_bin
[0]) {
248 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
250 if (!consumerd64_libdir
[0]) {
251 consumerd64_libdir
= INSTALL_LIB_PATH
;
254 #error "Unknown bitness"
258 * runtime env. var. overrides the build default.
260 bin
= getenv("LTTNG_CONSUMERD32_BIN");
262 consumerd32_bin
= bin
;
264 bin
= getenv("LTTNG_CONSUMERD64_BIN");
266 consumerd64_bin
= bin
;
268 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
270 consumerd32_libdir
= libdir
;
272 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
274 consumerd64_libdir
= libdir
;
279 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
281 static int create_thread_poll_set(struct lttng_poll_event
*events
,
286 if (events
== NULL
|| size
== 0) {
291 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
297 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
309 * Check if the thread quit pipe was triggered.
311 * Return 1 if it was triggered else 0;
313 static int check_thread_quit_pipe(int fd
, uint32_t events
)
315 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
323 * Return group ID of the tracing group or -1 if not found.
325 static gid_t
allowed_group(void)
329 if (opt_tracing_group
) {
330 grp
= getgrnam(opt_tracing_group
);
332 grp
= getgrnam(default_tracing_group
);
342 * Init thread quit pipe.
344 * Return -1 on error or 0 if all pipes are created.
346 static int init_thread_quit_pipe(void)
350 ret
= pipe(thread_quit_pipe
);
352 PERROR("thread quit pipe");
356 for (i
= 0; i
< 2; i
++) {
357 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
369 * Complete teardown of a kernel session. This free all data structure related
370 * to a kernel session and update counter.
372 static void teardown_kernel_session(struct ltt_session
*session
)
375 struct lttng_ht_iter iter
;
376 struct ltt_kernel_session
*ksess
;
377 struct consumer_socket
*socket
;
379 if (!session
->kernel_session
) {
380 DBG3("No kernel session when tearing down session");
384 ksess
= session
->kernel_session
;
386 DBG("Tearing down kernel session");
389 * Destroy relayd associated with the session consumer. This action is
390 * valid since in order to destroy a session we must acquire the session
391 * lock. This means that there CAN NOT be stream(s) being sent to a
392 * consumer since this action also requires the session lock at any time.
394 * At this point, we are sure that not streams data will be lost after this
397 if (ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) {
398 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
, socket
,
400 ret
= consumer_send_destroy_relayd(socket
, ksess
->consumer
);
402 ERR("Unable to send destroy relayd command to consumer");
403 /* Continue since we MUST delete everything at this point. */
409 * If a custom kernel consumer was registered, close the socket before
410 * tearing down the complete kernel session structure
412 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
, socket
,
414 if (socket
->fd
!= kconsumer_data
.cmd_sock
) {
416 consumer_del_socket(socket
, ksess
->consumer
);
417 lttcomm_close_unix_sock(socket
->fd
);
418 consumer_destroy_socket(socket
);
423 trace_kernel_destroy_session(ksess
);
427 * Complete teardown of all UST sessions. This will free everything on his path
428 * and destroy the core essence of all ust sessions :)
430 static void teardown_ust_session(struct ltt_session
*session
)
433 struct lttng_ht_iter iter
;
434 struct ltt_ust_session
*usess
;
435 struct consumer_socket
*socket
;
437 if (!session
->ust_session
) {
438 DBG3("No UST session when tearing down session");
441 usess
= session
->ust_session
;
443 DBG("Tearing down UST session(s)");
446 * Destroy relayd associated with the session consumer. This action is
447 * valid since in order to destroy a session we must acquire the session
448 * lock. This means that there CAN NOT be stream(s) being sent to a
449 * consumer since this action also requires the session lock at any time.
451 * At this point, we are sure that no data will be lost after this command
454 if (usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
) {
455 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
, socket
,
457 ret
= consumer_send_destroy_relayd(socket
, usess
->consumer
);
459 ERR("Unable to send destroy relayd command to consumer");
460 /* Continue since we MUST delete everything at this point. */
465 ret
= ust_app_destroy_trace_all(usess
);
467 ERR("Error in ust_app_destroy_trace_all");
470 trace_ust_destroy_session(usess
);
474 * Stop all threads by closing the thread quit pipe.
476 static void stop_threads(void)
480 /* Stopping all threads */
481 DBG("Terminating all threads");
482 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
484 ERR("write error on thread quit pipe");
487 /* Dispatch thread */
488 CMM_STORE_SHARED(dispatch_thread_exit
, 1);
489 futex_nto1_wake(&ust_cmd_queue
.futex
);
495 static void cleanup(void)
499 struct ltt_session
*sess
, *stmp
;
503 DBG("Removing %s directory", rundir
);
504 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
506 ERR("asprintf failed. Something is really wrong!");
509 /* Remove lttng run directory */
512 ERR("Unable to clean %s", rundir
);
516 DBG("Cleaning up all sessions");
518 /* Destroy session list mutex */
519 if (session_list_ptr
!= NULL
) {
520 pthread_mutex_destroy(&session_list_ptr
->lock
);
522 /* Cleanup ALL session */
523 cds_list_for_each_entry_safe(sess
, stmp
,
524 &session_list_ptr
->head
, list
) {
525 teardown_kernel_session(sess
);
526 teardown_ust_session(sess
);
531 DBG("Closing all UST sockets");
532 ust_app_clean_list();
534 if (is_root
&& !opt_no_kernel
) {
535 DBG2("Closing kernel fd");
536 if (kernel_tracer_fd
>= 0) {
537 ret
= close(kernel_tracer_fd
);
542 DBG("Unloading kernel modules");
543 modprobe_remove_lttng_all();
545 utils_close_pipe(kernel_poll_pipe
);
546 utils_close_pipe(thread_quit_pipe
);
547 utils_close_pipe(apps_cmd_pipe
);
550 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
551 "Matthew, BEET driven development works!%c[%dm",
552 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
557 * Send data on a unix socket using the liblttsessiondcomm API.
559 * Return lttcomm error code.
561 static int send_unix_sock(int sock
, void *buf
, size_t len
)
563 /* Check valid length */
568 return lttcomm_send_unix_sock(sock
, buf
, len
);
572 * Free memory of a command context structure.
574 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
576 DBG("Clean command context structure");
578 if ((*cmd_ctx
)->llm
) {
579 free((*cmd_ctx
)->llm
);
581 if ((*cmd_ctx
)->lsm
) {
582 free((*cmd_ctx
)->lsm
);
590 * Notify UST applications using the shm mmap futex.
592 static int notify_ust_apps(int active
)
596 DBG("Notifying applications of session daemon state: %d", active
);
598 /* See shm.c for this call implying mmap, shm and futex calls */
599 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
600 if (wait_shm_mmap
== NULL
) {
604 /* Wake waiting process */
605 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
607 /* Apps notified successfully */
615 * Setup the outgoing data buffer for the response (llm) by allocating the
616 * right amount of memory and copying the original information from the lsm
619 * Return total size of the buffer pointed by buf.
621 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
627 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
628 if (cmd_ctx
->llm
== NULL
) {
634 /* Copy common data */
635 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
636 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
638 cmd_ctx
->llm
->data_size
= size
;
639 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
648 * Update the kernel poll set of all channel fd available over all tracing
649 * session. Add the wakeup pipe at the end of the set.
651 static int update_kernel_poll(struct lttng_poll_event
*events
)
654 struct ltt_session
*session
;
655 struct ltt_kernel_channel
*channel
;
657 DBG("Updating kernel poll set");
660 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
661 session_lock(session
);
662 if (session
->kernel_session
== NULL
) {
663 session_unlock(session
);
667 cds_list_for_each_entry(channel
,
668 &session
->kernel_session
->channel_list
.head
, list
) {
669 /* Add channel fd to the kernel poll set */
670 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
672 session_unlock(session
);
675 DBG("Channel fd %d added to kernel set", channel
->fd
);
677 session_unlock(session
);
679 session_unlock_list();
684 session_unlock_list();
689 * Find the channel fd from 'fd' over all tracing session. When found, check
690 * for new channel stream and send those stream fds to the kernel consumer.
692 * Useful for CPU hotplug feature.
694 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
697 struct ltt_session
*session
;
698 struct ltt_kernel_session
*ksess
;
699 struct ltt_kernel_channel
*channel
;
701 DBG("Updating kernel streams for channel fd %d", fd
);
704 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
705 session_lock(session
);
706 if (session
->kernel_session
== NULL
) {
707 session_unlock(session
);
710 ksess
= session
->kernel_session
;
712 cds_list_for_each_entry(channel
, &ksess
->channel_list
.head
, list
) {
713 if (channel
->fd
== fd
) {
714 DBG("Channel found, updating kernel streams");
715 ret
= kernel_open_channel_stream(channel
);
721 * Have we already sent fds to the consumer? If yes, it means
722 * that tracing is started so it is safe to send our updated
725 if (ksess
->consumer_fds_sent
== 1 && ksess
->consumer
!= NULL
) {
726 struct lttng_ht_iter iter
;
727 struct consumer_socket
*socket
;
730 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
,
731 &iter
.iter
, socket
, node
.node
) {
732 /* Code flow error */
733 assert(socket
->fd
>= 0);
735 pthread_mutex_lock(socket
->lock
);
736 ret
= kernel_consumer_send_channel_stream(socket
->fd
,
738 pthread_mutex_unlock(socket
->lock
);
747 session_unlock(session
);
749 session_unlock_list();
753 session_unlock(session
);
754 session_unlock_list();
759 * For each tracing session, update newly registered apps.
761 static void update_ust_app(int app_sock
)
763 struct ltt_session
*sess
, *stmp
;
767 /* For all tracing session(s) */
768 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
770 if (sess
->ust_session
) {
771 ust_app_global_update(sess
->ust_session
, app_sock
);
773 session_unlock(sess
);
776 session_unlock_list();
780 * This thread manage event coming from the kernel.
782 * Features supported in this thread:
785 static void *thread_manage_kernel(void *data
)
787 int ret
, i
, pollfd
, update_poll_flag
= 1, err
= -1;
788 uint32_t revents
, nb_fd
;
790 struct lttng_poll_event events
;
792 DBG("Thread manage kernel started");
794 health_code_update(&health_thread_kernel
);
796 ret
= create_thread_poll_set(&events
, 2);
798 goto error_poll_create
;
801 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
807 health_code_update(&health_thread_kernel
);
809 if (update_poll_flag
== 1) {
811 * Reset number of fd in the poll set. Always 2 since there is the thread
812 * quit pipe and the kernel pipe.
816 ret
= update_kernel_poll(&events
);
820 update_poll_flag
= 0;
823 nb_fd
= LTTNG_POLL_GETNB(&events
);
825 DBG("Thread kernel polling on %d fds", nb_fd
);
827 /* Zeroed the poll events */
828 lttng_poll_reset(&events
);
830 /* Poll infinite value of time */
832 health_poll_update(&health_thread_kernel
);
833 ret
= lttng_poll_wait(&events
, -1);
834 health_poll_update(&health_thread_kernel
);
837 * Restart interrupted system call.
839 if (errno
== EINTR
) {
843 } else if (ret
== 0) {
844 /* Should not happen since timeout is infinite */
845 ERR("Return value of poll is 0 with an infinite timeout.\n"
846 "This should not have happened! Continuing...");
850 for (i
= 0; i
< nb_fd
; i
++) {
851 /* Fetch once the poll data */
852 revents
= LTTNG_POLL_GETEV(&events
, i
);
853 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
855 health_code_update(&health_thread_kernel
);
857 /* Thread quit pipe has been closed. Killing thread. */
858 ret
= check_thread_quit_pipe(pollfd
, revents
);
864 /* Check for data on kernel pipe */
865 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
866 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
867 update_poll_flag
= 1;
871 * New CPU detected by the kernel. Adding kernel stream to
872 * kernel session and updating the kernel consumer
874 if (revents
& LPOLLIN
) {
875 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
881 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
882 * and unregister kernel stream at this point.
891 lttng_poll_clean(&events
);
894 health_error(&health_thread_kernel
);
895 ERR("Health error occurred in %s", __func__
);
897 health_exit(&health_thread_kernel
);
898 DBG("Kernel thread dying");
903 * This thread manage the consumer error sent back to the session daemon.
905 static void *thread_manage_consumer(void *data
)
907 int sock
= -1, i
, ret
, pollfd
, err
= -1;
908 uint32_t revents
, nb_fd
;
909 enum lttcomm_return_code code
;
910 struct lttng_poll_event events
;
911 struct consumer_data
*consumer_data
= data
;
913 DBG("[thread] Manage consumer started");
915 health_code_update(&consumer_data
->health
);
917 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
923 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
924 * Nothing more will be added to this poll set.
926 ret
= create_thread_poll_set(&events
, 2);
931 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
936 nb_fd
= LTTNG_POLL_GETNB(&events
);
938 health_code_update(&consumer_data
->health
);
940 /* Inifinite blocking call, waiting for transmission */
942 health_poll_update(&consumer_data
->health
);
943 ret
= lttng_poll_wait(&events
, -1);
944 health_poll_update(&consumer_data
->health
);
947 * Restart interrupted system call.
949 if (errno
== EINTR
) {
955 for (i
= 0; i
< nb_fd
; i
++) {
956 /* Fetch once the poll data */
957 revents
= LTTNG_POLL_GETEV(&events
, i
);
958 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
960 health_code_update(&consumer_data
->health
);
962 /* Thread quit pipe has been closed. Killing thread. */
963 ret
= check_thread_quit_pipe(pollfd
, revents
);
969 /* Event on the registration socket */
970 if (pollfd
== consumer_data
->err_sock
) {
971 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
972 ERR("consumer err socket poll error");
978 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
983 health_code_update(&consumer_data
->health
);
985 DBG2("Receiving code from consumer err_sock");
987 /* Getting status code from kconsumerd */
988 ret
= lttcomm_recv_unix_sock(sock
, &code
,
989 sizeof(enum lttcomm_return_code
));
994 health_code_update(&consumer_data
->health
);
996 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
997 consumer_data
->cmd_sock
=
998 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
999 if (consumer_data
->cmd_sock
< 0) {
1000 sem_post(&consumer_data
->sem
);
1001 PERROR("consumer connect");
1004 /* Signal condition to tell that the kconsumerd is ready */
1005 sem_post(&consumer_data
->sem
);
1006 DBG("consumer command socket ready");
1008 ERR("consumer error when waiting for SOCK_READY : %s",
1009 lttcomm_get_readable_code(-code
));
1013 /* Remove the kconsumerd error sock since we've established a connexion */
1014 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1019 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1024 health_code_update(&consumer_data
->health
);
1026 /* Update number of fd */
1027 nb_fd
= LTTNG_POLL_GETNB(&events
);
1029 /* Inifinite blocking call, waiting for transmission */
1031 health_poll_update(&consumer_data
->health
);
1032 ret
= lttng_poll_wait(&events
, -1);
1033 health_poll_update(&consumer_data
->health
);
1036 * Restart interrupted system call.
1038 if (errno
== EINTR
) {
1044 for (i
= 0; i
< nb_fd
; i
++) {
1045 /* Fetch once the poll data */
1046 revents
= LTTNG_POLL_GETEV(&events
, i
);
1047 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1049 health_code_update(&consumer_data
->health
);
1051 /* Thread quit pipe has been closed. Killing thread. */
1052 ret
= check_thread_quit_pipe(pollfd
, revents
);
1058 /* Event on the kconsumerd socket */
1059 if (pollfd
== sock
) {
1060 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1061 ERR("consumer err socket second poll error");
1067 health_code_update(&consumer_data
->health
);
1069 /* Wait for any kconsumerd error */
1070 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1071 sizeof(enum lttcomm_return_code
));
1073 ERR("consumer closed the command socket");
1077 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1081 /* Immediately set the consumerd state to stopped */
1082 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
1083 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
1084 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
1085 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
1086 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
1088 /* Code flow error... */
1092 if (consumer_data
->err_sock
>= 0) {
1093 ret
= close(consumer_data
->err_sock
);
1098 if (consumer_data
->cmd_sock
>= 0) {
1099 ret
= close(consumer_data
->cmd_sock
);
1111 unlink(consumer_data
->err_unix_sock_path
);
1112 unlink(consumer_data
->cmd_unix_sock_path
);
1113 consumer_data
->pid
= 0;
1115 lttng_poll_clean(&events
);
1119 health_error(&consumer_data
->health
);
1120 ERR("Health error occurred in %s", __func__
);
1122 health_exit(&consumer_data
->health
);
1123 DBG("consumer thread cleanup completed");
1129 * This thread manage application communication.
1131 static void *thread_manage_apps(void *data
)
1133 int i
, ret
, pollfd
, err
= -1;
1134 uint32_t revents
, nb_fd
;
1135 struct ust_command ust_cmd
;
1136 struct lttng_poll_event events
;
1138 DBG("[thread] Manage application started");
1140 rcu_register_thread();
1141 rcu_thread_online();
1143 health_code_update(&health_thread_app_manage
);
1145 ret
= create_thread_poll_set(&events
, 2);
1147 goto error_poll_create
;
1150 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1155 health_code_update(&health_thread_app_manage
);
1158 /* Zeroed the events structure */
1159 lttng_poll_reset(&events
);
1161 nb_fd
= LTTNG_POLL_GETNB(&events
);
1163 DBG("Apps thread polling on %d fds", nb_fd
);
1165 /* Inifinite blocking call, waiting for transmission */
1167 health_poll_update(&health_thread_app_manage
);
1168 ret
= lttng_poll_wait(&events
, -1);
1169 health_poll_update(&health_thread_app_manage
);
1172 * Restart interrupted system call.
1174 if (errno
== EINTR
) {
1180 for (i
= 0; i
< nb_fd
; i
++) {
1181 /* Fetch once the poll data */
1182 revents
= LTTNG_POLL_GETEV(&events
, i
);
1183 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1185 health_code_update(&health_thread_app_manage
);
1187 /* Thread quit pipe has been closed. Killing thread. */
1188 ret
= check_thread_quit_pipe(pollfd
, revents
);
1194 /* Inspect the apps cmd pipe */
1195 if (pollfd
== apps_cmd_pipe
[0]) {
1196 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1197 ERR("Apps command pipe error");
1199 } else if (revents
& LPOLLIN
) {
1201 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1202 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1203 PERROR("read apps cmd pipe");
1207 health_code_update(&health_thread_app_manage
);
1209 /* Register applicaton to the session daemon */
1210 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1212 if (ret
== -ENOMEM
) {
1214 } else if (ret
< 0) {
1218 health_code_update(&health_thread_app_manage
);
1221 * Validate UST version compatibility.
1223 ret
= ust_app_validate_version(ust_cmd
.sock
);
1226 * Add channel(s) and event(s) to newly registered apps
1227 * from lttng global UST domain.
1229 update_ust_app(ust_cmd
.sock
);
1232 health_code_update(&health_thread_app_manage
);
1234 ret
= ust_app_register_done(ust_cmd
.sock
);
1237 * If the registration is not possible, we simply
1238 * unregister the apps and continue
1240 ust_app_unregister(ust_cmd
.sock
);
1243 * We just need here to monitor the close of the UST
1244 * socket and poll set monitor those by default.
1245 * Listen on POLLIN (even if we never expect any
1246 * data) to ensure that hangup wakes us.
1248 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1253 DBG("Apps with sock %d added to poll set",
1257 health_code_update(&health_thread_app_manage
);
1263 * At this point, we know that a registered application made
1264 * the event at poll_wait.
1266 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1267 /* Removing from the poll set */
1268 ret
= lttng_poll_del(&events
, pollfd
);
1273 /* Socket closed on remote end. */
1274 ust_app_unregister(pollfd
);
1279 health_code_update(&health_thread_app_manage
);
1285 lttng_poll_clean(&events
);
1288 health_error(&health_thread_app_manage
);
1289 ERR("Health error occurred in %s", __func__
);
1291 health_exit(&health_thread_app_manage
);
1292 DBG("Application communication apps thread cleanup complete");
1293 rcu_thread_offline();
1294 rcu_unregister_thread();
1299 * Dispatch request from the registration threads to the application
1300 * communication thread.
1302 static void *thread_dispatch_ust_registration(void *data
)
1305 struct cds_wfq_node
*node
;
1306 struct ust_command
*ust_cmd
= NULL
;
1308 DBG("[thread] Dispatch UST command started");
1310 while (!CMM_LOAD_SHARED(dispatch_thread_exit
)) {
1311 /* Atomically prepare the queue futex */
1312 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1315 /* Dequeue command for registration */
1316 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1318 DBG("Woken up but nothing in the UST command queue");
1319 /* Continue thread execution */
1323 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1325 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1326 " gid:%d sock:%d name:%s (version %d.%d)",
1327 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1328 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1329 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1330 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1332 * Inform apps thread of the new application registration. This
1333 * call is blocking so we can be assured that the data will be read
1334 * at some point in time or wait to the end of the world :)
1336 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1337 sizeof(struct ust_command
));
1339 PERROR("write apps cmd pipe");
1340 if (errno
== EBADF
) {
1342 * We can't inform the application thread to process
1343 * registration. We will exit or else application
1344 * registration will not occur and tracing will never
1351 } while (node
!= NULL
);
1353 /* Futex wait on queue. Blocking call on futex() */
1354 futex_nto1_wait(&ust_cmd_queue
.futex
);
1358 DBG("Dispatch thread dying");
1363 * This thread manage application registration.
1365 static void *thread_registration_apps(void *data
)
1367 int sock
= -1, i
, ret
, pollfd
, err
= -1;
1368 uint32_t revents
, nb_fd
;
1369 struct lttng_poll_event events
;
1371 * Get allocated in this thread, enqueued to a global queue, dequeued and
1372 * freed in the manage apps thread.
1374 struct ust_command
*ust_cmd
= NULL
;
1376 DBG("[thread] Manage application registration started");
1378 ret
= lttcomm_listen_unix_sock(apps_sock
);
1384 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1385 * more will be added to this poll set.
1387 ret
= create_thread_poll_set(&events
, 2);
1389 goto error_create_poll
;
1392 /* Add the application registration socket */
1393 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1395 goto error_poll_add
;
1398 /* Notify all applications to register */
1399 ret
= notify_ust_apps(1);
1401 ERR("Failed to notify applications or create the wait shared memory.\n"
1402 "Execution continues but there might be problem for already\n"
1403 "running applications that wishes to register.");
1407 DBG("Accepting application registration");
1409 nb_fd
= LTTNG_POLL_GETNB(&events
);
1411 /* Inifinite blocking call, waiting for transmission */
1413 health_poll_update(&health_thread_app_reg
);
1414 ret
= lttng_poll_wait(&events
, -1);
1415 health_poll_update(&health_thread_app_reg
);
1418 * Restart interrupted system call.
1420 if (errno
== EINTR
) {
1426 for (i
= 0; i
< nb_fd
; i
++) {
1427 health_code_update(&health_thread_app_reg
);
1429 /* Fetch once the poll data */
1430 revents
= LTTNG_POLL_GETEV(&events
, i
);
1431 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1433 /* Thread quit pipe has been closed. Killing thread. */
1434 ret
= check_thread_quit_pipe(pollfd
, revents
);
1440 /* Event on the registration socket */
1441 if (pollfd
== apps_sock
) {
1442 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1443 ERR("Register apps socket poll error");
1445 } else if (revents
& LPOLLIN
) {
1446 sock
= lttcomm_accept_unix_sock(apps_sock
);
1451 /* Create UST registration command for enqueuing */
1452 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1453 if (ust_cmd
== NULL
) {
1454 PERROR("ust command zmalloc");
1459 * Using message-based transmissions to ensure we don't
1460 * have to deal with partially received messages.
1462 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1464 ERR("Exhausted file descriptors allowed for applications.");
1473 health_code_update(&health_thread_app_reg
);
1474 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1475 sizeof(struct ust_register_msg
));
1476 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1478 PERROR("lttcomm_recv_unix_sock register apps");
1480 ERR("Wrong size received on apps register");
1487 lttng_fd_put(LTTNG_FD_APPS
, 1);
1491 health_code_update(&health_thread_app_reg
);
1493 ust_cmd
->sock
= sock
;
1496 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1497 " gid:%d sock:%d name:%s (version %d.%d)",
1498 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1499 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1500 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1501 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1504 * Lock free enqueue the registration request. The red pill
1505 * has been taken! This apps will be part of the *system*.
1507 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1510 * Wake the registration queue futex. Implicit memory
1511 * barrier with the exchange in cds_wfq_enqueue.
1513 futex_nto1_wake(&ust_cmd_queue
.futex
);
1522 health_error(&health_thread_app_reg
);
1523 ERR("Health error occurred in %s", __func__
);
1525 health_exit(&health_thread_app_reg
);
1527 /* Notify that the registration thread is gone */
1530 if (apps_sock
>= 0) {
1531 ret
= close(apps_sock
);
1541 lttng_fd_put(LTTNG_FD_APPS
, 1);
1543 unlink(apps_unix_sock_path
);
1546 lttng_poll_clean(&events
);
1549 DBG("UST Registration thread cleanup complete");
1555 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1556 * exec or it will fails.
1558 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1561 struct timespec timeout
;
1563 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1564 timeout
.tv_nsec
= 0;
1566 /* Setup semaphore */
1567 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1569 PERROR("sem_init consumer semaphore");
1573 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1574 thread_manage_consumer
, consumer_data
);
1576 PERROR("pthread_create consumer");
1581 /* Get time for sem_timedwait absolute timeout */
1582 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1584 PERROR("clock_gettime spawn consumer");
1585 /* Infinite wait for the kconsumerd thread to be ready */
1586 ret
= sem_wait(&consumer_data
->sem
);
1588 /* Normal timeout if the gettime was successful */
1589 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1590 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1594 if (errno
== ETIMEDOUT
) {
1596 * Call has timed out so we kill the kconsumerd_thread and return
1599 ERR("The consumer thread was never ready. Killing it");
1600 ret
= pthread_cancel(consumer_data
->thread
);
1602 PERROR("pthread_cancel consumer thread");
1605 PERROR("semaphore wait failed consumer thread");
1610 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1611 if (consumer_data
->pid
== 0) {
1612 ERR("Kconsumerd did not start");
1613 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1616 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1625 * Join consumer thread
1627 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1632 /* Consumer pid must be a real one. */
1633 if (consumer_data
->pid
> 0) {
1634 ret
= kill(consumer_data
->pid
, SIGTERM
);
1636 ERR("Error killing consumer daemon");
1639 return pthread_join(consumer_data
->thread
, &status
);
1646 * Fork and exec a consumer daemon (consumerd).
1648 * Return pid if successful else -1.
1650 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1654 const char *consumer_to_use
;
1655 const char *verbosity
;
1658 DBG("Spawning consumerd");
1665 if (opt_verbose_consumer
) {
1666 verbosity
= "--verbose";
1668 verbosity
= "--quiet";
1670 switch (consumer_data
->type
) {
1671 case LTTNG_CONSUMER_KERNEL
:
1673 * Find out which consumerd to execute. We will first try the
1674 * 64-bit path, then the sessiond's installation directory, and
1675 * fallback on the 32-bit one,
1677 DBG3("Looking for a kernel consumer at these locations:");
1678 DBG3(" 1) %s", consumerd64_bin
);
1679 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1680 DBG3(" 3) %s", consumerd32_bin
);
1681 if (stat(consumerd64_bin
, &st
) == 0) {
1682 DBG3("Found location #1");
1683 consumer_to_use
= consumerd64_bin
;
1684 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1685 DBG3("Found location #2");
1686 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1687 } else if (stat(consumerd32_bin
, &st
) == 0) {
1688 DBG3("Found location #3");
1689 consumer_to_use
= consumerd32_bin
;
1691 DBG("Could not find any valid consumerd executable");
1694 DBG("Using kernel consumer at: %s", consumer_to_use
);
1695 execl(consumer_to_use
,
1696 "lttng-consumerd", verbosity
, "-k",
1697 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1698 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1701 case LTTNG_CONSUMER64_UST
:
1703 char *tmpnew
= NULL
;
1705 if (consumerd64_libdir
[0] != '\0') {
1709 tmp
= getenv("LD_LIBRARY_PATH");
1713 tmplen
= strlen("LD_LIBRARY_PATH=")
1714 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1715 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1720 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1721 strcat(tmpnew
, consumerd64_libdir
);
1722 if (tmp
[0] != '\0') {
1723 strcat(tmpnew
, ":");
1724 strcat(tmpnew
, tmp
);
1726 ret
= putenv(tmpnew
);
1732 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1733 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1734 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1735 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1737 if (consumerd64_libdir
[0] != '\0') {
1745 case LTTNG_CONSUMER32_UST
:
1747 char *tmpnew
= NULL
;
1749 if (consumerd32_libdir
[0] != '\0') {
1753 tmp
= getenv("LD_LIBRARY_PATH");
1757 tmplen
= strlen("LD_LIBRARY_PATH=")
1758 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1759 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1764 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1765 strcat(tmpnew
, consumerd32_libdir
);
1766 if (tmp
[0] != '\0') {
1767 strcat(tmpnew
, ":");
1768 strcat(tmpnew
, tmp
);
1770 ret
= putenv(tmpnew
);
1776 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1777 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1778 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1779 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1781 if (consumerd32_libdir
[0] != '\0') {
1790 PERROR("unknown consumer type");
1794 PERROR("kernel start consumer exec");
1797 } else if (pid
> 0) {
1800 PERROR("start consumer fork");
1808 * Spawn the consumerd daemon and session daemon thread.
1810 static int start_consumerd(struct consumer_data
*consumer_data
)
1814 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1815 if (consumer_data
->pid
!= 0) {
1816 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1820 ret
= spawn_consumerd(consumer_data
);
1822 ERR("Spawning consumerd failed");
1823 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1827 /* Setting up the consumer_data pid */
1828 consumer_data
->pid
= ret
;
1829 DBG2("Consumer pid %d", consumer_data
->pid
);
1830 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1832 DBG2("Spawning consumer control thread");
1833 ret
= spawn_consumer_thread(consumer_data
);
1835 ERR("Fatal error spawning consumer control thread");
1847 * Compute health status of each consumer. If one of them is zero (bad
1848 * state), we return 0.
1850 static int check_consumer_health(void)
1854 ret
= health_check_state(&kconsumer_data
.health
) &&
1855 health_check_state(&ustconsumer32_data
.health
) &&
1856 health_check_state(&ustconsumer64_data
.health
);
1858 DBG3("Health consumer check %d", ret
);
1864 * Check version of the lttng-modules.
1866 static int validate_lttng_modules_version(void)
1868 return kernel_validate_version(kernel_tracer_fd
);
1872 * Setup necessary data for kernel tracer action.
1874 static int init_kernel_tracer(void)
1878 /* Modprobe lttng kernel modules */
1879 ret
= modprobe_lttng_control();
1884 /* Open debugfs lttng */
1885 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1886 if (kernel_tracer_fd
< 0) {
1887 DBG("Failed to open %s", module_proc_lttng
);
1892 /* Validate kernel version */
1893 ret
= validate_lttng_modules_version();
1898 ret
= modprobe_lttng_data();
1903 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1907 modprobe_remove_lttng_control();
1908 ret
= close(kernel_tracer_fd
);
1912 kernel_tracer_fd
= -1;
1913 return LTTCOMM_KERN_VERSION
;
1916 ret
= close(kernel_tracer_fd
);
1922 modprobe_remove_lttng_control();
1925 WARN("No kernel tracer available");
1926 kernel_tracer_fd
= -1;
1928 return LTTCOMM_NEED_ROOT_SESSIOND
;
1930 return LTTCOMM_KERN_NA
;
1935 * Init tracing by creating trace directory and sending fds kernel consumer.
1937 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1940 struct lttng_ht_iter iter
;
1941 struct consumer_socket
*socket
;
1945 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
1946 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
1947 socket
, node
.node
) {
1948 /* Code flow error */
1949 assert(socket
->fd
>= 0);
1951 pthread_mutex_lock(socket
->lock
);
1952 ret
= kernel_consumer_send_session(socket
->fd
, session
);
1953 pthread_mutex_unlock(socket
->lock
);
1955 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1966 * Create a socket to the relayd using the URI.
1968 * On success, the relayd_sock pointer is set to the created socket.
1969 * Else, it is untouched and an lttcomm error code is returned.
1971 static int create_connect_relayd(struct consumer_output
*output
,
1972 const char *session_name
, struct lttng_uri
*uri
,
1973 struct lttcomm_sock
**relayd_sock
)
1976 struct lttcomm_sock
*sock
;
1978 /* Create socket object from URI */
1979 sock
= lttcomm_alloc_sock_from_uri(uri
);
1981 ret
= LTTCOMM_FATAL
;
1985 ret
= lttcomm_create_sock(sock
);
1987 ret
= LTTCOMM_FATAL
;
1991 /* Connect to relayd so we can proceed with a session creation. */
1992 ret
= relayd_connect(sock
);
1994 ERR("Unable to reach lttng-relayd");
1995 ret
= LTTCOMM_RELAYD_SESSION_FAIL
;
1999 /* Create socket for control stream. */
2000 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
2001 DBG3("Creating relayd stream socket from URI");
2003 /* Check relayd version */
2004 ret
= relayd_version_check(sock
, LTTNG_UST_COMM_MAJOR
, 0);
2006 ret
= LTTCOMM_RELAYD_VERSION_FAIL
;
2009 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
2010 DBG3("Creating relayd data socket from URI");
2012 /* Command is not valid */
2013 ERR("Relayd invalid stream type: %d", uri
->stype
);
2014 ret
= LTTCOMM_INVALID
;
2018 *relayd_sock
= sock
;
2024 (void) relayd_close(sock
);
2028 lttcomm_destroy_sock(sock
);
2035 * Connect to the relayd using URI and send the socket to the right consumer.
2037 static int send_socket_relayd_consumer(int domain
, struct ltt_session
*session
,
2038 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
2042 struct lttcomm_sock
*sock
= NULL
;
2044 /* Set the network sequence index if not set. */
2045 if (consumer
->net_seq_index
== -1) {
2047 * Increment net_seq_idx because we are about to transfer the
2048 * new relayd socket to the consumer.
2050 uatomic_inc(&relayd_net_seq_idx
);
2051 /* Assign unique key so the consumer can match streams */
2052 consumer
->net_seq_index
= uatomic_read(&relayd_net_seq_idx
);
2055 /* Connect to relayd and make version check if uri is the control. */
2056 ret
= create_connect_relayd(consumer
, session
->name
, relayd_uri
, &sock
);
2057 if (ret
!= LTTCOMM_OK
) {
2061 /* If the control socket is connected, network session is ready */
2062 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
2063 session
->net_handle
= 1;
2066 /* Send relayd socket to consumer. */
2067 ret
= consumer_send_relayd_socket(consumer_fd
, sock
,
2068 consumer
, relayd_uri
->stype
);
2070 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
2077 * Close socket which was dup on the consumer side. The session daemon does
2078 * NOT keep track of the relayd socket(s) once transfer to the consumer.
2083 (void) relayd_close(sock
);
2084 lttcomm_destroy_sock(sock
);
2091 * Send both relayd sockets to a specific consumer and domain. This is a
2092 * helper function to facilitate sending the information to the consumer for a
2095 static int send_sockets_relayd_consumer(int domain
,
2096 struct ltt_session
*session
, struct consumer_output
*consumer
, int fd
)
2103 /* Don't resend the sockets to the consumer. */
2104 if (consumer
->dst
.net
.relayd_socks_sent
) {
2109 /* Sending control relayd socket. */
2110 ret
= send_socket_relayd_consumer(domain
, session
,
2111 &consumer
->dst
.net
.control
, consumer
, fd
);
2112 if (ret
!= LTTCOMM_OK
) {
2116 /* Sending data relayd socket. */
2117 ret
= send_socket_relayd_consumer(domain
, session
,
2118 &consumer
->dst
.net
.data
, consumer
, fd
);
2119 if (ret
!= LTTCOMM_OK
) {
2123 /* Flag that all relayd sockets were sent to the consumer. */
2124 consumer
->dst
.net
.relayd_socks_sent
= 1;
2131 * Setup relayd connections for a tracing session. First creates the socket to
2132 * the relayd and send them to the right domain consumer. Consumer type MUST be
2135 static int setup_relayd(struct ltt_session
*session
)
2137 int ret
= LTTCOMM_OK
;
2138 struct ltt_ust_session
*usess
;
2139 struct ltt_kernel_session
*ksess
;
2140 struct consumer_socket
*socket
;
2141 struct lttng_ht_iter iter
;
2145 usess
= session
->ust_session
;
2146 ksess
= session
->kernel_session
;
2148 DBG2("Setting relayd for session %s", session
->name
);
2150 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
2151 && usess
->consumer
->enabled
) {
2152 /* For each consumer socket, send relayd sockets */
2153 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
2154 socket
, node
.node
) {
2155 /* Code flow error */
2156 assert(socket
->fd
>= 0);
2158 pthread_mutex_lock(socket
->lock
);
2159 send_sockets_relayd_consumer(LTTNG_DOMAIN_UST
, session
,
2160 usess
->consumer
, socket
->fd
);
2161 pthread_mutex_unlock(socket
->lock
);
2162 if (ret
!= LTTCOMM_OK
) {
2168 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
2169 && ksess
->consumer
->enabled
) {
2170 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
2171 socket
, node
.node
) {
2172 /* Code flow error */
2173 assert(socket
->fd
>= 0);
2175 pthread_mutex_lock(socket
->lock
);
2176 send_sockets_relayd_consumer(LTTNG_DOMAIN_KERNEL
, session
,
2177 ksess
->consumer
, socket
->fd
);
2178 pthread_mutex_unlock(socket
->lock
);
2179 if (ret
!= LTTCOMM_OK
) {
2190 * Copy consumer output from the tracing session to the domain session. The
2191 * function also applies the right modification on a per domain basis for the
2192 * trace files destination directory.
2194 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2197 const char *dir_name
;
2198 struct consumer_output
*consumer
;
2201 assert(session
->consumer
);
2204 case LTTNG_DOMAIN_KERNEL
:
2205 DBG3("Copying tracing session consumer output in kernel session");
2206 session
->kernel_session
->consumer
=
2207 consumer_copy_output(session
->consumer
);
2208 /* Ease our life a bit for the next part */
2209 consumer
= session
->kernel_session
->consumer
;
2210 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2212 case LTTNG_DOMAIN_UST
:
2213 DBG3("Copying tracing session consumer output in UST session");
2214 session
->ust_session
->consumer
=
2215 consumer_copy_output(session
->consumer
);
2216 /* Ease our life a bit for the next part */
2217 consumer
= session
->ust_session
->consumer
;
2218 dir_name
= DEFAULT_UST_TRACE_DIR
;
2221 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2225 /* Append correct directory to subdir */
2226 strncat(consumer
->subdir
, dir_name
, sizeof(consumer
->subdir
));
2227 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2236 * Create an UST session and add it to the session ust list.
2238 static int create_ust_session(struct ltt_session
*session
,
2239 struct lttng_domain
*domain
)
2242 struct ltt_ust_session
*lus
= NULL
;
2246 assert(session
->consumer
);
2248 switch (domain
->type
) {
2249 case LTTNG_DOMAIN_UST
:
2252 ERR("Unknown UST domain on create session %d", domain
->type
);
2253 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2257 DBG("Creating UST session");
2259 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
2261 ret
= LTTCOMM_UST_SESS_FAIL
;
2265 lus
->uid
= session
->uid
;
2266 lus
->gid
= session
->gid
;
2267 session
->ust_session
= lus
;
2269 /* Copy session output to the newly created UST session */
2270 ret
= copy_session_consumer(domain
->type
, session
);
2271 if (ret
!= LTTCOMM_OK
) {
2279 session
->ust_session
= NULL
;
2284 * Create a kernel tracer session then create the default channel.
2286 static int create_kernel_session(struct ltt_session
*session
)
2290 DBG("Creating kernel session");
2292 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2294 ret
= LTTCOMM_KERN_SESS_FAIL
;
2298 /* Code flow safety */
2299 assert(session
->kernel_session
);
2301 /* Copy session output to the newly created Kernel session */
2302 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2303 if (ret
!= LTTCOMM_OK
) {
2307 /* Create directory(ies) on local filesystem. */
2308 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2309 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2310 ret
= run_as_mkdir_recursive(
2311 session
->kernel_session
->consumer
->dst
.trace_path
,
2312 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2314 if (ret
!= -EEXIST
) {
2315 ERR("Trace directory creation error");
2321 session
->kernel_session
->uid
= session
->uid
;
2322 session
->kernel_session
->gid
= session
->gid
;
2327 trace_kernel_destroy_session(session
->kernel_session
);
2328 session
->kernel_session
= NULL
;
2333 * Check if the UID or GID match the session. Root user has access to all
2336 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
2338 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
2346 * Count number of session permitted by uid/gid.
2348 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2351 struct ltt_session
*session
;
2353 DBG("Counting number of available session for UID %d GID %d",
2355 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2357 * Only list the sessions the user can control.
2359 if (!session_access_ok(session
, uid
, gid
)) {
2368 * Using the session list, filled a lttng_session array to send back to the
2369 * client for session listing.
2371 * The session list lock MUST be acquired before calling this function. Use
2372 * session_lock_list() and session_unlock_list().
2374 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2378 struct ltt_session
*session
;
2380 DBG("Getting all available session for UID %d GID %d",
2383 * Iterate over session list and append data after the control struct in
2386 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2388 * Only list the sessions the user can control.
2390 if (!session_access_ok(session
, uid
, gid
)) {
2393 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2394 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2395 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2396 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2397 sessions
[i
].enabled
= session
->enabled
;
2403 * Fill lttng_channel array of all channels.
2405 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2406 struct lttng_channel
*channels
)
2409 struct ltt_kernel_channel
*kchan
;
2411 DBG("Listing channels for session %s", session
->name
);
2414 case LTTNG_DOMAIN_KERNEL
:
2415 /* Kernel channels */
2416 if (session
->kernel_session
!= NULL
) {
2417 cds_list_for_each_entry(kchan
,
2418 &session
->kernel_session
->channel_list
.head
, list
) {
2419 /* Copy lttng_channel struct to array */
2420 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2421 channels
[i
].enabled
= kchan
->enabled
;
2426 case LTTNG_DOMAIN_UST
:
2428 struct lttng_ht_iter iter
;
2429 struct ltt_ust_channel
*uchan
;
2431 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2432 &iter
.iter
, uchan
, node
.node
) {
2433 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2434 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2435 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2436 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2437 channels
[i
].attr
.switch_timer_interval
=
2438 uchan
->attr
.switch_timer_interval
;
2439 channels
[i
].attr
.read_timer_interval
=
2440 uchan
->attr
.read_timer_interval
;
2441 channels
[i
].enabled
= uchan
->enabled
;
2442 switch (uchan
->attr
.output
) {
2443 case LTTNG_UST_MMAP
:
2445 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2458 * Create a list of ust global domain events.
2460 static int list_lttng_ust_global_events(char *channel_name
,
2461 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2464 unsigned int nb_event
= 0;
2465 struct lttng_ht_iter iter
;
2466 struct lttng_ht_node_str
*node
;
2467 struct ltt_ust_channel
*uchan
;
2468 struct ltt_ust_event
*uevent
;
2469 struct lttng_event
*tmp
;
2471 DBG("Listing UST global events for channel %s", channel_name
);
2475 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2476 node
= lttng_ht_iter_get_node_str(&iter
);
2478 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2482 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2484 nb_event
+= lttng_ht_get_count(uchan
->events
);
2486 if (nb_event
== 0) {
2491 DBG3("Listing UST global %d events", nb_event
);
2493 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2495 ret
= -LTTCOMM_FATAL
;
2499 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2500 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2501 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2502 tmp
[i
].enabled
= uevent
->enabled
;
2503 switch (uevent
->attr
.instrumentation
) {
2504 case LTTNG_UST_TRACEPOINT
:
2505 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2507 case LTTNG_UST_PROBE
:
2508 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2510 case LTTNG_UST_FUNCTION
:
2511 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2514 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2515 switch (uevent
->attr
.loglevel_type
) {
2516 case LTTNG_UST_LOGLEVEL_ALL
:
2517 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2519 case LTTNG_UST_LOGLEVEL_RANGE
:
2520 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2522 case LTTNG_UST_LOGLEVEL_SINGLE
:
2523 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2526 if (uevent
->filter
) {
2541 * Fill lttng_event array of all kernel events in the channel.
2543 static int list_lttng_kernel_events(char *channel_name
,
2544 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2547 unsigned int nb_event
;
2548 struct ltt_kernel_event
*event
;
2549 struct ltt_kernel_channel
*kchan
;
2551 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2552 if (kchan
== NULL
) {
2553 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2557 nb_event
= kchan
->event_count
;
2559 DBG("Listing events for channel %s", kchan
->channel
->name
);
2561 if (nb_event
== 0) {
2566 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2567 if (*events
== NULL
) {
2568 ret
= LTTCOMM_FATAL
;
2572 /* Kernel channels */
2573 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2574 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2575 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2576 (*events
)[i
].enabled
= event
->enabled
;
2577 switch (event
->event
->instrumentation
) {
2578 case LTTNG_KERNEL_TRACEPOINT
:
2579 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2581 case LTTNG_KERNEL_KPROBE
:
2582 case LTTNG_KERNEL_KRETPROBE
:
2583 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2584 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2585 sizeof(struct lttng_kernel_kprobe
));
2587 case LTTNG_KERNEL_FUNCTION
:
2588 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2589 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2590 sizeof(struct lttng_kernel_function
));
2592 case LTTNG_KERNEL_NOOP
:
2593 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2595 case LTTNG_KERNEL_SYSCALL
:
2596 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2598 case LTTNG_KERNEL_ALL
:
2613 * Add URI so the consumer output object. Set the correct path depending on the
2614 * domain adding the default trace directory.
2616 static int add_uri_to_consumer(struct consumer_output
*consumer
,
2617 struct lttng_uri
*uri
, int domain
)
2620 const char *default_trace_dir
;
2624 if (consumer
== NULL
) {
2625 DBG("No consumer detected. Don't add URI. Stopping.");
2626 ret
= LTTCOMM_NO_CONSUMER
;
2631 case LTTNG_DOMAIN_KERNEL
:
2632 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
2634 case LTTNG_DOMAIN_UST
:
2635 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
2639 * This case is possible is we try to add the URI to the global tracing
2640 * session consumer object which in this case there is no subdir.
2642 default_trace_dir
= "";
2645 switch (uri
->dtype
) {
2646 case LTTNG_DST_IPV4
:
2647 case LTTNG_DST_IPV6
:
2648 DBG2("Setting network URI to consumer");
2650 /* Set URI into consumer output object */
2651 ret
= consumer_set_network_uri(consumer
, uri
);
2653 ret
= LTTCOMM_FATAL
;
2657 /* On a new subdir, reappend the default trace dir. */
2658 if (strlen(uri
->subdir
) != 0) {
2659 strncat(consumer
->subdir
, default_trace_dir
,
2660 sizeof(consumer
->subdir
));
2664 case LTTNG_DST_PATH
:
2665 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
2666 memset(consumer
->dst
.trace_path
, 0,
2667 sizeof(consumer
->dst
.trace_path
));
2668 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
2669 sizeof(consumer
->dst
.trace_path
));
2670 /* Append default trace dir */
2671 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
2672 sizeof(consumer
->dst
.trace_path
));
2673 /* Flag consumer as local. */
2674 consumer
->type
= CONSUMER_DST_LOCAL
;
2683 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2685 static int cmd_disable_channel(struct ltt_session
*session
,
2686 int domain
, char *channel_name
)
2689 struct ltt_ust_session
*usess
;
2691 usess
= session
->ust_session
;
2694 case LTTNG_DOMAIN_KERNEL
:
2696 ret
= channel_kernel_disable(session
->kernel_session
,
2698 if (ret
!= LTTCOMM_OK
) {
2702 kernel_wait_quiescent(kernel_tracer_fd
);
2705 case LTTNG_DOMAIN_UST
:
2707 struct ltt_ust_channel
*uchan
;
2708 struct lttng_ht
*chan_ht
;
2710 chan_ht
= usess
->domain_global
.channels
;
2712 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2713 if (uchan
== NULL
) {
2714 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2718 ret
= channel_ust_disable(usess
, domain
, uchan
);
2719 if (ret
!= LTTCOMM_OK
) {
2725 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2726 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2727 case LTTNG_DOMAIN_UST_PID
:
2730 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2741 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2743 static int cmd_enable_channel(struct ltt_session
*session
,
2744 int domain
, struct lttng_channel
*attr
)
2747 struct ltt_ust_session
*usess
= session
->ust_session
;
2748 struct lttng_ht
*chan_ht
;
2750 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2753 case LTTNG_DOMAIN_KERNEL
:
2755 struct ltt_kernel_channel
*kchan
;
2757 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2758 session
->kernel_session
);
2759 if (kchan
== NULL
) {
2760 ret
= channel_kernel_create(session
->kernel_session
,
2761 attr
, kernel_poll_pipe
[1]);
2763 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2766 if (ret
!= LTTCOMM_OK
) {
2770 kernel_wait_quiescent(kernel_tracer_fd
);
2773 case LTTNG_DOMAIN_UST
:
2775 struct ltt_ust_channel
*uchan
;
2777 chan_ht
= usess
->domain_global
.channels
;
2779 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2780 if (uchan
== NULL
) {
2781 ret
= channel_ust_create(usess
, domain
, attr
);
2783 ret
= channel_ust_enable(usess
, domain
, uchan
);
2788 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2789 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2790 case LTTNG_DOMAIN_UST_PID
:
2793 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2802 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2804 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2805 char *channel_name
, char *event_name
)
2810 case LTTNG_DOMAIN_KERNEL
:
2812 struct ltt_kernel_channel
*kchan
;
2813 struct ltt_kernel_session
*ksess
;
2815 ksess
= session
->kernel_session
;
2817 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2818 if (kchan
== NULL
) {
2819 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2823 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2824 if (ret
!= LTTCOMM_OK
) {
2828 kernel_wait_quiescent(kernel_tracer_fd
);
2831 case LTTNG_DOMAIN_UST
:
2833 struct ltt_ust_channel
*uchan
;
2834 struct ltt_ust_session
*usess
;
2836 usess
= session
->ust_session
;
2838 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2840 if (uchan
== NULL
) {
2841 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2845 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2846 if (ret
!= LTTCOMM_OK
) {
2850 DBG3("Disable UST event %s in channel %s completed", event_name
,
2855 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2856 case LTTNG_DOMAIN_UST_PID
:
2857 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2871 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2873 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2879 case LTTNG_DOMAIN_KERNEL
:
2881 struct ltt_kernel_session
*ksess
;
2882 struct ltt_kernel_channel
*kchan
;
2884 ksess
= session
->kernel_session
;
2886 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2887 if (kchan
== NULL
) {
2888 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2892 ret
= event_kernel_disable_all(ksess
, kchan
);
2893 if (ret
!= LTTCOMM_OK
) {
2897 kernel_wait_quiescent(kernel_tracer_fd
);
2900 case LTTNG_DOMAIN_UST
:
2902 struct ltt_ust_session
*usess
;
2903 struct ltt_ust_channel
*uchan
;
2905 usess
= session
->ust_session
;
2907 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2909 if (uchan
== NULL
) {
2910 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2914 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2919 DBG3("Disable all UST events in channel %s completed", channel_name
);
2924 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2925 case LTTNG_DOMAIN_UST_PID
:
2926 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2940 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2942 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2943 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2948 case LTTNG_DOMAIN_KERNEL
:
2949 /* Add kernel context to kernel tracer */
2950 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2951 event_name
, channel_name
);
2952 if (ret
!= LTTCOMM_OK
) {
2956 case LTTNG_DOMAIN_UST
:
2958 struct ltt_ust_session
*usess
= session
->ust_session
;
2960 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2961 if (ret
!= LTTCOMM_OK
) {
2967 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2968 case LTTNG_DOMAIN_UST_PID
:
2969 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2983 * Command LTTNG_SET_FILTER processed by the client thread.
2985 static int cmd_set_filter(struct ltt_session
*session
, int domain
,
2986 char *channel_name
, char *event_name
,
2987 struct lttng_filter_bytecode
*bytecode
)
2992 case LTTNG_DOMAIN_KERNEL
:
2993 ret
= LTTCOMM_FATAL
;
2995 case LTTNG_DOMAIN_UST
:
2997 struct ltt_ust_session
*usess
= session
->ust_session
;
2999 ret
= filter_ust_set(usess
, domain
, bytecode
, event_name
, channel_name
);
3000 if (ret
!= LTTCOMM_OK
) {
3006 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3007 case LTTNG_DOMAIN_UST_PID
:
3008 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3023 * Command LTTNG_ENABLE_EVENT processed by the client thread.
3025 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
3026 char *channel_name
, struct lttng_event
*event
)
3029 struct lttng_channel
*attr
;
3030 struct ltt_ust_session
*usess
= session
->ust_session
;
3033 case LTTNG_DOMAIN_KERNEL
:
3035 struct ltt_kernel_channel
*kchan
;
3037 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3038 session
->kernel_session
);
3039 if (kchan
== NULL
) {
3040 attr
= channel_new_default_attr(domain
);
3042 ret
= LTTCOMM_FATAL
;
3045 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3047 /* This call will notify the kernel thread */
3048 ret
= channel_kernel_create(session
->kernel_session
,
3049 attr
, kernel_poll_pipe
[1]);
3050 if (ret
!= LTTCOMM_OK
) {
3057 /* Get the newly created kernel channel pointer */
3058 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3059 session
->kernel_session
);
3060 if (kchan
== NULL
) {
3061 /* This sould not happen... */
3062 ret
= LTTCOMM_FATAL
;
3066 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
3068 if (ret
!= LTTCOMM_OK
) {
3072 kernel_wait_quiescent(kernel_tracer_fd
);
3075 case LTTNG_DOMAIN_UST
:
3077 struct lttng_channel
*attr
;
3078 struct ltt_ust_channel
*uchan
;
3080 /* Get channel from global UST domain */
3081 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3083 if (uchan
== NULL
) {
3084 /* Create default channel */
3085 attr
= channel_new_default_attr(domain
);
3087 ret
= LTTCOMM_FATAL
;
3090 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3091 attr
->name
[NAME_MAX
- 1] = '\0';
3093 ret
= channel_ust_create(usess
, domain
, attr
);
3094 if (ret
!= LTTCOMM_OK
) {
3100 /* Get the newly created channel reference back */
3101 uchan
= trace_ust_find_channel_by_name(
3102 usess
->domain_global
.channels
, channel_name
);
3103 if (uchan
== NULL
) {
3104 /* Something is really wrong */
3105 ret
= LTTCOMM_FATAL
;
3110 /* At this point, the session and channel exist on the tracer */
3111 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
3112 if (ret
!= LTTCOMM_OK
) {
3118 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3119 case LTTNG_DOMAIN_UST_PID
:
3120 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3134 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
3136 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
3137 char *channel_name
, int event_type
)
3140 struct ltt_kernel_channel
*kchan
;
3143 case LTTNG_DOMAIN_KERNEL
:
3144 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3145 session
->kernel_session
);
3146 if (kchan
== NULL
) {
3147 /* This call will notify the kernel thread */
3148 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
3149 kernel_poll_pipe
[1]);
3150 if (ret
!= LTTCOMM_OK
) {
3154 /* Get the newly created kernel channel pointer */
3155 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3156 session
->kernel_session
);
3157 if (kchan
== NULL
) {
3158 /* This sould not happen... */
3159 ret
= LTTCOMM_FATAL
;
3165 switch (event_type
) {
3166 case LTTNG_EVENT_SYSCALL
:
3167 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
3168 kchan
, kernel_tracer_fd
);
3170 case LTTNG_EVENT_TRACEPOINT
:
3172 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
3173 * events already registered to the channel.
3175 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
3176 kchan
, kernel_tracer_fd
);
3178 case LTTNG_EVENT_ALL
:
3179 /* Enable syscalls and tracepoints */
3180 ret
= event_kernel_enable_all(session
->kernel_session
,
3181 kchan
, kernel_tracer_fd
);
3184 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3188 /* Manage return value */
3189 if (ret
!= LTTCOMM_OK
) {
3193 kernel_wait_quiescent(kernel_tracer_fd
);
3195 case LTTNG_DOMAIN_UST
:
3197 struct lttng_channel
*attr
;
3198 struct ltt_ust_channel
*uchan
;
3199 struct ltt_ust_session
*usess
= session
->ust_session
;
3201 /* Get channel from global UST domain */
3202 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3204 if (uchan
== NULL
) {
3205 /* Create default channel */
3206 attr
= channel_new_default_attr(domain
);
3208 ret
= LTTCOMM_FATAL
;
3211 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3212 attr
->name
[NAME_MAX
- 1] = '\0';
3214 /* Use the internal command enable channel */
3215 ret
= channel_ust_create(usess
, domain
, attr
);
3216 if (ret
!= LTTCOMM_OK
) {
3222 /* Get the newly created channel reference back */
3223 uchan
= trace_ust_find_channel_by_name(
3224 usess
->domain_global
.channels
, channel_name
);
3225 if (uchan
== NULL
) {
3226 /* Something is really wrong */
3227 ret
= LTTCOMM_FATAL
;
3232 /* At this point, the session and channel exist on the tracer */
3234 switch (event_type
) {
3235 case LTTNG_EVENT_ALL
:
3236 case LTTNG_EVENT_TRACEPOINT
:
3237 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
3238 if (ret
!= LTTCOMM_OK
) {
3243 ret
= LTTCOMM_UST_ENABLE_FAIL
;
3247 /* Manage return value */
3248 if (ret
!= LTTCOMM_OK
) {
3255 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3256 case LTTNG_DOMAIN_UST_PID
:
3257 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3271 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
3273 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
3276 ssize_t nb_events
= 0;
3279 case LTTNG_DOMAIN_KERNEL
:
3280 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
3281 if (nb_events
< 0) {
3282 ret
= LTTCOMM_KERN_LIST_FAIL
;
3286 case LTTNG_DOMAIN_UST
:
3287 nb_events
= ust_app_list_events(events
);
3288 if (nb_events
< 0) {
3289 ret
= LTTCOMM_UST_LIST_FAIL
;
3301 /* Return negative value to differentiate return code */
3306 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
3308 static ssize_t
cmd_list_tracepoint_fields(int domain
,
3309 struct lttng_event_field
**fields
)
3312 ssize_t nb_fields
= 0;
3315 case LTTNG_DOMAIN_UST
:
3316 nb_fields
= ust_app_list_event_fields(fields
);
3317 if (nb_fields
< 0) {
3318 ret
= LTTCOMM_UST_LIST_FAIL
;
3322 case LTTNG_DOMAIN_KERNEL
:
3323 default: /* fall-through */
3331 /* Return negative value to differentiate return code */
3336 * Command LTTNG_START_TRACE processed by the client thread.
3338 static int cmd_start_trace(struct ltt_session
*session
)
3341 struct ltt_kernel_session
*ksession
;
3342 struct ltt_ust_session
*usess
;
3343 struct ltt_kernel_channel
*kchan
;
3345 /* Ease our life a bit ;) */
3346 ksession
= session
->kernel_session
;
3347 usess
= session
->ust_session
;
3349 if (session
->enabled
) {
3350 /* Already started. */
3351 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3355 session
->enabled
= 1;
3357 ret
= setup_relayd(session
);
3358 if (ret
!= LTTCOMM_OK
) {
3359 ERR("Error setting up relayd for session %s", session
->name
);
3363 /* Kernel tracing */
3364 if (ksession
!= NULL
) {
3365 /* Open kernel metadata */
3366 if (ksession
->metadata
== NULL
) {
3367 ret
= kernel_open_metadata(ksession
);
3369 ret
= LTTCOMM_KERN_META_FAIL
;
3374 /* Open kernel metadata stream */
3375 if (ksession
->metadata_stream_fd
< 0) {
3376 ret
= kernel_open_metadata_stream(ksession
);
3378 ERR("Kernel create metadata stream failed");
3379 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3384 /* For each channel */
3385 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3386 if (kchan
->stream_count
== 0) {
3387 ret
= kernel_open_channel_stream(kchan
);
3389 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3392 /* Update the stream global counter */
3393 ksession
->stream_count_global
+= ret
;
3397 /* Setup kernel consumer socket and send fds to it */
3398 ret
= init_kernel_tracing(ksession
);
3400 ret
= LTTCOMM_KERN_START_FAIL
;
3404 /* This start the kernel tracing */
3405 ret
= kernel_start_session(ksession
);
3407 ret
= LTTCOMM_KERN_START_FAIL
;
3411 /* Quiescent wait after starting trace */
3412 kernel_wait_quiescent(kernel_tracer_fd
);
3415 /* Flag session that trace should start automatically */
3417 usess
->start_trace
= 1;
3419 ret
= ust_app_start_trace_all(usess
);
3421 ret
= LTTCOMM_UST_START_FAIL
;
3433 * Command LTTNG_STOP_TRACE processed by the client thread.
3435 static int cmd_stop_trace(struct ltt_session
*session
)
3438 struct ltt_kernel_channel
*kchan
;
3439 struct ltt_kernel_session
*ksession
;
3440 struct ltt_ust_session
*usess
;
3443 ksession
= session
->kernel_session
;
3444 usess
= session
->ust_session
;
3446 if (!session
->enabled
) {
3447 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
3451 session
->enabled
= 0;
3454 if (ksession
!= NULL
) {
3455 DBG("Stop kernel tracing");
3457 /* Flush metadata if exist */
3458 if (ksession
->metadata_stream_fd
>= 0) {
3459 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
3461 ERR("Kernel metadata flush failed");
3465 /* Flush all buffers before stopping */
3466 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3467 ret
= kernel_flush_buffer(kchan
);
3469 ERR("Kernel flush buffer error");
3473 ret
= kernel_stop_session(ksession
);
3475 ret
= LTTCOMM_KERN_STOP_FAIL
;
3479 kernel_wait_quiescent(kernel_tracer_fd
);
3483 usess
->start_trace
= 0;
3485 ret
= ust_app_stop_trace_all(usess
);
3487 ret
= LTTCOMM_UST_STOP_FAIL
;
3499 * Command LTTNG_CREATE_SESSION processed by the client thread.
3501 static int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
3502 size_t nb_uri
, lttng_sock_cred
*creds
)
3504 int ret
, have_default_name
= 0;
3505 char *path
= NULL
, datetime
[16];
3506 struct ltt_session
*session
;
3507 struct consumer_output
*consumer
= NULL
;
3508 struct lttng_uri
*ctrl_uri
, *data_uri
= NULL
;
3510 struct tm
*timeinfo
;
3514 /* Flag if we have a default session. */
3515 if (strncmp(name
, DEFAULT_SESSION_NAME
,
3516 strlen(DEFAULT_SESSION_NAME
)) == 0) {
3517 have_default_name
= 1;
3519 /* Get date and time for session path */
3521 timeinfo
= localtime(&rawtime
);
3522 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
3526 * Verify if the session already exist
3528 * XXX: There is no need for the session lock list here since the caller
3529 * (process_client_msg) is holding it. We might want to change that so a
3530 * single command does not lock the entire session list.
3532 session
= session_find_by_name(name
);
3533 if (session
!= NULL
) {
3534 ret
= LTTCOMM_EXIST_SESS
;
3535 goto consumer_error
;
3538 /* Create default consumer output for the session not yet created. */
3539 consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
3540 if (consumer
== NULL
) {
3541 ret
= LTTCOMM_FATAL
;
3542 goto consumer_error
;
3545 /* Add session name and data to the consumer subdir */
3546 if (have_default_name
) {
3547 ret
= snprintf(consumer
->subdir
, sizeof(consumer
->subdir
), "/%s",
3550 ret
= snprintf(consumer
->subdir
, sizeof(consumer
->subdir
), "/%s-%s",
3554 PERROR("snprintf consumer subdir");
3557 DBG2("Consumer subdir set to '%s'", consumer
->subdir
);
3560 * This means that the lttng_create_session call was called with the _path_
3561 * argument set to NULL.
3565 * At this point, we'll skip the consumer URI setup and create a
3566 * session with a NULL path which will flag the session to NOT spawn a
3569 DBG("Create session %s with NO uri, skipping consumer setup", name
);
3573 /* TODO: validate URIs */
3575 ctrl_uri
= &uris
[0];
3577 data_uri
= &uris
[1];
3580 /* Set subdirectory from the ctrl_uri received. */
3581 if (strlen(ctrl_uri
->subdir
) > 0) {
3582 strncpy(consumer
->subdir
, ctrl_uri
->subdir
, sizeof(consumer
->subdir
));
3583 DBG2("Consumer subdir copy from ctrl_uri '%s'", consumer
->subdir
);
3586 switch (ctrl_uri
->dtype
) {
3587 case LTTNG_DST_IPV4
:
3588 case LTTNG_DST_IPV6
:
3590 * We MUST have a data_uri set at this point or else there is a code
3591 * flow error. The caller should check that.
3595 /* Set control URI into consumer output object */
3596 ret
= consumer_set_network_uri(consumer
, ctrl_uri
);
3598 ret
= LTTCOMM_FATAL
;
3602 /* Set data URI into consumer output object */
3603 ret
= consumer_set_network_uri(consumer
, data_uri
);
3605 ret
= LTTCOMM_FATAL
;
3609 /* Empty path since the session is network */
3612 case LTTNG_DST_PATH
:
3613 /* Very volatile pointer. Only used for the create session. */
3614 path
= ctrl_uri
->dst
.path
;
3615 strncpy(consumer
->dst
.trace_path
, path
,
3616 sizeof(consumer
->dst
.trace_path
));
3620 consumer
->enabled
= 1;
3623 /* Create tracing session in the registry */
3624 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
3625 LTTNG_SOCK_GET_GID_CRED(creds
));
3626 if (ret
!= LTTCOMM_OK
) {
3631 * Get the newly created session pointer back
3633 * XXX: There is no need for the session lock list here since the caller
3634 * (process_client_msg) is holding it. We might want to change that so a
3635 * single command does not lock the entire session list.
3637 session
= session_find_by_name(name
);
3640 /* Assign consumer to session */
3641 session
->consumer
= consumer
;
3643 /* Set correct path to session */
3644 if (have_default_name
) {
3645 /* We have the default session so the date-time is already appended */
3646 ret
= snprintf(session
->path
, sizeof(session
->path
), "%s/%s",
3649 ret
= snprintf(session
->path
, sizeof(session
->path
), "%s/%s-%s",
3650 path
, name
, datetime
);
3653 PERROR("snprintf session path");
3660 session_destroy(session
);
3663 consumer_destroy_output(consumer
);
3670 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3672 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3679 /* Clean kernel session teardown */
3680 teardown_kernel_session(session
);
3681 /* UST session teardown */
3682 teardown_ust_session(session
);
3685 * Must notify the kernel thread here to update it's poll setin order
3686 * to remove the channel(s)' fd just destroyed.
3688 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3690 PERROR("write kernel poll pipe");
3693 ret
= session_destroy(session
);
3699 * Command LTTNG_CALIBRATE processed by the client thread.
3701 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3706 case LTTNG_DOMAIN_KERNEL
:
3708 struct lttng_kernel_calibrate kcalibrate
;
3710 kcalibrate
.type
= calibrate
->type
;
3711 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3713 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3718 case LTTNG_DOMAIN_UST
:
3720 struct lttng_ust_calibrate ucalibrate
;
3722 ucalibrate
.type
= calibrate
->type
;
3723 ret
= ust_app_calibrate_glb(&ucalibrate
);
3725 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3742 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3744 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3748 struct consumer_socket
*socket
;
3751 case LTTNG_DOMAIN_KERNEL
:
3752 /* Can't register a consumer if there is already one */
3753 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3754 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3758 sock
= lttcomm_connect_unix_sock(sock_path
);
3760 ret
= LTTCOMM_CONNECT_FAIL
;
3764 socket
= consumer_allocate_socket(sock
);
3765 if (socket
== NULL
) {
3766 ret
= LTTCOMM_FATAL
;
3771 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3772 if (socket
->lock
== NULL
) {
3773 PERROR("zmalloc pthread mutex");
3774 ret
= LTTCOMM_FATAL
;
3777 pthread_mutex_init(socket
->lock
, NULL
);
3780 consumer_add_socket(socket
, session
->kernel_session
->consumer
);
3783 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3784 kconsumer_data
.pid
= -1;
3785 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3789 /* TODO: Userspace tracing */
3801 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3803 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3804 struct lttng_domain
**domains
)
3809 if (session
->kernel_session
!= NULL
) {
3810 DBG3("Listing domains found kernel domain");
3814 if (session
->ust_session
!= NULL
) {
3815 DBG3("Listing domains found UST global domain");
3819 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3820 if (*domains
== NULL
) {
3821 ret
= -LTTCOMM_FATAL
;
3825 if (session
->kernel_session
!= NULL
) {
3826 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3830 if (session
->ust_session
!= NULL
) {
3831 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3842 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3844 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3845 struct lttng_channel
**channels
)
3848 ssize_t nb_chan
= 0;
3851 case LTTNG_DOMAIN_KERNEL
:
3852 if (session
->kernel_session
!= NULL
) {
3853 nb_chan
= session
->kernel_session
->channel_count
;
3855 DBG3("Number of kernel channels %zd", nb_chan
);
3857 case LTTNG_DOMAIN_UST
:
3858 if (session
->ust_session
!= NULL
) {
3859 nb_chan
= lttng_ht_get_count(
3860 session
->ust_session
->domain_global
.channels
);
3862 DBG3("Number of UST global channels %zd", nb_chan
);
3871 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3872 if (*channels
== NULL
) {
3873 ret
= -LTTCOMM_FATAL
;
3877 list_lttng_channels(domain
, session
, *channels
);
3889 * Command LTTNG_LIST_EVENTS processed by the client thread.
3891 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3892 char *channel_name
, struct lttng_event
**events
)
3895 ssize_t nb_event
= 0;
3898 case LTTNG_DOMAIN_KERNEL
:
3899 if (session
->kernel_session
!= NULL
) {
3900 nb_event
= list_lttng_kernel_events(channel_name
,
3901 session
->kernel_session
, events
);
3904 case LTTNG_DOMAIN_UST
:
3906 if (session
->ust_session
!= NULL
) {
3907 nb_event
= list_lttng_ust_global_events(channel_name
,
3908 &session
->ust_session
->domain_global
, events
);
3924 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
3926 static int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
3927 size_t nb_uri
, struct lttng_uri
*uris
)
3930 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3931 struct ltt_ust_session
*usess
= session
->ust_session
;
3932 struct consumer_output
*consumer
= NULL
;
3938 /* Can't enable consumer after session started. */
3939 if (session
->enabled
) {
3940 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3944 if (!session
->start_consumer
) {
3945 ret
= LTTCOMM_NO_CONSUMER
;
3950 * This case switch makes sure the domain session has a temporary consumer
3951 * so the URL can be set.
3955 /* Code flow error. A session MUST always have a consumer object */
3956 assert(session
->consumer
);
3958 * The URL will be added to the tracing session consumer instead of a
3959 * specific domain consumer.
3961 consumer
= session
->consumer
;
3963 case LTTNG_DOMAIN_KERNEL
:
3964 /* Code flow error if we don't have a kernel session here. */
3967 /* Create consumer output if none exists */
3968 consumer
= ksess
->tmp_consumer
;
3969 if (consumer
== NULL
) {
3970 consumer
= consumer_copy_output(ksess
->consumer
);
3971 if (consumer
== NULL
) {
3972 ret
= LTTCOMM_FATAL
;
3975 ksess
->tmp_consumer
= consumer
;
3979 case LTTNG_DOMAIN_UST
:
3980 /* Code flow error if we don't have a kernel session here. */
3983 /* Create consumer output if none exists */
3984 consumer
= usess
->tmp_consumer
;
3985 if (consumer
== NULL
) {
3986 consumer
= consumer_copy_output(usess
->consumer
);
3987 if (consumer
== NULL
) {
3988 ret
= LTTCOMM_FATAL
;
3991 usess
->tmp_consumer
= consumer
;
3997 for (i
= 0; i
< nb_uri
; i
++) {
3998 struct consumer_socket
*socket
;
3999 struct lttng_ht_iter iter
;
4001 ret
= add_uri_to_consumer(consumer
, &uris
[i
], domain
);
4007 * Don't send relayd socket if URI is NOT remote or if the relayd
4008 * sockets for the session are already sent.
4010 if (uris
[i
].dtype
== LTTNG_DST_PATH
||
4011 consumer
->dst
.net
.relayd_socks_sent
) {
4015 /* Try to send relayd URI to the consumer if exist. */
4016 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
,
4017 socket
, node
.node
) {
4019 /* A socket in the HT should never have a negative fd */
4020 assert(socket
->fd
>= 0);
4022 pthread_mutex_lock(socket
->lock
);
4023 ret
= send_socket_relayd_consumer(domain
, session
, &uris
[i
],
4024 consumer
, socket
->fd
);
4025 pthread_mutex_unlock(socket
->lock
);
4026 if (ret
!= LTTCOMM_OK
) {
4040 * Command LTTNG_DISABLE_CONSUMER processed by the client thread.
4042 static int cmd_disable_consumer(int domain
, struct ltt_session
*session
)
4045 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4046 struct ltt_ust_session
*usess
= session
->ust_session
;
4047 struct consumer_output
*consumer
;
4051 if (session
->enabled
) {
4052 /* Can't disable consumer on an already started session */
4053 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4057 if (!session
->start_consumer
) {
4058 ret
= LTTCOMM_NO_CONSUMER
;
4064 DBG("Disable tracing session %s consumer", session
->name
);
4065 consumer
= session
->consumer
;
4067 case LTTNG_DOMAIN_KERNEL
:
4068 /* Code flow error if we don't have a kernel session here. */
4071 DBG("Disabling kernel consumer");
4072 consumer
= ksess
->consumer
;
4075 case LTTNG_DOMAIN_UST
:
4076 /* Code flow error if we don't have a UST session here. */
4079 DBG("Disabling UST consumer");
4080 consumer
= usess
->consumer
;
4084 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
4089 consumer
->enabled
= 0;
4090 /* Success at this point */
4093 ret
= LTTCOMM_NO_CONSUMER
;
4101 * Command LTTNG_ENABLE_CONSUMER processed by the client thread.
4103 static int cmd_enable_consumer(int domain
, struct ltt_session
*session
)
4106 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4107 struct ltt_ust_session
*usess
= session
->ust_session
;
4108 struct consumer_output
*consumer
= NULL
;
4112 /* Can't enable consumer after session started. */
4113 if (session
->enabled
) {
4114 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4118 if (!session
->start_consumer
) {
4119 ret
= LTTCOMM_NO_CONSUMER
;
4125 assert(session
->consumer
);
4126 consumer
= session
->consumer
;
4128 case LTTNG_DOMAIN_KERNEL
:
4129 /* Code flow error if we don't have a kernel session here. */
4133 * Check if we have already sent fds to the consumer. In that case,
4134 * the enable-consumer command can't be used because a start trace
4135 * had previously occured.
4137 if (ksess
->consumer_fds_sent
) {
4138 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4142 consumer
= ksess
->tmp_consumer
;
4143 if (consumer
== NULL
) {
4145 /* No temp. consumer output exists. Using the current one. */
4146 DBG3("No temporary consumer. Using default");
4147 consumer
= ksess
->consumer
;
4151 switch (consumer
->type
) {
4152 case CONSUMER_DST_LOCAL
:
4153 DBG2("Consumer output is local. Creating directory(ies)");
4155 /* Create directory(ies) */
4156 ret
= run_as_mkdir_recursive(consumer
->dst
.trace_path
,
4157 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4159 if (ret
!= -EEXIST
) {
4160 ERR("Trace directory creation error");
4161 ret
= LTTCOMM_FATAL
;
4166 case CONSUMER_DST_NET
:
4167 DBG2("Consumer output is network. Validating URIs");
4168 /* Validate if we have both control and data path set. */
4169 if (!consumer
->dst
.net
.control_isset
) {
4170 ret
= LTTCOMM_URL_CTRL_MISS
;
4174 if (!consumer
->dst
.net
.data_isset
) {
4175 ret
= LTTCOMM_URL_DATA_MISS
;
4179 /* Check established network session state */
4180 if (session
->net_handle
== 0) {
4181 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4182 ERR("Session network handle is not set on enable-consumer");
4186 /* Append default kernel trace dir to subdir */
4187 strncat(ksess
->consumer
->subdir
, DEFAULT_KERNEL_TRACE_DIR
,
4188 sizeof(ksess
->consumer
->subdir
));
4195 * This is race free for now since the session lock is acquired before
4196 * ending up in this function. No other threads can access this kernel
4197 * session without this lock hence freeing the consumer output object
4201 consumer_destroy_output(ksess
->consumer
);
4203 ksess
->consumer
= consumer
;
4204 ksess
->tmp_consumer
= NULL
;
4207 case LTTNG_DOMAIN_UST
:
4208 /* Code flow error if we don't have a UST session here. */
4212 * Check if we have already sent fds to the consumer. In that case,
4213 * the enable-consumer command can't be used because a start trace
4214 * had previously occured.
4216 if (usess
->start_trace
) {
4217 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4221 consumer
= usess
->tmp_consumer
;
4222 if (consumer
== NULL
) {
4224 /* No temp. consumer output exists. Using the current one. */
4225 DBG3("No temporary consumer. Using default");
4226 consumer
= usess
->consumer
;
4230 switch (consumer
->type
) {
4231 case CONSUMER_DST_LOCAL
:
4232 DBG2("Consumer output is local. Creating directory(ies)");
4234 /* Create directory(ies) */
4235 ret
= run_as_mkdir_recursive(consumer
->dst
.trace_path
,
4236 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4238 if (ret
!= -EEXIST
) {
4239 ERR("Trace directory creation error");
4240 ret
= LTTCOMM_FATAL
;
4245 case CONSUMER_DST_NET
:
4246 DBG2("Consumer output is network. Validating URIs");
4247 /* Validate if we have both control and data path set. */
4248 if (!consumer
->dst
.net
.control_isset
) {
4249 ret
= LTTCOMM_URL_CTRL_MISS
;
4253 if (!consumer
->dst
.net
.data_isset
) {
4254 ret
= LTTCOMM_URL_DATA_MISS
;
4258 /* Check established network session state */
4259 if (session
->net_handle
== 0) {
4260 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4261 DBG2("Session network handle is not set on enable-consumer");
4265 if (consumer
->net_seq_index
== -1) {
4266 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4267 DBG2("Network index is not set on the consumer");
4271 /* Append default kernel trace dir to subdir */
4272 strncat(usess
->consumer
->subdir
, DEFAULT_UST_TRACE_DIR
,
4273 sizeof(usess
->consumer
->subdir
));
4280 * This is race free for now since the session lock is acquired before
4281 * ending up in this function. No other threads can access this kernel
4282 * session without this lock hence freeing the consumer output object
4286 consumer_destroy_output(usess
->consumer
);
4288 usess
->consumer
= consumer
;
4289 usess
->tmp_consumer
= NULL
;
4296 consumer
->enabled
= 1;
4297 /* Success at this point */
4300 /* Should not really happend... */
4301 ret
= LTTCOMM_NO_CONSUMER
;
4309 * Process the command requested by the lttng client within the command
4310 * context structure. This function make sure that the return structure (llm)
4311 * is set and ready for transmission before returning.
4313 * Return any error encountered or 0 for success.
4315 * "sock" is only used for special-case var. len data.
4317 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
4320 int ret
= LTTCOMM_OK
;
4321 int need_tracing_session
= 1;
4324 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
4328 switch (cmd_ctx
->lsm
->cmd_type
) {
4329 case LTTNG_CREATE_SESSION
:
4330 case LTTNG_DESTROY_SESSION
:
4331 case LTTNG_LIST_SESSIONS
:
4332 case LTTNG_LIST_DOMAINS
:
4333 case LTTNG_START_TRACE
:
4334 case LTTNG_STOP_TRACE
:
4341 if (opt_no_kernel
&& need_domain
4342 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
4344 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4346 ret
= LTTCOMM_KERN_NA
;
4352 * Check for command that don't needs to allocate a returned payload. We do
4353 * this here so we don't have to make the call for no payload at each
4356 switch(cmd_ctx
->lsm
->cmd_type
) {
4357 case LTTNG_LIST_SESSIONS
:
4358 case LTTNG_LIST_TRACEPOINTS
:
4359 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4360 case LTTNG_LIST_DOMAINS
:
4361 case LTTNG_LIST_CHANNELS
:
4362 case LTTNG_LIST_EVENTS
:
4365 /* Setup lttng message with no payload */
4366 ret
= setup_lttng_msg(cmd_ctx
, 0);
4368 /* This label does not try to unlock the session */
4369 goto init_setup_error
;
4373 /* Commands that DO NOT need a session. */
4374 switch (cmd_ctx
->lsm
->cmd_type
) {
4375 case LTTNG_CREATE_SESSION
:
4376 case LTTNG_CALIBRATE
:
4377 case LTTNG_LIST_SESSIONS
:
4378 case LTTNG_LIST_TRACEPOINTS
:
4379 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4380 need_tracing_session
= 0;
4383 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
4385 * We keep the session list lock across _all_ commands
4386 * for now, because the per-session lock does not
4387 * handle teardown properly.
4389 session_lock_list();
4390 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
4391 if (cmd_ctx
->session
== NULL
) {
4392 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
4393 ret
= LTTCOMM_SESS_NOT_FOUND
;
4395 /* If no session name specified */
4396 ret
= LTTCOMM_SELECT_SESS
;
4400 /* Acquire lock for the session */
4401 session_lock(cmd_ctx
->session
);
4411 * Check domain type for specific "pre-action".
4413 switch (cmd_ctx
->lsm
->domain
.type
) {
4414 case LTTNG_DOMAIN_KERNEL
:
4416 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4420 /* Kernel tracer check */
4421 if (kernel_tracer_fd
== -1) {
4422 /* Basically, load kernel tracer modules */
4423 ret
= init_kernel_tracer();
4429 /* Consumer is in an ERROR state. Report back to client */
4430 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
4431 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4435 /* Need a session for kernel command */
4436 if (need_tracing_session
) {
4437 if (cmd_ctx
->session
->kernel_session
== NULL
) {
4438 ret
= create_kernel_session(cmd_ctx
->session
);
4440 ret
= LTTCOMM_KERN_SESS_FAIL
;
4445 /* Start the kernel consumer daemon */
4446 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
4447 if (kconsumer_data
.pid
== 0 &&
4448 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4449 cmd_ctx
->session
->start_consumer
) {
4450 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4451 ret
= start_consumerd(&kconsumer_data
);
4453 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
4456 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
4458 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4462 * The consumer was just spawned so we need to add the socket to
4463 * the consumer output of the session if exist.
4465 ret
= consumer_create_socket(&kconsumer_data
,
4466 cmd_ctx
->session
->kernel_session
->consumer
);
4473 case LTTNG_DOMAIN_UST
:
4475 /* Consumer is in an ERROR state. Report back to client */
4476 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
4477 ret
= LTTCOMM_NO_USTCONSUMERD
;
4481 if (need_tracing_session
) {
4482 /* Create UST session if none exist. */
4483 if (cmd_ctx
->session
->ust_session
== NULL
) {
4484 ret
= create_ust_session(cmd_ctx
->session
,
4485 &cmd_ctx
->lsm
->domain
);
4486 if (ret
!= LTTCOMM_OK
) {
4491 /* Start the UST consumer daemons */
4493 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
4494 if (consumerd64_bin
[0] != '\0' &&
4495 ustconsumer64_data
.pid
== 0 &&
4496 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4497 cmd_ctx
->session
->start_consumer
) {
4498 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4499 ret
= start_consumerd(&ustconsumer64_data
);
4501 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
4502 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
4506 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
4507 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4509 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4513 * Setup socket for consumer 64 bit. No need for atomic access
4514 * since it was set above and can ONLY be set in this thread.
4516 ret
= consumer_create_socket(&ustconsumer64_data
,
4517 cmd_ctx
->session
->ust_session
->consumer
);
4523 if (consumerd32_bin
[0] != '\0' &&
4524 ustconsumer32_data
.pid
== 0 &&
4525 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4526 cmd_ctx
->session
->start_consumer
) {
4527 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4528 ret
= start_consumerd(&ustconsumer32_data
);
4530 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
4531 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
4535 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
4536 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4538 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4542 * Setup socket for consumer 64 bit. No need for atomic access
4543 * since it was set above and can ONLY be set in this thread.
4545 ret
= consumer_create_socket(&ustconsumer32_data
,
4546 cmd_ctx
->session
->ust_session
->consumer
);
4558 /* Validate consumer daemon state when start/stop trace command */
4559 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
4560 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
4561 switch (cmd_ctx
->lsm
->domain
.type
) {
4562 case LTTNG_DOMAIN_UST
:
4563 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
4564 ret
= LTTCOMM_NO_USTCONSUMERD
;
4568 case LTTNG_DOMAIN_KERNEL
:
4569 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
4570 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4578 * Check that the UID or GID match that of the tracing session.
4579 * The root user can interact with all sessions.
4581 if (need_tracing_session
) {
4582 if (!session_access_ok(cmd_ctx
->session
,
4583 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4584 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
4585 ret
= LTTCOMM_EPERM
;
4590 /* Process by command type */
4591 switch (cmd_ctx
->lsm
->cmd_type
) {
4592 case LTTNG_ADD_CONTEXT
:
4594 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4595 cmd_ctx
->lsm
->u
.context
.channel_name
,
4596 cmd_ctx
->lsm
->u
.context
.event_name
,
4597 &cmd_ctx
->lsm
->u
.context
.ctx
);
4600 case LTTNG_DISABLE_CHANNEL
:
4602 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4603 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4606 case LTTNG_DISABLE_EVENT
:
4608 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4609 cmd_ctx
->lsm
->u
.disable
.channel_name
,
4610 cmd_ctx
->lsm
->u
.disable
.name
);
4613 case LTTNG_DISABLE_ALL_EVENT
:
4615 DBG("Disabling all events");
4617 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4618 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4621 case LTTNG_DISABLE_CONSUMER
:
4623 ret
= cmd_disable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4626 case LTTNG_ENABLE_CHANNEL
:
4628 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4629 &cmd_ctx
->lsm
->u
.channel
.chan
);
4632 case LTTNG_ENABLE_CONSUMER
:
4635 * XXX: 0 means that this URI should be applied on the session. Should
4636 * be a DOMAIN enuam.
4638 ret
= cmd_enable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4639 if (ret
!= LTTCOMM_OK
) {
4643 if (cmd_ctx
->lsm
->domain
.type
== 0) {
4644 /* Add the URI for the UST session if a consumer is present. */
4645 if (cmd_ctx
->session
->ust_session
&&
4646 cmd_ctx
->session
->ust_session
->consumer
) {
4647 ret
= cmd_enable_consumer(LTTNG_DOMAIN_UST
, cmd_ctx
->session
);
4648 } else if (cmd_ctx
->session
->kernel_session
&&
4649 cmd_ctx
->session
->kernel_session
->consumer
) {
4650 ret
= cmd_enable_consumer(LTTNG_DOMAIN_KERNEL
,
4656 case LTTNG_ENABLE_EVENT
:
4658 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4659 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4660 &cmd_ctx
->lsm
->u
.enable
.event
);
4663 case LTTNG_ENABLE_ALL_EVENT
:
4665 DBG("Enabling all events");
4667 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4668 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4669 cmd_ctx
->lsm
->u
.enable
.event
.type
);
4672 case LTTNG_LIST_TRACEPOINTS
:
4674 struct lttng_event
*events
;
4677 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
4678 if (nb_events
< 0) {
4684 * Setup lttng message with payload size set to the event list size in
4685 * bytes and then copy list into the llm payload.
4687 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
4693 /* Copy event list into message payload */
4694 memcpy(cmd_ctx
->llm
->payload
, events
,
4695 sizeof(struct lttng_event
) * nb_events
);
4702 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4704 struct lttng_event_field
*fields
;
4707 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
4709 if (nb_fields
< 0) {
4715 * Setup lttng message with payload size set to the event list size in
4716 * bytes and then copy list into the llm payload.
4718 ret
= setup_lttng_msg(cmd_ctx
,
4719 sizeof(struct lttng_event_field
) * nb_fields
);
4725 /* Copy event list into message payload */
4726 memcpy(cmd_ctx
->llm
->payload
, fields
,
4727 sizeof(struct lttng_event_field
) * nb_fields
);
4734 case LTTNG_SET_CONSUMER_URI
:
4737 struct lttng_uri
*uris
;
4739 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4740 len
= nb_uri
* sizeof(struct lttng_uri
);
4743 ret
= LTTCOMM_INVALID
;
4747 uris
= zmalloc(len
);
4749 ret
= LTTCOMM_FATAL
;
4753 /* Receive variable len data */
4754 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
4755 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4757 DBG("No URIs received from client... continuing");
4759 ret
= LTTCOMM_SESSION_FAIL
;
4763 ret
= cmd_set_consumer_uri(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4765 if (ret
!= LTTCOMM_OK
) {
4770 * XXX: 0 means that this URI should be applied on the session. Should
4771 * be a DOMAIN enuam.
4773 if (cmd_ctx
->lsm
->domain
.type
== 0) {
4774 /* Add the URI for the UST session if a consumer is present. */
4775 if (cmd_ctx
->session
->ust_session
&&
4776 cmd_ctx
->session
->ust_session
->consumer
) {
4777 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_UST
, cmd_ctx
->session
,
4779 } else if (cmd_ctx
->session
->kernel_session
&&
4780 cmd_ctx
->session
->kernel_session
->consumer
) {
4781 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_KERNEL
,
4782 cmd_ctx
->session
, nb_uri
, uris
);
4788 case LTTNG_START_TRACE
:
4790 ret
= cmd_start_trace(cmd_ctx
->session
);
4793 case LTTNG_STOP_TRACE
:
4795 ret
= cmd_stop_trace(cmd_ctx
->session
);
4798 case LTTNG_CREATE_SESSION
:
4801 struct lttng_uri
*uris
= NULL
;
4803 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4804 len
= nb_uri
* sizeof(struct lttng_uri
);
4807 uris
= zmalloc(len
);
4809 ret
= LTTCOMM_FATAL
;
4813 /* Receive variable len data */
4814 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4815 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4817 DBG("No URIs received from client... continuing");
4819 ret
= LTTCOMM_SESSION_FAIL
;
4823 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4824 DBG("Creating session with ONE network URI is a bad call");
4825 ret
= LTTCOMM_SESSION_FAIL
;
4830 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
4835 case LTTNG_DESTROY_SESSION
:
4837 ret
= cmd_destroy_session(cmd_ctx
->session
,
4838 cmd_ctx
->lsm
->session
.name
);
4840 /* Set session to NULL so we do not unlock it after free. */
4841 cmd_ctx
->session
= NULL
;
4844 case LTTNG_LIST_DOMAINS
:
4847 struct lttng_domain
*domains
;
4849 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
4855 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
4860 /* Copy event list into message payload */
4861 memcpy(cmd_ctx
->llm
->payload
, domains
,
4862 nb_dom
* sizeof(struct lttng_domain
));
4869 case LTTNG_LIST_CHANNELS
:
4872 struct lttng_channel
*channels
;
4874 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
4875 cmd_ctx
->session
, &channels
);
4881 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
4886 /* Copy event list into message payload */
4887 memcpy(cmd_ctx
->llm
->payload
, channels
,
4888 nb_chan
* sizeof(struct lttng_channel
));
4895 case LTTNG_LIST_EVENTS
:
4898 struct lttng_event
*events
= NULL
;
4900 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4901 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
4907 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
4912 /* Copy event list into message payload */
4913 memcpy(cmd_ctx
->llm
->payload
, events
,
4914 nb_event
* sizeof(struct lttng_event
));
4921 case LTTNG_LIST_SESSIONS
:
4923 unsigned int nr_sessions
;
4925 session_lock_list();
4926 nr_sessions
= lttng_sessions_count(
4927 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4928 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
4930 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
4932 session_unlock_list();
4936 /* Filled the session array */
4937 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
4938 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4939 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
4941 session_unlock_list();
4946 case LTTNG_CALIBRATE
:
4948 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
4949 &cmd_ctx
->lsm
->u
.calibrate
);
4952 case LTTNG_REGISTER_CONSUMER
:
4954 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4955 cmd_ctx
->lsm
->u
.reg
.path
);
4958 case LTTNG_SET_FILTER
:
4960 struct lttng_filter_bytecode
*bytecode
;
4962 if (cmd_ctx
->lsm
->u
.filter
.bytecode_len
> 65336) {
4963 ret
= LTTCOMM_FILTER_INVAL
;
4966 bytecode
= zmalloc(cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
4968 ret
= LTTCOMM_FILTER_NOMEM
;
4971 /* Receive var. len. data */
4972 DBG("Receiving var len data from client ...");
4973 ret
= lttcomm_recv_unix_sock(sock
, bytecode
,
4974 cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
4976 DBG("Nothing recv() from client var len data... continuing");
4978 ret
= LTTCOMM_FILTER_INVAL
;
4982 if (bytecode
->len
+ sizeof(*bytecode
)
4983 != cmd_ctx
->lsm
->u
.filter
.bytecode_len
) {
4985 ret
= LTTCOMM_FILTER_INVAL
;
4989 ret
= cmd_set_filter(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4990 cmd_ctx
->lsm
->u
.filter
.channel_name
,
4991 cmd_ctx
->lsm
->u
.filter
.event_name
,
5001 if (cmd_ctx
->llm
== NULL
) {
5002 DBG("Missing llm structure. Allocating one.");
5003 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
5007 /* Set return code */
5008 cmd_ctx
->llm
->ret_code
= ret
;
5010 if (cmd_ctx
->session
) {
5011 session_unlock(cmd_ctx
->session
);
5013 if (need_tracing_session
) {
5014 session_unlock_list();
5021 * Thread managing health check socket.
5023 static void *thread_manage_health(void *data
)
5025 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
5026 uint32_t revents
, nb_fd
;
5027 struct lttng_poll_event events
;
5028 struct lttcomm_health_msg msg
;
5029 struct lttcomm_health_data reply
;
5031 DBG("[thread] Manage health check started");
5033 rcu_register_thread();
5035 /* Create unix socket */
5036 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
5038 ERR("Unable to create health check Unix socket");
5043 ret
= lttcomm_listen_unix_sock(sock
);
5049 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5050 * more will be added to this poll set.
5052 ret
= create_thread_poll_set(&events
, 2);
5057 /* Add the application registration socket */
5058 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
5064 DBG("Health check ready");
5066 nb_fd
= LTTNG_POLL_GETNB(&events
);
5068 /* Inifinite blocking call, waiting for transmission */
5070 ret
= lttng_poll_wait(&events
, -1);
5073 * Restart interrupted system call.
5075 if (errno
== EINTR
) {
5081 for (i
= 0; i
< nb_fd
; i
++) {
5082 /* Fetch once the poll data */
5083 revents
= LTTNG_POLL_GETEV(&events
, i
);
5084 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5086 /* Thread quit pipe has been closed. Killing thread. */
5087 ret
= check_thread_quit_pipe(pollfd
, revents
);
5093 /* Event on the registration socket */
5094 if (pollfd
== sock
) {
5095 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5096 ERR("Health socket poll error");
5102 new_sock
= lttcomm_accept_unix_sock(sock
);
5107 DBG("Receiving data from client for health...");
5108 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
5110 DBG("Nothing recv() from client... continuing");
5111 ret
= close(new_sock
);
5119 rcu_thread_online();
5121 switch (msg
.component
) {
5122 case LTTNG_HEALTH_CMD
:
5123 reply
.ret_code
= health_check_state(&health_thread_cmd
);
5125 case LTTNG_HEALTH_APP_MANAGE
:
5126 reply
.ret_code
= health_check_state(&health_thread_app_manage
);
5128 case LTTNG_HEALTH_APP_REG
:
5129 reply
.ret_code
= health_check_state(&health_thread_app_reg
);
5131 case LTTNG_HEALTH_KERNEL
:
5132 reply
.ret_code
= health_check_state(&health_thread_kernel
);
5134 case LTTNG_HEALTH_CONSUMER
:
5135 reply
.ret_code
= check_consumer_health();
5137 case LTTNG_HEALTH_ALL
:
5139 health_check_state(&health_thread_app_manage
) &&
5140 health_check_state(&health_thread_app_reg
) &&
5141 health_check_state(&health_thread_cmd
) &&
5142 health_check_state(&health_thread_kernel
) &&
5143 check_consumer_health();
5146 reply
.ret_code
= LTTCOMM_UND
;
5151 * Flip ret value since 0 is a success and 1 indicates a bad health for
5152 * the client where in the sessiond it is the opposite. Again, this is
5153 * just to make things easier for us poor developer which enjoy a lot
5156 if (reply
.ret_code
== 0 || reply
.ret_code
== 1) {
5157 reply
.ret_code
= !reply
.ret_code
;
5160 DBG2("Health check return value %d", reply
.ret_code
);
5162 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
5164 ERR("Failed to send health data back to client");
5167 /* End of transmission */
5168 ret
= close(new_sock
);
5178 ERR("Health error occurred in %s", __func__
);
5180 DBG("Health check thread dying");
5181 unlink(health_unix_sock_path
);
5188 if (new_sock
>= 0) {
5189 ret
= close(new_sock
);
5195 lttng_poll_clean(&events
);
5197 rcu_unregister_thread();
5202 * This thread manage all clients request using the unix client socket for
5205 static void *thread_manage_clients(void *data
)
5207 int sock
= -1, ret
, i
, pollfd
, err
= -1;
5209 uint32_t revents
, nb_fd
;
5210 struct command_ctx
*cmd_ctx
= NULL
;
5211 struct lttng_poll_event events
;
5213 DBG("[thread] Manage client started");
5215 rcu_register_thread();
5217 health_code_update(&health_thread_cmd
);
5219 ret
= lttcomm_listen_unix_sock(client_sock
);
5225 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5226 * more will be added to this poll set.
5228 ret
= create_thread_poll_set(&events
, 2);
5233 /* Add the application registration socket */
5234 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
5240 * Notify parent pid that we are ready to accept command for client side.
5242 if (opt_sig_parent
) {
5243 kill(ppid
, SIGUSR1
);
5246 health_code_update(&health_thread_cmd
);
5249 DBG("Accepting client command ...");
5251 nb_fd
= LTTNG_POLL_GETNB(&events
);
5253 /* Inifinite blocking call, waiting for transmission */
5255 health_poll_update(&health_thread_cmd
);
5256 ret
= lttng_poll_wait(&events
, -1);
5257 health_poll_update(&health_thread_cmd
);
5260 * Restart interrupted system call.
5262 if (errno
== EINTR
) {
5268 for (i
= 0; i
< nb_fd
; i
++) {
5269 /* Fetch once the poll data */
5270 revents
= LTTNG_POLL_GETEV(&events
, i
);
5271 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5273 health_code_update(&health_thread_cmd
);
5275 /* Thread quit pipe has been closed. Killing thread. */
5276 ret
= check_thread_quit_pipe(pollfd
, revents
);
5282 /* Event on the registration socket */
5283 if (pollfd
== client_sock
) {
5284 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5285 ERR("Client socket poll error");
5291 DBG("Wait for client response");
5293 health_code_update(&health_thread_cmd
);
5295 sock
= lttcomm_accept_unix_sock(client_sock
);
5300 /* Set socket option for credentials retrieval */
5301 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
5306 /* Allocate context command to process the client request */
5307 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
5308 if (cmd_ctx
== NULL
) {
5309 PERROR("zmalloc cmd_ctx");
5313 /* Allocate data buffer for reception */
5314 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
5315 if (cmd_ctx
->lsm
== NULL
) {
5316 PERROR("zmalloc cmd_ctx->lsm");
5320 cmd_ctx
->llm
= NULL
;
5321 cmd_ctx
->session
= NULL
;
5323 health_code_update(&health_thread_cmd
);
5326 * Data is received from the lttng client. The struct
5327 * lttcomm_session_msg (lsm) contains the command and data request of
5330 DBG("Receiving data from client ...");
5331 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
5332 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
5334 DBG("Nothing recv() from client... continuing");
5340 clean_command_ctx(&cmd_ctx
);
5344 health_code_update(&health_thread_cmd
);
5346 // TODO: Validate cmd_ctx including sanity check for
5347 // security purpose.
5349 rcu_thread_online();
5351 * This function dispatch the work to the kernel or userspace tracer
5352 * libs and fill the lttcomm_lttng_msg data structure of all the needed
5353 * informations for the client. The command context struct contains
5354 * everything this function may needs.
5356 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
5357 rcu_thread_offline();
5367 * TODO: Inform client somehow of the fatal error. At
5368 * this point, ret < 0 means that a zmalloc failed
5369 * (ENOMEM). Error detected but still accept
5370 * command, unless a socket error has been
5373 clean_command_ctx(&cmd_ctx
);
5377 health_code_update(&health_thread_cmd
);
5379 DBG("Sending response (size: %d, retcode: %s)",
5380 cmd_ctx
->lttng_msg_size
,
5381 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
5382 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
5384 ERR("Failed to send data back to client");
5387 /* End of transmission */
5394 clean_command_ctx(&cmd_ctx
);
5396 health_code_update(&health_thread_cmd
);
5402 health_error(&health_thread_cmd
);
5403 ERR("Health error occurred in %s", __func__
);
5405 health_exit(&health_thread_cmd
);
5407 DBG("Client thread dying");
5408 unlink(client_unix_sock_path
);
5409 if (client_sock
>= 0) {
5410 ret
= close(client_sock
);
5422 lttng_poll_clean(&events
);
5423 clean_command_ctx(&cmd_ctx
);
5425 rcu_unregister_thread();
5431 * usage function on stderr
5433 static void usage(void)
5435 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
5436 fprintf(stderr
, " -h, --help Display this usage.\n");
5437 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
5438 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
5439 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
5440 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
5441 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
5442 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
5443 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
5444 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
5445 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
5446 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
5447 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
5448 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
5449 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
5450 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
5451 fprintf(stderr
, " -V, --version Show version number.\n");
5452 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
5453 fprintf(stderr
, " -q, --quiet No output at all.\n");
5454 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
5455 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
5456 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
5460 * daemon argument parsing
5462 static int parse_args(int argc
, char **argv
)
5466 static struct option long_options
[] = {
5467 { "client-sock", 1, 0, 'c' },
5468 { "apps-sock", 1, 0, 'a' },
5469 { "kconsumerd-cmd-sock", 1, 0, 'C' },
5470 { "kconsumerd-err-sock", 1, 0, 'E' },
5471 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
5472 { "ustconsumerd32-err-sock", 1, 0, 'H' },
5473 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
5474 { "ustconsumerd64-err-sock", 1, 0, 'F' },
5475 { "consumerd32-path", 1, 0, 'u' },
5476 { "consumerd32-libdir", 1, 0, 'U' },
5477 { "consumerd64-path", 1, 0, 't' },
5478 { "consumerd64-libdir", 1, 0, 'T' },
5479 { "daemonize", 0, 0, 'd' },
5480 { "sig-parent", 0, 0, 'S' },
5481 { "help", 0, 0, 'h' },
5482 { "group", 1, 0, 'g' },
5483 { "version", 0, 0, 'V' },
5484 { "quiet", 0, 0, 'q' },
5485 { "verbose", 0, 0, 'v' },
5486 { "verbose-consumer", 0, 0, 'Z' },
5487 { "no-kernel", 0, 0, 'N' },
5492 int option_index
= 0;
5493 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
5494 long_options
, &option_index
);
5501 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
5503 fprintf(stderr
, " with arg %s\n", optarg
);
5507 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5510 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5516 opt_tracing_group
= optarg
;
5522 fprintf(stdout
, "%s\n", VERSION
);
5528 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5531 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5534 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5537 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5540 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5543 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5549 lttng_opt_quiet
= 1;
5552 /* Verbose level can increase using multiple -v */
5553 lttng_opt_verbose
+= 1;
5556 opt_verbose_consumer
+= 1;
5559 consumerd32_bin
= optarg
;
5562 consumerd32_libdir
= optarg
;
5565 consumerd64_bin
= optarg
;
5568 consumerd64_libdir
= optarg
;
5571 /* Unknown option or other error.
5572 * Error is printed by getopt, just return */
5581 * Creates the two needed socket by the daemon.
5582 * apps_sock - The communication socket for all UST apps.
5583 * client_sock - The communication of the cli tool (lttng).
5585 static int init_daemon_socket(void)
5590 old_umask
= umask(0);
5592 /* Create client tool unix socket */
5593 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5594 if (client_sock
< 0) {
5595 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5600 /* File permission MUST be 660 */
5601 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5603 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5608 /* Create the application unix socket */
5609 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5610 if (apps_sock
< 0) {
5611 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5616 /* File permission MUST be 666 */
5617 ret
= chmod(apps_unix_sock_path
,
5618 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5620 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5631 * Check if the global socket is available, and if a daemon is answering at the
5632 * other side. If yes, error is returned.
5634 static int check_existing_daemon(void)
5636 /* Is there anybody out there ? */
5637 if (lttng_session_daemon_alive()) {
5645 * Set the tracing group gid onto the client socket.
5647 * Race window between mkdir and chown is OK because we are going from more
5648 * permissive (root.root) to less permissive (root.tracing).
5650 static int set_permissions(char *rundir
)
5655 ret
= allowed_group();
5657 WARN("No tracing group detected");
5664 /* Set lttng run dir */
5665 ret
= chown(rundir
, 0, gid
);
5667 ERR("Unable to set group on %s", rundir
);
5671 /* Ensure tracing group can search the run dir */
5672 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
5674 ERR("Unable to set permissions on %s", rundir
);
5678 /* lttng client socket path */
5679 ret
= chown(client_unix_sock_path
, 0, gid
);
5681 ERR("Unable to set group on %s", client_unix_sock_path
);
5685 /* kconsumer error socket path */
5686 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
5688 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5692 /* 64-bit ustconsumer error socket path */
5693 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
5695 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5699 /* 32-bit ustconsumer compat32 error socket path */
5700 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
5702 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5706 DBG("All permissions are set");
5713 * Create the lttng run directory needed for all global sockets and pipe.
5715 static int create_lttng_rundir(const char *rundir
)
5719 DBG3("Creating LTTng run directory: %s", rundir
);
5721 ret
= mkdir(rundir
, S_IRWXU
);
5723 if (errno
!= EEXIST
) {
5724 ERR("Unable to create %s", rundir
);
5736 * Setup sockets and directory needed by the kconsumerd communication with the
5739 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5743 char path
[PATH_MAX
];
5745 switch (consumer_data
->type
) {
5746 case LTTNG_CONSUMER_KERNEL
:
5747 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5749 case LTTNG_CONSUMER64_UST
:
5750 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5752 case LTTNG_CONSUMER32_UST
:
5753 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5756 ERR("Consumer type unknown");
5761 DBG2("Creating consumer directory: %s", path
);
5763 ret
= mkdir(path
, S_IRWXU
);
5765 if (errno
!= EEXIST
) {
5767 ERR("Failed to create %s", path
);
5773 /* Create the kconsumerd error unix socket */
5774 consumer_data
->err_sock
=
5775 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5776 if (consumer_data
->err_sock
< 0) {
5777 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5782 /* File permission MUST be 660 */
5783 ret
= chmod(consumer_data
->err_unix_sock_path
,
5784 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5786 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5796 * Signal handler for the daemon
5798 * Simply stop all worker threads, leaving main() return gracefully after
5799 * joining all threads and calling cleanup().
5801 static void sighandler(int sig
)
5805 DBG("SIGPIPE caught");
5808 DBG("SIGINT caught");
5812 DBG("SIGTERM caught");
5821 * Setup signal handler for :
5822 * SIGINT, SIGTERM, SIGPIPE
5824 static int set_signal_handler(void)
5827 struct sigaction sa
;
5830 if ((ret
= sigemptyset(&sigset
)) < 0) {
5831 PERROR("sigemptyset");
5835 sa
.sa_handler
= sighandler
;
5836 sa
.sa_mask
= sigset
;
5838 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5839 PERROR("sigaction");
5843 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5844 PERROR("sigaction");
5848 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5849 PERROR("sigaction");
5853 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
5859 * Set open files limit to unlimited. This daemon can open a large number of
5860 * file descriptors in order to consumer multiple kernel traces.
5862 static void set_ulimit(void)
5867 /* The kernel does not allowed an infinite limit for open files */
5868 lim
.rlim_cur
= 65535;
5869 lim
.rlim_max
= 65535;
5871 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5873 PERROR("failed to set open files limit");
5880 int main(int argc
, char **argv
)
5884 const char *home_path
;
5886 init_kernel_workarounds();
5888 rcu_register_thread();
5890 setup_consumerd_path();
5892 /* Parse arguments */
5894 if ((ret
= parse_args(argc
, argv
) < 0)) {
5904 * child: setsid, close FD 0, 1, 2, chdir /
5905 * parent: exit (if fork is successful)
5913 * We are in the child. Make sure all other file
5914 * descriptors are closed, in case we are called with
5915 * more opened file descriptors than the standard ones.
5917 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5922 /* Create thread quit pipe */
5923 if ((ret
= init_thread_quit_pipe()) < 0) {
5927 /* Check if daemon is UID = 0 */
5928 is_root
= !getuid();
5931 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5933 /* Create global run dir with root access */
5934 ret
= create_lttng_rundir(rundir
);
5939 if (strlen(apps_unix_sock_path
) == 0) {
5940 snprintf(apps_unix_sock_path
, PATH_MAX
,
5941 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5944 if (strlen(client_unix_sock_path
) == 0) {
5945 snprintf(client_unix_sock_path
, PATH_MAX
,
5946 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5949 /* Set global SHM for ust */
5950 if (strlen(wait_shm_path
) == 0) {
5951 snprintf(wait_shm_path
, PATH_MAX
,
5952 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5955 if (strlen(health_unix_sock_path
) == 0) {
5956 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
5957 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5960 /* Setup kernel consumerd path */
5961 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5962 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5963 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5964 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5966 DBG2("Kernel consumer err path: %s",
5967 kconsumer_data
.err_unix_sock_path
);
5968 DBG2("Kernel consumer cmd path: %s",
5969 kconsumer_data
.cmd_unix_sock_path
);
5971 home_path
= get_home_dir();
5972 if (home_path
== NULL
) {
5973 /* TODO: Add --socket PATH option */
5974 ERR("Can't get HOME directory for sockets creation.");
5980 * Create rundir from home path. This will create something like
5983 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5989 ret
= create_lttng_rundir(rundir
);
5994 if (strlen(apps_unix_sock_path
) == 0) {
5995 snprintf(apps_unix_sock_path
, PATH_MAX
,
5996 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
5999 /* Set the cli tool unix socket path */
6000 if (strlen(client_unix_sock_path
) == 0) {
6001 snprintf(client_unix_sock_path
, PATH_MAX
,
6002 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
6005 /* Set global SHM for ust */
6006 if (strlen(wait_shm_path
) == 0) {
6007 snprintf(wait_shm_path
, PATH_MAX
,
6008 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
6011 /* Set health check Unix path */
6012 if (strlen(health_unix_sock_path
) == 0) {
6013 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
6014 DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
6018 /* Set consumer initial state */
6019 kernel_consumerd_state
= CONSUMER_STOPPED
;
6020 ust_consumerd_state
= CONSUMER_STOPPED
;
6022 DBG("Client socket path %s", client_unix_sock_path
);
6023 DBG("Application socket path %s", apps_unix_sock_path
);
6024 DBG("LTTng run directory path: %s", rundir
);
6026 /* 32 bits consumerd path setup */
6027 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
6028 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
6029 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
6030 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
6032 DBG2("UST consumer 32 bits err path: %s",
6033 ustconsumer32_data
.err_unix_sock_path
);
6034 DBG2("UST consumer 32 bits cmd path: %s",
6035 ustconsumer32_data
.cmd_unix_sock_path
);
6037 /* 64 bits consumerd path setup */
6038 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
6039 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
6040 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
6041 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
6043 DBG2("UST consumer 64 bits err path: %s",
6044 ustconsumer64_data
.err_unix_sock_path
);
6045 DBG2("UST consumer 64 bits cmd path: %s",
6046 ustconsumer64_data
.cmd_unix_sock_path
);
6049 * See if daemon already exist.
6051 if ((ret
= check_existing_daemon()) < 0) {
6052 ERR("Already running daemon.\n");
6054 * We do not goto exit because we must not cleanup()
6055 * because a daemon is already running.
6061 * Init UST app hash table. Alloc hash table before this point since
6062 * cleanup() can get called after that point.
6066 /* After this point, we can safely call cleanup() with "goto exit" */
6069 * These actions must be executed as root. We do that *after* setting up
6070 * the sockets path because we MUST make the check for another daemon using
6071 * those paths *before* trying to set the kernel consumer sockets and init
6075 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
6080 /* Setup kernel tracer */
6081 if (!opt_no_kernel
) {
6082 init_kernel_tracer();
6085 /* Set ulimit for open files */
6088 /* init lttng_fd tracking must be done after set_ulimit. */
6091 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
6096 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
6101 if ((ret
= set_signal_handler()) < 0) {
6105 /* Setup the needed unix socket */
6106 if ((ret
= init_daemon_socket()) < 0) {
6110 /* Set credentials to socket */
6111 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
6115 /* Get parent pid if -S, --sig-parent is specified. */
6116 if (opt_sig_parent
) {
6120 /* Setup the kernel pipe for waking up the kernel thread */
6121 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
6125 /* Setup the thread apps communication pipe. */
6126 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
6130 /* Init UST command queue. */
6131 cds_wfq_init(&ust_cmd_queue
.queue
);
6134 * Get session list pointer. This pointer MUST NOT be free(). This list is
6135 * statically declared in session.c
6137 session_list_ptr
= session_get_list();
6139 /* Set up max poll set size */
6140 lttng_poll_set_max_size();
6143 * Set network sequence index to 1 for streams to match a relayd socket on
6144 * the consumer side.
6146 uatomic_set(&relayd_net_seq_idx
, 1);
6148 /* Init all health thread counters. */
6149 health_init(&health_thread_cmd
);
6150 health_init(&health_thread_kernel
);
6151 health_init(&health_thread_app_manage
);
6152 health_init(&health_thread_app_reg
);
6155 * Init health counters of the consumer thread. We do a quick hack here to
6156 * the state of the consumer health is fine even if the thread is not
6157 * started. This is simply to ease our life and has no cost what so ever.
6159 health_init(&kconsumer_data
.health
);
6160 health_poll_update(&kconsumer_data
.health
);
6161 health_init(&ustconsumer32_data
.health
);
6162 health_poll_update(&ustconsumer32_data
.health
);
6163 health_init(&ustconsumer64_data
.health
);
6164 health_poll_update(&ustconsumer64_data
.health
);
6166 /* Create thread to manage the client socket */
6167 ret
= pthread_create(&health_thread
, NULL
,
6168 thread_manage_health
, (void *) NULL
);
6170 PERROR("pthread_create health");
6174 /* Create thread to manage the client socket */
6175 ret
= pthread_create(&client_thread
, NULL
,
6176 thread_manage_clients
, (void *) NULL
);
6178 PERROR("pthread_create clients");
6182 /* Create thread to dispatch registration */
6183 ret
= pthread_create(&dispatch_thread
, NULL
,
6184 thread_dispatch_ust_registration
, (void *) NULL
);
6186 PERROR("pthread_create dispatch");
6190 /* Create thread to manage application registration. */
6191 ret
= pthread_create(®_apps_thread
, NULL
,
6192 thread_registration_apps
, (void *) NULL
);
6194 PERROR("pthread_create registration");
6198 /* Create thread to manage application socket */
6199 ret
= pthread_create(&apps_thread
, NULL
,
6200 thread_manage_apps
, (void *) NULL
);
6202 PERROR("pthread_create apps");
6206 /* Create kernel thread to manage kernel event */
6207 ret
= pthread_create(&kernel_thread
, NULL
,
6208 thread_manage_kernel
, (void *) NULL
);
6210 PERROR("pthread_create kernel");
6214 ret
= pthread_join(kernel_thread
, &status
);
6216 PERROR("pthread_join");
6217 goto error
; /* join error, exit without cleanup */
6221 ret
= pthread_join(apps_thread
, &status
);
6223 PERROR("pthread_join");
6224 goto error
; /* join error, exit without cleanup */
6228 ret
= pthread_join(reg_apps_thread
, &status
);
6230 PERROR("pthread_join");
6231 goto error
; /* join error, exit without cleanup */
6235 ret
= pthread_join(dispatch_thread
, &status
);
6237 PERROR("pthread_join");
6238 goto error
; /* join error, exit without cleanup */
6242 ret
= pthread_join(client_thread
, &status
);
6244 PERROR("pthread_join");
6245 goto error
; /* join error, exit without cleanup */
6248 ret
= join_consumer_thread(&kconsumer_data
);
6250 PERROR("join_consumer");
6251 goto error
; /* join error, exit without cleanup */
6258 * cleanup() is called when no other thread is running.
6260 rcu_thread_online();
6262 rcu_thread_offline();
6263 rcu_unregister_thread();