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 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2517 struct ltt_ust_session
*usess
= session
->ust_session
;
2519 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2520 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2521 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2522 ret
= build_network_session_path(sessions
[i
].path
,
2523 sizeof(session
[i
].path
), session
);
2525 ret
= snprintf(sessions
[i
].path
, sizeof(session
[i
].path
), "%s",
2526 session
->consumer
->dst
.trace_path
);
2529 PERROR("snprintf session path");
2533 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2534 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2535 sessions
[i
].enabled
= session
->enabled
;
2541 * Fill lttng_channel array of all channels.
2543 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2544 struct lttng_channel
*channels
)
2547 struct ltt_kernel_channel
*kchan
;
2549 DBG("Listing channels for session %s", session
->name
);
2552 case LTTNG_DOMAIN_KERNEL
:
2553 /* Kernel channels */
2554 if (session
->kernel_session
!= NULL
) {
2555 cds_list_for_each_entry(kchan
,
2556 &session
->kernel_session
->channel_list
.head
, list
) {
2557 /* Copy lttng_channel struct to array */
2558 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2559 channels
[i
].enabled
= kchan
->enabled
;
2564 case LTTNG_DOMAIN_UST
:
2566 struct lttng_ht_iter iter
;
2567 struct ltt_ust_channel
*uchan
;
2569 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2570 &iter
.iter
, uchan
, node
.node
) {
2571 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2572 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2573 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2574 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2575 channels
[i
].attr
.switch_timer_interval
=
2576 uchan
->attr
.switch_timer_interval
;
2577 channels
[i
].attr
.read_timer_interval
=
2578 uchan
->attr
.read_timer_interval
;
2579 channels
[i
].enabled
= uchan
->enabled
;
2580 switch (uchan
->attr
.output
) {
2581 case LTTNG_UST_MMAP
:
2583 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2596 * Create a list of ust global domain events.
2598 static int list_lttng_ust_global_events(char *channel_name
,
2599 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2602 unsigned int nb_event
= 0;
2603 struct lttng_ht_iter iter
;
2604 struct lttng_ht_node_str
*node
;
2605 struct ltt_ust_channel
*uchan
;
2606 struct ltt_ust_event
*uevent
;
2607 struct lttng_event
*tmp
;
2609 DBG("Listing UST global events for channel %s", channel_name
);
2613 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2614 node
= lttng_ht_iter_get_node_str(&iter
);
2616 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2620 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2622 nb_event
+= lttng_ht_get_count(uchan
->events
);
2624 if (nb_event
== 0) {
2629 DBG3("Listing UST global %d events", nb_event
);
2631 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2633 ret
= -LTTCOMM_FATAL
;
2637 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2638 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2639 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2640 tmp
[i
].enabled
= uevent
->enabled
;
2641 switch (uevent
->attr
.instrumentation
) {
2642 case LTTNG_UST_TRACEPOINT
:
2643 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2645 case LTTNG_UST_PROBE
:
2646 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2648 case LTTNG_UST_FUNCTION
:
2649 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2652 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2653 switch (uevent
->attr
.loglevel_type
) {
2654 case LTTNG_UST_LOGLEVEL_ALL
:
2655 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2657 case LTTNG_UST_LOGLEVEL_RANGE
:
2658 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2660 case LTTNG_UST_LOGLEVEL_SINGLE
:
2661 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2664 if (uevent
->filter
) {
2679 * Fill lttng_event array of all kernel events in the channel.
2681 static int list_lttng_kernel_events(char *channel_name
,
2682 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2685 unsigned int nb_event
;
2686 struct ltt_kernel_event
*event
;
2687 struct ltt_kernel_channel
*kchan
;
2689 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2690 if (kchan
== NULL
) {
2691 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2695 nb_event
= kchan
->event_count
;
2697 DBG("Listing events for channel %s", kchan
->channel
->name
);
2699 if (nb_event
== 0) {
2704 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2705 if (*events
== NULL
) {
2706 ret
= LTTCOMM_FATAL
;
2710 /* Kernel channels */
2711 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2712 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2713 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2714 (*events
)[i
].enabled
= event
->enabled
;
2715 switch (event
->event
->instrumentation
) {
2716 case LTTNG_KERNEL_TRACEPOINT
:
2717 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2719 case LTTNG_KERNEL_KPROBE
:
2720 case LTTNG_KERNEL_KRETPROBE
:
2721 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2722 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2723 sizeof(struct lttng_kernel_kprobe
));
2725 case LTTNG_KERNEL_FUNCTION
:
2726 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2727 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2728 sizeof(struct lttng_kernel_function
));
2730 case LTTNG_KERNEL_NOOP
:
2731 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2733 case LTTNG_KERNEL_SYSCALL
:
2734 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2736 case LTTNG_KERNEL_ALL
:
2751 * Add URI so the consumer output object. Set the correct path depending on the
2752 * domain adding the default trace directory.
2754 static int add_uri_to_consumer(struct consumer_output
*consumer
,
2755 struct lttng_uri
*uri
, int domain
, const char *session_name
)
2757 int ret
= LTTCOMM_OK
;
2758 const char *default_trace_dir
;
2762 if (consumer
== NULL
) {
2763 DBG("No consumer detected. Don't add URI. Stopping.");
2764 ret
= LTTCOMM_NO_CONSUMER
;
2769 case LTTNG_DOMAIN_KERNEL
:
2770 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
2772 case LTTNG_DOMAIN_UST
:
2773 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
2777 * This case is possible is we try to add the URI to the global tracing
2778 * session consumer object which in this case there is no subdir.
2780 default_trace_dir
= "";
2783 switch (uri
->dtype
) {
2784 case LTTNG_DST_IPV4
:
2785 case LTTNG_DST_IPV6
:
2786 DBG2("Setting network URI to consumer");
2788 /* Set URI into consumer output object */
2789 ret
= consumer_set_network_uri(consumer
, uri
);
2791 ret
= LTTCOMM_FATAL
;
2793 } else if (ret
== 1) {
2795 * URI was the same in the consumer so we do not append the subdir
2796 * again so to not duplicate output dir.
2801 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
2802 ret
= set_consumer_subdir(consumer
, session_name
);
2804 ret
= LTTCOMM_FATAL
;
2809 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
2810 /* On a new subdir, reappend the default trace dir. */
2811 strncat(consumer
->subdir
, default_trace_dir
, sizeof(consumer
->subdir
));
2812 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
2816 case LTTNG_DST_PATH
:
2817 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
2818 memset(consumer
->dst
.trace_path
, 0,
2819 sizeof(consumer
->dst
.trace_path
));
2820 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
2821 sizeof(consumer
->dst
.trace_path
));
2822 /* Append default trace dir */
2823 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
2824 sizeof(consumer
->dst
.trace_path
));
2825 /* Flag consumer as local. */
2826 consumer
->type
= CONSUMER_DST_LOCAL
;
2835 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2837 static int cmd_disable_channel(struct ltt_session
*session
,
2838 int domain
, char *channel_name
)
2841 struct ltt_ust_session
*usess
;
2843 usess
= session
->ust_session
;
2846 case LTTNG_DOMAIN_KERNEL
:
2848 ret
= channel_kernel_disable(session
->kernel_session
,
2850 if (ret
!= LTTCOMM_OK
) {
2854 kernel_wait_quiescent(kernel_tracer_fd
);
2857 case LTTNG_DOMAIN_UST
:
2859 struct ltt_ust_channel
*uchan
;
2860 struct lttng_ht
*chan_ht
;
2862 chan_ht
= usess
->domain_global
.channels
;
2864 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2865 if (uchan
== NULL
) {
2866 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2870 ret
= channel_ust_disable(usess
, domain
, uchan
);
2871 if (ret
!= LTTCOMM_OK
) {
2877 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2878 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2879 case LTTNG_DOMAIN_UST_PID
:
2882 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2893 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2895 static int cmd_enable_channel(struct ltt_session
*session
,
2896 int domain
, struct lttng_channel
*attr
)
2899 struct ltt_ust_session
*usess
= session
->ust_session
;
2900 struct lttng_ht
*chan_ht
;
2902 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2905 case LTTNG_DOMAIN_KERNEL
:
2907 struct ltt_kernel_channel
*kchan
;
2909 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2910 session
->kernel_session
);
2911 if (kchan
== NULL
) {
2912 ret
= channel_kernel_create(session
->kernel_session
,
2913 attr
, kernel_poll_pipe
[1]);
2915 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2918 if (ret
!= LTTCOMM_OK
) {
2922 kernel_wait_quiescent(kernel_tracer_fd
);
2925 case LTTNG_DOMAIN_UST
:
2927 struct ltt_ust_channel
*uchan
;
2929 chan_ht
= usess
->domain_global
.channels
;
2931 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2932 if (uchan
== NULL
) {
2933 ret
= channel_ust_create(usess
, domain
, attr
);
2935 ret
= channel_ust_enable(usess
, domain
, uchan
);
2940 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2941 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2942 case LTTNG_DOMAIN_UST_PID
:
2945 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2954 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2956 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2957 char *channel_name
, char *event_name
)
2962 case LTTNG_DOMAIN_KERNEL
:
2964 struct ltt_kernel_channel
*kchan
;
2965 struct ltt_kernel_session
*ksess
;
2967 ksess
= session
->kernel_session
;
2969 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2970 if (kchan
== NULL
) {
2971 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2975 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2976 if (ret
!= LTTCOMM_OK
) {
2980 kernel_wait_quiescent(kernel_tracer_fd
);
2983 case LTTNG_DOMAIN_UST
:
2985 struct ltt_ust_channel
*uchan
;
2986 struct ltt_ust_session
*usess
;
2988 usess
= session
->ust_session
;
2990 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2992 if (uchan
== NULL
) {
2993 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2997 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2998 if (ret
!= LTTCOMM_OK
) {
3002 DBG3("Disable UST event %s in channel %s completed", event_name
,
3007 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3008 case LTTNG_DOMAIN_UST_PID
:
3009 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3023 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
3025 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
3031 case LTTNG_DOMAIN_KERNEL
:
3033 struct ltt_kernel_session
*ksess
;
3034 struct ltt_kernel_channel
*kchan
;
3036 ksess
= session
->kernel_session
;
3038 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
3039 if (kchan
== NULL
) {
3040 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
3044 ret
= event_kernel_disable_all(ksess
, kchan
);
3045 if (ret
!= LTTCOMM_OK
) {
3049 kernel_wait_quiescent(kernel_tracer_fd
);
3052 case LTTNG_DOMAIN_UST
:
3054 struct ltt_ust_session
*usess
;
3055 struct ltt_ust_channel
*uchan
;
3057 usess
= session
->ust_session
;
3059 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3061 if (uchan
== NULL
) {
3062 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
3066 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
3071 DBG3("Disable all UST events in channel %s completed", channel_name
);
3076 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3077 case LTTNG_DOMAIN_UST_PID
:
3078 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3092 * Command LTTNG_ADD_CONTEXT processed by the client thread.
3094 static int cmd_add_context(struct ltt_session
*session
, int domain
,
3095 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
3100 case LTTNG_DOMAIN_KERNEL
:
3101 /* Add kernel context to kernel tracer */
3102 ret
= context_kernel_add(session
->kernel_session
, ctx
,
3103 event_name
, channel_name
);
3104 if (ret
!= LTTCOMM_OK
) {
3108 case LTTNG_DOMAIN_UST
:
3110 struct ltt_ust_session
*usess
= session
->ust_session
;
3112 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
3113 if (ret
!= LTTCOMM_OK
) {
3119 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3120 case LTTNG_DOMAIN_UST_PID
:
3121 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3135 * Command LTTNG_SET_FILTER processed by the client thread.
3137 static int cmd_set_filter(struct ltt_session
*session
, int domain
,
3138 char *channel_name
, char *event_name
,
3139 struct lttng_filter_bytecode
*bytecode
)
3144 case LTTNG_DOMAIN_KERNEL
:
3145 ret
= LTTCOMM_FATAL
;
3147 case LTTNG_DOMAIN_UST
:
3149 struct ltt_ust_session
*usess
= session
->ust_session
;
3151 ret
= filter_ust_set(usess
, domain
, bytecode
, event_name
, channel_name
);
3152 if (ret
!= LTTCOMM_OK
) {
3158 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3159 case LTTNG_DOMAIN_UST_PID
:
3160 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3175 * Command LTTNG_ENABLE_EVENT processed by the client thread.
3177 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
3178 char *channel_name
, struct lttng_event
*event
)
3181 struct lttng_channel
*attr
;
3182 struct ltt_ust_session
*usess
= session
->ust_session
;
3185 case LTTNG_DOMAIN_KERNEL
:
3187 struct ltt_kernel_channel
*kchan
;
3189 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3190 session
->kernel_session
);
3191 if (kchan
== NULL
) {
3192 attr
= channel_new_default_attr(domain
);
3194 ret
= LTTCOMM_FATAL
;
3197 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3199 /* This call will notify the kernel thread */
3200 ret
= channel_kernel_create(session
->kernel_session
,
3201 attr
, kernel_poll_pipe
[1]);
3202 if (ret
!= LTTCOMM_OK
) {
3209 /* Get the newly created kernel channel pointer */
3210 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3211 session
->kernel_session
);
3212 if (kchan
== NULL
) {
3213 /* This sould not happen... */
3214 ret
= LTTCOMM_FATAL
;
3218 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
3220 if (ret
!= LTTCOMM_OK
) {
3224 kernel_wait_quiescent(kernel_tracer_fd
);
3227 case LTTNG_DOMAIN_UST
:
3229 struct lttng_channel
*attr
;
3230 struct ltt_ust_channel
*uchan
;
3232 /* Get channel from global UST domain */
3233 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3235 if (uchan
== NULL
) {
3236 /* Create default channel */
3237 attr
= channel_new_default_attr(domain
);
3239 ret
= LTTCOMM_FATAL
;
3242 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3243 attr
->name
[NAME_MAX
- 1] = '\0';
3245 ret
= channel_ust_create(usess
, domain
, attr
);
3246 if (ret
!= LTTCOMM_OK
) {
3252 /* Get the newly created channel reference back */
3253 uchan
= trace_ust_find_channel_by_name(
3254 usess
->domain_global
.channels
, channel_name
);
3255 if (uchan
== NULL
) {
3256 /* Something is really wrong */
3257 ret
= LTTCOMM_FATAL
;
3262 /* At this point, the session and channel exist on the tracer */
3263 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
3264 if (ret
!= LTTCOMM_OK
) {
3270 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3271 case LTTNG_DOMAIN_UST_PID
:
3272 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3286 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
3288 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
3289 char *channel_name
, int event_type
)
3292 struct ltt_kernel_channel
*kchan
;
3295 case LTTNG_DOMAIN_KERNEL
:
3296 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3297 session
->kernel_session
);
3298 if (kchan
== NULL
) {
3299 /* This call will notify the kernel thread */
3300 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
3301 kernel_poll_pipe
[1]);
3302 if (ret
!= LTTCOMM_OK
) {
3306 /* Get the newly created kernel channel pointer */
3307 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3308 session
->kernel_session
);
3309 if (kchan
== NULL
) {
3310 /* This sould not happen... */
3311 ret
= LTTCOMM_FATAL
;
3317 switch (event_type
) {
3318 case LTTNG_EVENT_SYSCALL
:
3319 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
3320 kchan
, kernel_tracer_fd
);
3322 case LTTNG_EVENT_TRACEPOINT
:
3324 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
3325 * events already registered to the channel.
3327 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
3328 kchan
, kernel_tracer_fd
);
3330 case LTTNG_EVENT_ALL
:
3331 /* Enable syscalls and tracepoints */
3332 ret
= event_kernel_enable_all(session
->kernel_session
,
3333 kchan
, kernel_tracer_fd
);
3336 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3340 /* Manage return value */
3341 if (ret
!= LTTCOMM_OK
) {
3345 kernel_wait_quiescent(kernel_tracer_fd
);
3347 case LTTNG_DOMAIN_UST
:
3349 struct lttng_channel
*attr
;
3350 struct ltt_ust_channel
*uchan
;
3351 struct ltt_ust_session
*usess
= session
->ust_session
;
3353 /* Get channel from global UST domain */
3354 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3356 if (uchan
== NULL
) {
3357 /* Create default channel */
3358 attr
= channel_new_default_attr(domain
);
3360 ret
= LTTCOMM_FATAL
;
3363 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3364 attr
->name
[NAME_MAX
- 1] = '\0';
3366 /* Use the internal command enable channel */
3367 ret
= channel_ust_create(usess
, domain
, attr
);
3368 if (ret
!= LTTCOMM_OK
) {
3374 /* Get the newly created channel reference back */
3375 uchan
= trace_ust_find_channel_by_name(
3376 usess
->domain_global
.channels
, channel_name
);
3377 if (uchan
== NULL
) {
3378 /* Something is really wrong */
3379 ret
= LTTCOMM_FATAL
;
3384 /* At this point, the session and channel exist on the tracer */
3386 switch (event_type
) {
3387 case LTTNG_EVENT_ALL
:
3388 case LTTNG_EVENT_TRACEPOINT
:
3389 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
3390 if (ret
!= LTTCOMM_OK
) {
3395 ret
= LTTCOMM_UST_ENABLE_FAIL
;
3399 /* Manage return value */
3400 if (ret
!= LTTCOMM_OK
) {
3407 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3408 case LTTNG_DOMAIN_UST_PID
:
3409 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3423 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
3425 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
3428 ssize_t nb_events
= 0;
3431 case LTTNG_DOMAIN_KERNEL
:
3432 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
3433 if (nb_events
< 0) {
3434 ret
= LTTCOMM_KERN_LIST_FAIL
;
3438 case LTTNG_DOMAIN_UST
:
3439 nb_events
= ust_app_list_events(events
);
3440 if (nb_events
< 0) {
3441 ret
= LTTCOMM_UST_LIST_FAIL
;
3453 /* Return negative value to differentiate return code */
3458 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
3460 static ssize_t
cmd_list_tracepoint_fields(int domain
,
3461 struct lttng_event_field
**fields
)
3464 ssize_t nb_fields
= 0;
3467 case LTTNG_DOMAIN_UST
:
3468 nb_fields
= ust_app_list_event_fields(fields
);
3469 if (nb_fields
< 0) {
3470 ret
= LTTCOMM_UST_LIST_FAIL
;
3474 case LTTNG_DOMAIN_KERNEL
:
3475 default: /* fall-through */
3483 /* Return negative value to differentiate return code */
3488 * Command LTTNG_START_TRACE processed by the client thread.
3490 static int cmd_start_trace(struct ltt_session
*session
)
3493 struct ltt_kernel_session
*ksession
;
3494 struct ltt_ust_session
*usess
;
3495 struct ltt_kernel_channel
*kchan
;
3497 /* Ease our life a bit ;) */
3498 ksession
= session
->kernel_session
;
3499 usess
= session
->ust_session
;
3501 if (session
->enabled
) {
3502 /* Already started. */
3503 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3507 session
->enabled
= 1;
3509 ret
= setup_relayd(session
);
3510 if (ret
!= LTTCOMM_OK
) {
3511 ERR("Error setting up relayd for session %s", session
->name
);
3515 /* Kernel tracing */
3516 if (ksession
!= NULL
) {
3517 /* Open kernel metadata */
3518 if (ksession
->metadata
== NULL
) {
3519 ret
= kernel_open_metadata(ksession
);
3521 ret
= LTTCOMM_KERN_META_FAIL
;
3526 /* Open kernel metadata stream */
3527 if (ksession
->metadata_stream_fd
< 0) {
3528 ret
= kernel_open_metadata_stream(ksession
);
3530 ERR("Kernel create metadata stream failed");
3531 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3536 /* For each channel */
3537 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3538 if (kchan
->stream_count
== 0) {
3539 ret
= kernel_open_channel_stream(kchan
);
3541 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3544 /* Update the stream global counter */
3545 ksession
->stream_count_global
+= ret
;
3549 /* Setup kernel consumer socket and send fds to it */
3550 ret
= init_kernel_tracing(ksession
);
3552 ret
= LTTCOMM_KERN_START_FAIL
;
3556 /* This start the kernel tracing */
3557 ret
= kernel_start_session(ksession
);
3559 ret
= LTTCOMM_KERN_START_FAIL
;
3563 /* Quiescent wait after starting trace */
3564 kernel_wait_quiescent(kernel_tracer_fd
);
3567 /* Flag session that trace should start automatically */
3569 usess
->start_trace
= 1;
3571 ret
= ust_app_start_trace_all(usess
);
3573 ret
= LTTCOMM_UST_START_FAIL
;
3585 * Command LTTNG_STOP_TRACE processed by the client thread.
3587 static int cmd_stop_trace(struct ltt_session
*session
)
3590 struct ltt_kernel_channel
*kchan
;
3591 struct ltt_kernel_session
*ksession
;
3592 struct ltt_ust_session
*usess
;
3595 ksession
= session
->kernel_session
;
3596 usess
= session
->ust_session
;
3598 if (!session
->enabled
) {
3599 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
3603 session
->enabled
= 0;
3606 if (ksession
!= NULL
) {
3607 DBG("Stop kernel tracing");
3609 /* Flush metadata if exist */
3610 if (ksession
->metadata_stream_fd
>= 0) {
3611 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
3613 ERR("Kernel metadata flush failed");
3617 /* Flush all buffers before stopping */
3618 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3619 ret
= kernel_flush_buffer(kchan
);
3621 ERR("Kernel flush buffer error");
3625 ret
= kernel_stop_session(ksession
);
3627 ret
= LTTCOMM_KERN_STOP_FAIL
;
3631 kernel_wait_quiescent(kernel_tracer_fd
);
3635 usess
->start_trace
= 0;
3637 ret
= ust_app_stop_trace_all(usess
);
3639 ret
= LTTCOMM_UST_STOP_FAIL
;
3651 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
3653 static int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
3654 size_t nb_uri
, struct lttng_uri
*uris
)
3657 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3658 struct ltt_ust_session
*usess
= session
->ust_session
;
3659 struct consumer_output
*consumer
= NULL
;
3665 /* Can't enable consumer after session started. */
3666 if (session
->enabled
) {
3667 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3671 if (!session
->start_consumer
) {
3672 ret
= LTTCOMM_NO_CONSUMER
;
3677 * This case switch makes sure the domain session has a temporary consumer
3678 * so the URL can be set.
3682 /* Code flow error. A session MUST always have a consumer object */
3683 assert(session
->consumer
);
3685 * The URL will be added to the tracing session consumer instead of a
3686 * specific domain consumer.
3688 consumer
= session
->consumer
;
3690 case LTTNG_DOMAIN_KERNEL
:
3691 /* Code flow error if we don't have a kernel session here. */
3694 /* Create consumer output if none exists */
3695 consumer
= ksess
->tmp_consumer
;
3696 if (consumer
== NULL
) {
3697 consumer
= consumer_copy_output(ksess
->consumer
);
3698 if (consumer
== NULL
) {
3699 ret
= LTTCOMM_FATAL
;
3702 /* Trash the consumer subdir, we are about to set a new one. */
3703 memset(consumer
->subdir
, 0, sizeof(consumer
->subdir
));
3704 ksess
->tmp_consumer
= consumer
;
3708 case LTTNG_DOMAIN_UST
:
3709 /* Code flow error if we don't have a kernel session here. */
3712 /* Create consumer output if none exists */
3713 consumer
= usess
->tmp_consumer
;
3714 if (consumer
== NULL
) {
3715 consumer
= consumer_copy_output(usess
->consumer
);
3716 if (consumer
== NULL
) {
3717 ret
= LTTCOMM_FATAL
;
3720 /* Trash the consumer subdir, we are about to set a new one. */
3721 memset(consumer
->subdir
, 0, sizeof(consumer
->subdir
));
3722 usess
->tmp_consumer
= consumer
;
3728 for (i
= 0; i
< nb_uri
; i
++) {
3729 struct consumer_socket
*socket
;
3730 struct lttng_ht_iter iter
;
3732 ret
= add_uri_to_consumer(consumer
, &uris
[i
], domain
, session
->name
);
3738 * Don't send relayd socket if URI is NOT remote or if the relayd
3739 * sockets for the session are already sent.
3741 if (uris
[i
].dtype
== LTTNG_DST_PATH
||
3742 consumer
->dst
.net
.relayd_socks_sent
) {
3746 /* Try to send relayd URI to the consumer if exist. */
3747 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
,
3748 socket
, node
.node
) {
3750 /* A socket in the HT should never have a negative fd */
3751 assert(socket
->fd
>= 0);
3753 pthread_mutex_lock(socket
->lock
);
3754 ret
= send_socket_relayd_consumer(domain
, session
, &uris
[i
],
3755 consumer
, socket
->fd
);
3756 pthread_mutex_unlock(socket
->lock
);
3757 if (ret
!= LTTCOMM_OK
) {
3772 * Command LTTNG_CREATE_SESSION processed by the client thread.
3774 static int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
3775 size_t nb_uri
, lttng_sock_cred
*creds
)
3779 struct ltt_session
*session
;
3784 * Verify if the session already exist
3786 * XXX: There is no need for the session lock list here since the caller
3787 * (process_client_msg) is holding it. We might want to change that so a
3788 * single command does not lock the entire session list.
3790 session
= session_find_by_name(name
);
3791 if (session
!= NULL
) {
3792 ret
= LTTCOMM_EXIST_SESS
;
3796 /* Create tracing session in the registry */
3797 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
3798 LTTNG_SOCK_GET_GID_CRED(creds
));
3799 if (ret
!= LTTCOMM_OK
) {
3804 * Get the newly created session pointer back
3806 * XXX: There is no need for the session lock list here since the caller
3807 * (process_client_msg) is holding it. We might want to change that so a
3808 * single command does not lock the entire session list.
3810 session
= session_find_by_name(name
);
3813 /* Create default consumer output for the session not yet created. */
3814 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
3815 if (session
->consumer
== NULL
) {
3816 ret
= LTTCOMM_FATAL
;
3817 goto consumer_error
;
3821 * This means that the lttng_create_session call was called with the _path_
3822 * argument set to NULL.
3826 * At this point, we'll skip the consumer URI setup and create a
3827 * session with a NULL path which will flag the session to NOT spawn a
3830 DBG("Create session %s with NO uri, skipping consumer setup", name
);
3834 session
->start_consumer
= 1;
3836 ret
= cmd_set_consumer_uri(0, session
, nb_uri
, uris
);
3837 if (ret
!= LTTCOMM_OK
) {
3838 goto consumer_error
;
3841 session
->consumer
->enabled
= 1;
3847 session_destroy(session
);
3854 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3856 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3863 /* Clean kernel session teardown */
3864 teardown_kernel_session(session
);
3865 /* UST session teardown */
3866 teardown_ust_session(session
);
3869 * Must notify the kernel thread here to update it's poll setin order
3870 * to remove the channel(s)' fd just destroyed.
3872 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3874 PERROR("write kernel poll pipe");
3877 ret
= session_destroy(session
);
3883 * Command LTTNG_CALIBRATE processed by the client thread.
3885 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3890 case LTTNG_DOMAIN_KERNEL
:
3892 struct lttng_kernel_calibrate kcalibrate
;
3894 kcalibrate
.type
= calibrate
->type
;
3895 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3897 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3902 case LTTNG_DOMAIN_UST
:
3904 struct lttng_ust_calibrate ucalibrate
;
3906 ucalibrate
.type
= calibrate
->type
;
3907 ret
= ust_app_calibrate_glb(&ucalibrate
);
3909 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3926 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3928 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3932 struct consumer_socket
*socket
;
3935 case LTTNG_DOMAIN_KERNEL
:
3936 /* Can't register a consumer if there is already one */
3937 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3938 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3942 sock
= lttcomm_connect_unix_sock(sock_path
);
3944 ret
= LTTCOMM_CONNECT_FAIL
;
3948 socket
= consumer_allocate_socket(sock
);
3949 if (socket
== NULL
) {
3950 ret
= LTTCOMM_FATAL
;
3955 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3956 if (socket
->lock
== NULL
) {
3957 PERROR("zmalloc pthread mutex");
3958 ret
= LTTCOMM_FATAL
;
3961 pthread_mutex_init(socket
->lock
, NULL
);
3964 consumer_add_socket(socket
, session
->kernel_session
->consumer
);
3967 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3968 kconsumer_data
.pid
= -1;
3969 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3973 /* TODO: Userspace tracing */
3985 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3987 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3988 struct lttng_domain
**domains
)
3993 if (session
->kernel_session
!= NULL
) {
3994 DBG3("Listing domains found kernel domain");
3998 if (session
->ust_session
!= NULL
) {
3999 DBG3("Listing domains found UST global domain");
4003 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
4004 if (*domains
== NULL
) {
4005 ret
= -LTTCOMM_FATAL
;
4009 if (session
->kernel_session
!= NULL
) {
4010 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
4014 if (session
->ust_session
!= NULL
) {
4015 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
4026 * Command LTTNG_LIST_CHANNELS processed by the client thread.
4028 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
4029 struct lttng_channel
**channels
)
4032 ssize_t nb_chan
= 0;
4035 case LTTNG_DOMAIN_KERNEL
:
4036 if (session
->kernel_session
!= NULL
) {
4037 nb_chan
= session
->kernel_session
->channel_count
;
4039 DBG3("Number of kernel channels %zd", nb_chan
);
4041 case LTTNG_DOMAIN_UST
:
4042 if (session
->ust_session
!= NULL
) {
4043 nb_chan
= lttng_ht_get_count(
4044 session
->ust_session
->domain_global
.channels
);
4046 DBG3("Number of UST global channels %zd", nb_chan
);
4055 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
4056 if (*channels
== NULL
) {
4057 ret
= -LTTCOMM_FATAL
;
4061 list_lttng_channels(domain
, session
, *channels
);
4073 * Command LTTNG_LIST_EVENTS processed by the client thread.
4075 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
4076 char *channel_name
, struct lttng_event
**events
)
4079 ssize_t nb_event
= 0;
4082 case LTTNG_DOMAIN_KERNEL
:
4083 if (session
->kernel_session
!= NULL
) {
4084 nb_event
= list_lttng_kernel_events(channel_name
,
4085 session
->kernel_session
, events
);
4088 case LTTNG_DOMAIN_UST
:
4090 if (session
->ust_session
!= NULL
) {
4091 nb_event
= list_lttng_ust_global_events(channel_name
,
4092 &session
->ust_session
->domain_global
, events
);
4108 * Command LTTNG_DISABLE_CONSUMER processed by the client thread.
4110 static int cmd_disable_consumer(int domain
, struct ltt_session
*session
)
4113 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4114 struct ltt_ust_session
*usess
= session
->ust_session
;
4115 struct consumer_output
*consumer
;
4119 if (session
->enabled
) {
4120 /* Can't disable consumer on an already started session */
4121 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4125 if (!session
->start_consumer
) {
4126 ret
= LTTCOMM_NO_CONSUMER
;
4132 DBG("Disable tracing session %s consumer", session
->name
);
4133 consumer
= session
->consumer
;
4135 case LTTNG_DOMAIN_KERNEL
:
4136 /* Code flow error if we don't have a kernel session here. */
4139 DBG("Disabling kernel consumer");
4140 consumer
= ksess
->consumer
;
4143 case LTTNG_DOMAIN_UST
:
4144 /* Code flow error if we don't have a UST session here. */
4147 DBG("Disabling UST consumer");
4148 consumer
= usess
->consumer
;
4152 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
4157 consumer
->enabled
= 0;
4158 /* Success at this point */
4161 ret
= LTTCOMM_NO_CONSUMER
;
4169 * Command LTTNG_ENABLE_CONSUMER processed by the client thread.
4171 static int cmd_enable_consumer(int domain
, struct ltt_session
*session
)
4174 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4175 struct ltt_ust_session
*usess
= session
->ust_session
;
4176 struct consumer_output
*consumer
= NULL
;
4180 /* Can't enable consumer after session started. */
4181 if (session
->enabled
) {
4182 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4186 if (!session
->start_consumer
) {
4187 ret
= LTTCOMM_NO_CONSUMER
;
4193 assert(session
->consumer
);
4194 consumer
= session
->consumer
;
4196 case LTTNG_DOMAIN_KERNEL
:
4197 /* Code flow error if we don't have a kernel session here. */
4201 * Check if we have already sent fds to the consumer. In that case,
4202 * the enable-consumer command can't be used because a start trace
4203 * had previously occured.
4205 if (ksess
->consumer_fds_sent
) {
4206 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4210 consumer
= ksess
->tmp_consumer
;
4211 if (consumer
== NULL
) {
4213 /* No temp. consumer output exists. Using the current one. */
4214 DBG3("No temporary consumer. Using default");
4215 consumer
= ksess
->consumer
;
4219 switch (consumer
->type
) {
4220 case CONSUMER_DST_LOCAL
:
4221 DBG2("Consumer output is local. Creating directory(ies)");
4223 /* Create directory(ies) */
4224 ret
= run_as_mkdir_recursive(consumer
->dst
.trace_path
,
4225 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4227 if (ret
!= -EEXIST
) {
4228 ERR("Trace directory creation error");
4229 ret
= LTTCOMM_FATAL
;
4234 case CONSUMER_DST_NET
:
4235 DBG2("Consumer output is network. Validating URIs");
4236 /* Validate if we have both control and data path set. */
4237 if (!consumer
->dst
.net
.control_isset
) {
4238 ret
= LTTCOMM_URL_CTRL_MISS
;
4242 if (!consumer
->dst
.net
.data_isset
) {
4243 ret
= LTTCOMM_URL_DATA_MISS
;
4247 /* Check established network session state */
4248 if (session
->net_handle
== 0) {
4249 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4250 ERR("Session network handle is not set on enable-consumer");
4257 /* Append default kernel trace dir to subdir */
4258 strncat(ksess
->consumer
->subdir
, DEFAULT_KERNEL_TRACE_DIR
,
4259 sizeof(ksess
->consumer
->subdir
));
4263 * This is race free for now since the session lock is acquired before
4264 * ending up in this function. No other threads can access this kernel
4265 * session without this lock hence freeing the consumer output object
4269 consumer_destroy_output(ksess
->consumer
);
4271 ksess
->consumer
= consumer
;
4272 ksess
->tmp_consumer
= NULL
;
4275 case LTTNG_DOMAIN_UST
:
4276 /* Code flow error if we don't have a UST session here. */
4280 * Check if we have already sent fds to the consumer. In that case,
4281 * the enable-consumer command can't be used because a start trace
4282 * had previously occured.
4284 if (usess
->start_trace
) {
4285 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4289 consumer
= usess
->tmp_consumer
;
4290 if (consumer
== NULL
) {
4292 /* No temp. consumer output exists. Using the current one. */
4293 DBG3("No temporary consumer. Using default");
4294 consumer
= usess
->consumer
;
4298 switch (consumer
->type
) {
4299 case CONSUMER_DST_LOCAL
:
4300 DBG2("Consumer output is local. Creating directory(ies)");
4302 /* Create directory(ies) */
4303 ret
= run_as_mkdir_recursive(consumer
->dst
.trace_path
,
4304 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4306 if (ret
!= -EEXIST
) {
4307 ERR("Trace directory creation error");
4308 ret
= LTTCOMM_FATAL
;
4313 case CONSUMER_DST_NET
:
4314 DBG2("Consumer output is network. Validating URIs");
4315 /* Validate if we have both control and data path set. */
4316 if (!consumer
->dst
.net
.control_isset
) {
4317 ret
= LTTCOMM_URL_CTRL_MISS
;
4321 if (!consumer
->dst
.net
.data_isset
) {
4322 ret
= LTTCOMM_URL_DATA_MISS
;
4326 /* Check established network session state */
4327 if (session
->net_handle
== 0) {
4328 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4329 DBG2("Session network handle is not set on enable-consumer");
4333 if (consumer
->net_seq_index
== -1) {
4334 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4335 DBG2("Network index is not set on the consumer");
4342 /* Append default kernel trace dir to subdir */
4343 strncat(usess
->consumer
->subdir
, DEFAULT_UST_TRACE_DIR
,
4344 sizeof(usess
->consumer
->subdir
));
4348 * This is race free for now since the session lock is acquired before
4349 * ending up in this function. No other threads can access this kernel
4350 * session without this lock hence freeing the consumer output object
4354 consumer_destroy_output(usess
->consumer
);
4356 usess
->consumer
= consumer
;
4357 usess
->tmp_consumer
= NULL
;
4364 consumer
->enabled
= 1;
4365 /* Success at this point */
4368 /* Should not really happend... */
4369 ret
= LTTCOMM_NO_CONSUMER
;
4377 * Process the command requested by the lttng client within the command
4378 * context structure. This function make sure that the return structure (llm)
4379 * is set and ready for transmission before returning.
4381 * Return any error encountered or 0 for success.
4383 * "sock" is only used for special-case var. len data.
4385 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
4388 int ret
= LTTCOMM_OK
;
4389 int need_tracing_session
= 1;
4392 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
4396 switch (cmd_ctx
->lsm
->cmd_type
) {
4397 case LTTNG_CREATE_SESSION
:
4398 case LTTNG_DESTROY_SESSION
:
4399 case LTTNG_LIST_SESSIONS
:
4400 case LTTNG_LIST_DOMAINS
:
4401 case LTTNG_START_TRACE
:
4402 case LTTNG_STOP_TRACE
:
4409 if (opt_no_kernel
&& need_domain
4410 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
4412 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4414 ret
= LTTCOMM_KERN_NA
;
4419 /* Deny register consumer if we already have a spawned consumer. */
4420 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
4421 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
4422 if (kconsumer_data
.pid
> 0) {
4423 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
4426 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4430 * Check for command that don't needs to allocate a returned payload. We do
4431 * this here so we don't have to make the call for no payload at each
4434 switch(cmd_ctx
->lsm
->cmd_type
) {
4435 case LTTNG_LIST_SESSIONS
:
4436 case LTTNG_LIST_TRACEPOINTS
:
4437 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4438 case LTTNG_LIST_DOMAINS
:
4439 case LTTNG_LIST_CHANNELS
:
4440 case LTTNG_LIST_EVENTS
:
4443 /* Setup lttng message with no payload */
4444 ret
= setup_lttng_msg(cmd_ctx
, 0);
4446 /* This label does not try to unlock the session */
4447 goto init_setup_error
;
4451 /* Commands that DO NOT need a session. */
4452 switch (cmd_ctx
->lsm
->cmd_type
) {
4453 case LTTNG_CREATE_SESSION
:
4454 case LTTNG_CALIBRATE
:
4455 case LTTNG_LIST_SESSIONS
:
4456 case LTTNG_LIST_TRACEPOINTS
:
4457 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4458 need_tracing_session
= 0;
4461 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
4463 * We keep the session list lock across _all_ commands
4464 * for now, because the per-session lock does not
4465 * handle teardown properly.
4467 session_lock_list();
4468 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
4469 if (cmd_ctx
->session
== NULL
) {
4470 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
4471 ret
= LTTCOMM_SESS_NOT_FOUND
;
4473 /* If no session name specified */
4474 ret
= LTTCOMM_SELECT_SESS
;
4478 /* Acquire lock for the session */
4479 session_lock(cmd_ctx
->session
);
4489 * Check domain type for specific "pre-action".
4491 switch (cmd_ctx
->lsm
->domain
.type
) {
4492 case LTTNG_DOMAIN_KERNEL
:
4494 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4498 /* Kernel tracer check */
4499 if (kernel_tracer_fd
== -1) {
4500 /* Basically, load kernel tracer modules */
4501 ret
= init_kernel_tracer();
4507 /* Consumer is in an ERROR state. Report back to client */
4508 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
4509 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4513 /* Need a session for kernel command */
4514 if (need_tracing_session
) {
4515 if (cmd_ctx
->session
->kernel_session
== NULL
) {
4516 ret
= create_kernel_session(cmd_ctx
->session
);
4518 ret
= LTTCOMM_KERN_SESS_FAIL
;
4523 /* Start the kernel consumer daemon */
4524 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
4525 if (kconsumer_data
.pid
== 0 &&
4526 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4527 cmd_ctx
->session
->start_consumer
) {
4528 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4529 ret
= start_consumerd(&kconsumer_data
);
4531 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
4534 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
4536 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4540 * The consumer was just spawned so we need to add the socket to
4541 * the consumer output of the session if exist.
4543 ret
= consumer_create_socket(&kconsumer_data
,
4544 cmd_ctx
->session
->kernel_session
->consumer
);
4551 case LTTNG_DOMAIN_UST
:
4553 /* Consumer is in an ERROR state. Report back to client */
4554 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
4555 ret
= LTTCOMM_NO_USTCONSUMERD
;
4559 if (need_tracing_session
) {
4560 /* Create UST session if none exist. */
4561 if (cmd_ctx
->session
->ust_session
== NULL
) {
4562 ret
= create_ust_session(cmd_ctx
->session
,
4563 &cmd_ctx
->lsm
->domain
);
4564 if (ret
!= LTTCOMM_OK
) {
4569 /* Start the UST consumer daemons */
4571 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
4572 if (consumerd64_bin
[0] != '\0' &&
4573 ustconsumer64_data
.pid
== 0 &&
4574 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4575 cmd_ctx
->session
->start_consumer
) {
4576 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4577 ret
= start_consumerd(&ustconsumer64_data
);
4579 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
4580 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
4584 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
4585 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4587 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4591 * Setup socket for consumer 64 bit. No need for atomic access
4592 * since it was set above and can ONLY be set in this thread.
4594 ret
= consumer_create_socket(&ustconsumer64_data
,
4595 cmd_ctx
->session
->ust_session
->consumer
);
4601 if (consumerd32_bin
[0] != '\0' &&
4602 ustconsumer32_data
.pid
== 0 &&
4603 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
&&
4604 cmd_ctx
->session
->start_consumer
) {
4605 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4606 ret
= start_consumerd(&ustconsumer32_data
);
4608 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
4609 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
4613 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
4614 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4616 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4620 * Setup socket for consumer 64 bit. No need for atomic access
4621 * since it was set above and can ONLY be set in this thread.
4623 ret
= consumer_create_socket(&ustconsumer32_data
,
4624 cmd_ctx
->session
->ust_session
->consumer
);
4636 /* Validate consumer daemon state when start/stop trace command */
4637 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
4638 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
4639 switch (cmd_ctx
->lsm
->domain
.type
) {
4640 case LTTNG_DOMAIN_UST
:
4641 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
4642 ret
= LTTCOMM_NO_USTCONSUMERD
;
4646 case LTTNG_DOMAIN_KERNEL
:
4647 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
4648 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4656 * Check that the UID or GID match that of the tracing session.
4657 * The root user can interact with all sessions.
4659 if (need_tracing_session
) {
4660 if (!session_access_ok(cmd_ctx
->session
,
4661 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4662 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
4663 ret
= LTTCOMM_EPERM
;
4668 /* Process by command type */
4669 switch (cmd_ctx
->lsm
->cmd_type
) {
4670 case LTTNG_ADD_CONTEXT
:
4672 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4673 cmd_ctx
->lsm
->u
.context
.channel_name
,
4674 cmd_ctx
->lsm
->u
.context
.event_name
,
4675 &cmd_ctx
->lsm
->u
.context
.ctx
);
4678 case LTTNG_DISABLE_CHANNEL
:
4680 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4681 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4684 case LTTNG_DISABLE_EVENT
:
4686 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4687 cmd_ctx
->lsm
->u
.disable
.channel_name
,
4688 cmd_ctx
->lsm
->u
.disable
.name
);
4691 case LTTNG_DISABLE_ALL_EVENT
:
4693 DBG("Disabling all events");
4695 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4696 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4699 case LTTNG_DISABLE_CONSUMER
:
4701 ret
= cmd_disable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4704 case LTTNG_ENABLE_CHANNEL
:
4706 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4707 &cmd_ctx
->lsm
->u
.channel
.chan
);
4710 case LTTNG_ENABLE_CONSUMER
:
4713 * XXX: 0 means that this URI should be applied on the session. Should
4714 * be a DOMAIN enuam.
4716 ret
= cmd_enable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4717 if (ret
!= LTTCOMM_OK
) {
4721 if (cmd_ctx
->lsm
->domain
.type
== 0) {
4722 /* Add the URI for the UST session if a consumer is present. */
4723 if (cmd_ctx
->session
->ust_session
&&
4724 cmd_ctx
->session
->ust_session
->consumer
) {
4725 ret
= cmd_enable_consumer(LTTNG_DOMAIN_UST
, cmd_ctx
->session
);
4726 } else if (cmd_ctx
->session
->kernel_session
&&
4727 cmd_ctx
->session
->kernel_session
->consumer
) {
4728 ret
= cmd_enable_consumer(LTTNG_DOMAIN_KERNEL
,
4734 case LTTNG_ENABLE_EVENT
:
4736 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4737 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4738 &cmd_ctx
->lsm
->u
.enable
.event
);
4741 case LTTNG_ENABLE_ALL_EVENT
:
4743 DBG("Enabling all events");
4745 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4746 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4747 cmd_ctx
->lsm
->u
.enable
.event
.type
);
4750 case LTTNG_LIST_TRACEPOINTS
:
4752 struct lttng_event
*events
;
4755 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
4756 if (nb_events
< 0) {
4762 * Setup lttng message with payload size set to the event list size in
4763 * bytes and then copy list into the llm payload.
4765 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
4771 /* Copy event list into message payload */
4772 memcpy(cmd_ctx
->llm
->payload
, events
,
4773 sizeof(struct lttng_event
) * nb_events
);
4780 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4782 struct lttng_event_field
*fields
;
4785 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
4787 if (nb_fields
< 0) {
4793 * Setup lttng message with payload size set to the event list size in
4794 * bytes and then copy list into the llm payload.
4796 ret
= setup_lttng_msg(cmd_ctx
,
4797 sizeof(struct lttng_event_field
) * nb_fields
);
4803 /* Copy event list into message payload */
4804 memcpy(cmd_ctx
->llm
->payload
, fields
,
4805 sizeof(struct lttng_event_field
) * nb_fields
);
4812 case LTTNG_SET_CONSUMER_URI
:
4815 struct lttng_uri
*uris
;
4817 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4818 len
= nb_uri
* sizeof(struct lttng_uri
);
4821 ret
= LTTCOMM_INVALID
;
4825 uris
= zmalloc(len
);
4827 ret
= LTTCOMM_FATAL
;
4831 /* Receive variable len data */
4832 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
4833 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4835 DBG("No URIs received from client... continuing");
4837 ret
= LTTCOMM_SESSION_FAIL
;
4841 ret
= cmd_set_consumer_uri(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4843 if (ret
!= LTTCOMM_OK
) {
4848 * XXX: 0 means that this URI should be applied on the session. Should
4849 * be a DOMAIN enuam.
4851 if (cmd_ctx
->lsm
->domain
.type
== 0) {
4852 /* Add the URI for the UST session if a consumer is present. */
4853 if (cmd_ctx
->session
->ust_session
&&
4854 cmd_ctx
->session
->ust_session
->consumer
) {
4855 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_UST
, cmd_ctx
->session
,
4857 } else if (cmd_ctx
->session
->kernel_session
&&
4858 cmd_ctx
->session
->kernel_session
->consumer
) {
4859 ret
= cmd_set_consumer_uri(LTTNG_DOMAIN_KERNEL
,
4860 cmd_ctx
->session
, nb_uri
, uris
);
4866 case LTTNG_START_TRACE
:
4868 ret
= cmd_start_trace(cmd_ctx
->session
);
4871 case LTTNG_STOP_TRACE
:
4873 ret
= cmd_stop_trace(cmd_ctx
->session
);
4876 case LTTNG_CREATE_SESSION
:
4879 struct lttng_uri
*uris
= NULL
;
4881 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
4882 len
= nb_uri
* sizeof(struct lttng_uri
);
4885 uris
= zmalloc(len
);
4887 ret
= LTTCOMM_FATAL
;
4891 /* Receive variable len data */
4892 DBG("Waiting for %zu URIs from client ...", nb_uri
);
4893 ret
= lttcomm_recv_unix_sock(sock
, uris
, len
);
4895 DBG("No URIs received from client... continuing");
4897 ret
= LTTCOMM_SESSION_FAIL
;
4901 if (nb_uri
== 1 && uris
[0].dtype
!= LTTNG_DST_PATH
) {
4902 DBG("Creating session with ONE network URI is a bad call");
4903 ret
= LTTCOMM_SESSION_FAIL
;
4908 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
, uris
, nb_uri
,
4913 case LTTNG_DESTROY_SESSION
:
4915 ret
= cmd_destroy_session(cmd_ctx
->session
,
4916 cmd_ctx
->lsm
->session
.name
);
4918 /* Set session to NULL so we do not unlock it after free. */
4919 cmd_ctx
->session
= NULL
;
4922 case LTTNG_LIST_DOMAINS
:
4925 struct lttng_domain
*domains
;
4927 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
4933 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
4938 /* Copy event list into message payload */
4939 memcpy(cmd_ctx
->llm
->payload
, domains
,
4940 nb_dom
* sizeof(struct lttng_domain
));
4947 case LTTNG_LIST_CHANNELS
:
4950 struct lttng_channel
*channels
;
4952 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
4953 cmd_ctx
->session
, &channels
);
4959 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
4964 /* Copy event list into message payload */
4965 memcpy(cmd_ctx
->llm
->payload
, channels
,
4966 nb_chan
* sizeof(struct lttng_channel
));
4973 case LTTNG_LIST_EVENTS
:
4976 struct lttng_event
*events
= NULL
;
4978 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4979 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
4985 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
4990 /* Copy event list into message payload */
4991 memcpy(cmd_ctx
->llm
->payload
, events
,
4992 nb_event
* sizeof(struct lttng_event
));
4999 case LTTNG_LIST_SESSIONS
:
5001 unsigned int nr_sessions
;
5003 session_lock_list();
5004 nr_sessions
= lttng_sessions_count(
5005 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
5006 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
5008 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
5010 session_unlock_list();
5014 /* Filled the session array */
5015 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
5016 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
5017 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
5019 session_unlock_list();
5024 case LTTNG_CALIBRATE
:
5026 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
5027 &cmd_ctx
->lsm
->u
.calibrate
);
5030 case LTTNG_REGISTER_CONSUMER
:
5032 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
5033 cmd_ctx
->lsm
->u
.reg
.path
);
5036 case LTTNG_SET_FILTER
:
5038 struct lttng_filter_bytecode
*bytecode
;
5040 if (cmd_ctx
->lsm
->u
.filter
.bytecode_len
> 65336) {
5041 ret
= LTTCOMM_FILTER_INVAL
;
5044 bytecode
= zmalloc(cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
5046 ret
= LTTCOMM_FILTER_NOMEM
;
5049 /* Receive var. len. data */
5050 DBG("Receiving var len data from client ...");
5051 ret
= lttcomm_recv_unix_sock(sock
, bytecode
,
5052 cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
5054 DBG("Nothing recv() from client var len data... continuing");
5056 ret
= LTTCOMM_FILTER_INVAL
;
5060 if (bytecode
->len
+ sizeof(*bytecode
)
5061 != cmd_ctx
->lsm
->u
.filter
.bytecode_len
) {
5063 ret
= LTTCOMM_FILTER_INVAL
;
5067 ret
= cmd_set_filter(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
5068 cmd_ctx
->lsm
->u
.filter
.channel_name
,
5069 cmd_ctx
->lsm
->u
.filter
.event_name
,
5079 if (cmd_ctx
->llm
== NULL
) {
5080 DBG("Missing llm structure. Allocating one.");
5081 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
5085 /* Set return code */
5086 cmd_ctx
->llm
->ret_code
= ret
;
5088 if (cmd_ctx
->session
) {
5089 session_unlock(cmd_ctx
->session
);
5091 if (need_tracing_session
) {
5092 session_unlock_list();
5099 * Thread managing health check socket.
5101 static void *thread_manage_health(void *data
)
5103 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
5104 uint32_t revents
, nb_fd
;
5105 struct lttng_poll_event events
;
5106 struct lttcomm_health_msg msg
;
5107 struct lttcomm_health_data reply
;
5109 DBG("[thread] Manage health check started");
5111 rcu_register_thread();
5113 /* Create unix socket */
5114 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
5116 ERR("Unable to create health check Unix socket");
5121 ret
= lttcomm_listen_unix_sock(sock
);
5127 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5128 * more will be added to this poll set.
5130 ret
= create_thread_poll_set(&events
, 2);
5135 /* Add the application registration socket */
5136 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
5142 DBG("Health check ready");
5144 nb_fd
= LTTNG_POLL_GETNB(&events
);
5146 /* Inifinite blocking call, waiting for transmission */
5148 ret
= lttng_poll_wait(&events
, -1);
5151 * Restart interrupted system call.
5153 if (errno
== EINTR
) {
5159 for (i
= 0; i
< nb_fd
; i
++) {
5160 /* Fetch once the poll data */
5161 revents
= LTTNG_POLL_GETEV(&events
, i
);
5162 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5164 /* Thread quit pipe has been closed. Killing thread. */
5165 ret
= check_thread_quit_pipe(pollfd
, revents
);
5171 /* Event on the registration socket */
5172 if (pollfd
== sock
) {
5173 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5174 ERR("Health socket poll error");
5180 new_sock
= lttcomm_accept_unix_sock(sock
);
5185 DBG("Receiving data from client for health...");
5186 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
5188 DBG("Nothing recv() from client... continuing");
5189 ret
= close(new_sock
);
5197 rcu_thread_online();
5199 switch (msg
.component
) {
5200 case LTTNG_HEALTH_CMD
:
5201 reply
.ret_code
= health_check_state(&health_thread_cmd
);
5203 case LTTNG_HEALTH_APP_MANAGE
:
5204 reply
.ret_code
= health_check_state(&health_thread_app_manage
);
5206 case LTTNG_HEALTH_APP_REG
:
5207 reply
.ret_code
= health_check_state(&health_thread_app_reg
);
5209 case LTTNG_HEALTH_KERNEL
:
5210 reply
.ret_code
= health_check_state(&health_thread_kernel
);
5212 case LTTNG_HEALTH_CONSUMER
:
5213 reply
.ret_code
= check_consumer_health();
5215 case LTTNG_HEALTH_ALL
:
5217 health_check_state(&health_thread_app_manage
) &&
5218 health_check_state(&health_thread_app_reg
) &&
5219 health_check_state(&health_thread_cmd
) &&
5220 health_check_state(&health_thread_kernel
) &&
5221 check_consumer_health();
5224 reply
.ret_code
= LTTCOMM_UND
;
5229 * Flip ret value since 0 is a success and 1 indicates a bad health for
5230 * the client where in the sessiond it is the opposite. Again, this is
5231 * just to make things easier for us poor developer which enjoy a lot
5234 if (reply
.ret_code
== 0 || reply
.ret_code
== 1) {
5235 reply
.ret_code
= !reply
.ret_code
;
5238 DBG2("Health check return value %d", reply
.ret_code
);
5240 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
5242 ERR("Failed to send health data back to client");
5245 /* End of transmission */
5246 ret
= close(new_sock
);
5256 ERR("Health error occurred in %s", __func__
);
5258 DBG("Health check thread dying");
5259 unlink(health_unix_sock_path
);
5266 if (new_sock
>= 0) {
5267 ret
= close(new_sock
);
5273 lttng_poll_clean(&events
);
5275 rcu_unregister_thread();
5280 * This thread manage all clients request using the unix client socket for
5283 static void *thread_manage_clients(void *data
)
5285 int sock
= -1, ret
, i
, pollfd
, err
= -1;
5287 uint32_t revents
, nb_fd
;
5288 struct command_ctx
*cmd_ctx
= NULL
;
5289 struct lttng_poll_event events
;
5291 DBG("[thread] Manage client started");
5293 rcu_register_thread();
5295 health_code_update(&health_thread_cmd
);
5297 ret
= lttcomm_listen_unix_sock(client_sock
);
5303 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5304 * more will be added to this poll set.
5306 ret
= create_thread_poll_set(&events
, 2);
5311 /* Add the application registration socket */
5312 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
5318 * Notify parent pid that we are ready to accept command for client side.
5320 if (opt_sig_parent
) {
5321 kill(ppid
, SIGUSR1
);
5324 health_code_update(&health_thread_cmd
);
5327 DBG("Accepting client command ...");
5329 nb_fd
= LTTNG_POLL_GETNB(&events
);
5331 /* Inifinite blocking call, waiting for transmission */
5333 health_poll_update(&health_thread_cmd
);
5334 ret
= lttng_poll_wait(&events
, -1);
5335 health_poll_update(&health_thread_cmd
);
5338 * Restart interrupted system call.
5340 if (errno
== EINTR
) {
5346 for (i
= 0; i
< nb_fd
; i
++) {
5347 /* Fetch once the poll data */
5348 revents
= LTTNG_POLL_GETEV(&events
, i
);
5349 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5351 health_code_update(&health_thread_cmd
);
5353 /* Thread quit pipe has been closed. Killing thread. */
5354 ret
= check_thread_quit_pipe(pollfd
, revents
);
5360 /* Event on the registration socket */
5361 if (pollfd
== client_sock
) {
5362 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5363 ERR("Client socket poll error");
5369 DBG("Wait for client response");
5371 health_code_update(&health_thread_cmd
);
5373 sock
= lttcomm_accept_unix_sock(client_sock
);
5378 /* Set socket option for credentials retrieval */
5379 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
5384 /* Allocate context command to process the client request */
5385 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
5386 if (cmd_ctx
== NULL
) {
5387 PERROR("zmalloc cmd_ctx");
5391 /* Allocate data buffer for reception */
5392 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
5393 if (cmd_ctx
->lsm
== NULL
) {
5394 PERROR("zmalloc cmd_ctx->lsm");
5398 cmd_ctx
->llm
= NULL
;
5399 cmd_ctx
->session
= NULL
;
5401 health_code_update(&health_thread_cmd
);
5404 * Data is received from the lttng client. The struct
5405 * lttcomm_session_msg (lsm) contains the command and data request of
5408 DBG("Receiving data from client ...");
5409 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
5410 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
5412 DBG("Nothing recv() from client... continuing");
5418 clean_command_ctx(&cmd_ctx
);
5422 health_code_update(&health_thread_cmd
);
5424 // TODO: Validate cmd_ctx including sanity check for
5425 // security purpose.
5427 rcu_thread_online();
5429 * This function dispatch the work to the kernel or userspace tracer
5430 * libs and fill the lttcomm_lttng_msg data structure of all the needed
5431 * informations for the client. The command context struct contains
5432 * everything this function may needs.
5434 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
5435 rcu_thread_offline();
5445 * TODO: Inform client somehow of the fatal error. At
5446 * this point, ret < 0 means that a zmalloc failed
5447 * (ENOMEM). Error detected but still accept
5448 * command, unless a socket error has been
5451 clean_command_ctx(&cmd_ctx
);
5455 health_code_update(&health_thread_cmd
);
5457 DBG("Sending response (size: %d, retcode: %s)",
5458 cmd_ctx
->lttng_msg_size
,
5459 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
5460 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
5462 ERR("Failed to send data back to client");
5465 /* End of transmission */
5472 clean_command_ctx(&cmd_ctx
);
5474 health_code_update(&health_thread_cmd
);
5480 health_error(&health_thread_cmd
);
5481 ERR("Health error occurred in %s", __func__
);
5483 health_exit(&health_thread_cmd
);
5485 DBG("Client thread dying");
5486 unlink(client_unix_sock_path
);
5487 if (client_sock
>= 0) {
5488 ret
= close(client_sock
);
5500 lttng_poll_clean(&events
);
5501 clean_command_ctx(&cmd_ctx
);
5503 rcu_unregister_thread();
5509 * usage function on stderr
5511 static void usage(void)
5513 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
5514 fprintf(stderr
, " -h, --help Display this usage.\n");
5515 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
5516 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
5517 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
5518 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
5519 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
5520 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
5521 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
5522 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
5523 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
5524 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
5525 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
5526 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
5527 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
5528 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
5529 fprintf(stderr
, " -V, --version Show version number.\n");
5530 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
5531 fprintf(stderr
, " -q, --quiet No output at all.\n");
5532 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
5533 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
5534 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
5538 * daemon argument parsing
5540 static int parse_args(int argc
, char **argv
)
5544 static struct option long_options
[] = {
5545 { "client-sock", 1, 0, 'c' },
5546 { "apps-sock", 1, 0, 'a' },
5547 { "kconsumerd-cmd-sock", 1, 0, 'C' },
5548 { "kconsumerd-err-sock", 1, 0, 'E' },
5549 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
5550 { "ustconsumerd32-err-sock", 1, 0, 'H' },
5551 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
5552 { "ustconsumerd64-err-sock", 1, 0, 'F' },
5553 { "consumerd32-path", 1, 0, 'u' },
5554 { "consumerd32-libdir", 1, 0, 'U' },
5555 { "consumerd64-path", 1, 0, 't' },
5556 { "consumerd64-libdir", 1, 0, 'T' },
5557 { "daemonize", 0, 0, 'd' },
5558 { "sig-parent", 0, 0, 'S' },
5559 { "help", 0, 0, 'h' },
5560 { "group", 1, 0, 'g' },
5561 { "version", 0, 0, 'V' },
5562 { "quiet", 0, 0, 'q' },
5563 { "verbose", 0, 0, 'v' },
5564 { "verbose-consumer", 0, 0, 'Z' },
5565 { "no-kernel", 0, 0, 'N' },
5570 int option_index
= 0;
5571 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
5572 long_options
, &option_index
);
5579 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
5581 fprintf(stderr
, " with arg %s\n", optarg
);
5585 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5588 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5594 opt_tracing_group
= optarg
;
5600 fprintf(stdout
, "%s\n", VERSION
);
5606 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5609 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5612 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5615 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5618 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5621 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5627 lttng_opt_quiet
= 1;
5630 /* Verbose level can increase using multiple -v */
5631 lttng_opt_verbose
+= 1;
5634 opt_verbose_consumer
+= 1;
5637 consumerd32_bin
= optarg
;
5640 consumerd32_libdir
= optarg
;
5643 consumerd64_bin
= optarg
;
5646 consumerd64_libdir
= optarg
;
5649 /* Unknown option or other error.
5650 * Error is printed by getopt, just return */
5659 * Creates the two needed socket by the daemon.
5660 * apps_sock - The communication socket for all UST apps.
5661 * client_sock - The communication of the cli tool (lttng).
5663 static int init_daemon_socket(void)
5668 old_umask
= umask(0);
5670 /* Create client tool unix socket */
5671 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5672 if (client_sock
< 0) {
5673 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5678 /* File permission MUST be 660 */
5679 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5681 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5686 /* Create the application unix socket */
5687 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5688 if (apps_sock
< 0) {
5689 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5694 /* File permission MUST be 666 */
5695 ret
= chmod(apps_unix_sock_path
,
5696 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5698 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5709 * Check if the global socket is available, and if a daemon is answering at the
5710 * other side. If yes, error is returned.
5712 static int check_existing_daemon(void)
5714 /* Is there anybody out there ? */
5715 if (lttng_session_daemon_alive()) {
5723 * Set the tracing group gid onto the client socket.
5725 * Race window between mkdir and chown is OK because we are going from more
5726 * permissive (root.root) to less permissive (root.tracing).
5728 static int set_permissions(char *rundir
)
5733 ret
= allowed_group();
5735 WARN("No tracing group detected");
5742 /* Set lttng run dir */
5743 ret
= chown(rundir
, 0, gid
);
5745 ERR("Unable to set group on %s", rundir
);
5749 /* Ensure tracing group can search the run dir */
5750 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
5752 ERR("Unable to set permissions on %s", rundir
);
5756 /* lttng client socket path */
5757 ret
= chown(client_unix_sock_path
, 0, gid
);
5759 ERR("Unable to set group on %s", client_unix_sock_path
);
5763 /* kconsumer error socket path */
5764 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
5766 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5770 /* 64-bit ustconsumer error socket path */
5771 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
5773 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5777 /* 32-bit ustconsumer compat32 error socket path */
5778 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
5780 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5784 DBG("All permissions are set");
5791 * Create the lttng run directory needed for all global sockets and pipe.
5793 static int create_lttng_rundir(const char *rundir
)
5797 DBG3("Creating LTTng run directory: %s", rundir
);
5799 ret
= mkdir(rundir
, S_IRWXU
);
5801 if (errno
!= EEXIST
) {
5802 ERR("Unable to create %s", rundir
);
5814 * Setup sockets and directory needed by the kconsumerd communication with the
5817 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5821 char path
[PATH_MAX
];
5823 switch (consumer_data
->type
) {
5824 case LTTNG_CONSUMER_KERNEL
:
5825 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5827 case LTTNG_CONSUMER64_UST
:
5828 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5830 case LTTNG_CONSUMER32_UST
:
5831 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5834 ERR("Consumer type unknown");
5839 DBG2("Creating consumer directory: %s", path
);
5841 ret
= mkdir(path
, S_IRWXU
);
5843 if (errno
!= EEXIST
) {
5845 ERR("Failed to create %s", path
);
5851 /* Create the kconsumerd error unix socket */
5852 consumer_data
->err_sock
=
5853 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5854 if (consumer_data
->err_sock
< 0) {
5855 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5860 /* File permission MUST be 660 */
5861 ret
= chmod(consumer_data
->err_unix_sock_path
,
5862 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5864 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5874 * Signal handler for the daemon
5876 * Simply stop all worker threads, leaving main() return gracefully after
5877 * joining all threads and calling cleanup().
5879 static void sighandler(int sig
)
5883 DBG("SIGPIPE caught");
5886 DBG("SIGINT caught");
5890 DBG("SIGTERM caught");
5899 * Setup signal handler for :
5900 * SIGINT, SIGTERM, SIGPIPE
5902 static int set_signal_handler(void)
5905 struct sigaction sa
;
5908 if ((ret
= sigemptyset(&sigset
)) < 0) {
5909 PERROR("sigemptyset");
5913 sa
.sa_handler
= sighandler
;
5914 sa
.sa_mask
= sigset
;
5916 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5917 PERROR("sigaction");
5921 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5922 PERROR("sigaction");
5926 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5927 PERROR("sigaction");
5931 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
5937 * Set open files limit to unlimited. This daemon can open a large number of
5938 * file descriptors in order to consumer multiple kernel traces.
5940 static void set_ulimit(void)
5945 /* The kernel does not allowed an infinite limit for open files */
5946 lim
.rlim_cur
= 65535;
5947 lim
.rlim_max
= 65535;
5949 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5951 PERROR("failed to set open files limit");
5958 int main(int argc
, char **argv
)
5962 const char *home_path
;
5964 init_kernel_workarounds();
5966 rcu_register_thread();
5968 setup_consumerd_path();
5970 /* Parse arguments */
5972 if ((ret
= parse_args(argc
, argv
) < 0)) {
5982 * child: setsid, close FD 0, 1, 2, chdir /
5983 * parent: exit (if fork is successful)
5991 * We are in the child. Make sure all other file
5992 * descriptors are closed, in case we are called with
5993 * more opened file descriptors than the standard ones.
5995 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
6000 /* Create thread quit pipe */
6001 if ((ret
= init_thread_quit_pipe()) < 0) {
6005 /* Check if daemon is UID = 0 */
6006 is_root
= !getuid();
6009 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
6011 /* Create global run dir with root access */
6012 ret
= create_lttng_rundir(rundir
);
6017 if (strlen(apps_unix_sock_path
) == 0) {
6018 snprintf(apps_unix_sock_path
, PATH_MAX
,
6019 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
6022 if (strlen(client_unix_sock_path
) == 0) {
6023 snprintf(client_unix_sock_path
, PATH_MAX
,
6024 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
6027 /* Set global SHM for ust */
6028 if (strlen(wait_shm_path
) == 0) {
6029 snprintf(wait_shm_path
, PATH_MAX
,
6030 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
6033 if (strlen(health_unix_sock_path
) == 0) {
6034 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
6035 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
6038 /* Setup kernel consumerd path */
6039 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
6040 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
6041 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
6042 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
6044 DBG2("Kernel consumer err path: %s",
6045 kconsumer_data
.err_unix_sock_path
);
6046 DBG2("Kernel consumer cmd path: %s",
6047 kconsumer_data
.cmd_unix_sock_path
);
6049 home_path
= get_home_dir();
6050 if (home_path
== NULL
) {
6051 /* TODO: Add --socket PATH option */
6052 ERR("Can't get HOME directory for sockets creation.");
6058 * Create rundir from home path. This will create something like
6061 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
6067 ret
= create_lttng_rundir(rundir
);
6072 if (strlen(apps_unix_sock_path
) == 0) {
6073 snprintf(apps_unix_sock_path
, PATH_MAX
,
6074 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
6077 /* Set the cli tool unix socket path */
6078 if (strlen(client_unix_sock_path
) == 0) {
6079 snprintf(client_unix_sock_path
, PATH_MAX
,
6080 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
6083 /* Set global SHM for ust */
6084 if (strlen(wait_shm_path
) == 0) {
6085 snprintf(wait_shm_path
, PATH_MAX
,
6086 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
6089 /* Set health check Unix path */
6090 if (strlen(health_unix_sock_path
) == 0) {
6091 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
6092 DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
6096 /* Set consumer initial state */
6097 kernel_consumerd_state
= CONSUMER_STOPPED
;
6098 ust_consumerd_state
= CONSUMER_STOPPED
;
6100 DBG("Client socket path %s", client_unix_sock_path
);
6101 DBG("Application socket path %s", apps_unix_sock_path
);
6102 DBG("LTTng run directory path: %s", rundir
);
6104 /* 32 bits consumerd path setup */
6105 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
6106 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
6107 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
6108 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
6110 DBG2("UST consumer 32 bits err path: %s",
6111 ustconsumer32_data
.err_unix_sock_path
);
6112 DBG2("UST consumer 32 bits cmd path: %s",
6113 ustconsumer32_data
.cmd_unix_sock_path
);
6115 /* 64 bits consumerd path setup */
6116 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
6117 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
6118 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
6119 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
6121 DBG2("UST consumer 64 bits err path: %s",
6122 ustconsumer64_data
.err_unix_sock_path
);
6123 DBG2("UST consumer 64 bits cmd path: %s",
6124 ustconsumer64_data
.cmd_unix_sock_path
);
6127 * See if daemon already exist.
6129 if ((ret
= check_existing_daemon()) < 0) {
6130 ERR("Already running daemon.\n");
6132 * We do not goto exit because we must not cleanup()
6133 * because a daemon is already running.
6139 * Init UST app hash table. Alloc hash table before this point since
6140 * cleanup() can get called after that point.
6144 /* After this point, we can safely call cleanup() with "goto exit" */
6147 * These actions must be executed as root. We do that *after* setting up
6148 * the sockets path because we MUST make the check for another daemon using
6149 * those paths *before* trying to set the kernel consumer sockets and init
6153 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
6158 /* Setup kernel tracer */
6159 if (!opt_no_kernel
) {
6160 init_kernel_tracer();
6163 /* Set ulimit for open files */
6166 /* init lttng_fd tracking must be done after set_ulimit. */
6169 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
6174 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
6179 if ((ret
= set_signal_handler()) < 0) {
6183 /* Setup the needed unix socket */
6184 if ((ret
= init_daemon_socket()) < 0) {
6188 /* Set credentials to socket */
6189 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
6193 /* Get parent pid if -S, --sig-parent is specified. */
6194 if (opt_sig_parent
) {
6198 /* Setup the kernel pipe for waking up the kernel thread */
6199 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
6203 /* Setup the thread apps communication pipe. */
6204 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
6208 /* Init UST command queue. */
6209 cds_wfq_init(&ust_cmd_queue
.queue
);
6212 * Get session list pointer. This pointer MUST NOT be free(). This list is
6213 * statically declared in session.c
6215 session_list_ptr
= session_get_list();
6217 /* Set up max poll set size */
6218 lttng_poll_set_max_size();
6221 * Set network sequence index to 1 for streams to match a relayd socket on
6222 * the consumer side.
6224 uatomic_set(&relayd_net_seq_idx
, 1);
6226 /* Init all health thread counters. */
6227 health_init(&health_thread_cmd
);
6228 health_init(&health_thread_kernel
);
6229 health_init(&health_thread_app_manage
);
6230 health_init(&health_thread_app_reg
);
6233 * Init health counters of the consumer thread. We do a quick hack here to
6234 * the state of the consumer health is fine even if the thread is not
6235 * started. This is simply to ease our life and has no cost what so ever.
6237 health_init(&kconsumer_data
.health
);
6238 health_poll_update(&kconsumer_data
.health
);
6239 health_init(&ustconsumer32_data
.health
);
6240 health_poll_update(&ustconsumer32_data
.health
);
6241 health_init(&ustconsumer64_data
.health
);
6242 health_poll_update(&ustconsumer64_data
.health
);
6244 /* Create thread to manage the client socket */
6245 ret
= pthread_create(&health_thread
, NULL
,
6246 thread_manage_health
, (void *) NULL
);
6248 PERROR("pthread_create health");
6252 /* Create thread to manage the client socket */
6253 ret
= pthread_create(&client_thread
, NULL
,
6254 thread_manage_clients
, (void *) NULL
);
6256 PERROR("pthread_create clients");
6260 /* Create thread to dispatch registration */
6261 ret
= pthread_create(&dispatch_thread
, NULL
,
6262 thread_dispatch_ust_registration
, (void *) NULL
);
6264 PERROR("pthread_create dispatch");
6268 /* Create thread to manage application registration. */
6269 ret
= pthread_create(®_apps_thread
, NULL
,
6270 thread_registration_apps
, (void *) NULL
);
6272 PERROR("pthread_create registration");
6276 /* Create thread to manage application socket */
6277 ret
= pthread_create(&apps_thread
, NULL
,
6278 thread_manage_apps
, (void *) NULL
);
6280 PERROR("pthread_create apps");
6284 /* Create kernel thread to manage kernel event */
6285 ret
= pthread_create(&kernel_thread
, NULL
,
6286 thread_manage_kernel
, (void *) NULL
);
6288 PERROR("pthread_create kernel");
6292 ret
= pthread_join(kernel_thread
, &status
);
6294 PERROR("pthread_join");
6295 goto error
; /* join error, exit without cleanup */
6299 ret
= pthread_join(apps_thread
, &status
);
6301 PERROR("pthread_join");
6302 goto error
; /* join error, exit without cleanup */
6306 ret
= pthread_join(reg_apps_thread
, &status
);
6308 PERROR("pthread_join");
6309 goto error
; /* join error, exit without cleanup */
6313 ret
= pthread_join(dispatch_thread
, &status
);
6315 PERROR("pthread_join");
6316 goto error
; /* join error, exit without cleanup */
6320 ret
= pthread_join(client_thread
, &status
);
6322 PERROR("pthread_join");
6323 goto error
; /* join error, exit without cleanup */
6326 ret
= join_consumer_thread(&kconsumer_data
);
6328 PERROR("join_consumer");
6329 goto error
; /* join error, exit without cleanup */
6336 * cleanup() is called when no other thread is running.
6338 rcu_thread_online();
6340 rcu_thread_offline();
6341 rcu_unregister_thread();