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 * Set consumer subdirectory using the session name and a generated datetime if
2191 * needed. This is appended to the current subdirectory.
2193 static int set_consumer_subdir(struct consumer_output
*consumer
,
2194 const char *session_name
)
2197 unsigned int have_default_name
= 0;
2198 char datetime
[16], tmp_path
[PATH_MAX
];
2200 struct tm
*timeinfo
;
2203 assert(session_name
);
2205 memset(tmp_path
, 0, sizeof(tmp_path
));
2207 /* Flag if we have a default session. */
2208 if (strncmp(session_name
, DEFAULT_SESSION_NAME
"-",
2209 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) {
2210 have_default_name
= 1;
2212 /* Get date and time for session path */
2214 timeinfo
= localtime(&rawtime
);
2215 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2218 if (have_default_name
) {
2219 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
2220 "%s/%s", consumer
->subdir
, session_name
);
2222 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
2223 "%s/%s-%s/", consumer
->subdir
, session_name
, datetime
);
2226 PERROR("snprintf session name date");
2230 strncpy(consumer
->subdir
, tmp_path
, sizeof(consumer
->subdir
));
2231 DBG2("Consumer subdir set to %s", consumer
->subdir
);
2238 * Copy consumer output from the tracing session to the domain session. The
2239 * function also applies the right modification on a per domain basis for the
2240 * trace files destination directory.
2242 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2245 const char *dir_name
;
2246 struct consumer_output
*consumer
;
2249 assert(session
->consumer
);
2252 case LTTNG_DOMAIN_KERNEL
:
2253 DBG3("Copying tracing session consumer output in kernel session");
2254 session
->kernel_session
->consumer
=
2255 consumer_copy_output(session
->consumer
);
2256 /* Ease our life a bit for the next part */
2257 consumer
= session
->kernel_session
->consumer
;
2258 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2260 case LTTNG_DOMAIN_UST
:
2261 DBG3("Copying tracing session consumer output in UST session");
2262 session
->ust_session
->consumer
=
2263 consumer_copy_output(session
->consumer
);
2264 /* Ease our life a bit for the next part */
2265 consumer
= session
->ust_session
->consumer
;
2266 dir_name
= DEFAULT_UST_TRACE_DIR
;
2269 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2273 ret
= set_consumer_subdir(session
->consumer
, session
->name
);
2275 ret
= LTTCOMM_FATAL
;
2279 /* Append correct directory to subdir */
2280 strncat(consumer
->subdir
, dir_name
, sizeof(consumer
->subdir
));
2281 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2290 * Create an UST session and add it to the session ust list.
2292 static int create_ust_session(struct ltt_session
*session
,
2293 struct lttng_domain
*domain
)
2296 struct ltt_ust_session
*lus
= NULL
;
2300 assert(session
->consumer
);
2302 switch (domain
->type
) {
2303 case LTTNG_DOMAIN_UST
:
2306 ERR("Unknown UST domain on create session %d", domain
->type
);
2307 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2311 DBG("Creating UST session");
2313 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
2315 ret
= LTTCOMM_UST_SESS_FAIL
;
2319 lus
->uid
= session
->uid
;
2320 lus
->gid
= session
->gid
;
2321 session
->ust_session
= lus
;
2323 /* Copy session output to the newly created UST session */
2324 ret
= copy_session_consumer(domain
->type
, session
);
2325 if (ret
!= LTTCOMM_OK
) {
2333 session
->ust_session
= NULL
;
2338 * Create a kernel tracer session then create the default channel.
2340 static int create_kernel_session(struct ltt_session
*session
)
2344 DBG("Creating kernel session");
2346 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2348 ret
= LTTCOMM_KERN_SESS_FAIL
;
2352 /* Code flow safety */
2353 assert(session
->kernel_session
);
2355 /* Copy session output to the newly created Kernel session */
2356 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2357 if (ret
!= LTTCOMM_OK
) {
2361 /* Create directory(ies) on local filesystem. */
2362 if (session
->kernel_session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2363 strlen(session
->kernel_session
->consumer
->dst
.trace_path
) > 0) {
2364 ret
= run_as_mkdir_recursive(
2365 session
->kernel_session
->consumer
->dst
.trace_path
,
2366 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2368 if (ret
!= -EEXIST
) {
2369 ERR("Trace directory creation error");
2375 session
->kernel_session
->uid
= session
->uid
;
2376 session
->kernel_session
->gid
= session
->gid
;
2381 trace_kernel_destroy_session(session
->kernel_session
);
2382 session
->kernel_session
= NULL
;
2387 * Check if the UID or GID match the session. Root user has access to all
2390 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
2392 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
2400 * Count number of session permitted by uid/gid.
2402 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2405 struct ltt_session
*session
;
2407 DBG("Counting number of available session for UID %d GID %d",
2409 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2411 * Only list the sessions the user can control.
2413 if (!session_access_ok(session
, uid
, gid
)) {
2422 * Create a session path used by list_lttng_sessions for the case that the
2423 * session consumer is on the network.
2425 static int build_network_session_path(char *dst
, size_t size
,
2426 struct ltt_session
*session
)
2428 int ret
, kdata_port
, udata_port
;
2429 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
2430 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
2435 memset(tmp_urls
, 0, sizeof(tmp_urls
));
2436 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
2438 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
2440 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
2441 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
2442 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
2445 if (session
->ust_session
&& session
->ust_session
->consumer
) {
2446 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
2447 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
2450 if (uuri
== NULL
&& kuri
== NULL
) {
2451 uri
= &session
->consumer
->dst
.net
.control
;
2452 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
2453 } else if (kuri
&& uuri
) {
2454 ret
= uri_compare(kuri
, uuri
);
2458 /* Build uuri URL string */
2459 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
2466 } else if (kuri
&& uuri
== NULL
) {
2468 } else if (uuri
&& kuri
== NULL
) {
2472 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
2477 if (strlen(tmp_uurl
) > 0) {
2478 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
2479 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
2481 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, kdata_port
);
2489 * Using the session list, filled a lttng_session array to send back to the
2490 * client for session listing.
2492 * The session list lock MUST be acquired before calling this function. Use
2493 * session_lock_list() and session_unlock_list().
2495 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2500 struct ltt_session
*session
;
2502 DBG("Getting all available session for UID %d GID %d",
2505 * Iterate over session list and append data after the control struct in
2508 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2510 * Only list the sessions the user can control.
2512 if (!session_access_ok(session
, uid
, gid
)) {
2516 if (session
->consumer
->type
== CONSUMER_DST_LOCAL
&&
2517 (!session
->kernel_session
&& !session
->ust_session
)) {
2518 ret
= snprintf(sessions
[i
].path
, sizeof(session
[i
].path
), "%s",
2519 session
->consumer
->dst
.trace_path
);
2521 ret
= build_network_session_path(sessions
[i
].path
,
2522 sizeof(session
[i
].path
), session
);
2525 PERROR("snprintf session path");
2529 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2530 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2531 sessions
[i
].enabled
= session
->enabled
;
2537 * Fill lttng_channel array of all channels.
2539 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2540 struct lttng_channel
*channels
)
2543 struct ltt_kernel_channel
*kchan
;
2545 DBG("Listing channels for session %s", session
->name
);
2548 case LTTNG_DOMAIN_KERNEL
:
2549 /* Kernel channels */
2550 if (session
->kernel_session
!= NULL
) {
2551 cds_list_for_each_entry(kchan
,
2552 &session
->kernel_session
->channel_list
.head
, list
) {
2553 /* Copy lttng_channel struct to array */
2554 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2555 channels
[i
].enabled
= kchan
->enabled
;
2560 case LTTNG_DOMAIN_UST
:
2562 struct lttng_ht_iter iter
;
2563 struct ltt_ust_channel
*uchan
;
2565 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2566 &iter
.iter
, uchan
, node
.node
) {
2567 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2568 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2569 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2570 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2571 channels
[i
].attr
.switch_timer_interval
=
2572 uchan
->attr
.switch_timer_interval
;
2573 channels
[i
].attr
.read_timer_interval
=
2574 uchan
->attr
.read_timer_interval
;
2575 channels
[i
].enabled
= uchan
->enabled
;
2576 switch (uchan
->attr
.output
) {
2577 case LTTNG_UST_MMAP
:
2579 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2592 * Create a list of ust global domain events.
2594 static int list_lttng_ust_global_events(char *channel_name
,
2595 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2598 unsigned int nb_event
= 0;
2599 struct lttng_ht_iter iter
;
2600 struct lttng_ht_node_str
*node
;
2601 struct ltt_ust_channel
*uchan
;
2602 struct ltt_ust_event
*uevent
;
2603 struct lttng_event
*tmp
;
2605 DBG("Listing UST global events for channel %s", channel_name
);
2609 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2610 node
= lttng_ht_iter_get_node_str(&iter
);
2612 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2616 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2618 nb_event
+= lttng_ht_get_count(uchan
->events
);
2620 if (nb_event
== 0) {
2625 DBG3("Listing UST global %d events", nb_event
);
2627 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2629 ret
= -LTTCOMM_FATAL
;
2633 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2634 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2635 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2636 tmp
[i
].enabled
= uevent
->enabled
;
2637 switch (uevent
->attr
.instrumentation
) {
2638 case LTTNG_UST_TRACEPOINT
:
2639 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2641 case LTTNG_UST_PROBE
:
2642 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2644 case LTTNG_UST_FUNCTION
:
2645 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2648 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2649 switch (uevent
->attr
.loglevel_type
) {
2650 case LTTNG_UST_LOGLEVEL_ALL
:
2651 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2653 case LTTNG_UST_LOGLEVEL_RANGE
:
2654 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2656 case LTTNG_UST_LOGLEVEL_SINGLE
:
2657 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2660 if (uevent
->filter
) {
2675 * Fill lttng_event array of all kernel events in the channel.
2677 static int list_lttng_kernel_events(char *channel_name
,
2678 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2681 unsigned int nb_event
;
2682 struct ltt_kernel_event
*event
;
2683 struct ltt_kernel_channel
*kchan
;
2685 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2686 if (kchan
== NULL
) {
2687 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2691 nb_event
= kchan
->event_count
;
2693 DBG("Listing events for channel %s", kchan
->channel
->name
);
2695 if (nb_event
== 0) {
2700 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2701 if (*events
== NULL
) {
2702 ret
= LTTCOMM_FATAL
;
2706 /* Kernel channels */
2707 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2708 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2709 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2710 (*events
)[i
].enabled
= event
->enabled
;
2711 switch (event
->event
->instrumentation
) {
2712 case LTTNG_KERNEL_TRACEPOINT
:
2713 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2715 case LTTNG_KERNEL_KPROBE
:
2716 case LTTNG_KERNEL_KRETPROBE
:
2717 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2718 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2719 sizeof(struct lttng_kernel_kprobe
));
2721 case LTTNG_KERNEL_FUNCTION
:
2722 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2723 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2724 sizeof(struct lttng_kernel_function
));
2726 case LTTNG_KERNEL_NOOP
:
2727 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2729 case LTTNG_KERNEL_SYSCALL
:
2730 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2732 case LTTNG_KERNEL_ALL
:
2747 * Add URI so the consumer output object. Set the correct path depending on the
2748 * domain adding the default trace directory.
2750 static int add_uri_to_consumer(struct consumer_output
*consumer
,
2751 struct lttng_uri
*uri
, int domain
, const char *session_name
)
2753 int ret
= LTTCOMM_OK
;
2754 const char *default_trace_dir
;
2758 if (consumer
== NULL
) {
2759 DBG("No consumer detected. Don't add URI. Stopping.");
2760 ret
= LTTCOMM_NO_CONSUMER
;
2765 case LTTNG_DOMAIN_KERNEL
:
2766 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
2768 case LTTNG_DOMAIN_UST
:
2769 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
2773 * This case is possible is we try to add the URI to the global tracing
2774 * session consumer object which in this case there is no subdir.
2776 default_trace_dir
= "";
2779 switch (uri
->dtype
) {
2780 case LTTNG_DST_IPV4
:
2781 case LTTNG_DST_IPV6
:
2782 DBG2("Setting network URI to consumer");
2784 /* Set URI into consumer output object */
2785 ret
= consumer_set_network_uri(consumer
, uri
);
2787 ret
= LTTCOMM_FATAL
;
2789 } else if (ret
== 1) {
2791 * URI was the same in the consumer so we do not append the subdir
2792 * again so to not duplicate output dir.
2797 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
2798 ret
= set_consumer_subdir(consumer
, session_name
);
2800 ret
= LTTCOMM_FATAL
;
2805 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
2806 /* On a new subdir, reappend the default trace dir. */
2807 strncat(consumer
->subdir
, default_trace_dir
, sizeof(consumer
->subdir
));
2808 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
2812 case LTTNG_DST_PATH
:
2813 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
2814 memset(consumer
->dst
.trace_path
, 0,
2815 sizeof(consumer
->dst
.trace_path
));
2816 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
2817 sizeof(consumer
->dst
.trace_path
));
2818 /* Append default trace dir */
2819 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
2820 sizeof(consumer
->dst
.trace_path
));
2821 /* Flag consumer as local. */
2822 consumer
->type
= CONSUMER_DST_LOCAL
;
2831 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2833 static int cmd_disable_channel(struct ltt_session
*session
,
2834 int domain
, char *channel_name
)
2837 struct ltt_ust_session
*usess
;
2839 usess
= session
->ust_session
;
2842 case LTTNG_DOMAIN_KERNEL
:
2844 ret
= channel_kernel_disable(session
->kernel_session
,
2846 if (ret
!= LTTCOMM_OK
) {
2850 kernel_wait_quiescent(kernel_tracer_fd
);
2853 case LTTNG_DOMAIN_UST
:
2855 struct ltt_ust_channel
*uchan
;
2856 struct lttng_ht
*chan_ht
;
2858 chan_ht
= usess
->domain_global
.channels
;
2860 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2861 if (uchan
== NULL
) {
2862 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2866 ret
= channel_ust_disable(usess
, domain
, uchan
);
2867 if (ret
!= LTTCOMM_OK
) {
2873 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2874 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2875 case LTTNG_DOMAIN_UST_PID
:
2878 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2889 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2891 static int cmd_enable_channel(struct ltt_session
*session
,
2892 int domain
, struct lttng_channel
*attr
)
2895 struct ltt_ust_session
*usess
= session
->ust_session
;
2896 struct lttng_ht
*chan_ht
;
2898 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2901 case LTTNG_DOMAIN_KERNEL
:
2903 struct ltt_kernel_channel
*kchan
;
2905 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2906 session
->kernel_session
);
2907 if (kchan
== NULL
) {
2908 ret
= channel_kernel_create(session
->kernel_session
,
2909 attr
, kernel_poll_pipe
[1]);
2911 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2914 if (ret
!= LTTCOMM_OK
) {
2918 kernel_wait_quiescent(kernel_tracer_fd
);
2921 case LTTNG_DOMAIN_UST
:
2923 struct ltt_ust_channel
*uchan
;
2925 chan_ht
= usess
->domain_global
.channels
;
2927 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2928 if (uchan
== NULL
) {
2929 ret
= channel_ust_create(usess
, domain
, attr
);
2931 ret
= channel_ust_enable(usess
, domain
, uchan
);
2936 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2937 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2938 case LTTNG_DOMAIN_UST_PID
:
2941 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2950 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2952 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2953 char *channel_name
, char *event_name
)
2958 case LTTNG_DOMAIN_KERNEL
:
2960 struct ltt_kernel_channel
*kchan
;
2961 struct ltt_kernel_session
*ksess
;
2963 ksess
= session
->kernel_session
;
2965 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2966 if (kchan
== NULL
) {
2967 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2971 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2972 if (ret
!= LTTCOMM_OK
) {
2976 kernel_wait_quiescent(kernel_tracer_fd
);
2979 case LTTNG_DOMAIN_UST
:
2981 struct ltt_ust_channel
*uchan
;
2982 struct ltt_ust_session
*usess
;
2984 usess
= session
->ust_session
;
2986 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2988 if (uchan
== NULL
) {
2989 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2993 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2994 if (ret
!= LTTCOMM_OK
) {
2998 DBG3("Disable UST event %s in channel %s completed", event_name
,
3003 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3004 case LTTNG_DOMAIN_UST_PID
:
3005 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3019 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
3021 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
3027 case LTTNG_DOMAIN_KERNEL
:
3029 struct ltt_kernel_session
*ksess
;
3030 struct ltt_kernel_channel
*kchan
;
3032 ksess
= session
->kernel_session
;
3034 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
3035 if (kchan
== NULL
) {
3036 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
3040 ret
= event_kernel_disable_all(ksess
, kchan
);
3041 if (ret
!= LTTCOMM_OK
) {
3045 kernel_wait_quiescent(kernel_tracer_fd
);
3048 case LTTNG_DOMAIN_UST
:
3050 struct ltt_ust_session
*usess
;
3051 struct ltt_ust_channel
*uchan
;
3053 usess
= session
->ust_session
;
3055 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3057 if (uchan
== NULL
) {
3058 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
3062 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
3067 DBG3("Disable all UST events in channel %s completed", channel_name
);
3072 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3073 case LTTNG_DOMAIN_UST_PID
:
3074 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3088 * Command LTTNG_ADD_CONTEXT processed by the client thread.
3090 static int cmd_add_context(struct ltt_session
*session
, int domain
,
3091 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
3096 case LTTNG_DOMAIN_KERNEL
:
3097 /* Add kernel context to kernel tracer */
3098 ret
= context_kernel_add(session
->kernel_session
, ctx
,
3099 event_name
, channel_name
);
3100 if (ret
!= LTTCOMM_OK
) {
3104 case LTTNG_DOMAIN_UST
:
3106 struct ltt_ust_session
*usess
= session
->ust_session
;
3108 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
3109 if (ret
!= LTTCOMM_OK
) {
3115 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3116 case LTTNG_DOMAIN_UST_PID
:
3117 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3131 * Command LTTNG_SET_FILTER processed by the client thread.
3133 static int cmd_set_filter(struct ltt_session
*session
, int domain
,
3134 char *channel_name
, char *event_name
,
3135 struct lttng_filter_bytecode
*bytecode
)
3140 case LTTNG_DOMAIN_KERNEL
:
3141 ret
= LTTCOMM_FATAL
;
3143 case LTTNG_DOMAIN_UST
:
3145 struct ltt_ust_session
*usess
= session
->ust_session
;
3147 ret
= filter_ust_set(usess
, domain
, bytecode
, event_name
, channel_name
);
3148 if (ret
!= LTTCOMM_OK
) {
3154 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3155 case LTTNG_DOMAIN_UST_PID
:
3156 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3171 * Command LTTNG_ENABLE_EVENT processed by the client thread.
3173 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
3174 char *channel_name
, struct lttng_event
*event
)
3177 struct lttng_channel
*attr
;
3178 struct ltt_ust_session
*usess
= session
->ust_session
;
3181 case LTTNG_DOMAIN_KERNEL
:
3183 struct ltt_kernel_channel
*kchan
;
3185 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3186 session
->kernel_session
);
3187 if (kchan
== NULL
) {
3188 attr
= channel_new_default_attr(domain
);
3190 ret
= LTTCOMM_FATAL
;
3193 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3195 /* This call will notify the kernel thread */
3196 ret
= channel_kernel_create(session
->kernel_session
,
3197 attr
, kernel_poll_pipe
[1]);
3198 if (ret
!= LTTCOMM_OK
) {
3205 /* Get the newly created kernel channel pointer */
3206 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3207 session
->kernel_session
);
3208 if (kchan
== NULL
) {
3209 /* This sould not happen... */
3210 ret
= LTTCOMM_FATAL
;
3214 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
3216 if (ret
!= LTTCOMM_OK
) {
3220 kernel_wait_quiescent(kernel_tracer_fd
);
3223 case LTTNG_DOMAIN_UST
:
3225 struct lttng_channel
*attr
;
3226 struct ltt_ust_channel
*uchan
;
3228 /* Get channel from global UST domain */
3229 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3231 if (uchan
== NULL
) {
3232 /* Create default channel */
3233 attr
= channel_new_default_attr(domain
);
3235 ret
= LTTCOMM_FATAL
;
3238 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3239 attr
->name
[NAME_MAX
- 1] = '\0';
3241 ret
= channel_ust_create(usess
, domain
, attr
);
3242 if (ret
!= LTTCOMM_OK
) {
3248 /* Get the newly created channel reference back */
3249 uchan
= trace_ust_find_channel_by_name(
3250 usess
->domain_global
.channels
, channel_name
);
3251 if (uchan
== NULL
) {
3252 /* Something is really wrong */
3253 ret
= LTTCOMM_FATAL
;
3258 /* At this point, the session and channel exist on the tracer */
3259 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
3260 if (ret
!= LTTCOMM_OK
) {
3266 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3267 case LTTNG_DOMAIN_UST_PID
:
3268 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3282 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
3284 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
3285 char *channel_name
, int event_type
)
3288 struct ltt_kernel_channel
*kchan
;
3291 case LTTNG_DOMAIN_KERNEL
:
3292 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3293 session
->kernel_session
);
3294 if (kchan
== NULL
) {
3295 /* This call will notify the kernel thread */
3296 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
3297 kernel_poll_pipe
[1]);
3298 if (ret
!= LTTCOMM_OK
) {
3302 /* Get the newly created kernel channel pointer */
3303 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3304 session
->kernel_session
);
3305 if (kchan
== NULL
) {
3306 /* This sould not happen... */
3307 ret
= LTTCOMM_FATAL
;
3313 switch (event_type
) {
3314 case LTTNG_EVENT_SYSCALL
:
3315 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
3316 kchan
, kernel_tracer_fd
);
3318 case LTTNG_EVENT_TRACEPOINT
:
3320 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
3321 * events already registered to the channel.
3323 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
3324 kchan
, kernel_tracer_fd
);
3326 case LTTNG_EVENT_ALL
:
3327 /* Enable syscalls and tracepoints */
3328 ret
= event_kernel_enable_all(session
->kernel_session
,
3329 kchan
, kernel_tracer_fd
);
3332 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3336 /* Manage return value */
3337 if (ret
!= LTTCOMM_OK
) {
3341 kernel_wait_quiescent(kernel_tracer_fd
);
3343 case LTTNG_DOMAIN_UST
:
3345 struct lttng_channel
*attr
;
3346 struct ltt_ust_channel
*uchan
;
3347 struct ltt_ust_session
*usess
= session
->ust_session
;
3349 /* Get channel from global UST domain */
3350 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3352 if (uchan
== NULL
) {
3353 /* Create default channel */
3354 attr
= channel_new_default_attr(domain
);
3356 ret
= LTTCOMM_FATAL
;
3359 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3360 attr
->name
[NAME_MAX
- 1] = '\0';
3362 /* Use the internal command enable channel */
3363 ret
= channel_ust_create(usess
, domain
, attr
);
3364 if (ret
!= LTTCOMM_OK
) {
3370 /* Get the newly created channel reference back */
3371 uchan
= trace_ust_find_channel_by_name(
3372 usess
->domain_global
.channels
, channel_name
);
3373 if (uchan
== NULL
) {
3374 /* Something is really wrong */
3375 ret
= LTTCOMM_FATAL
;
3380 /* At this point, the session and channel exist on the tracer */
3382 switch (event_type
) {
3383 case LTTNG_EVENT_ALL
:
3384 case LTTNG_EVENT_TRACEPOINT
:
3385 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
3386 if (ret
!= LTTCOMM_OK
) {
3391 ret
= LTTCOMM_UST_ENABLE_FAIL
;
3395 /* Manage return value */
3396 if (ret
!= LTTCOMM_OK
) {
3403 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3404 case LTTNG_DOMAIN_UST_PID
:
3405 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3419 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
3421 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
3424 ssize_t nb_events
= 0;
3427 case LTTNG_DOMAIN_KERNEL
:
3428 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
3429 if (nb_events
< 0) {
3430 ret
= LTTCOMM_KERN_LIST_FAIL
;
3434 case LTTNG_DOMAIN_UST
:
3435 nb_events
= ust_app_list_events(events
);
3436 if (nb_events
< 0) {
3437 ret
= LTTCOMM_UST_LIST_FAIL
;
3449 /* Return negative value to differentiate return code */
3454 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
3456 static ssize_t
cmd_list_tracepoint_fields(int domain
,
3457 struct lttng_event_field
**fields
)
3460 ssize_t nb_fields
= 0;
3463 case LTTNG_DOMAIN_UST
:
3464 nb_fields
= ust_app_list_event_fields(fields
);
3465 if (nb_fields
< 0) {
3466 ret
= LTTCOMM_UST_LIST_FAIL
;
3470 case LTTNG_DOMAIN_KERNEL
:
3471 default: /* fall-through */
3479 /* Return negative value to differentiate return code */
3484 * Command LTTNG_START_TRACE processed by the client thread.
3486 static int cmd_start_trace(struct ltt_session
*session
)
3489 struct ltt_kernel_session
*ksession
;
3490 struct ltt_ust_session
*usess
;
3491 struct ltt_kernel_channel
*kchan
;
3493 /* Ease our life a bit ;) */
3494 ksession
= session
->kernel_session
;
3495 usess
= session
->ust_session
;
3497 if (session
->enabled
) {
3498 /* Already started. */
3499 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3503 session
->enabled
= 1;
3505 ret
= setup_relayd(session
);
3506 if (ret
!= LTTCOMM_OK
) {
3507 ERR("Error setting up relayd for session %s", session
->name
);
3511 /* Kernel tracing */
3512 if (ksession
!= NULL
) {
3513 /* Open kernel metadata */
3514 if (ksession
->metadata
== NULL
) {
3515 ret
= kernel_open_metadata(ksession
);
3517 ret
= LTTCOMM_KERN_META_FAIL
;
3522 /* Open kernel metadata stream */
3523 if (ksession
->metadata_stream_fd
< 0) {
3524 ret
= kernel_open_metadata_stream(ksession
);
3526 ERR("Kernel create metadata stream failed");
3527 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3532 /* For each channel */
3533 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3534 if (kchan
->stream_count
== 0) {
3535 ret
= kernel_open_channel_stream(kchan
);
3537 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3540 /* Update the stream global counter */
3541 ksession
->stream_count_global
+= ret
;
3545 /* Setup kernel consumer socket and send fds to it */
3546 ret
= init_kernel_tracing(ksession
);
3548 ret
= LTTCOMM_KERN_START_FAIL
;
3552 /* This start the kernel tracing */
3553 ret
= kernel_start_session(ksession
);
3555 ret
= LTTCOMM_KERN_START_FAIL
;
3559 /* Quiescent wait after starting trace */
3560 kernel_wait_quiescent(kernel_tracer_fd
);
3563 /* Flag session that trace should start automatically */
3565 usess
->start_trace
= 1;
3567 ret
= ust_app_start_trace_all(usess
);
3569 ret
= LTTCOMM_UST_START_FAIL
;
3581 * Command LTTNG_STOP_TRACE processed by the client thread.
3583 static int cmd_stop_trace(struct ltt_session
*session
)
3586 struct ltt_kernel_channel
*kchan
;
3587 struct ltt_kernel_session
*ksession
;
3588 struct ltt_ust_session
*usess
;
3591 ksession
= session
->kernel_session
;
3592 usess
= session
->ust_session
;
3594 if (!session
->enabled
) {
3595 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
3599 session
->enabled
= 0;
3602 if (ksession
!= NULL
) {
3603 DBG("Stop kernel tracing");
3605 /* Flush metadata if exist */
3606 if (ksession
->metadata_stream_fd
>= 0) {
3607 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
3609 ERR("Kernel metadata flush failed");
3613 /* Flush all buffers before stopping */
3614 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3615 ret
= kernel_flush_buffer(kchan
);
3617 ERR("Kernel flush buffer error");
3621 ret
= kernel_stop_session(ksession
);
3623 ret
= LTTCOMM_KERN_STOP_FAIL
;
3627 kernel_wait_quiescent(kernel_tracer_fd
);
3631 usess
->start_trace
= 0;
3633 ret
= ust_app_stop_trace_all(usess
);
3635 ret
= LTTCOMM_UST_STOP_FAIL
;
3647 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
3649 static int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
3650 size_t nb_uri
, struct lttng_uri
*uris
)
3653 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3654 struct ltt_ust_session
*usess
= session
->ust_session
;
3655 struct consumer_output
*consumer
= NULL
;
3661 /* Can't enable consumer after session started. */
3662 if (session
->enabled
) {
3663 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3667 if (!session
->start_consumer
) {
3668 ret
= LTTCOMM_NO_CONSUMER
;
3673 * This case switch makes sure the domain session has a temporary consumer
3674 * so the URL can be set.
3678 /* Code flow error. A session MUST always have a consumer object */
3679 assert(session
->consumer
);
3681 * The URL will be added to the tracing session consumer instead of a
3682 * specific domain consumer.
3684 consumer
= session
->consumer
;
3686 case LTTNG_DOMAIN_KERNEL
:
3687 /* Code flow error if we don't have a kernel session here. */
3690 /* Create consumer output if none exists */
3691 consumer
= ksess
->tmp_consumer
;
3692 if (consumer
== NULL
) {
3693 consumer
= consumer_copy_output(ksess
->consumer
);
3694 if (consumer
== NULL
) {
3695 ret
= LTTCOMM_FATAL
;
3698 /* Trash the consumer subdir, we are about to set a new one. */
3699 memset(consumer
->subdir
, 0, sizeof(consumer
->subdir
));
3700 ksess
->tmp_consumer
= consumer
;
3704 case LTTNG_DOMAIN_UST
:
3705 /* Code flow error if we don't have a kernel session here. */
3708 /* Create consumer output if none exists */
3709 consumer
= usess
->tmp_consumer
;
3710 if (consumer
== NULL
) {
3711 consumer
= consumer_copy_output(usess
->consumer
);
3712 if (consumer
== NULL
) {
3713 ret
= LTTCOMM_FATAL
;
3716 /* Trash the consumer subdir, we are about to set a new one. */
3717 memset(consumer
->subdir
, 0, sizeof(consumer
->subdir
));
3718 usess
->tmp_consumer
= consumer
;
3724 for (i
= 0; i
< nb_uri
; i
++) {
3725 struct consumer_socket
*socket
;
3726 struct lttng_ht_iter iter
;
3728 ret
= add_uri_to_consumer(consumer
, &uris
[i
], domain
, session
->name
);
3734 * Don't send relayd socket if URI is NOT remote or if the relayd
3735 * sockets for the session are already sent.
3737 if (uris
[i
].dtype
== LTTNG_DST_PATH
||
3738 consumer
->dst
.net
.relayd_socks_sent
) {
3742 /* Try to send relayd URI to the consumer if exist. */
3743 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
,
3744 socket
, node
.node
) {
3746 /* A socket in the HT should never have a negative fd */
3747 assert(socket
->fd
>= 0);
3749 pthread_mutex_lock(socket
->lock
);
3750 ret
= send_socket_relayd_consumer(domain
, session
, &uris
[i
],
3751 consumer
, socket
->fd
);
3752 pthread_mutex_unlock(socket
->lock
);
3753 if (ret
!= LTTCOMM_OK
) {
3768 * Command LTTNG_CREATE_SESSION processed by the client thread.
3770 static int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
3771 size_t nb_uri
, lttng_sock_cred
*creds
)
3775 struct ltt_session
*session
;
3780 * Verify if the session already exist
3782 * XXX: There is no need for the session lock list here since the caller
3783 * (process_client_msg) is holding it. We might want to change that so a
3784 * single command does not lock the entire session list.
3786 session
= session_find_by_name(name
);
3787 if (session
!= NULL
) {
3788 ret
= LTTCOMM_EXIST_SESS
;
3792 /* Create tracing session in the registry */
3793 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
3794 LTTNG_SOCK_GET_GID_CRED(creds
));
3795 if (ret
!= LTTCOMM_OK
) {
3800 * Get the newly created session pointer back
3802 * XXX: There is no need for the session lock list here since the caller
3803 * (process_client_msg) is holding it. We might want to change that so a
3804 * single command does not lock the entire session list.
3806 session
= session_find_by_name(name
);
3809 /* Create default consumer output for the session not yet created. */
3810 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
3811 if (session
->consumer
== NULL
) {
3812 ret
= LTTCOMM_FATAL
;
3813 goto consumer_error
;
3817 * This means that the lttng_create_session call was called with the _path_
3818 * argument set to NULL.
3822 * At this point, we'll skip the consumer URI setup and create a
3823 * session with a NULL path which will flag the session to NOT spawn a
3826 DBG("Create session %s with NO uri, skipping consumer setup", name
);
3830 session
->start_consumer
= 1;
3832 ret
= cmd_set_consumer_uri(0, session
, nb_uri
, uris
);
3833 if (ret
!= LTTCOMM_OK
) {
3834 goto consumer_error
;
3837 session
->consumer
->enabled
= 1;
3843 session_destroy(session
);
3850 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3852 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3859 /* Clean kernel session teardown */
3860 teardown_kernel_session(session
);
3861 /* UST session teardown */
3862 teardown_ust_session(session
);
3865 * Must notify the kernel thread here to update it's poll setin order
3866 * to remove the channel(s)' fd just destroyed.
3868 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3870 PERROR("write kernel poll pipe");
3873 ret
= session_destroy(session
);
3879 * Command LTTNG_CALIBRATE processed by the client thread.
3881 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3886 case LTTNG_DOMAIN_KERNEL
:
3888 struct lttng_kernel_calibrate kcalibrate
;
3890 kcalibrate
.type
= calibrate
->type
;
3891 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3893 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3898 case LTTNG_DOMAIN_UST
:
3900 struct lttng_ust_calibrate ucalibrate
;
3902 ucalibrate
.type
= calibrate
->type
;
3903 ret
= ust_app_calibrate_glb(&ucalibrate
);
3905 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3922 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3924 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3928 struct consumer_socket
*socket
;
3931 case LTTNG_DOMAIN_KERNEL
:
3932 /* Can't register a consumer if there is already one */
3933 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3934 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3938 sock
= lttcomm_connect_unix_sock(sock_path
);
3940 ret
= LTTCOMM_CONNECT_FAIL
;
3944 socket
= consumer_allocate_socket(sock
);
3945 if (socket
== NULL
) {
3946 ret
= LTTCOMM_FATAL
;
3951 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3952 if (socket
->lock
== NULL
) {
3953 PERROR("zmalloc pthread mutex");
3954 ret
= LTTCOMM_FATAL
;
3957 pthread_mutex_init(socket
->lock
, NULL
);
3960 consumer_add_socket(socket
, session
->kernel_session
->consumer
);
3963 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3964 kconsumer_data
.pid
= -1;
3965 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3969 /* TODO: Userspace tracing */
3981 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3983 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3984 struct lttng_domain
**domains
)
3989 if (session
->kernel_session
!= NULL
) {
3990 DBG3("Listing domains found kernel domain");
3994 if (session
->ust_session
!= NULL
) {
3995 DBG3("Listing domains found UST global domain");
3999 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
4000 if (*domains
== NULL
) {
4001 ret
= -LTTCOMM_FATAL
;
4005 if (session
->kernel_session
!= NULL
) {
4006 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
4010 if (session
->ust_session
!= NULL
) {
4011 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
4022 * Command LTTNG_LIST_CHANNELS processed by the client thread.
4024 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
4025 struct lttng_channel
**channels
)
4028 ssize_t nb_chan
= 0;
4031 case LTTNG_DOMAIN_KERNEL
:
4032 if (session
->kernel_session
!= NULL
) {
4033 nb_chan
= session
->kernel_session
->channel_count
;
4035 DBG3("Number of kernel channels %zd", nb_chan
);
4037 case LTTNG_DOMAIN_UST
:
4038 if (session
->ust_session
!= NULL
) {
4039 nb_chan
= lttng_ht_get_count(
4040 session
->ust_session
->domain_global
.channels
);
4042 DBG3("Number of UST global channels %zd", nb_chan
);
4051 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
4052 if (*channels
== NULL
) {
4053 ret
= -LTTCOMM_FATAL
;
4057 list_lttng_channels(domain
, session
, *channels
);
4069 * Command LTTNG_LIST_EVENTS processed by the client thread.
4071 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
4072 char *channel_name
, struct lttng_event
**events
)
4075 ssize_t nb_event
= 0;
4078 case LTTNG_DOMAIN_KERNEL
:
4079 if (session
->kernel_session
!= NULL
) {
4080 nb_event
= list_lttng_kernel_events(channel_name
,
4081 session
->kernel_session
, events
);
4084 case LTTNG_DOMAIN_UST
:
4086 if (session
->ust_session
!= NULL
) {
4087 nb_event
= list_lttng_ust_global_events(channel_name
,
4088 &session
->ust_session
->domain_global
, events
);
4104 * Command LTTNG_DISABLE_CONSUMER processed by the client thread.
4106 static int cmd_disable_consumer(int domain
, struct ltt_session
*session
)
4109 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4110 struct ltt_ust_session
*usess
= session
->ust_session
;
4111 struct consumer_output
*consumer
;
4115 if (session
->enabled
) {
4116 /* Can't disable consumer on an already started session */
4117 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4121 if (!session
->start_consumer
) {
4122 ret
= LTTCOMM_NO_CONSUMER
;
4128 DBG("Disable tracing session %s consumer", session
->name
);
4129 consumer
= session
->consumer
;
4131 case LTTNG_DOMAIN_KERNEL
:
4132 /* Code flow error if we don't have a kernel session here. */
4135 DBG("Disabling kernel consumer");
4136 consumer
= ksess
->consumer
;
4139 case LTTNG_DOMAIN_UST
:
4140 /* Code flow error if we don't have a UST session here. */
4143 DBG("Disabling UST consumer");
4144 consumer
= usess
->consumer
;
4148 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
4153 consumer
->enabled
= 0;
4154 /* Success at this point */
4157 ret
= LTTCOMM_NO_CONSUMER
;
4165 * Command LTTNG_ENABLE_CONSUMER processed by the client thread.
4167 static int cmd_enable_consumer(int domain
, struct ltt_session
*session
)
4170 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4171 struct ltt_ust_session
*usess
= session
->ust_session
;
4172 struct consumer_output
*consumer
= NULL
;
4176 /* Can't enable consumer after session started. */
4177 if (session
->enabled
) {
4178 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4182 if (!session
->start_consumer
) {
4183 ret
= LTTCOMM_NO_CONSUMER
;
4189 assert(session
->consumer
);
4190 consumer
= session
->consumer
;
4192 case LTTNG_DOMAIN_KERNEL
:
4193 /* Code flow error if we don't have a kernel session here. */
4197 * Check if we have already sent fds to the consumer. In that case,
4198 * the enable-consumer command can't be used because a start trace
4199 * had previously occured.
4201 if (ksess
->consumer_fds_sent
) {
4202 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4206 consumer
= ksess
->tmp_consumer
;
4207 if (consumer
== NULL
) {
4209 /* No temp. consumer output exists. Using the current one. */
4210 DBG3("No temporary consumer. Using default");
4211 consumer
= ksess
->consumer
;
4215 switch (consumer
->type
) {
4216 case CONSUMER_DST_LOCAL
:
4217 DBG2("Consumer output is local. Creating directory(ies)");
4219 /* Create directory(ies) */
4220 ret
= run_as_mkdir_recursive(consumer
->dst
.trace_path
,
4221 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4223 if (ret
!= -EEXIST
) {
4224 ERR("Trace directory creation error");
4225 ret
= LTTCOMM_FATAL
;
4230 case CONSUMER_DST_NET
:
4231 DBG2("Consumer output is network. Validating URIs");
4232 /* Validate if we have both control and data path set. */
4233 if (!consumer
->dst
.net
.control_isset
) {
4234 ret
= LTTCOMM_URL_CTRL_MISS
;
4238 if (!consumer
->dst
.net
.data_isset
) {
4239 ret
= LTTCOMM_URL_DATA_MISS
;
4243 /* Check established network session state */
4244 if (session
->net_handle
== 0) {
4245 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4246 ERR("Session network handle is not set on enable-consumer");
4253 /* Append default kernel trace dir to subdir */
4254 strncat(ksess
->consumer
->subdir
, DEFAULT_KERNEL_TRACE_DIR
,
4255 sizeof(ksess
->consumer
->subdir
));
4259 * This is race free for now since the session lock is acquired before
4260 * ending up in this function. No other threads can access this kernel
4261 * session without this lock hence freeing the consumer output object
4265 consumer_destroy_output(ksess
->consumer
);
4267 ksess
->consumer
= consumer
;
4268 ksess
->tmp_consumer
= NULL
;
4271 case LTTNG_DOMAIN_UST
:
4272 /* Code flow error if we don't have a UST session here. */
4276 * Check if we have already sent fds to the consumer. In that case,
4277 * the enable-consumer command can't be used because a start trace
4278 * had previously occured.
4280 if (usess
->start_trace
) {
4281 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4285 consumer
= usess
->tmp_consumer
;
4286 if (consumer
== NULL
) {
4288 /* No temp. consumer output exists. Using the current one. */
4289 DBG3("No temporary consumer. Using default");
4290 consumer
= usess
->consumer
;
4294 switch (consumer
->type
) {
4295 case CONSUMER_DST_LOCAL
:
4296 DBG2("Consumer output is local. Creating directory(ies)");
4298 /* Create directory(ies) */
4299 ret
= run_as_mkdir_recursive(consumer
->dst
.trace_path
,
4300 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4302 if (ret
!= -EEXIST
) {
4303 ERR("Trace directory creation error");
4304 ret
= LTTCOMM_FATAL
;
4309 case CONSUMER_DST_NET
:
4310 DBG2("Consumer output is network. Validating URIs");
4311 /* Validate if we have both control and data path set. */
4312 if (!consumer
->dst
.net
.control_isset
) {
4313 ret
= LTTCOMM_URL_CTRL_MISS
;
4317 if (!consumer
->dst
.net
.data_isset
) {
4318 ret
= LTTCOMM_URL_DATA_MISS
;
4322 /* Check established network session state */
4323 if (session
->net_handle
== 0) {
4324 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4325 DBG2("Session network handle is not set on enable-consumer");
4329 if (consumer
->net_seq_index
== -1) {
4330 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4331 DBG2("Network index is not set on the consumer");
4338 /* Append default kernel trace dir to subdir */
4339 strncat(usess
->consumer
->subdir
, DEFAULT_UST_TRACE_DIR
,
4340 sizeof(usess
->consumer
->subdir
));
4344 * This is race free for now since the session lock is acquired before
4345 * ending up in this function. No other threads can access this kernel
4346 * session without this lock hence freeing the consumer output object
4350 consumer_destroy_output(usess
->consumer
);
4352 usess
->consumer
= consumer
;
4353 usess
->tmp_consumer
= NULL
;
4360 consumer
->enabled
= 1;
4361 /* Success at this point */
4364 /* Should not really happend... */
4365 ret
= LTTCOMM_NO_CONSUMER
;
4373 * Process the command requested by the lttng client within the command
4374 * context structure. This function make sure that the return structure (llm)
4375 * is set and ready for transmission before returning.
4377 * Return any error encountered or 0 for success.
4379 * "sock" is only used for special-case var. len data.
4381 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
4384 int ret
= LTTCOMM_OK
;
4385 int need_tracing_session
= 1;
4388 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
4392 switch (cmd_ctx
->lsm
->cmd_type
) {
4393 case LTTNG_CREATE_SESSION
:
4394 case LTTNG_DESTROY_SESSION
:
4395 case LTTNG_LIST_SESSIONS
:
4396 case LTTNG_LIST_DOMAINS
:
4397 case LTTNG_START_TRACE
:
4398 case LTTNG_STOP_TRACE
:
4405 if (opt_no_kernel
&& need_domain
4406 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
4408 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4410 ret
= LTTCOMM_KERN_NA
;
4415 /* Deny register consumer if we already have a spawned consumer. */
4416 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
4417 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
4418 if (kconsumer_data
.pid
> 0) {
4419 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
4422 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4426 * Check for command that don't needs to allocate a returned payload. We do
4427 * this here so we don't have to make the call for no payload at each
4430 switch(cmd_ctx
->lsm
->cmd_type
) {
4431 case LTTNG_LIST_SESSIONS
:
4432 case LTTNG_LIST_TRACEPOINTS
:
4433 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4434 case LTTNG_LIST_DOMAINS
:
4435 case LTTNG_LIST_CHANNELS
:
4436 case LTTNG_LIST_EVENTS
:
4439 /* Setup lttng message with no payload */
4440 ret
= setup_lttng_msg(cmd_ctx
, 0);
4442 /* This label does not try to unlock the session */
4443 goto init_setup_error
;
4447 /* Commands that DO NOT need a session. */
4448 switch (cmd_ctx
->lsm
->cmd_type
) {
4449 case LTTNG_CREATE_SESSION
:
4450 case LTTNG_CALIBRATE
:
4451 case LTTNG_LIST_SESSIONS
:
4452 case LTTNG_LIST_TRACEPOINTS
:
4453 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4454 need_tracing_session
= 0;
4457 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
4459 * We keep the session list lock across _all_ commands
4460 * for now, because the per-session lock does not
4461 * handle teardown properly.
4463 session_lock_list();
4464 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
4465 if (cmd_ctx
->session
== NULL
) {
4466 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
4467 ret
= LTTCOMM_SESS_NOT_FOUND
;
4469 /* If no session name specified */
4470 ret
= LTTCOMM_SELECT_SESS
;
4474 /* Acquire lock for the session */
4475 session_lock(cmd_ctx
->session
);
4485 * Check domain type for specific "pre-action".
4487 switch (cmd_ctx
->lsm
->domain
.type
) {
4488 case LTTNG_DOMAIN_KERNEL
:
4490 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4494 /* Kernel tracer check */
4495 if (kernel_tracer_fd
== -1) {
4496 /* Basically, load kernel tracer modules */
4497 ret
= init_kernel_tracer();
4503 /* Consumer is in an ERROR state. Report back to client */
4504 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
4505 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4509 /* Need a session for kernel command */
4510 if (need_tracing_session
) {
4511 if (cmd_ctx
->session
->kernel_session
== NULL
) {
4512 ret
= create_kernel_session(cmd_ctx
->session
);
4514 ret
= LTTCOMM_KERN_SESS_FAIL
;
4519 /* Start the kernel consumer daemon */
4520 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
4521 if (kconsumer_data
.pid
== 0 &&
4522 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4523 cmd_ctx
->session
->start_consumer
) {
4524 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4525 ret
= start_consumerd(&kconsumer_data
);
4527 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
4530 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
4532 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4536 * The consumer was just spawned so we need to add the socket to
4537 * the consumer output of the session if exist.
4539 ret
= consumer_create_socket(&kconsumer_data
,
4540 cmd_ctx
->session
->kernel_session
->consumer
);
4547 case LTTNG_DOMAIN_UST
:
4549 /* Consumer is in an ERROR state. Report back to client */
4550 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
4551 ret
= LTTCOMM_NO_USTCONSUMERD
;
4555 if (need_tracing_session
) {
4556 /* Create UST session if none exist. */
4557 if (cmd_ctx
->session
->ust_session
== NULL
) {
4558 ret
= create_ust_session(cmd_ctx
->session
,
4559 &cmd_ctx
->lsm
->domain
);
4560 if (ret
!= LTTCOMM_OK
) {
4565 /* Start the UST consumer daemons */
4567 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
4568 if (consumerd64_bin
[0] != '\0' &&
4569 ustconsumer64_data
.pid
== 0 &&
4570 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4571 cmd_ctx
->session
->start_consumer
) {
4572 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4573 ret
= start_consumerd(&ustconsumer64_data
);
4575 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
4576 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
4580 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
4581 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4583 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4587 * Setup socket for consumer 64 bit. No need for atomic access
4588 * since it was set above and can ONLY be set in this thread.
4590 ret
= consumer_create_socket(&ustconsumer64_data
,
4591 cmd_ctx
->session
->ust_session
->consumer
);
4597 if (consumerd32_bin
[0] != '\0' &&
4598 ustconsumer32_data
.pid
== 0 &&
4599 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4600 cmd_ctx
->session
->start_consumer
) {
4601 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4602 ret
= start_consumerd(&ustconsumer32_data
);
4604 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
4605 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
4609 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
4610 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4612 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4616 * Setup socket for consumer 64 bit. No need for atomic access
4617 * since it was set above and can ONLY be set in this thread.
4619 ret
= consumer_create_socket(&ustconsumer32_data
,
4620 cmd_ctx
->session
->ust_session
->consumer
);
4632 /* Validate consumer daemon state when start/stop trace command */
4633 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
4634 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
4635 switch (cmd_ctx
->lsm
->domain
.type
) {
4636 case LTTNG_DOMAIN_UST
:
4637 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
4638 ret
= LTTCOMM_NO_USTCONSUMERD
;
4642 case LTTNG_DOMAIN_KERNEL
:
4643 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
4644 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4652 * Check that the UID or GID match that of the tracing session.
4653 * The root user can interact with all sessions.
4655 if (need_tracing_session
) {
4656 if (!session_access_ok(cmd_ctx
->session
,
4657 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4658 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
4659 ret
= LTTCOMM_EPERM
;
4664 /* Process by command type */
4665 switch (cmd_ctx
->lsm
->cmd_type
) {
4666 case LTTNG_ADD_CONTEXT
:
4668 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4669 cmd_ctx
->lsm
->u
.context
.channel_name
,
4670 cmd_ctx
->lsm
->u
.context
.event_name
,
4671 &cmd_ctx
->lsm
->u
.context
.ctx
);
4674 case LTTNG_DISABLE_CHANNEL
:
4676 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4677 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4680 case LTTNG_DISABLE_EVENT
:
4682 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4683 cmd_ctx
->lsm
->u
.disable
.channel_name
,
4684 cmd_ctx
->lsm
->u
.disable
.name
);
4687 case LTTNG_DISABLE_ALL_EVENT
:
4689 DBG("Disabling all events");
4691 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4692 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4695 case LTTNG_DISABLE_CONSUMER
:
4697 ret
= cmd_disable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4700 case LTTNG_ENABLE_CHANNEL
:
4702 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4703 &cmd_ctx
->lsm
->u
.channel
.chan
);
4706 case LTTNG_ENABLE_CONSUMER
:
4709 * XXX: 0 means that this URI should be applied on the session. Should
4710 * be a DOMAIN enuam.
4712 ret
= cmd_enable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4713 if (ret
!= LTTCOMM_OK
) {
4717 if (cmd_ctx
->lsm
->domain
.type
== 0) {
4718 /* Add the URI for the UST session if a consumer is present. */
4719 if (cmd_ctx
->session
->ust_session
&&
4720 cmd_ctx
->session
->ust_session
->consumer
) {
4721 ret
= cmd_enable_consumer(LTTNG_DOMAIN_UST
, cmd_ctx
->session
);
4722 } else if (cmd_ctx
->session
->kernel_session
&&
4723 cmd_ctx
->session
->kernel_session
->consumer
) {
4724 ret
= cmd_enable_consumer(LTTNG_DOMAIN_KERNEL
,
4730 case LTTNG_ENABLE_EVENT
:
4732 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4733 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4734 &cmd_ctx
->lsm
->u
.enable
.event
);
4737 case LTTNG_ENABLE_ALL_EVENT
:
4739 DBG("Enabling all events");
4741 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4742 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4743 cmd_ctx
->lsm
->u
.enable
.event
.type
);
4746 case LTTNG_LIST_TRACEPOINTS
:
4748 struct lttng_event
*events
;
4751 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
4752 if (nb_events
< 0) {
4758 * Setup lttng message with payload size set to the event list size in
4759 * bytes and then copy list into the llm payload.
4761 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
4767 /* Copy event list into message payload */
4768 memcpy(cmd_ctx
->llm
->payload
, events
,
4769 sizeof(struct lttng_event
) * nb_events
);
4776 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4778 struct lttng_event_field
*fields
;
4781 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
4783 if (nb_fields
< 0) {
4789 * Setup lttng message with payload size set to the event list size in
4790 * bytes and then copy list into the llm payload.
4792 ret
= setup_lttng_msg(cmd_ctx
,
4793 sizeof(struct lttng_event_field
) * nb_fields
);
4799 /* Copy event list into message payload */
4800 memcpy(cmd_ctx
->llm
->payload
, fields
,
4801 sizeof(struct lttng_event_field
) * nb_fields
);
4808 case LTTNG_SET_CONSUMER_URI
:
4811 struct lttng_uri
*uris
;
4813 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4814 len
= nb_uri
* sizeof(struct lttng_uri
);
4817 ret
= LTTCOMM_INVALID
;
4821 uris
= zmalloc(len
);
4823 ret
= LTTCOMM_FATAL
;
4827 /* Receive variable len data */
4828 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
4829 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4831 DBG("No URIs received from client... continuing");
4833 ret
= LTTCOMM_SESSION_FAIL
;
4837 ret
= cmd_set_consumer_uri(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4839 if (ret
!= LTTCOMM_OK
) {
4844 * XXX: 0 means that this URI should be applied on the session. Should
4845 * be a DOMAIN enuam.
4847 if (cmd_ctx
->lsm
->domain
.type
== 0) {
4848 /* Add the URI for the UST session if a consumer is present. */
4849 if (cmd_ctx
->session
->ust_session
&&
4850 cmd_ctx
->session
->ust_session
->consumer
) {
4851 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_UST
, cmd_ctx
->session
,
4853 } else if (cmd_ctx
->session
->kernel_session
&&
4854 cmd_ctx
->session
->kernel_session
->consumer
) {
4855 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_KERNEL
,
4856 cmd_ctx
->session
, nb_uri
, uris
);
4862 case LTTNG_START_TRACE
:
4864 ret
= cmd_start_trace(cmd_ctx
->session
);
4867 case LTTNG_STOP_TRACE
:
4869 ret
= cmd_stop_trace(cmd_ctx
->session
);
4872 case LTTNG_CREATE_SESSION
:
4875 struct lttng_uri
*uris
= NULL
;
4877 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4878 len
= nb_uri
* sizeof(struct lttng_uri
);
4881 uris
= zmalloc(len
);
4883 ret
= LTTCOMM_FATAL
;
4887 /* Receive variable len data */
4888 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4889 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4891 DBG("No URIs received from client... continuing");
4893 ret
= LTTCOMM_SESSION_FAIL
;
4897 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4898 DBG("Creating session with ONE network URI is a bad call");
4899 ret
= LTTCOMM_SESSION_FAIL
;
4904 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
4909 case LTTNG_DESTROY_SESSION
:
4911 ret
= cmd_destroy_session(cmd_ctx
->session
,
4912 cmd_ctx
->lsm
->session
.name
);
4914 /* Set session to NULL so we do not unlock it after free. */
4915 cmd_ctx
->session
= NULL
;
4918 case LTTNG_LIST_DOMAINS
:
4921 struct lttng_domain
*domains
;
4923 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
4929 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
4934 /* Copy event list into message payload */
4935 memcpy(cmd_ctx
->llm
->payload
, domains
,
4936 nb_dom
* sizeof(struct lttng_domain
));
4943 case LTTNG_LIST_CHANNELS
:
4946 struct lttng_channel
*channels
;
4948 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
4949 cmd_ctx
->session
, &channels
);
4955 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
4960 /* Copy event list into message payload */
4961 memcpy(cmd_ctx
->llm
->payload
, channels
,
4962 nb_chan
* sizeof(struct lttng_channel
));
4969 case LTTNG_LIST_EVENTS
:
4972 struct lttng_event
*events
= NULL
;
4974 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4975 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
4981 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
4986 /* Copy event list into message payload */
4987 memcpy(cmd_ctx
->llm
->payload
, events
,
4988 nb_event
* sizeof(struct lttng_event
));
4995 case LTTNG_LIST_SESSIONS
:
4997 unsigned int nr_sessions
;
4999 session_lock_list();
5000 nr_sessions
= lttng_sessions_count(
5001 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
5002 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
5004 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
5006 session_unlock_list();
5010 /* Filled the session array */
5011 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
5012 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
5013 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
5015 session_unlock_list();
5020 case LTTNG_CALIBRATE
:
5022 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
5023 &cmd_ctx
->lsm
->u
.calibrate
);
5026 case LTTNG_REGISTER_CONSUMER
:
5028 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
5029 cmd_ctx
->lsm
->u
.reg
.path
);
5032 case LTTNG_SET_FILTER
:
5034 struct lttng_filter_bytecode
*bytecode
;
5036 if (cmd_ctx
->lsm
->u
.filter
.bytecode_len
> 65336) {
5037 ret
= LTTCOMM_FILTER_INVAL
;
5040 bytecode
= zmalloc(cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
5042 ret
= LTTCOMM_FILTER_NOMEM
;
5045 /* Receive var. len. data */
5046 DBG("Receiving var len data from client ...");
5047 ret
= lttcomm_recv_unix_sock(sock
, bytecode
,
5048 cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
5050 DBG("Nothing recv() from client var len data... continuing");
5052 ret
= LTTCOMM_FILTER_INVAL
;
5056 if (bytecode
->len
+ sizeof(*bytecode
)
5057 != cmd_ctx
->lsm
->u
.filter
.bytecode_len
) {
5059 ret
= LTTCOMM_FILTER_INVAL
;
5063 ret
= cmd_set_filter(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
5064 cmd_ctx
->lsm
->u
.filter
.channel_name
,
5065 cmd_ctx
->lsm
->u
.filter
.event_name
,
5075 if (cmd_ctx
->llm
== NULL
) {
5076 DBG("Missing llm structure. Allocating one.");
5077 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
5081 /* Set return code */
5082 cmd_ctx
->llm
->ret_code
= ret
;
5084 if (cmd_ctx
->session
) {
5085 session_unlock(cmd_ctx
->session
);
5087 if (need_tracing_session
) {
5088 session_unlock_list();
5095 * Thread managing health check socket.
5097 static void *thread_manage_health(void *data
)
5099 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
5100 uint32_t revents
, nb_fd
;
5101 struct lttng_poll_event events
;
5102 struct lttcomm_health_msg msg
;
5103 struct lttcomm_health_data reply
;
5105 DBG("[thread] Manage health check started");
5107 rcu_register_thread();
5109 /* Create unix socket */
5110 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
5112 ERR("Unable to create health check Unix socket");
5117 ret
= lttcomm_listen_unix_sock(sock
);
5123 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5124 * more will be added to this poll set.
5126 ret
= create_thread_poll_set(&events
, 2);
5131 /* Add the application registration socket */
5132 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
5138 DBG("Health check ready");
5140 nb_fd
= LTTNG_POLL_GETNB(&events
);
5142 /* Inifinite blocking call, waiting for transmission */
5144 ret
= lttng_poll_wait(&events
, -1);
5147 * Restart interrupted system call.
5149 if (errno
== EINTR
) {
5155 for (i
= 0; i
< nb_fd
; i
++) {
5156 /* Fetch once the poll data */
5157 revents
= LTTNG_POLL_GETEV(&events
, i
);
5158 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5160 /* Thread quit pipe has been closed. Killing thread. */
5161 ret
= check_thread_quit_pipe(pollfd
, revents
);
5167 /* Event on the registration socket */
5168 if (pollfd
== sock
) {
5169 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5170 ERR("Health socket poll error");
5176 new_sock
= lttcomm_accept_unix_sock(sock
);
5181 DBG("Receiving data from client for health...");
5182 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
5184 DBG("Nothing recv() from client... continuing");
5185 ret
= close(new_sock
);
5193 rcu_thread_online();
5195 switch (msg
.component
) {
5196 case LTTNG_HEALTH_CMD
:
5197 reply
.ret_code
= health_check_state(&health_thread_cmd
);
5199 case LTTNG_HEALTH_APP_MANAGE
:
5200 reply
.ret_code
= health_check_state(&health_thread_app_manage
);
5202 case LTTNG_HEALTH_APP_REG
:
5203 reply
.ret_code
= health_check_state(&health_thread_app_reg
);
5205 case LTTNG_HEALTH_KERNEL
:
5206 reply
.ret_code
= health_check_state(&health_thread_kernel
);
5208 case LTTNG_HEALTH_CONSUMER
:
5209 reply
.ret_code
= check_consumer_health();
5211 case LTTNG_HEALTH_ALL
:
5213 health_check_state(&health_thread_app_manage
) &&
5214 health_check_state(&health_thread_app_reg
) &&
5215 health_check_state(&health_thread_cmd
) &&
5216 health_check_state(&health_thread_kernel
) &&
5217 check_consumer_health();
5220 reply
.ret_code
= LTTCOMM_UND
;
5225 * Flip ret value since 0 is a success and 1 indicates a bad health for
5226 * the client where in the sessiond it is the opposite. Again, this is
5227 * just to make things easier for us poor developer which enjoy a lot
5230 if (reply
.ret_code
== 0 || reply
.ret_code
== 1) {
5231 reply
.ret_code
= !reply
.ret_code
;
5234 DBG2("Health check return value %d", reply
.ret_code
);
5236 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
5238 ERR("Failed to send health data back to client");
5241 /* End of transmission */
5242 ret
= close(new_sock
);
5252 ERR("Health error occurred in %s", __func__
);
5254 DBG("Health check thread dying");
5255 unlink(health_unix_sock_path
);
5262 if (new_sock
>= 0) {
5263 ret
= close(new_sock
);
5269 lttng_poll_clean(&events
);
5271 rcu_unregister_thread();
5276 * This thread manage all clients request using the unix client socket for
5279 static void *thread_manage_clients(void *data
)
5281 int sock
= -1, ret
, i
, pollfd
, err
= -1;
5283 uint32_t revents
, nb_fd
;
5284 struct command_ctx
*cmd_ctx
= NULL
;
5285 struct lttng_poll_event events
;
5287 DBG("[thread] Manage client started");
5289 rcu_register_thread();
5291 health_code_update(&health_thread_cmd
);
5293 ret
= lttcomm_listen_unix_sock(client_sock
);
5299 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5300 * more will be added to this poll set.
5302 ret
= create_thread_poll_set(&events
, 2);
5307 /* Add the application registration socket */
5308 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
5314 * Notify parent pid that we are ready to accept command for client side.
5316 if (opt_sig_parent
) {
5317 kill(ppid
, SIGUSR1
);
5320 health_code_update(&health_thread_cmd
);
5323 DBG("Accepting client command ...");
5325 nb_fd
= LTTNG_POLL_GETNB(&events
);
5327 /* Inifinite blocking call, waiting for transmission */
5329 health_poll_update(&health_thread_cmd
);
5330 ret
= lttng_poll_wait(&events
, -1);
5331 health_poll_update(&health_thread_cmd
);
5334 * Restart interrupted system call.
5336 if (errno
== EINTR
) {
5342 for (i
= 0; i
< nb_fd
; i
++) {
5343 /* Fetch once the poll data */
5344 revents
= LTTNG_POLL_GETEV(&events
, i
);
5345 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5347 health_code_update(&health_thread_cmd
);
5349 /* Thread quit pipe has been closed. Killing thread. */
5350 ret
= check_thread_quit_pipe(pollfd
, revents
);
5356 /* Event on the registration socket */
5357 if (pollfd
== client_sock
) {
5358 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5359 ERR("Client socket poll error");
5365 DBG("Wait for client response");
5367 health_code_update(&health_thread_cmd
);
5369 sock
= lttcomm_accept_unix_sock(client_sock
);
5374 /* Set socket option for credentials retrieval */
5375 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
5380 /* Allocate context command to process the client request */
5381 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
5382 if (cmd_ctx
== NULL
) {
5383 PERROR("zmalloc cmd_ctx");
5387 /* Allocate data buffer for reception */
5388 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
5389 if (cmd_ctx
->lsm
== NULL
) {
5390 PERROR("zmalloc cmd_ctx->lsm");
5394 cmd_ctx
->llm
= NULL
;
5395 cmd_ctx
->session
= NULL
;
5397 health_code_update(&health_thread_cmd
);
5400 * Data is received from the lttng client. The struct
5401 * lttcomm_session_msg (lsm) contains the command and data request of
5404 DBG("Receiving data from client ...");
5405 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
5406 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
5408 DBG("Nothing recv() from client... continuing");
5414 clean_command_ctx(&cmd_ctx
);
5418 health_code_update(&health_thread_cmd
);
5420 // TODO: Validate cmd_ctx including sanity check for
5421 // security purpose.
5423 rcu_thread_online();
5425 * This function dispatch the work to the kernel or userspace tracer
5426 * libs and fill the lttcomm_lttng_msg data structure of all the needed
5427 * informations for the client. The command context struct contains
5428 * everything this function may needs.
5430 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
5431 rcu_thread_offline();
5441 * TODO: Inform client somehow of the fatal error. At
5442 * this point, ret < 0 means that a zmalloc failed
5443 * (ENOMEM). Error detected but still accept
5444 * command, unless a socket error has been
5447 clean_command_ctx(&cmd_ctx
);
5451 health_code_update(&health_thread_cmd
);
5453 DBG("Sending response (size: %d, retcode: %s)",
5454 cmd_ctx
->lttng_msg_size
,
5455 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
5456 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
5458 ERR("Failed to send data back to client");
5461 /* End of transmission */
5468 clean_command_ctx(&cmd_ctx
);
5470 health_code_update(&health_thread_cmd
);
5476 health_error(&health_thread_cmd
);
5477 ERR("Health error occurred in %s", __func__
);
5479 health_exit(&health_thread_cmd
);
5481 DBG("Client thread dying");
5482 unlink(client_unix_sock_path
);
5483 if (client_sock
>= 0) {
5484 ret
= close(client_sock
);
5496 lttng_poll_clean(&events
);
5497 clean_command_ctx(&cmd_ctx
);
5499 rcu_unregister_thread();
5505 * usage function on stderr
5507 static void usage(void)
5509 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
5510 fprintf(stderr
, " -h, --help Display this usage.\n");
5511 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
5512 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
5513 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
5514 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
5515 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
5516 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
5517 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
5518 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
5519 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
5520 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
5521 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
5522 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
5523 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
5524 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
5525 fprintf(stderr
, " -V, --version Show version number.\n");
5526 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
5527 fprintf(stderr
, " -q, --quiet No output at all.\n");
5528 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
5529 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
5530 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
5534 * daemon argument parsing
5536 static int parse_args(int argc
, char **argv
)
5540 static struct option long_options
[] = {
5541 { "client-sock", 1, 0, 'c' },
5542 { "apps-sock", 1, 0, 'a' },
5543 { "kconsumerd-cmd-sock", 1, 0, 'C' },
5544 { "kconsumerd-err-sock", 1, 0, 'E' },
5545 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
5546 { "ustconsumerd32-err-sock", 1, 0, 'H' },
5547 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
5548 { "ustconsumerd64-err-sock", 1, 0, 'F' },
5549 { "consumerd32-path", 1, 0, 'u' },
5550 { "consumerd32-libdir", 1, 0, 'U' },
5551 { "consumerd64-path", 1, 0, 't' },
5552 { "consumerd64-libdir", 1, 0, 'T' },
5553 { "daemonize", 0, 0, 'd' },
5554 { "sig-parent", 0, 0, 'S' },
5555 { "help", 0, 0, 'h' },
5556 { "group", 1, 0, 'g' },
5557 { "version", 0, 0, 'V' },
5558 { "quiet", 0, 0, 'q' },
5559 { "verbose", 0, 0, 'v' },
5560 { "verbose-consumer", 0, 0, 'Z' },
5561 { "no-kernel", 0, 0, 'N' },
5566 int option_index
= 0;
5567 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
5568 long_options
, &option_index
);
5575 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
5577 fprintf(stderr
, " with arg %s\n", optarg
);
5581 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5584 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5590 opt_tracing_group
= optarg
;
5596 fprintf(stdout
, "%s\n", VERSION
);
5602 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5605 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5608 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5611 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5614 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5617 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5623 lttng_opt_quiet
= 1;
5626 /* Verbose level can increase using multiple -v */
5627 lttng_opt_verbose
+= 1;
5630 opt_verbose_consumer
+= 1;
5633 consumerd32_bin
= optarg
;
5636 consumerd32_libdir
= optarg
;
5639 consumerd64_bin
= optarg
;
5642 consumerd64_libdir
= optarg
;
5645 /* Unknown option or other error.
5646 * Error is printed by getopt, just return */
5655 * Creates the two needed socket by the daemon.
5656 * apps_sock - The communication socket for all UST apps.
5657 * client_sock - The communication of the cli tool (lttng).
5659 static int init_daemon_socket(void)
5664 old_umask
= umask(0);
5666 /* Create client tool unix socket */
5667 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5668 if (client_sock
< 0) {
5669 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5674 /* File permission MUST be 660 */
5675 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5677 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5682 /* Create the application unix socket */
5683 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5684 if (apps_sock
< 0) {
5685 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5690 /* File permission MUST be 666 */
5691 ret
= chmod(apps_unix_sock_path
,
5692 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5694 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5705 * Check if the global socket is available, and if a daemon is answering at the
5706 * other side. If yes, error is returned.
5708 static int check_existing_daemon(void)
5710 /* Is there anybody out there ? */
5711 if (lttng_session_daemon_alive()) {
5719 * Set the tracing group gid onto the client socket.
5721 * Race window between mkdir and chown is OK because we are going from more
5722 * permissive (root.root) to less permissive (root.tracing).
5724 static int set_permissions(char *rundir
)
5729 ret
= allowed_group();
5731 WARN("No tracing group detected");
5738 /* Set lttng run dir */
5739 ret
= chown(rundir
, 0, gid
);
5741 ERR("Unable to set group on %s", rundir
);
5745 /* Ensure tracing group can search the run dir */
5746 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
5748 ERR("Unable to set permissions on %s", rundir
);
5752 /* lttng client socket path */
5753 ret
= chown(client_unix_sock_path
, 0, gid
);
5755 ERR("Unable to set group on %s", client_unix_sock_path
);
5759 /* kconsumer error socket path */
5760 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
5762 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5766 /* 64-bit ustconsumer error socket path */
5767 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
5769 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5773 /* 32-bit ustconsumer compat32 error socket path */
5774 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
5776 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5780 DBG("All permissions are set");
5787 * Create the lttng run directory needed for all global sockets and pipe.
5789 static int create_lttng_rundir(const char *rundir
)
5793 DBG3("Creating LTTng run directory: %s", rundir
);
5795 ret
= mkdir(rundir
, S_IRWXU
);
5797 if (errno
!= EEXIST
) {
5798 ERR("Unable to create %s", rundir
);
5810 * Setup sockets and directory needed by the kconsumerd communication with the
5813 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5817 char path
[PATH_MAX
];
5819 switch (consumer_data
->type
) {
5820 case LTTNG_CONSUMER_KERNEL
:
5821 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5823 case LTTNG_CONSUMER64_UST
:
5824 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5826 case LTTNG_CONSUMER32_UST
:
5827 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5830 ERR("Consumer type unknown");
5835 DBG2("Creating consumer directory: %s", path
);
5837 ret
= mkdir(path
, S_IRWXU
);
5839 if (errno
!= EEXIST
) {
5841 ERR("Failed to create %s", path
);
5847 /* Create the kconsumerd error unix socket */
5848 consumer_data
->err_sock
=
5849 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5850 if (consumer_data
->err_sock
< 0) {
5851 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5856 /* File permission MUST be 660 */
5857 ret
= chmod(consumer_data
->err_unix_sock_path
,
5858 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5860 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5870 * Signal handler for the daemon
5872 * Simply stop all worker threads, leaving main() return gracefully after
5873 * joining all threads and calling cleanup().
5875 static void sighandler(int sig
)
5879 DBG("SIGPIPE caught");
5882 DBG("SIGINT caught");
5886 DBG("SIGTERM caught");
5895 * Setup signal handler for :
5896 * SIGINT, SIGTERM, SIGPIPE
5898 static int set_signal_handler(void)
5901 struct sigaction sa
;
5904 if ((ret
= sigemptyset(&sigset
)) < 0) {
5905 PERROR("sigemptyset");
5909 sa
.sa_handler
= sighandler
;
5910 sa
.sa_mask
= sigset
;
5912 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5913 PERROR("sigaction");
5917 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5918 PERROR("sigaction");
5922 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5923 PERROR("sigaction");
5927 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
5933 * Set open files limit to unlimited. This daemon can open a large number of
5934 * file descriptors in order to consumer multiple kernel traces.
5936 static void set_ulimit(void)
5941 /* The kernel does not allowed an infinite limit for open files */
5942 lim
.rlim_cur
= 65535;
5943 lim
.rlim_max
= 65535;
5945 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5947 PERROR("failed to set open files limit");
5954 int main(int argc
, char **argv
)
5958 const char *home_path
;
5960 init_kernel_workarounds();
5962 rcu_register_thread();
5964 setup_consumerd_path();
5966 /* Parse arguments */
5968 if ((ret
= parse_args(argc
, argv
) < 0)) {
5978 * child: setsid, close FD 0, 1, 2, chdir /
5979 * parent: exit (if fork is successful)
5987 * We are in the child. Make sure all other file
5988 * descriptors are closed, in case we are called with
5989 * more opened file descriptors than the standard ones.
5991 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5996 /* Create thread quit pipe */
5997 if ((ret
= init_thread_quit_pipe()) < 0) {
6001 /* Check if daemon is UID = 0 */
6002 is_root
= !getuid();
6005 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
6007 /* Create global run dir with root access */
6008 ret
= create_lttng_rundir(rundir
);
6013 if (strlen(apps_unix_sock_path
) == 0) {
6014 snprintf(apps_unix_sock_path
, PATH_MAX
,
6015 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
6018 if (strlen(client_unix_sock_path
) == 0) {
6019 snprintf(client_unix_sock_path
, PATH_MAX
,
6020 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
6023 /* Set global SHM for ust */
6024 if (strlen(wait_shm_path
) == 0) {
6025 snprintf(wait_shm_path
, PATH_MAX
,
6026 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
6029 if (strlen(health_unix_sock_path
) == 0) {
6030 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
6031 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
6034 /* Setup kernel consumerd path */
6035 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
6036 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
6037 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
6038 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
6040 DBG2("Kernel consumer err path: %s",
6041 kconsumer_data
.err_unix_sock_path
);
6042 DBG2("Kernel consumer cmd path: %s",
6043 kconsumer_data
.cmd_unix_sock_path
);
6045 home_path
= get_home_dir();
6046 if (home_path
== NULL
) {
6047 /* TODO: Add --socket PATH option */
6048 ERR("Can't get HOME directory for sockets creation.");
6054 * Create rundir from home path. This will create something like
6057 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
6063 ret
= create_lttng_rundir(rundir
);
6068 if (strlen(apps_unix_sock_path
) == 0) {
6069 snprintf(apps_unix_sock_path
, PATH_MAX
,
6070 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
6073 /* Set the cli tool unix socket path */
6074 if (strlen(client_unix_sock_path
) == 0) {
6075 snprintf(client_unix_sock_path
, PATH_MAX
,
6076 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
6079 /* Set global SHM for ust */
6080 if (strlen(wait_shm_path
) == 0) {
6081 snprintf(wait_shm_path
, PATH_MAX
,
6082 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
6085 /* Set health check Unix path */
6086 if (strlen(health_unix_sock_path
) == 0) {
6087 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
6088 DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
6092 /* Set consumer initial state */
6093 kernel_consumerd_state
= CONSUMER_STOPPED
;
6094 ust_consumerd_state
= CONSUMER_STOPPED
;
6096 DBG("Client socket path %s", client_unix_sock_path
);
6097 DBG("Application socket path %s", apps_unix_sock_path
);
6098 DBG("LTTng run directory path: %s", rundir
);
6100 /* 32 bits consumerd path setup */
6101 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
6102 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
6103 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
6104 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
6106 DBG2("UST consumer 32 bits err path: %s",
6107 ustconsumer32_data
.err_unix_sock_path
);
6108 DBG2("UST consumer 32 bits cmd path: %s",
6109 ustconsumer32_data
.cmd_unix_sock_path
);
6111 /* 64 bits consumerd path setup */
6112 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
6113 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
6114 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
6115 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
6117 DBG2("UST consumer 64 bits err path: %s",
6118 ustconsumer64_data
.err_unix_sock_path
);
6119 DBG2("UST consumer 64 bits cmd path: %s",
6120 ustconsumer64_data
.cmd_unix_sock_path
);
6123 * See if daemon already exist.
6125 if ((ret
= check_existing_daemon()) < 0) {
6126 ERR("Already running daemon.\n");
6128 * We do not goto exit because we must not cleanup()
6129 * because a daemon is already running.
6135 * Init UST app hash table. Alloc hash table before this point since
6136 * cleanup() can get called after that point.
6140 /* After this point, we can safely call cleanup() with "goto exit" */
6143 * These actions must be executed as root. We do that *after* setting up
6144 * the sockets path because we MUST make the check for another daemon using
6145 * those paths *before* trying to set the kernel consumer sockets and init
6149 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
6154 /* Setup kernel tracer */
6155 if (!opt_no_kernel
) {
6156 init_kernel_tracer();
6159 /* Set ulimit for open files */
6162 /* init lttng_fd tracking must be done after set_ulimit. */
6165 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
6170 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
6175 if ((ret
= set_signal_handler()) < 0) {
6179 /* Setup the needed unix socket */
6180 if ((ret
= init_daemon_socket()) < 0) {
6184 /* Set credentials to socket */
6185 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
6189 /* Get parent pid if -S, --sig-parent is specified. */
6190 if (opt_sig_parent
) {
6194 /* Setup the kernel pipe for waking up the kernel thread */
6195 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
6199 /* Setup the thread apps communication pipe. */
6200 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
6204 /* Init UST command queue. */
6205 cds_wfq_init(&ust_cmd_queue
.queue
);
6208 * Get session list pointer. This pointer MUST NOT be free(). This list is
6209 * statically declared in session.c
6211 session_list_ptr
= session_get_list();
6213 /* Set up max poll set size */
6214 lttng_poll_set_max_size();
6217 * Set network sequence index to 1 for streams to match a relayd socket on
6218 * the consumer side.
6220 uatomic_set(&relayd_net_seq_idx
, 1);
6222 /* Init all health thread counters. */
6223 health_init(&health_thread_cmd
);
6224 health_init(&health_thread_kernel
);
6225 health_init(&health_thread_app_manage
);
6226 health_init(&health_thread_app_reg
);
6229 * Init health counters of the consumer thread. We do a quick hack here to
6230 * the state of the consumer health is fine even if the thread is not
6231 * started. This is simply to ease our life and has no cost what so ever.
6233 health_init(&kconsumer_data
.health
);
6234 health_poll_update(&kconsumer_data
.health
);
6235 health_init(&ustconsumer32_data
.health
);
6236 health_poll_update(&ustconsumer32_data
.health
);
6237 health_init(&ustconsumer64_data
.health
);
6238 health_poll_update(&ustconsumer64_data
.health
);
6240 /* Create thread to manage the client socket */
6241 ret
= pthread_create(&health_thread
, NULL
,
6242 thread_manage_health
, (void *) NULL
);
6244 PERROR("pthread_create health");
6248 /* Create thread to manage the client socket */
6249 ret
= pthread_create(&client_thread
, NULL
,
6250 thread_manage_clients
, (void *) NULL
);
6252 PERROR("pthread_create clients");
6256 /* Create thread to dispatch registration */
6257 ret
= pthread_create(&dispatch_thread
, NULL
,
6258 thread_dispatch_ust_registration
, (void *) NULL
);
6260 PERROR("pthread_create dispatch");
6264 /* Create thread to manage application registration. */
6265 ret
= pthread_create(®_apps_thread
, NULL
,
6266 thread_registration_apps
, (void *) NULL
);
6268 PERROR("pthread_create registration");
6272 /* Create thread to manage application socket */
6273 ret
= pthread_create(&apps_thread
, NULL
,
6274 thread_manage_apps
, (void *) NULL
);
6276 PERROR("pthread_create apps");
6280 /* Create kernel thread to manage kernel event */
6281 ret
= pthread_create(&kernel_thread
, NULL
,
6282 thread_manage_kernel
, (void *) NULL
);
6284 PERROR("pthread_create kernel");
6288 ret
= pthread_join(kernel_thread
, &status
);
6290 PERROR("pthread_join");
6291 goto error
; /* join error, exit without cleanup */
6295 ret
= pthread_join(apps_thread
, &status
);
6297 PERROR("pthread_join");
6298 goto error
; /* join error, exit without cleanup */
6302 ret
= pthread_join(reg_apps_thread
, &status
);
6304 PERROR("pthread_join");
6305 goto error
; /* join error, exit without cleanup */
6309 ret
= pthread_join(dispatch_thread
, &status
);
6311 PERROR("pthread_join");
6312 goto error
; /* join error, exit without cleanup */
6316 ret
= pthread_join(client_thread
, &status
);
6318 PERROR("pthread_join");
6319 goto error
; /* join error, exit without cleanup */
6322 ret
= join_consumer_thread(&kconsumer_data
);
6324 PERROR("join_consumer");
6325 goto error
; /* join error, exit without cleanup */
6332 * cleanup() is called when no other thread is running.
6334 rcu_thread_online();
6336 rcu_thread_offline();
6337 rcu_unregister_thread();