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 not streams data will be lost after this
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
)
2100 /* Sending control relayd socket. */
2101 ret
= send_socket_relayd_consumer(domain
, session
,
2102 &consumer
->dst
.net
.control
, consumer
, fd
);
2103 if (ret
!= LTTCOMM_OK
) {
2107 /* Sending data relayd socket. */
2108 ret
= send_socket_relayd_consumer(domain
, session
,
2109 &consumer
->dst
.net
.data
, consumer
, fd
);
2110 if (ret
!= LTTCOMM_OK
) {
2119 * Setup relayd connections for a tracing session. First creates the socket to
2120 * the relayd and send them to the right domain consumer. Consumer type MUST be
2123 static int setup_relayd(struct ltt_session
*session
)
2125 int ret
= LTTCOMM_OK
;
2126 struct ltt_ust_session
*usess
;
2127 struct ltt_kernel_session
*ksess
;
2128 struct consumer_socket
*socket
;
2129 struct lttng_ht_iter iter
;
2133 usess
= session
->ust_session
;
2134 ksess
= session
->kernel_session
;
2136 DBG2("Setting relayd for session %s", session
->name
);
2138 if (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
&&
2139 usess
->consumer
->enabled
) {
2140 /* For each consumer socket, send relayd sockets */
2141 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
2142 socket
, node
.node
) {
2143 /* Code flow error */
2144 assert(socket
->fd
>= 0);
2146 pthread_mutex_lock(socket
->lock
);
2147 send_sockets_relayd_consumer(LTTNG_DOMAIN_UST
, session
,
2148 usess
->consumer
, socket
->fd
);
2149 pthread_mutex_unlock(socket
->lock
);
2150 if (ret
!= LTTCOMM_OK
) {
2154 } else if (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
&&
2155 ksess
->consumer
->enabled
) {
2156 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
2157 socket
, node
.node
) {
2158 /* Code flow error */
2159 assert(socket
->fd
>= 0);
2161 pthread_mutex_lock(socket
->lock
);
2162 send_sockets_relayd_consumer(LTTNG_DOMAIN_KERNEL
, session
,
2163 ksess
->consumer
, socket
->fd
);
2164 pthread_mutex_unlock(socket
->lock
);
2165 if (ret
!= LTTCOMM_OK
) {
2176 * Copy consumer output from the tracing session to the domain session. The
2177 * function also applies the right modification on a per domain basis for the
2178 * trace files destination directory.
2180 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
2183 const char *dir_name
;
2184 struct consumer_output
*consumer
;
2187 case LTTNG_DOMAIN_KERNEL
:
2188 DBG3("Copying tracing session consumer output in kernel session");
2189 session
->kernel_session
->consumer
=
2190 consumer_copy_output(session
->consumer
);
2191 /* Ease our life a bit for the next part */
2192 consumer
= session
->kernel_session
->consumer
;
2193 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
2195 case LTTNG_DOMAIN_UST
:
2196 DBG3("Copying tracing session consumer output in UST session");
2197 session
->ust_session
->consumer
=
2198 consumer_copy_output(session
->consumer
);
2199 /* Ease our life a bit for the next part */
2200 consumer
= session
->ust_session
->consumer
;
2201 dir_name
= DEFAULT_UST_TRACE_DIR
;
2204 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2208 /* Append correct directory to subdir */
2209 strncat(consumer
->subdir
, dir_name
, sizeof(consumer
->subdir
));
2210 DBG3("Copy session consumer subdir %s", consumer
->subdir
);
2212 /* Add default trace directory name */
2213 if (consumer
->type
== CONSUMER_DST_LOCAL
) {
2214 strncat(consumer
->dst
.trace_path
, dir_name
,
2215 sizeof(consumer
->dst
.trace_path
));
2225 * Create an UST session and add it to the session ust list.
2227 static int create_ust_session(struct ltt_session
*session
,
2228 struct lttng_domain
*domain
)
2231 struct ltt_ust_session
*lus
= NULL
;
2234 assert(session
->consumer
);
2236 switch (domain
->type
) {
2237 case LTTNG_DOMAIN_UST
:
2240 ERR("Unknown UST domain on create session %d", domain
->type
);
2241 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2245 DBG("Creating UST session");
2247 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
2249 ret
= LTTCOMM_UST_SESS_FAIL
;
2253 if (session
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2254 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
2255 session
->uid
, session
->gid
);
2257 if (ret
!= -EEXIST
) {
2258 ERR("Trace directory creation error");
2259 ret
= LTTCOMM_UST_SESS_FAIL
;
2265 lus
->uid
= session
->uid
;
2266 lus
->gid
= session
->gid
;
2267 session
->ust_session
= lus
;
2269 /* Copy session output to the newly created UST session */
2270 ret
= copy_session_consumer(domain
->type
, session
);
2271 if (ret
!= LTTCOMM_OK
) {
2279 session
->ust_session
= NULL
;
2284 * Create a kernel tracer session then create the default channel.
2286 static int create_kernel_session(struct ltt_session
*session
)
2290 DBG("Creating kernel session");
2292 ret
= kernel_create_session(session
, kernel_tracer_fd
);
2294 ret
= LTTCOMM_KERN_SESS_FAIL
;
2298 /* Copy session output to the newly created Kernel session */
2299 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
2300 if (ret
!= LTTCOMM_OK
) {
2304 /* Create directory(ies) on local filesystem. */
2305 if (session
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2306 ret
= run_as_mkdir_recursive(
2307 session
->kernel_session
->consumer
->dst
.trace_path
,
2308 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
2310 if (ret
!= -EEXIST
) {
2311 ERR("Trace directory creation error");
2317 session
->kernel_session
->uid
= session
->uid
;
2318 session
->kernel_session
->gid
= session
->gid
;
2323 trace_kernel_destroy_session(session
->kernel_session
);
2324 session
->kernel_session
= NULL
;
2329 * Check if the UID or GID match the session. Root user has access to all
2332 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
2334 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
2342 * Count number of session permitted by uid/gid.
2344 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
2347 struct ltt_session
*session
;
2349 DBG("Counting number of available session for UID %d GID %d",
2351 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2353 * Only list the sessions the user can control.
2355 if (!session_access_ok(session
, uid
, gid
)) {
2364 * Using the session list, filled a lttng_session array to send back to the
2365 * client for session listing.
2367 * The session list lock MUST be acquired before calling this function. Use
2368 * session_lock_list() and session_unlock_list().
2370 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2374 struct ltt_session
*session
;
2376 DBG("Getting all available session for UID %d GID %d",
2379 * Iterate over session list and append data after the control struct in
2382 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2384 * Only list the sessions the user can control.
2386 if (!session_access_ok(session
, uid
, gid
)) {
2389 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2390 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2391 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2392 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2393 sessions
[i
].enabled
= session
->enabled
;
2399 * Fill lttng_channel array of all channels.
2401 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2402 struct lttng_channel
*channels
)
2405 struct ltt_kernel_channel
*kchan
;
2407 DBG("Listing channels for session %s", session
->name
);
2410 case LTTNG_DOMAIN_KERNEL
:
2411 /* Kernel channels */
2412 if (session
->kernel_session
!= NULL
) {
2413 cds_list_for_each_entry(kchan
,
2414 &session
->kernel_session
->channel_list
.head
, list
) {
2415 /* Copy lttng_channel struct to array */
2416 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2417 channels
[i
].enabled
= kchan
->enabled
;
2422 case LTTNG_DOMAIN_UST
:
2424 struct lttng_ht_iter iter
;
2425 struct ltt_ust_channel
*uchan
;
2427 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2428 &iter
.iter
, uchan
, node
.node
) {
2429 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2430 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2431 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2432 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2433 channels
[i
].attr
.switch_timer_interval
=
2434 uchan
->attr
.switch_timer_interval
;
2435 channels
[i
].attr
.read_timer_interval
=
2436 uchan
->attr
.read_timer_interval
;
2437 channels
[i
].enabled
= uchan
->enabled
;
2438 switch (uchan
->attr
.output
) {
2439 case LTTNG_UST_MMAP
:
2441 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2454 * Create a list of ust global domain events.
2456 static int list_lttng_ust_global_events(char *channel_name
,
2457 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2460 unsigned int nb_event
= 0;
2461 struct lttng_ht_iter iter
;
2462 struct lttng_ht_node_str
*node
;
2463 struct ltt_ust_channel
*uchan
;
2464 struct ltt_ust_event
*uevent
;
2465 struct lttng_event
*tmp
;
2467 DBG("Listing UST global events for channel %s", channel_name
);
2471 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2472 node
= lttng_ht_iter_get_node_str(&iter
);
2474 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2478 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2480 nb_event
+= lttng_ht_get_count(uchan
->events
);
2482 if (nb_event
== 0) {
2487 DBG3("Listing UST global %d events", nb_event
);
2489 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2491 ret
= -LTTCOMM_FATAL
;
2495 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2496 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2497 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2498 tmp
[i
].enabled
= uevent
->enabled
;
2499 switch (uevent
->attr
.instrumentation
) {
2500 case LTTNG_UST_TRACEPOINT
:
2501 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2503 case LTTNG_UST_PROBE
:
2504 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2506 case LTTNG_UST_FUNCTION
:
2507 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2510 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2511 switch (uevent
->attr
.loglevel_type
) {
2512 case LTTNG_UST_LOGLEVEL_ALL
:
2513 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2515 case LTTNG_UST_LOGLEVEL_RANGE
:
2516 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2518 case LTTNG_UST_LOGLEVEL_SINGLE
:
2519 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2522 if (uevent
->filter
) {
2537 * Fill lttng_event array of all kernel events in the channel.
2539 static int list_lttng_kernel_events(char *channel_name
,
2540 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2543 unsigned int nb_event
;
2544 struct ltt_kernel_event
*event
;
2545 struct ltt_kernel_channel
*kchan
;
2547 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2548 if (kchan
== NULL
) {
2549 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2553 nb_event
= kchan
->event_count
;
2555 DBG("Listing events for channel %s", kchan
->channel
->name
);
2557 if (nb_event
== 0) {
2562 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2563 if (*events
== NULL
) {
2564 ret
= LTTCOMM_FATAL
;
2568 /* Kernel channels */
2569 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2570 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2571 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2572 (*events
)[i
].enabled
= event
->enabled
;
2573 switch (event
->event
->instrumentation
) {
2574 case LTTNG_KERNEL_TRACEPOINT
:
2575 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2577 case LTTNG_KERNEL_KPROBE
:
2578 case LTTNG_KERNEL_KRETPROBE
:
2579 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2580 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2581 sizeof(struct lttng_kernel_kprobe
));
2583 case LTTNG_KERNEL_FUNCTION
:
2584 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2585 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2586 sizeof(struct lttng_kernel_function
));
2588 case LTTNG_KERNEL_NOOP
:
2589 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2591 case LTTNG_KERNEL_SYSCALL
:
2592 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2594 case LTTNG_KERNEL_ALL
:
2608 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2610 static int cmd_disable_channel(struct ltt_session
*session
,
2611 int domain
, char *channel_name
)
2614 struct ltt_ust_session
*usess
;
2616 usess
= session
->ust_session
;
2619 case LTTNG_DOMAIN_KERNEL
:
2621 ret
= channel_kernel_disable(session
->kernel_session
,
2623 if (ret
!= LTTCOMM_OK
) {
2627 kernel_wait_quiescent(kernel_tracer_fd
);
2630 case LTTNG_DOMAIN_UST
:
2632 struct ltt_ust_channel
*uchan
;
2633 struct lttng_ht
*chan_ht
;
2635 chan_ht
= usess
->domain_global
.channels
;
2637 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2638 if (uchan
== NULL
) {
2639 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2643 ret
= channel_ust_disable(usess
, domain
, uchan
);
2644 if (ret
!= LTTCOMM_OK
) {
2650 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2651 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2652 case LTTNG_DOMAIN_UST_PID
:
2655 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2666 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2668 static int cmd_enable_channel(struct ltt_session
*session
,
2669 int domain
, struct lttng_channel
*attr
)
2672 struct ltt_ust_session
*usess
= session
->ust_session
;
2673 struct lttng_ht
*chan_ht
;
2675 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2678 case LTTNG_DOMAIN_KERNEL
:
2680 struct ltt_kernel_channel
*kchan
;
2682 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2683 session
->kernel_session
);
2684 if (kchan
== NULL
) {
2685 ret
= channel_kernel_create(session
->kernel_session
,
2686 attr
, kernel_poll_pipe
[1]);
2688 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2691 if (ret
!= LTTCOMM_OK
) {
2695 kernel_wait_quiescent(kernel_tracer_fd
);
2698 case LTTNG_DOMAIN_UST
:
2700 struct ltt_ust_channel
*uchan
;
2702 chan_ht
= usess
->domain_global
.channels
;
2704 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2705 if (uchan
== NULL
) {
2706 ret
= channel_ust_create(usess
, domain
, attr
);
2708 ret
= channel_ust_enable(usess
, domain
, uchan
);
2713 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2714 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2715 case LTTNG_DOMAIN_UST_PID
:
2718 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2727 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2729 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2730 char *channel_name
, char *event_name
)
2735 case LTTNG_DOMAIN_KERNEL
:
2737 struct ltt_kernel_channel
*kchan
;
2738 struct ltt_kernel_session
*ksess
;
2740 ksess
= session
->kernel_session
;
2742 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2743 if (kchan
== NULL
) {
2744 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2748 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2749 if (ret
!= LTTCOMM_OK
) {
2753 kernel_wait_quiescent(kernel_tracer_fd
);
2756 case LTTNG_DOMAIN_UST
:
2758 struct ltt_ust_channel
*uchan
;
2759 struct ltt_ust_session
*usess
;
2761 usess
= session
->ust_session
;
2763 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2765 if (uchan
== NULL
) {
2766 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2770 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2771 if (ret
!= LTTCOMM_OK
) {
2775 DBG3("Disable UST event %s in channel %s completed", event_name
,
2780 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2781 case LTTNG_DOMAIN_UST_PID
:
2782 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2796 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2798 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2804 case LTTNG_DOMAIN_KERNEL
:
2806 struct ltt_kernel_session
*ksess
;
2807 struct ltt_kernel_channel
*kchan
;
2809 ksess
= session
->kernel_session
;
2811 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2812 if (kchan
== NULL
) {
2813 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2817 ret
= event_kernel_disable_all(ksess
, kchan
);
2818 if (ret
!= LTTCOMM_OK
) {
2822 kernel_wait_quiescent(kernel_tracer_fd
);
2825 case LTTNG_DOMAIN_UST
:
2827 struct ltt_ust_session
*usess
;
2828 struct ltt_ust_channel
*uchan
;
2830 usess
= session
->ust_session
;
2832 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2834 if (uchan
== NULL
) {
2835 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2839 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2844 DBG3("Disable all UST events in channel %s completed", channel_name
);
2849 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2850 case LTTNG_DOMAIN_UST_PID
:
2851 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2865 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2867 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2868 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2873 case LTTNG_DOMAIN_KERNEL
:
2874 /* Add kernel context to kernel tracer */
2875 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2876 event_name
, channel_name
);
2877 if (ret
!= LTTCOMM_OK
) {
2881 case LTTNG_DOMAIN_UST
:
2883 struct ltt_ust_session
*usess
= session
->ust_session
;
2885 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2886 if (ret
!= LTTCOMM_OK
) {
2892 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2893 case LTTNG_DOMAIN_UST_PID
:
2894 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2908 * Command LTTNG_SET_FILTER processed by the client thread.
2910 static int cmd_set_filter(struct ltt_session
*session
, int domain
,
2911 char *channel_name
, char *event_name
,
2912 struct lttng_filter_bytecode
*bytecode
)
2917 case LTTNG_DOMAIN_KERNEL
:
2918 ret
= LTTCOMM_FATAL
;
2920 case LTTNG_DOMAIN_UST
:
2922 struct ltt_ust_session
*usess
= session
->ust_session
;
2924 ret
= filter_ust_set(usess
, domain
, bytecode
, event_name
, channel_name
);
2925 if (ret
!= LTTCOMM_OK
) {
2931 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2932 case LTTNG_DOMAIN_UST_PID
:
2933 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2948 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2950 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2951 char *channel_name
, struct lttng_event
*event
)
2954 struct lttng_channel
*attr
;
2955 struct ltt_ust_session
*usess
= session
->ust_session
;
2958 case LTTNG_DOMAIN_KERNEL
:
2960 struct ltt_kernel_channel
*kchan
;
2962 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2963 session
->kernel_session
);
2964 if (kchan
== NULL
) {
2965 attr
= channel_new_default_attr(domain
);
2967 ret
= LTTCOMM_FATAL
;
2970 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2972 /* This call will notify the kernel thread */
2973 ret
= channel_kernel_create(session
->kernel_session
,
2974 attr
, kernel_poll_pipe
[1]);
2975 if (ret
!= LTTCOMM_OK
) {
2982 /* Get the newly created kernel channel pointer */
2983 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2984 session
->kernel_session
);
2985 if (kchan
== NULL
) {
2986 /* This sould not happen... */
2987 ret
= LTTCOMM_FATAL
;
2991 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2993 if (ret
!= LTTCOMM_OK
) {
2997 kernel_wait_quiescent(kernel_tracer_fd
);
3000 case LTTNG_DOMAIN_UST
:
3002 struct lttng_channel
*attr
;
3003 struct ltt_ust_channel
*uchan
;
3005 /* Get channel from global UST domain */
3006 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3008 if (uchan
== NULL
) {
3009 /* Create default channel */
3010 attr
= channel_new_default_attr(domain
);
3012 ret
= LTTCOMM_FATAL
;
3015 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3016 attr
->name
[NAME_MAX
- 1] = '\0';
3018 ret
= channel_ust_create(usess
, domain
, attr
);
3019 if (ret
!= LTTCOMM_OK
) {
3025 /* Get the newly created channel reference back */
3026 uchan
= trace_ust_find_channel_by_name(
3027 usess
->domain_global
.channels
, channel_name
);
3028 if (uchan
== NULL
) {
3029 /* Something is really wrong */
3030 ret
= LTTCOMM_FATAL
;
3035 /* At this point, the session and channel exist on the tracer */
3036 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
3037 if (ret
!= LTTCOMM_OK
) {
3043 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3044 case LTTNG_DOMAIN_UST_PID
:
3045 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3059 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
3061 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
3062 char *channel_name
, int event_type
)
3065 struct ltt_kernel_channel
*kchan
;
3068 case LTTNG_DOMAIN_KERNEL
:
3069 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3070 session
->kernel_session
);
3071 if (kchan
== NULL
) {
3072 /* This call will notify the kernel thread */
3073 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
3074 kernel_poll_pipe
[1]);
3075 if (ret
!= LTTCOMM_OK
) {
3079 /* Get the newly created kernel channel pointer */
3080 kchan
= trace_kernel_get_channel_by_name(channel_name
,
3081 session
->kernel_session
);
3082 if (kchan
== NULL
) {
3083 /* This sould not happen... */
3084 ret
= LTTCOMM_FATAL
;
3090 switch (event_type
) {
3091 case LTTNG_EVENT_SYSCALL
:
3092 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
3093 kchan
, kernel_tracer_fd
);
3095 case LTTNG_EVENT_TRACEPOINT
:
3097 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
3098 * events already registered to the channel.
3100 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
3101 kchan
, kernel_tracer_fd
);
3103 case LTTNG_EVENT_ALL
:
3104 /* Enable syscalls and tracepoints */
3105 ret
= event_kernel_enable_all(session
->kernel_session
,
3106 kchan
, kernel_tracer_fd
);
3109 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3113 /* Manage return value */
3114 if (ret
!= LTTCOMM_OK
) {
3118 kernel_wait_quiescent(kernel_tracer_fd
);
3120 case LTTNG_DOMAIN_UST
:
3122 struct lttng_channel
*attr
;
3123 struct ltt_ust_channel
*uchan
;
3124 struct ltt_ust_session
*usess
= session
->ust_session
;
3126 /* Get channel from global UST domain */
3127 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
3129 if (uchan
== NULL
) {
3130 /* Create default channel */
3131 attr
= channel_new_default_attr(domain
);
3133 ret
= LTTCOMM_FATAL
;
3136 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
3137 attr
->name
[NAME_MAX
- 1] = '\0';
3139 /* Use the internal command enable channel */
3140 ret
= channel_ust_create(usess
, domain
, attr
);
3141 if (ret
!= LTTCOMM_OK
) {
3147 /* Get the newly created channel reference back */
3148 uchan
= trace_ust_find_channel_by_name(
3149 usess
->domain_global
.channels
, channel_name
);
3150 if (uchan
== NULL
) {
3151 /* Something is really wrong */
3152 ret
= LTTCOMM_FATAL
;
3157 /* At this point, the session and channel exist on the tracer */
3159 switch (event_type
) {
3160 case LTTNG_EVENT_ALL
:
3161 case LTTNG_EVENT_TRACEPOINT
:
3162 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
3163 if (ret
!= LTTCOMM_OK
) {
3168 ret
= LTTCOMM_UST_ENABLE_FAIL
;
3172 /* Manage return value */
3173 if (ret
!= LTTCOMM_OK
) {
3180 case LTTNG_DOMAIN_UST_EXEC_NAME
:
3181 case LTTNG_DOMAIN_UST_PID
:
3182 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
3196 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
3198 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
3201 ssize_t nb_events
= 0;
3204 case LTTNG_DOMAIN_KERNEL
:
3205 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
3206 if (nb_events
< 0) {
3207 ret
= LTTCOMM_KERN_LIST_FAIL
;
3211 case LTTNG_DOMAIN_UST
:
3212 nb_events
= ust_app_list_events(events
);
3213 if (nb_events
< 0) {
3214 ret
= LTTCOMM_UST_LIST_FAIL
;
3226 /* Return negative value to differentiate return code */
3231 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
3233 static ssize_t
cmd_list_tracepoint_fields(int domain
,
3234 struct lttng_event_field
**fields
)
3237 ssize_t nb_fields
= 0;
3240 case LTTNG_DOMAIN_UST
:
3241 nb_fields
= ust_app_list_event_fields(fields
);
3242 if (nb_fields
< 0) {
3243 ret
= LTTCOMM_UST_LIST_FAIL
;
3247 case LTTNG_DOMAIN_KERNEL
:
3248 default: /* fall-through */
3256 /* Return negative value to differentiate return code */
3261 * Command LTTNG_START_TRACE processed by the client thread.
3263 static int cmd_start_trace(struct ltt_session
*session
)
3266 struct ltt_kernel_session
*ksession
;
3267 struct ltt_ust_session
*usess
;
3268 struct ltt_kernel_channel
*kchan
;
3270 /* Ease our life a bit ;) */
3271 ksession
= session
->kernel_session
;
3272 usess
= session
->ust_session
;
3274 if (session
->enabled
) {
3275 /* Already started. */
3276 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3280 session
->enabled
= 1;
3282 ret
= setup_relayd(session
);
3283 if (ret
!= LTTCOMM_OK
) {
3284 ERR("Error setting up relayd for session %s", session
->name
);
3288 /* Kernel tracing */
3289 if (ksession
!= NULL
) {
3290 /* Open kernel metadata */
3291 if (ksession
->metadata
== NULL
) {
3292 ret
= kernel_open_metadata(ksession
,
3293 ksession
->consumer
->dst
.trace_path
);
3295 ret
= LTTCOMM_KERN_META_FAIL
;
3300 /* Open kernel metadata stream */
3301 if (ksession
->metadata_stream_fd
< 0) {
3302 ret
= kernel_open_metadata_stream(ksession
);
3304 ERR("Kernel create metadata stream failed");
3305 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3310 /* For each channel */
3311 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3312 if (kchan
->stream_count
== 0) {
3313 ret
= kernel_open_channel_stream(kchan
);
3315 ret
= LTTCOMM_KERN_STREAM_FAIL
;
3318 /* Update the stream global counter */
3319 ksession
->stream_count_global
+= ret
;
3323 /* Setup kernel consumer socket and send fds to it */
3324 ret
= init_kernel_tracing(ksession
);
3326 ret
= LTTCOMM_KERN_START_FAIL
;
3330 /* This start the kernel tracing */
3331 ret
= kernel_start_session(ksession
);
3333 ret
= LTTCOMM_KERN_START_FAIL
;
3337 /* Quiescent wait after starting trace */
3338 kernel_wait_quiescent(kernel_tracer_fd
);
3341 /* Flag session that trace should start automatically */
3343 usess
->start_trace
= 1;
3345 ret
= ust_app_start_trace_all(usess
);
3347 ret
= LTTCOMM_UST_START_FAIL
;
3359 * Command LTTNG_STOP_TRACE processed by the client thread.
3361 static int cmd_stop_trace(struct ltt_session
*session
)
3364 struct ltt_kernel_channel
*kchan
;
3365 struct ltt_kernel_session
*ksession
;
3366 struct ltt_ust_session
*usess
;
3369 ksession
= session
->kernel_session
;
3370 usess
= session
->ust_session
;
3372 if (!session
->enabled
) {
3373 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
3377 session
->enabled
= 0;
3380 if (ksession
!= NULL
) {
3381 DBG("Stop kernel tracing");
3383 /* Flush metadata if exist */
3384 if (ksession
->metadata_stream_fd
>= 0) {
3385 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
3387 ERR("Kernel metadata flush failed");
3391 /* Flush all buffers before stopping */
3392 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
3393 ret
= kernel_flush_buffer(kchan
);
3395 ERR("Kernel flush buffer error");
3399 ret
= kernel_stop_session(ksession
);
3401 ret
= LTTCOMM_KERN_STOP_FAIL
;
3405 kernel_wait_quiescent(kernel_tracer_fd
);
3409 usess
->start_trace
= 0;
3411 ret
= ust_app_stop_trace_all(usess
);
3413 ret
= LTTCOMM_UST_STOP_FAIL
;
3425 * Command LTTNG_CREATE_SESSION_URI processed by the client thread.
3427 static int cmd_create_session_uri(char *name
, struct lttng_uri
*ctrl_uri
,
3428 struct lttng_uri
*data_uri
, unsigned int enable_consumer
,
3429 lttng_sock_cred
*creds
)
3433 struct ltt_session
*session
;
3434 struct consumer_output
*consumer
;
3436 /* Verify if the session already exist */
3437 session
= session_find_by_name(name
);
3438 if (session
!= NULL
) {
3439 ret
= LTTCOMM_EXIST_SESS
;
3443 /* TODO: validate URIs */
3445 /* Create default consumer output */
3446 consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
3447 if (consumer
== NULL
) {
3448 ret
= LTTCOMM_FATAL
;
3451 strncpy(consumer
->subdir
, ctrl_uri
->subdir
, sizeof(consumer
->subdir
));
3452 DBG2("Consumer subdir set to %s", consumer
->subdir
);
3454 switch (ctrl_uri
->dtype
) {
3455 case LTTNG_DST_IPV4
:
3456 case LTTNG_DST_IPV6
:
3457 /* Set control URI into consumer output object */
3458 ret
= consumer_set_network_uri(consumer
, ctrl_uri
);
3460 ret
= LTTCOMM_FATAL
;
3464 /* Set data URI into consumer output object */
3465 ret
= consumer_set_network_uri(consumer
, data_uri
);
3467 ret
= LTTCOMM_FATAL
;
3471 /* Empty path since the session is network */
3474 case LTTNG_DST_PATH
:
3475 /* Very volatile pointer. Only used for the create session. */
3476 path
= ctrl_uri
->dst
.path
;
3477 strncpy(consumer
->dst
.trace_path
, path
,
3478 sizeof(consumer
->dst
.trace_path
));
3482 /* Set if the consumer is enabled or not */
3483 consumer
->enabled
= enable_consumer
;
3485 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
3486 LTTNG_SOCK_GET_GID_CRED(creds
));
3487 if (ret
!= LTTCOMM_OK
) {
3488 goto consumer_error
;
3491 /* Get the newly created session pointer back */
3492 session
= session_find_by_name(name
);
3495 /* Assign consumer to session */
3496 session
->consumer
= consumer
;
3501 consumer_destroy_output(consumer
);
3507 * Command LTTNG_CREATE_SESSION processed by the client thread.
3509 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
3512 struct lttng_uri uri
;
3514 /* Zeroed temporary URI */
3515 memset(&uri
, 0, sizeof(uri
));
3517 uri
.dtype
= LTTNG_DST_PATH
;
3518 uri
.utype
= LTTNG_URI_DST
;
3519 strncpy(uri
.dst
.path
, path
, sizeof(uri
.dst
.path
));
3521 /* TODO: Strip date-time from path and put it in uri's subdir */
3523 ret
= cmd_create_session_uri(name
, &uri
, NULL
, 1, creds
);
3524 if (ret
!= LTTCOMM_OK
) {
3533 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3535 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3542 /* Clean kernel session teardown */
3543 teardown_kernel_session(session
);
3544 /* UST session teardown */
3545 teardown_ust_session(session
);
3548 * Must notify the kernel thread here to update it's poll setin order
3549 * to remove the channel(s)' fd just destroyed.
3551 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3553 PERROR("write kernel poll pipe");
3556 ret
= session_destroy(session
);
3562 * Command LTTNG_CALIBRATE processed by the client thread.
3564 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3569 case LTTNG_DOMAIN_KERNEL
:
3571 struct lttng_kernel_calibrate kcalibrate
;
3573 kcalibrate
.type
= calibrate
->type
;
3574 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3576 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3581 case LTTNG_DOMAIN_UST
:
3583 struct lttng_ust_calibrate ucalibrate
;
3585 ucalibrate
.type
= calibrate
->type
;
3586 ret
= ust_app_calibrate_glb(&ucalibrate
);
3588 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3605 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3607 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3611 struct consumer_socket
*socket
;
3614 case LTTNG_DOMAIN_KERNEL
:
3615 /* Can't register a consumer if there is already one */
3616 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3617 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3621 sock
= lttcomm_connect_unix_sock(sock_path
);
3623 ret
= LTTCOMM_CONNECT_FAIL
;
3627 socket
= consumer_allocate_socket(sock
);
3628 if (socket
== NULL
) {
3629 ret
= LTTCOMM_FATAL
;
3634 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3635 if (socket
->lock
== NULL
) {
3636 PERROR("zmalloc pthread mutex");
3637 ret
= LTTCOMM_FATAL
;
3640 pthread_mutex_init(socket
->lock
, NULL
);
3643 consumer_add_socket(socket
, session
->kernel_session
->consumer
);
3646 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3647 kconsumer_data
.pid
= -1;
3648 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3652 /* TODO: Userspace tracing */
3664 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3666 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3667 struct lttng_domain
**domains
)
3672 if (session
->kernel_session
!= NULL
) {
3673 DBG3("Listing domains found kernel domain");
3677 if (session
->ust_session
!= NULL
) {
3678 DBG3("Listing domains found UST global domain");
3682 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3683 if (*domains
== NULL
) {
3684 ret
= -LTTCOMM_FATAL
;
3688 if (session
->kernel_session
!= NULL
) {
3689 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3693 if (session
->ust_session
!= NULL
) {
3694 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3705 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3707 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3708 struct lttng_channel
**channels
)
3711 ssize_t nb_chan
= 0;
3714 case LTTNG_DOMAIN_KERNEL
:
3715 if (session
->kernel_session
!= NULL
) {
3716 nb_chan
= session
->kernel_session
->channel_count
;
3718 DBG3("Number of kernel channels %zd", nb_chan
);
3720 case LTTNG_DOMAIN_UST
:
3721 if (session
->ust_session
!= NULL
) {
3722 nb_chan
= lttng_ht_get_count(
3723 session
->ust_session
->domain_global
.channels
);
3725 DBG3("Number of UST global channels %zd", nb_chan
);
3734 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3735 if (*channels
== NULL
) {
3736 ret
= -LTTCOMM_FATAL
;
3740 list_lttng_channels(domain
, session
, *channels
);
3752 * Command LTTNG_LIST_EVENTS processed by the client thread.
3754 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3755 char *channel_name
, struct lttng_event
**events
)
3758 ssize_t nb_event
= 0;
3761 case LTTNG_DOMAIN_KERNEL
:
3762 if (session
->kernel_session
!= NULL
) {
3763 nb_event
= list_lttng_kernel_events(channel_name
,
3764 session
->kernel_session
, events
);
3767 case LTTNG_DOMAIN_UST
:
3769 if (session
->ust_session
!= NULL
) {
3770 nb_event
= list_lttng_ust_global_events(channel_name
,
3771 &session
->ust_session
->domain_global
, events
);
3787 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
3789 static int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
3790 struct lttng_uri
*uri
)
3793 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3794 struct ltt_ust_session
*usess
= session
->ust_session
;
3795 struct consumer_output
*consumer
;
3797 /* Can't enable consumer after session started. */
3798 if (session
->enabled
) {
3799 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3804 case LTTNG_DOMAIN_KERNEL
:
3806 struct lttng_ht_iter iter
;
3807 struct consumer_socket
*socket
;
3809 /* Code flow error if we don't have a kernel session here. */
3812 /* Create consumer output if none exists */
3813 consumer
= ksess
->tmp_consumer
;
3814 if (consumer
== NULL
) {
3815 consumer
= consumer_copy_output(ksess
->consumer
);
3816 if (consumer
== NULL
) {
3817 ret
= LTTCOMM_FATAL
;
3820 /* Reassign new pointer */
3821 ksess
->tmp_consumer
= consumer
;
3824 switch (uri
->dtype
) {
3825 case LTTNG_DST_IPV4
:
3826 case LTTNG_DST_IPV6
:
3827 DBG2("Setting network URI for kernel session %s", session
->name
);
3829 /* Set URI into consumer output object */
3830 ret
= consumer_set_network_uri(consumer
, uri
);
3832 ret
= LTTCOMM_FATAL
;
3836 /* On a new subdir, reappend the default trace dir. */
3837 if (strlen(uri
->subdir
) != 0) {
3838 strncat(consumer
->subdir
, DEFAULT_KERNEL_TRACE_DIR
,
3839 sizeof(consumer
->subdir
));
3842 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
,
3843 socket
, node
.node
) {
3844 /* Code flow error */
3845 assert(socket
->fd
>= 0);
3847 pthread_mutex_lock(socket
->lock
);
3848 ret
= send_socket_relayd_consumer(domain
, session
, uri
, consumer
,
3850 pthread_mutex_unlock(socket
->lock
);
3851 if (ret
!= LTTCOMM_OK
) {
3857 case LTTNG_DST_PATH
:
3858 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
3859 memset(consumer
->dst
.trace_path
, 0,
3860 sizeof(consumer
->dst
.trace_path
));
3861 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
3862 sizeof(consumer
->dst
.trace_path
));
3863 /* Append default kernel trace dir */
3864 strncat(consumer
->dst
.trace_path
, DEFAULT_KERNEL_TRACE_DIR
,
3865 sizeof(consumer
->dst
.trace_path
));
3872 case LTTNG_DOMAIN_UST
:
3873 /* Code flow error if we don't have a kernel session here. */
3876 /* Create consumer output if none exists */
3877 consumer
= usess
->tmp_consumer
;
3878 if (consumer
== NULL
) {
3879 consumer
= consumer_copy_output(usess
->consumer
);
3880 if (consumer
== NULL
) {
3881 ret
= LTTCOMM_FATAL
;
3884 /* Reassign new pointer */
3885 usess
->tmp_consumer
= consumer
;
3888 switch (uri
->dtype
) {
3889 case LTTNG_DST_IPV4
:
3890 case LTTNG_DST_IPV6
:
3892 struct consumer_socket
*socket
;
3894 DBG2("Setting network URI for UST session %s", session
->name
);
3896 /* Set URI into consumer object */
3897 ret
= consumer_set_network_uri(consumer
, uri
);
3899 ret
= LTTCOMM_FATAL
;
3903 /* On a new subdir, reappend the default trace dir. */
3904 if (strlen(uri
->subdir
) != 0) {
3905 strncat(consumer
->subdir
, DEFAULT_UST_TRACE_DIR
,
3906 sizeof(consumer
->subdir
));
3910 socket
= consumer_find_socket(uatomic_read(&ust_consumerd64_fd
),
3912 if (socket
!= NULL
) {
3913 pthread_mutex_lock(socket
->lock
);
3914 ret
= send_socket_relayd_consumer(domain
, session
, uri
,
3915 consumer
, socket
->fd
);
3916 pthread_mutex_unlock(socket
->lock
);
3917 if (ret
!= LTTCOMM_OK
) {
3922 socket
= consumer_find_socket(uatomic_read(&ust_consumerd32_fd
),
3924 if (socket
!= NULL
) {
3925 pthread_mutex_lock(socket
->lock
);
3926 ret
= send_socket_relayd_consumer(domain
, session
, uri
,
3927 consumer
, socket
->fd
);
3928 pthread_mutex_unlock(socket
->lock
);
3929 if (ret
!= LTTCOMM_OK
) {
3936 case LTTNG_DST_PATH
:
3937 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
3938 memset(consumer
->dst
.trace_path
, 0,
3939 sizeof(consumer
->dst
.trace_path
));
3940 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
3941 sizeof(consumer
->dst
.trace_path
));
3942 /* Append default UST trace dir */
3943 strncat(consumer
->dst
.trace_path
, DEFAULT_UST_TRACE_DIR
,
3944 sizeof(consumer
->dst
.trace_path
));
3958 * Command LTTNG_DISABLE_CONSUMER processed by the client thread.
3960 static int cmd_disable_consumer(int domain
, struct ltt_session
*session
)
3963 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3964 struct ltt_ust_session
*usess
= session
->ust_session
;
3965 struct consumer_output
*consumer
;
3967 if (session
->enabled
) {
3968 /* Can't disable consumer on an already started session */
3969 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
3974 case LTTNG_DOMAIN_KERNEL
:
3975 /* Code flow error if we don't have a kernel session here. */
3978 DBG("Disabling kernel consumer");
3979 consumer
= ksess
->consumer
;
3982 case LTTNG_DOMAIN_UST
:
3983 /* Code flow error if we don't have a UST session here. */
3986 DBG("Disabling UST consumer");
3987 consumer
= usess
->consumer
;
3991 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
3996 consumer
->enabled
= 0;
3998 /* Success at this point */
4006 * Command LTTNG_ENABLE_CONSUMER processed by the client thread.
4008 static int cmd_enable_consumer(int domain
, struct ltt_session
*session
)
4011 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
4012 struct ltt_ust_session
*usess
= session
->ust_session
;
4013 struct consumer_output
*tmp_out
;
4015 /* Can't enable consumer after session started. */
4016 if (session
->enabled
) {
4017 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
4022 case LTTNG_DOMAIN_KERNEL
:
4023 /* Code flow error if we don't have a kernel session here. */
4027 * Check if we have already sent fds to the consumer. In that case,
4028 * the enable-consumer command can't be used because a start trace
4029 * had previously occured.
4031 if (ksess
->consumer_fds_sent
) {
4032 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4036 tmp_out
= ksess
->tmp_consumer
;
4037 if (tmp_out
== NULL
) {
4038 /* No temp. consumer output exists. Using the current one. */
4039 DBG3("No temporary consumer. Using default");
4044 switch (tmp_out
->type
) {
4045 case CONSUMER_DST_LOCAL
:
4046 DBG2("Consumer output is local. Creating directory(ies)");
4048 /* Create directory(ies) */
4049 ret
= run_as_mkdir_recursive(tmp_out
->dst
.trace_path
,
4050 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4052 if (ret
!= -EEXIST
) {
4053 ERR("Trace directory creation error");
4054 ret
= LTTCOMM_FATAL
;
4059 case CONSUMER_DST_NET
:
4060 DBG2("Consumer output is network. Validating URIs");
4061 /* Validate if we have both control and data path set. */
4062 if (!tmp_out
->dst
.net
.control_isset
) {
4063 ret
= LTTCOMM_URI_CTRL_MISS
;
4067 if (!tmp_out
->dst
.net
.data_isset
) {
4068 ret
= LTTCOMM_URI_DATA_MISS
;
4072 /* Check established network session state */
4073 if (session
->net_handle
== 0) {
4074 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4075 ERR("Session network handle is not set on enable-consumer");
4079 /* Append default kernel trace dir to subdir */
4080 strncat(ksess
->consumer
->subdir
, DEFAULT_KERNEL_TRACE_DIR
,
4081 sizeof(ksess
->consumer
->subdir
));
4088 * This is race free for now since the session lock is acquired before
4089 * ending up in this function. No other threads can access this kernel
4090 * session without this lock hence freeing the consumer output object
4093 consumer_destroy_output(ksess
->consumer
);
4094 ksess
->consumer
= tmp_out
;
4095 ksess
->tmp_consumer
= NULL
;
4098 case LTTNG_DOMAIN_UST
:
4099 /* Code flow error if we don't have a UST session here. */
4103 * Check if we have already sent fds to the consumer. In that case,
4104 * the enable-consumer command can't be used because a start trace
4105 * had previously occured.
4107 if (usess
->start_trace
) {
4108 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4112 tmp_out
= usess
->tmp_consumer
;
4113 if (tmp_out
== NULL
) {
4114 /* No temp. consumer output exists. Using the current one. */
4115 DBG3("No temporary consumer. Using default");
4120 switch (tmp_out
->type
) {
4121 case CONSUMER_DST_LOCAL
:
4122 DBG2("Consumer output is local. Creating directory(ies)");
4124 /* Create directory(ies) */
4125 ret
= run_as_mkdir_recursive(tmp_out
->dst
.trace_path
,
4126 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
4128 if (ret
!= -EEXIST
) {
4129 ERR("Trace directory creation error");
4130 ret
= LTTCOMM_FATAL
;
4135 case CONSUMER_DST_NET
:
4136 DBG2("Consumer output is network. Validating URIs");
4137 /* Validate if we have both control and data path set. */
4138 if (!tmp_out
->dst
.net
.control_isset
) {
4139 ret
= LTTCOMM_URI_CTRL_MISS
;
4143 if (!tmp_out
->dst
.net
.data_isset
) {
4144 ret
= LTTCOMM_URI_DATA_MISS
;
4148 /* Check established network session state */
4149 if (session
->net_handle
== 0) {
4150 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4151 DBG2("Session network handle is not set on enable-consumer");
4155 if (tmp_out
->net_seq_index
== -1) {
4156 ret
= LTTCOMM_ENABLE_CONSUMER_FAIL
;
4157 DBG2("Network index is not set on the consumer");
4161 /* Append default kernel trace dir to subdir */
4162 strncat(usess
->consumer
->subdir
, DEFAULT_UST_TRACE_DIR
,
4163 sizeof(usess
->consumer
->subdir
));
4170 * This is race free for now since the session lock is acquired before
4171 * ending up in this function. No other threads can access this kernel
4172 * session without this lock hence freeing the consumer output object
4175 consumer_destroy_output(usess
->consumer
);
4176 usess
->consumer
= tmp_out
;
4177 usess
->tmp_consumer
= NULL
;
4182 /* Success at this point */
4190 * Process the command requested by the lttng client within the command
4191 * context structure. This function make sure that the return structure (llm)
4192 * is set and ready for transmission before returning.
4194 * Return any error encountered or 0 for success.
4196 * "sock" is only used for special-case var. len data.
4198 static int process_client_msg(struct command_ctx
*cmd_ctx
, int sock
,
4201 int ret
= LTTCOMM_OK
;
4202 int need_tracing_session
= 1;
4205 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
4209 switch (cmd_ctx
->lsm
->cmd_type
) {
4210 case LTTNG_CREATE_SESSION
:
4211 case LTTNG_CREATE_SESSION_URI
:
4212 case LTTNG_DESTROY_SESSION
:
4213 case LTTNG_LIST_SESSIONS
:
4214 case LTTNG_LIST_DOMAINS
:
4215 case LTTNG_START_TRACE
:
4216 case LTTNG_STOP_TRACE
:
4223 if (opt_no_kernel
&& need_domain
4224 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
4226 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4228 ret
= LTTCOMM_KERN_NA
;
4234 * Check for command that don't needs to allocate a returned payload. We do
4235 * this here so we don't have to make the call for no payload at each
4238 switch(cmd_ctx
->lsm
->cmd_type
) {
4239 case LTTNG_LIST_SESSIONS
:
4240 case LTTNG_LIST_TRACEPOINTS
:
4241 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4242 case LTTNG_LIST_DOMAINS
:
4243 case LTTNG_LIST_CHANNELS
:
4244 case LTTNG_LIST_EVENTS
:
4247 /* Setup lttng message with no payload */
4248 ret
= setup_lttng_msg(cmd_ctx
, 0);
4250 /* This label does not try to unlock the session */
4251 goto init_setup_error
;
4255 /* Commands that DO NOT need a session. */
4256 switch (cmd_ctx
->lsm
->cmd_type
) {
4257 case LTTNG_CREATE_SESSION
:
4258 case LTTNG_CREATE_SESSION_URI
:
4259 case LTTNG_CALIBRATE
:
4260 case LTTNG_LIST_SESSIONS
:
4261 case LTTNG_LIST_TRACEPOINTS
:
4262 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4263 need_tracing_session
= 0;
4266 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
4268 * We keep the session list lock across _all_ commands
4269 * for now, because the per-session lock does not
4270 * handle teardown properly.
4272 session_lock_list();
4273 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
4274 if (cmd_ctx
->session
== NULL
) {
4275 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
4276 ret
= LTTCOMM_SESS_NOT_FOUND
;
4278 /* If no session name specified */
4279 ret
= LTTCOMM_SELECT_SESS
;
4283 /* Acquire lock for the session */
4284 session_lock(cmd_ctx
->session
);
4293 * Check domain type for specific "pre-action".
4295 switch (cmd_ctx
->lsm
->domain
.type
) {
4296 case LTTNG_DOMAIN_KERNEL
:
4298 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
4302 /* Kernel tracer check */
4303 if (kernel_tracer_fd
== -1) {
4304 /* Basically, load kernel tracer modules */
4305 ret
= init_kernel_tracer();
4311 /* Consumer is in an ERROR state. Report back to client */
4312 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
4313 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4317 /* Need a session for kernel command */
4318 if (need_tracing_session
) {
4319 struct consumer_socket
*socket
;
4321 if (cmd_ctx
->session
->kernel_session
== NULL
) {
4322 ret
= create_kernel_session(cmd_ctx
->session
);
4324 ret
= LTTCOMM_KERN_SESS_FAIL
;
4329 /* Start the kernel consumer daemon */
4330 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
4331 if (kconsumer_data
.pid
== 0 &&
4332 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
4333 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4334 ret
= start_consumerd(&kconsumer_data
);
4336 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
4339 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
4341 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
4344 /* Set kernel consumer socket fd */
4345 if (kconsumer_data
.cmd_sock
>= 0) {
4347 socket
= consumer_find_socket(kconsumer_data
.cmd_sock
,
4348 cmd_ctx
->session
->kernel_session
->consumer
);
4350 if (socket
== NULL
) {
4351 socket
= consumer_allocate_socket(kconsumer_data
.cmd_sock
);
4352 if (socket
== NULL
) {
4356 socket
->lock
= &kconsumer_data
.lock
;
4358 consumer_add_socket(socket
,
4359 cmd_ctx
->session
->kernel_session
->consumer
);
4366 case LTTNG_DOMAIN_UST
:
4368 /* Consumer is in an ERROR state. Report back to client */
4369 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
4370 ret
= LTTCOMM_NO_USTCONSUMERD
;
4374 if (need_tracing_session
) {
4375 struct consumer_socket
*socket
;
4377 if (cmd_ctx
->session
->ust_session
== NULL
) {
4378 ret
= create_ust_session(cmd_ctx
->session
,
4379 &cmd_ctx
->lsm
->domain
);
4380 if (ret
!= LTTCOMM_OK
) {
4385 /* Start the UST consumer daemons */
4387 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
4388 if (consumerd64_bin
[0] != '\0' &&
4389 ustconsumer64_data
.pid
== 0 &&
4390 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
4391 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4392 ret
= start_consumerd(&ustconsumer64_data
);
4394 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
4395 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
4399 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
4400 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4402 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
4406 * Setup socket for consumer 64 bit. No need for atomic access
4407 * since it was set above and can ONLY be set in this thread.
4409 if (ust_consumerd64_fd
>= 0) {
4411 socket
= consumer_find_socket(uatomic_read(&ust_consumerd64_fd
),
4412 cmd_ctx
->session
->ust_session
->consumer
);
4414 if (socket
== NULL
) {
4415 socket
= consumer_allocate_socket(ust_consumerd64_fd
);
4416 if (socket
== NULL
) {
4419 socket
->lock
= &ustconsumer32_data
.lock
;
4422 consumer_add_socket(socket
,
4423 cmd_ctx
->session
->ust_session
->consumer
);
4426 DBG3("UST consumer 64 bit socket set to %d", socket
->fd
);
4430 if (consumerd32_bin
[0] != '\0' &&
4431 ustconsumer32_data
.pid
== 0 &&
4432 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
4433 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4434 ret
= start_consumerd(&ustconsumer32_data
);
4436 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
4437 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
4441 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
4442 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
4444 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
4448 * Setup socket for consumer 64 bit. No need for atomic access
4449 * since it was set above and can ONLY be set in this thread.
4451 if (ust_consumerd32_fd
>= 0) {
4453 socket
= consumer_find_socket(uatomic_read(&ust_consumerd64_fd
),
4454 cmd_ctx
->session
->ust_session
->consumer
);
4456 if (socket
== NULL
) {
4457 socket
= consumer_allocate_socket(ust_consumerd32_fd
);
4458 if (socket
== NULL
) {
4461 socket
->lock
= &ustconsumer32_data
.lock
;
4464 consumer_add_socket(socket
,
4465 cmd_ctx
->session
->ust_session
->consumer
);
4468 DBG3("UST consumer 32 bit socket set to %d", socket
->fd
);
4478 /* Validate consumer daemon state when start/stop trace command */
4479 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
4480 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
4481 switch (cmd_ctx
->lsm
->domain
.type
) {
4482 case LTTNG_DOMAIN_UST
:
4483 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
4484 ret
= LTTCOMM_NO_USTCONSUMERD
;
4488 case LTTNG_DOMAIN_KERNEL
:
4489 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
4490 ret
= LTTCOMM_NO_KERNCONSUMERD
;
4498 * Check that the UID or GID match that of the tracing session.
4499 * The root user can interact with all sessions.
4501 if (need_tracing_session
) {
4502 if (!session_access_ok(cmd_ctx
->session
,
4503 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4504 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
4505 ret
= LTTCOMM_EPERM
;
4510 /* Process by command type */
4511 switch (cmd_ctx
->lsm
->cmd_type
) {
4512 case LTTNG_ADD_CONTEXT
:
4514 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4515 cmd_ctx
->lsm
->u
.context
.channel_name
,
4516 cmd_ctx
->lsm
->u
.context
.event_name
,
4517 &cmd_ctx
->lsm
->u
.context
.ctx
);
4520 case LTTNG_DISABLE_CHANNEL
:
4522 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4523 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4526 case LTTNG_DISABLE_EVENT
:
4528 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4529 cmd_ctx
->lsm
->u
.disable
.channel_name
,
4530 cmd_ctx
->lsm
->u
.disable
.name
);
4533 case LTTNG_DISABLE_ALL_EVENT
:
4535 DBG("Disabling all events");
4537 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4538 cmd_ctx
->lsm
->u
.disable
.channel_name
);
4541 case LTTNG_DISABLE_CONSUMER
:
4543 ret
= cmd_disable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4546 case LTTNG_ENABLE_CHANNEL
:
4548 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4549 &cmd_ctx
->lsm
->u
.channel
.chan
);
4552 case LTTNG_ENABLE_CONSUMER
:
4554 ret
= cmd_enable_consumer(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
);
4557 case LTTNG_ENABLE_EVENT
:
4559 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4560 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4561 &cmd_ctx
->lsm
->u
.enable
.event
);
4564 case LTTNG_ENABLE_ALL_EVENT
:
4566 DBG("Enabling all events");
4568 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4569 cmd_ctx
->lsm
->u
.enable
.channel_name
,
4570 cmd_ctx
->lsm
->u
.enable
.event
.type
);
4573 case LTTNG_LIST_TRACEPOINTS
:
4575 struct lttng_event
*events
;
4578 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
4579 if (nb_events
< 0) {
4585 * Setup lttng message with payload size set to the event list size in
4586 * bytes and then copy list into the llm payload.
4588 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
4594 /* Copy event list into message payload */
4595 memcpy(cmd_ctx
->llm
->payload
, events
,
4596 sizeof(struct lttng_event
) * nb_events
);
4603 case LTTNG_LIST_TRACEPOINT_FIELDS
:
4605 struct lttng_event_field
*fields
;
4608 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
, &fields
);
4609 if (nb_fields
< 0) {
4615 * Setup lttng message with payload size set to the event list size in
4616 * bytes and then copy list into the llm payload.
4618 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event_field
) * nb_fields
);
4624 /* Copy event list into message payload */
4625 memcpy(cmd_ctx
->llm
->payload
, fields
,
4626 sizeof(struct lttng_event_field
) * nb_fields
);
4633 case LTTNG_SET_CONSUMER_URI
:
4635 ret
= cmd_set_consumer_uri(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4636 &cmd_ctx
->lsm
->u
.uri
);
4639 case LTTNG_START_TRACE
:
4641 ret
= cmd_start_trace(cmd_ctx
->session
);
4644 case LTTNG_STOP_TRACE
:
4646 ret
= cmd_stop_trace(cmd_ctx
->session
);
4649 case LTTNG_CREATE_SESSION
:
4651 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
4652 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
4655 case LTTNG_CREATE_SESSION_URI
:
4657 ret
= cmd_create_session_uri(cmd_ctx
->lsm
->session
.name
,
4658 &cmd_ctx
->lsm
->u
.create_uri
.ctrl_uri
,
4659 &cmd_ctx
->lsm
->u
.create_uri
.data_uri
,
4660 cmd_ctx
->lsm
->u
.create_uri
.enable_consumer
, &cmd_ctx
->creds
);
4663 case LTTNG_DESTROY_SESSION
:
4665 ret
= cmd_destroy_session(cmd_ctx
->session
,
4666 cmd_ctx
->lsm
->session
.name
);
4668 * Set session to NULL so we do not unlock it after
4671 cmd_ctx
->session
= NULL
;
4674 case LTTNG_LIST_DOMAINS
:
4677 struct lttng_domain
*domains
;
4679 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
4685 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
4690 /* Copy event list into message payload */
4691 memcpy(cmd_ctx
->llm
->payload
, domains
,
4692 nb_dom
* sizeof(struct lttng_domain
));
4699 case LTTNG_LIST_CHANNELS
:
4702 struct lttng_channel
*channels
;
4704 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
4705 cmd_ctx
->session
, &channels
);
4711 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
4716 /* Copy event list into message payload */
4717 memcpy(cmd_ctx
->llm
->payload
, channels
,
4718 nb_chan
* sizeof(struct lttng_channel
));
4725 case LTTNG_LIST_EVENTS
:
4728 struct lttng_event
*events
= NULL
;
4730 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
4731 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
4737 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
4742 /* Copy event list into message payload */
4743 memcpy(cmd_ctx
->llm
->payload
, events
,
4744 nb_event
* sizeof(struct lttng_event
));
4751 case LTTNG_LIST_SESSIONS
:
4753 unsigned int nr_sessions
;
4755 session_lock_list();
4756 nr_sessions
= lttng_sessions_count(
4757 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4758 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
4760 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
4762 session_unlock_list();
4766 /* Filled the session array */
4767 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
4768 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
4769 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
4771 session_unlock_list();
4776 case LTTNG_CALIBRATE
:
4778 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
4779 &cmd_ctx
->lsm
->u
.calibrate
);
4782 case LTTNG_REGISTER_CONSUMER
:
4784 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4785 cmd_ctx
->lsm
->u
.reg
.path
);
4788 case LTTNG_SET_FILTER
:
4790 struct lttng_filter_bytecode
*bytecode
;
4792 if (cmd_ctx
->lsm
->u
.filter
.bytecode_len
> 65336) {
4793 ret
= LTTCOMM_FILTER_INVAL
;
4796 bytecode
= zmalloc(cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
4798 ret
= LTTCOMM_FILTER_NOMEM
;
4801 /* Receive var. len. data */
4802 DBG("Receiving var len data from client ...");
4803 ret
= lttcomm_recv_unix_sock(sock
, bytecode
,
4804 cmd_ctx
->lsm
->u
.filter
.bytecode_len
);
4806 DBG("Nothing recv() from client var len data... continuing");
4808 ret
= LTTCOMM_FILTER_INVAL
;
4812 if (bytecode
->len
+ sizeof(*bytecode
)
4813 != cmd_ctx
->lsm
->u
.filter
.bytecode_len
) {
4815 ret
= LTTCOMM_FILTER_INVAL
;
4819 ret
= cmd_set_filter(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
4820 cmd_ctx
->lsm
->u
.filter
.channel_name
,
4821 cmd_ctx
->lsm
->u
.filter
.event_name
,
4831 if (cmd_ctx
->llm
== NULL
) {
4832 DBG("Missing llm structure. Allocating one.");
4833 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
4837 /* Set return code */
4838 cmd_ctx
->llm
->ret_code
= ret
;
4840 if (cmd_ctx
->session
) {
4841 session_unlock(cmd_ctx
->session
);
4843 if (need_tracing_session
) {
4844 session_unlock_list();
4851 * Thread managing health check socket.
4853 static void *thread_manage_health(void *data
)
4855 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
4856 uint32_t revents
, nb_fd
;
4857 struct lttng_poll_event events
;
4858 struct lttcomm_health_msg msg
;
4859 struct lttcomm_health_data reply
;
4861 DBG("[thread] Manage health check started");
4863 rcu_register_thread();
4865 /* Create unix socket */
4866 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
4868 ERR("Unable to create health check Unix socket");
4873 ret
= lttcomm_listen_unix_sock(sock
);
4879 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4880 * more will be added to this poll set.
4882 ret
= create_thread_poll_set(&events
, 2);
4887 /* Add the application registration socket */
4888 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
4894 DBG("Health check ready");
4896 nb_fd
= LTTNG_POLL_GETNB(&events
);
4898 /* Inifinite blocking call, waiting for transmission */
4900 ret
= lttng_poll_wait(&events
, -1);
4903 * Restart interrupted system call.
4905 if (errno
== EINTR
) {
4911 for (i
= 0; i
< nb_fd
; i
++) {
4912 /* Fetch once the poll data */
4913 revents
= LTTNG_POLL_GETEV(&events
, i
);
4914 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
4916 /* Thread quit pipe has been closed. Killing thread. */
4917 ret
= check_thread_quit_pipe(pollfd
, revents
);
4923 /* Event on the registration socket */
4924 if (pollfd
== sock
) {
4925 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
4926 ERR("Health socket poll error");
4932 new_sock
= lttcomm_accept_unix_sock(sock
);
4937 DBG("Receiving data from client for health...");
4938 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
4940 DBG("Nothing recv() from client... continuing");
4941 ret
= close(new_sock
);
4949 rcu_thread_online();
4951 switch (msg
.component
) {
4952 case LTTNG_HEALTH_CMD
:
4953 reply
.ret_code
= health_check_state(&health_thread_cmd
);
4955 case LTTNG_HEALTH_APP_MANAGE
:
4956 reply
.ret_code
= health_check_state(&health_thread_app_manage
);
4958 case LTTNG_HEALTH_APP_REG
:
4959 reply
.ret_code
= health_check_state(&health_thread_app_reg
);
4961 case LTTNG_HEALTH_KERNEL
:
4962 reply
.ret_code
= health_check_state(&health_thread_kernel
);
4964 case LTTNG_HEALTH_CONSUMER
:
4965 reply
.ret_code
= check_consumer_health();
4967 case LTTNG_HEALTH_ALL
:
4969 health_check_state(&health_thread_app_manage
) &&
4970 health_check_state(&health_thread_app_reg
) &&
4971 health_check_state(&health_thread_cmd
) &&
4972 health_check_state(&health_thread_kernel
) &&
4973 check_consumer_health();
4976 reply
.ret_code
= LTTCOMM_UND
;
4981 * Flip ret value since 0 is a success and 1 indicates a bad health for
4982 * the client where in the sessiond it is the opposite. Again, this is
4983 * just to make things easier for us poor developer which enjoy a lot
4986 if (reply
.ret_code
== 0 || reply
.ret_code
== 1) {
4987 reply
.ret_code
= !reply
.ret_code
;
4990 DBG2("Health check return value %d", reply
.ret_code
);
4992 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
4994 ERR("Failed to send health data back to client");
4997 /* End of transmission */
4998 ret
= close(new_sock
);
5008 ERR("Health error occurred in %s", __func__
);
5010 DBG("Health check thread dying");
5011 unlink(health_unix_sock_path
);
5018 if (new_sock
>= 0) {
5019 ret
= close(new_sock
);
5025 lttng_poll_clean(&events
);
5027 rcu_unregister_thread();
5032 * This thread manage all clients request using the unix client socket for
5035 static void *thread_manage_clients(void *data
)
5037 int sock
= -1, ret
, i
, pollfd
, err
= -1;
5039 uint32_t revents
, nb_fd
;
5040 struct command_ctx
*cmd_ctx
= NULL
;
5041 struct lttng_poll_event events
;
5043 DBG("[thread] Manage client started");
5045 rcu_register_thread();
5047 health_code_update(&health_thread_cmd
);
5049 ret
= lttcomm_listen_unix_sock(client_sock
);
5055 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
5056 * more will be added to this poll set.
5058 ret
= create_thread_poll_set(&events
, 2);
5063 /* Add the application registration socket */
5064 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
5070 * Notify parent pid that we are ready to accept command for client side.
5072 if (opt_sig_parent
) {
5073 kill(ppid
, SIGUSR1
);
5076 health_code_update(&health_thread_cmd
);
5079 DBG("Accepting client command ...");
5081 nb_fd
= LTTNG_POLL_GETNB(&events
);
5083 /* Inifinite blocking call, waiting for transmission */
5085 health_poll_update(&health_thread_cmd
);
5086 ret
= lttng_poll_wait(&events
, -1);
5087 health_poll_update(&health_thread_cmd
);
5090 * Restart interrupted system call.
5092 if (errno
== EINTR
) {
5098 for (i
= 0; i
< nb_fd
; i
++) {
5099 /* Fetch once the poll data */
5100 revents
= LTTNG_POLL_GETEV(&events
, i
);
5101 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
5103 health_code_update(&health_thread_cmd
);
5105 /* Thread quit pipe has been closed. Killing thread. */
5106 ret
= check_thread_quit_pipe(pollfd
, revents
);
5112 /* Event on the registration socket */
5113 if (pollfd
== client_sock
) {
5114 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
5115 ERR("Client socket poll error");
5121 DBG("Wait for client response");
5123 health_code_update(&health_thread_cmd
);
5125 sock
= lttcomm_accept_unix_sock(client_sock
);
5130 /* Set socket option for credentials retrieval */
5131 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
5136 /* Allocate context command to process the client request */
5137 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
5138 if (cmd_ctx
== NULL
) {
5139 PERROR("zmalloc cmd_ctx");
5143 /* Allocate data buffer for reception */
5144 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
5145 if (cmd_ctx
->lsm
== NULL
) {
5146 PERROR("zmalloc cmd_ctx->lsm");
5150 cmd_ctx
->llm
= NULL
;
5151 cmd_ctx
->session
= NULL
;
5153 health_code_update(&health_thread_cmd
);
5156 * Data is received from the lttng client. The struct
5157 * lttcomm_session_msg (lsm) contains the command and data request of
5160 DBG("Receiving data from client ...");
5161 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
5162 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
5164 DBG("Nothing recv() from client... continuing");
5170 clean_command_ctx(&cmd_ctx
);
5174 health_code_update(&health_thread_cmd
);
5176 // TODO: Validate cmd_ctx including sanity check for
5177 // security purpose.
5179 rcu_thread_online();
5181 * This function dispatch the work to the kernel or userspace tracer
5182 * libs and fill the lttcomm_lttng_msg data structure of all the needed
5183 * informations for the client. The command context struct contains
5184 * everything this function may needs.
5186 ret
= process_client_msg(cmd_ctx
, sock
, &sock_error
);
5187 rcu_thread_offline();
5197 * TODO: Inform client somehow of the fatal error. At
5198 * this point, ret < 0 means that a zmalloc failed
5199 * (ENOMEM). Error detected but still accept
5200 * command, unless a socket error has been
5203 clean_command_ctx(&cmd_ctx
);
5207 health_code_update(&health_thread_cmd
);
5209 DBG("Sending response (size: %d, retcode: %s)",
5210 cmd_ctx
->lttng_msg_size
,
5211 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
5212 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
5214 ERR("Failed to send data back to client");
5217 /* End of transmission */
5224 clean_command_ctx(&cmd_ctx
);
5226 health_code_update(&health_thread_cmd
);
5232 health_error(&health_thread_cmd
);
5233 ERR("Health error occurred in %s", __func__
);
5235 health_exit(&health_thread_cmd
);
5237 DBG("Client thread dying");
5238 unlink(client_unix_sock_path
);
5239 if (client_sock
>= 0) {
5240 ret
= close(client_sock
);
5252 lttng_poll_clean(&events
);
5253 clean_command_ctx(&cmd_ctx
);
5255 rcu_unregister_thread();
5261 * usage function on stderr
5263 static void usage(void)
5265 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
5266 fprintf(stderr
, " -h, --help Display this usage.\n");
5267 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
5268 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
5269 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
5270 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
5271 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
5272 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
5273 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
5274 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
5275 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
5276 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
5277 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
5278 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
5279 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
5280 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
5281 fprintf(stderr
, " -V, --version Show version number.\n");
5282 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
5283 fprintf(stderr
, " -q, --quiet No output at all.\n");
5284 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
5285 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
5286 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
5290 * daemon argument parsing
5292 static int parse_args(int argc
, char **argv
)
5296 static struct option long_options
[] = {
5297 { "client-sock", 1, 0, 'c' },
5298 { "apps-sock", 1, 0, 'a' },
5299 { "kconsumerd-cmd-sock", 1, 0, 'C' },
5300 { "kconsumerd-err-sock", 1, 0, 'E' },
5301 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
5302 { "ustconsumerd32-err-sock", 1, 0, 'H' },
5303 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
5304 { "ustconsumerd64-err-sock", 1, 0, 'F' },
5305 { "consumerd32-path", 1, 0, 'u' },
5306 { "consumerd32-libdir", 1, 0, 'U' },
5307 { "consumerd64-path", 1, 0, 't' },
5308 { "consumerd64-libdir", 1, 0, 'T' },
5309 { "daemonize", 0, 0, 'd' },
5310 { "sig-parent", 0, 0, 'S' },
5311 { "help", 0, 0, 'h' },
5312 { "group", 1, 0, 'g' },
5313 { "version", 0, 0, 'V' },
5314 { "quiet", 0, 0, 'q' },
5315 { "verbose", 0, 0, 'v' },
5316 { "verbose-consumer", 0, 0, 'Z' },
5317 { "no-kernel", 0, 0, 'N' },
5322 int option_index
= 0;
5323 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
5324 long_options
, &option_index
);
5331 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
5333 fprintf(stderr
, " with arg %s\n", optarg
);
5337 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5340 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5346 opt_tracing_group
= optarg
;
5352 fprintf(stdout
, "%s\n", VERSION
);
5358 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5361 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5364 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5367 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5370 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5373 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
5379 lttng_opt_quiet
= 1;
5382 /* Verbose level can increase using multiple -v */
5383 lttng_opt_verbose
+= 1;
5386 opt_verbose_consumer
+= 1;
5389 consumerd32_bin
= optarg
;
5392 consumerd32_libdir
= optarg
;
5395 consumerd64_bin
= optarg
;
5398 consumerd64_libdir
= optarg
;
5401 /* Unknown option or other error.
5402 * Error is printed by getopt, just return */
5411 * Creates the two needed socket by the daemon.
5412 * apps_sock - The communication socket for all UST apps.
5413 * client_sock - The communication of the cli tool (lttng).
5415 static int init_daemon_socket(void)
5420 old_umask
= umask(0);
5422 /* Create client tool unix socket */
5423 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
5424 if (client_sock
< 0) {
5425 ERR("Create unix sock failed: %s", client_unix_sock_path
);
5430 /* File permission MUST be 660 */
5431 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5433 ERR("Set file permissions failed: %s", client_unix_sock_path
);
5438 /* Create the application unix socket */
5439 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
5440 if (apps_sock
< 0) {
5441 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
5446 /* File permission MUST be 666 */
5447 ret
= chmod(apps_unix_sock_path
,
5448 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
5450 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
5461 * Check if the global socket is available, and if a daemon is answering at the
5462 * other side. If yes, error is returned.
5464 static int check_existing_daemon(void)
5466 /* Is there anybody out there ? */
5467 if (lttng_session_daemon_alive()) {
5475 * Set the tracing group gid onto the client socket.
5477 * Race window between mkdir and chown is OK because we are going from more
5478 * permissive (root.root) to less permissive (root.tracing).
5480 static int set_permissions(char *rundir
)
5485 ret
= allowed_group();
5487 WARN("No tracing group detected");
5494 /* Set lttng run dir */
5495 ret
= chown(rundir
, 0, gid
);
5497 ERR("Unable to set group on %s", rundir
);
5501 /* Ensure tracing group can search the run dir */
5502 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
5504 ERR("Unable to set permissions on %s", rundir
);
5508 /* lttng client socket path */
5509 ret
= chown(client_unix_sock_path
, 0, gid
);
5511 ERR("Unable to set group on %s", client_unix_sock_path
);
5515 /* kconsumer error socket path */
5516 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
5518 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
5522 /* 64-bit ustconsumer error socket path */
5523 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
5525 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
5529 /* 32-bit ustconsumer compat32 error socket path */
5530 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
5532 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
5536 DBG("All permissions are set");
5543 * Create the lttng run directory needed for all global sockets and pipe.
5545 static int create_lttng_rundir(const char *rundir
)
5549 DBG3("Creating LTTng run directory: %s", rundir
);
5551 ret
= mkdir(rundir
, S_IRWXU
);
5553 if (errno
!= EEXIST
) {
5554 ERR("Unable to create %s", rundir
);
5566 * Setup sockets and directory needed by the kconsumerd communication with the
5569 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
5573 char path
[PATH_MAX
];
5575 switch (consumer_data
->type
) {
5576 case LTTNG_CONSUMER_KERNEL
:
5577 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
5579 case LTTNG_CONSUMER64_UST
:
5580 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
5582 case LTTNG_CONSUMER32_UST
:
5583 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
5586 ERR("Consumer type unknown");
5591 DBG2("Creating consumer directory: %s", path
);
5593 ret
= mkdir(path
, S_IRWXU
);
5595 if (errno
!= EEXIST
) {
5597 ERR("Failed to create %s", path
);
5603 /* Create the kconsumerd error unix socket */
5604 consumer_data
->err_sock
=
5605 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
5606 if (consumer_data
->err_sock
< 0) {
5607 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
5612 /* File permission MUST be 660 */
5613 ret
= chmod(consumer_data
->err_unix_sock_path
,
5614 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
5616 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
5626 * Signal handler for the daemon
5628 * Simply stop all worker threads, leaving main() return gracefully after
5629 * joining all threads and calling cleanup().
5631 static void sighandler(int sig
)
5635 DBG("SIGPIPE caught");
5638 DBG("SIGINT caught");
5642 DBG("SIGTERM caught");
5651 * Setup signal handler for :
5652 * SIGINT, SIGTERM, SIGPIPE
5654 static int set_signal_handler(void)
5657 struct sigaction sa
;
5660 if ((ret
= sigemptyset(&sigset
)) < 0) {
5661 PERROR("sigemptyset");
5665 sa
.sa_handler
= sighandler
;
5666 sa
.sa_mask
= sigset
;
5668 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
5669 PERROR("sigaction");
5673 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
5674 PERROR("sigaction");
5678 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
5679 PERROR("sigaction");
5683 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
5689 * Set open files limit to unlimited. This daemon can open a large number of
5690 * file descriptors in order to consumer multiple kernel traces.
5692 static void set_ulimit(void)
5697 /* The kernel does not allowed an infinite limit for open files */
5698 lim
.rlim_cur
= 65535;
5699 lim
.rlim_max
= 65535;
5701 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
5703 PERROR("failed to set open files limit");
5710 int main(int argc
, char **argv
)
5714 const char *home_path
;
5716 init_kernel_workarounds();
5718 rcu_register_thread();
5720 setup_consumerd_path();
5722 /* Parse arguments */
5724 if ((ret
= parse_args(argc
, argv
) < 0)) {
5734 * child: setsid, close FD 0, 1, 2, chdir /
5735 * parent: exit (if fork is successful)
5743 * We are in the child. Make sure all other file
5744 * descriptors are closed, in case we are called with
5745 * more opened file descriptors than the standard ones.
5747 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
5752 /* Create thread quit pipe */
5753 if ((ret
= init_thread_quit_pipe()) < 0) {
5757 /* Check if daemon is UID = 0 */
5758 is_root
= !getuid();
5761 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
5763 /* Create global run dir with root access */
5764 ret
= create_lttng_rundir(rundir
);
5769 if (strlen(apps_unix_sock_path
) == 0) {
5770 snprintf(apps_unix_sock_path
, PATH_MAX
,
5771 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
5774 if (strlen(client_unix_sock_path
) == 0) {
5775 snprintf(client_unix_sock_path
, PATH_MAX
,
5776 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
5779 /* Set global SHM for ust */
5780 if (strlen(wait_shm_path
) == 0) {
5781 snprintf(wait_shm_path
, PATH_MAX
,
5782 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
5785 if (strlen(health_unix_sock_path
) == 0) {
5786 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
5787 DEFAULT_GLOBAL_HEALTH_UNIX_SOCK
);
5790 /* Setup kernel consumerd path */
5791 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
5792 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
5793 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
5794 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
5796 DBG2("Kernel consumer err path: %s",
5797 kconsumer_data
.err_unix_sock_path
);
5798 DBG2("Kernel consumer cmd path: %s",
5799 kconsumer_data
.cmd_unix_sock_path
);
5801 home_path
= get_home_dir();
5802 if (home_path
== NULL
) {
5803 /* TODO: Add --socket PATH option */
5804 ERR("Can't get HOME directory for sockets creation.");
5810 * Create rundir from home path. This will create something like
5813 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
5819 ret
= create_lttng_rundir(rundir
);
5824 if (strlen(apps_unix_sock_path
) == 0) {
5825 snprintf(apps_unix_sock_path
, PATH_MAX
,
5826 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
5829 /* Set the cli tool unix socket path */
5830 if (strlen(client_unix_sock_path
) == 0) {
5831 snprintf(client_unix_sock_path
, PATH_MAX
,
5832 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
5835 /* Set global SHM for ust */
5836 if (strlen(wait_shm_path
) == 0) {
5837 snprintf(wait_shm_path
, PATH_MAX
,
5838 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
5841 /* Set health check Unix path */
5842 if (strlen(health_unix_sock_path
) == 0) {
5843 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
5844 DEFAULT_HOME_HEALTH_UNIX_SOCK
, home_path
);
5848 /* Set consumer initial state */
5849 kernel_consumerd_state
= CONSUMER_STOPPED
;
5850 ust_consumerd_state
= CONSUMER_STOPPED
;
5852 DBG("Client socket path %s", client_unix_sock_path
);
5853 DBG("Application socket path %s", apps_unix_sock_path
);
5854 DBG("LTTng run directory path: %s", rundir
);
5856 /* 32 bits consumerd path setup */
5857 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
5858 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
5859 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
5860 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
5862 DBG2("UST consumer 32 bits err path: %s",
5863 ustconsumer32_data
.err_unix_sock_path
);
5864 DBG2("UST consumer 32 bits cmd path: %s",
5865 ustconsumer32_data
.cmd_unix_sock_path
);
5867 /* 64 bits consumerd path setup */
5868 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
5869 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
5870 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
5871 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
5873 DBG2("UST consumer 64 bits err path: %s",
5874 ustconsumer64_data
.err_unix_sock_path
);
5875 DBG2("UST consumer 64 bits cmd path: %s",
5876 ustconsumer64_data
.cmd_unix_sock_path
);
5879 * See if daemon already exist.
5881 if ((ret
= check_existing_daemon()) < 0) {
5882 ERR("Already running daemon.\n");
5884 * We do not goto exit because we must not cleanup()
5885 * because a daemon is already running.
5891 * Init UST app hash table. Alloc hash table before this point since
5892 * cleanup() can get called after that point.
5896 /* After this point, we can safely call cleanup() with "goto exit" */
5899 * These actions must be executed as root. We do that *after* setting up
5900 * the sockets path because we MUST make the check for another daemon using
5901 * those paths *before* trying to set the kernel consumer sockets and init
5905 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
5910 /* Setup kernel tracer */
5911 if (!opt_no_kernel
) {
5912 init_kernel_tracer();
5915 /* Set ulimit for open files */
5918 /* init lttng_fd tracking must be done after set_ulimit. */
5921 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
5926 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
5931 if ((ret
= set_signal_handler()) < 0) {
5935 /* Setup the needed unix socket */
5936 if ((ret
= init_daemon_socket()) < 0) {
5940 /* Set credentials to socket */
5941 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
5945 /* Get parent pid if -S, --sig-parent is specified. */
5946 if (opt_sig_parent
) {
5950 /* Setup the kernel pipe for waking up the kernel thread */
5951 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
5955 /* Setup the thread apps communication pipe. */
5956 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
5960 /* Init UST command queue. */
5961 cds_wfq_init(&ust_cmd_queue
.queue
);
5964 * Get session list pointer. This pointer MUST NOT be free(). This list is
5965 * statically declared in session.c
5967 session_list_ptr
= session_get_list();
5969 /* Set up max poll set size */
5970 lttng_poll_set_max_size();
5973 * Set network sequence index to 1 for streams to match a relayd socket on
5974 * the consumer side.
5976 uatomic_set(&relayd_net_seq_idx
, 1);
5978 /* Init all health thread counters. */
5979 health_init(&health_thread_cmd
);
5980 health_init(&health_thread_kernel
);
5981 health_init(&health_thread_app_manage
);
5982 health_init(&health_thread_app_reg
);
5985 * Init health counters of the consumer thread. We do a quick hack here to
5986 * the state of the consumer health is fine even if the thread is not
5987 * started. This is simply to ease our life and has no cost what so ever.
5989 health_init(&kconsumer_data
.health
);
5990 health_poll_update(&kconsumer_data
.health
);
5991 health_init(&ustconsumer32_data
.health
);
5992 health_poll_update(&ustconsumer32_data
.health
);
5993 health_init(&ustconsumer64_data
.health
);
5994 health_poll_update(&ustconsumer64_data
.health
);
5996 /* Create thread to manage the client socket */
5997 ret
= pthread_create(&health_thread
, NULL
,
5998 thread_manage_health
, (void *) NULL
);
6000 PERROR("pthread_create health");
6004 /* Create thread to manage the client socket */
6005 ret
= pthread_create(&client_thread
, NULL
,
6006 thread_manage_clients
, (void *) NULL
);
6008 PERROR("pthread_create clients");
6012 /* Create thread to dispatch registration */
6013 ret
= pthread_create(&dispatch_thread
, NULL
,
6014 thread_dispatch_ust_registration
, (void *) NULL
);
6016 PERROR("pthread_create dispatch");
6020 /* Create thread to manage application registration. */
6021 ret
= pthread_create(®_apps_thread
, NULL
,
6022 thread_registration_apps
, (void *) NULL
);
6024 PERROR("pthread_create registration");
6028 /* Create thread to manage application socket */
6029 ret
= pthread_create(&apps_thread
, NULL
,
6030 thread_manage_apps
, (void *) NULL
);
6032 PERROR("pthread_create apps");
6036 /* Create kernel thread to manage kernel event */
6037 ret
= pthread_create(&kernel_thread
, NULL
,
6038 thread_manage_kernel
, (void *) NULL
);
6040 PERROR("pthread_create kernel");
6044 ret
= pthread_join(kernel_thread
, &status
);
6046 PERROR("pthread_join");
6047 goto error
; /* join error, exit without cleanup */
6051 ret
= pthread_join(apps_thread
, &status
);
6053 PERROR("pthread_join");
6054 goto error
; /* join error, exit without cleanup */
6058 ret
= pthread_join(reg_apps_thread
, &status
);
6060 PERROR("pthread_join");
6061 goto error
; /* join error, exit without cleanup */
6065 ret
= pthread_join(dispatch_thread
, &status
);
6067 PERROR("pthread_join");
6068 goto error
; /* join error, exit without cleanup */
6072 ret
= pthread_join(client_thread
, &status
);
6074 PERROR("pthread_join");
6075 goto error
; /* join error, exit without cleanup */
6078 ret
= join_consumer_thread(&kconsumer_data
);
6080 PERROR("join_consumer");
6081 goto error
; /* join error, exit without cleanup */
6088 * cleanup() is called when no other thread is running.
6090 rcu_thread_online();
6092 rcu_thread_offline();
6093 rcu_unregister_thread();