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/ust-consumer/ust-consumer.h>
46 #include <common/futex.h>
48 #include "lttng-sessiond.h"
53 #include "kernel-consumer.h"
60 #define CONSUMERD_FILE "lttng-consumerd"
63 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
64 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
65 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
66 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
69 const char *opt_tracing_group
;
70 static int opt_sig_parent
;
71 static int opt_verbose_consumer
;
72 static int opt_daemon
;
73 static int opt_no_kernel
;
74 static int is_root
; /* Set to 1 if the daemon is running as root */
75 static pid_t ppid
; /* Parent PID for --sig-parent option */
78 /* Consumer daemon specific control data */
79 static struct consumer_data kconsumer_data
= {
80 .type
= LTTNG_CONSUMER_KERNEL
,
81 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
82 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
86 static struct consumer_data ustconsumer64_data
= {
87 .type
= LTTNG_CONSUMER64_UST
,
88 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
89 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
93 static struct consumer_data ustconsumer32_data
= {
94 .type
= LTTNG_CONSUMER32_UST
,
95 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
96 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
101 static int dispatch_thread_exit
;
103 /* Global application Unix socket path */
104 static char apps_unix_sock_path
[PATH_MAX
];
105 /* Global client Unix socket path */
106 static char client_unix_sock_path
[PATH_MAX
];
107 /* global wait shm path for UST */
108 static char wait_shm_path
[PATH_MAX
];
110 /* Sockets and FDs */
111 static int client_sock
= -1;
112 static int apps_sock
= -1;
113 static int kernel_tracer_fd
= -1;
114 static int kernel_poll_pipe
[2] = { -1, -1 };
117 * Quit pipe for all threads. This permits a single cancellation point
118 * for all threads when receiving an event on the pipe.
120 static int thread_quit_pipe
[2] = { -1, -1 };
123 * This pipe is used to inform the thread managing application communication
124 * that a command is queued and ready to be processed.
126 static int apps_cmd_pipe
[2] = { -1, -1 };
128 /* Pthread, Mutexes and Semaphores */
129 static pthread_t apps_thread
;
130 static pthread_t reg_apps_thread
;
131 static pthread_t client_thread
;
132 static pthread_t kernel_thread
;
133 static pthread_t dispatch_thread
;
137 * UST registration command queue. This queue is tied with a futex and uses a N
138 * wakers / 1 waiter implemented and detailed in futex.c/.h
140 * The thread_manage_apps and thread_dispatch_ust_registration interact with
141 * this queue and the wait/wake scheme.
143 static struct ust_cmd_queue ust_cmd_queue
;
146 * Pointer initialized before thread creation.
148 * This points to the tracing session list containing the session count and a
149 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
150 * MUST NOT be taken if you call a public function in session.c.
152 * The lock is nested inside the structure: session_list_ptr->lock. Please use
153 * session_lock_list and session_unlock_list for lock acquisition.
155 static struct ltt_session_list
*session_list_ptr
;
157 int ust_consumerd64_fd
= -1;
158 int ust_consumerd32_fd
= -1;
160 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
161 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
162 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
163 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
166 * Consumer daemon state which is changed when spawning it, killing it or in
167 * case of a fatal error.
169 enum consumerd_state
{
170 CONSUMER_STARTED
= 1,
171 CONSUMER_STOPPED
= 2,
176 * This consumer daemon state is used to validate if a client command will be
177 * able to reach the consumer. If not, the client is informed. For instance,
178 * doing a "lttng start" when the consumer state is set to ERROR will return an
179 * error to the client.
181 * The following example shows a possible race condition of this scheme:
183 * consumer thread error happens
185 * client cmd checks state -> still OK
186 * consumer thread exit, sets error
187 * client cmd try to talk to consumer
190 * However, since the consumer is a different daemon, we have no way of making
191 * sure the command will reach it safely even with this state flag. This is why
192 * we consider that up to the state validation during command processing, the
193 * command is safe. After that, we can not guarantee the correctness of the
194 * client request vis-a-vis the consumer.
196 static enum consumerd_state ust_consumerd_state
;
197 static enum consumerd_state kernel_consumerd_state
;
200 void setup_consumerd_path(void)
202 const char *bin
, *libdir
;
205 * Allow INSTALL_BIN_PATH to be used as a target path for the
206 * native architecture size consumer if CONFIG_CONSUMER*_PATH
207 * has not been defined.
209 #if (CAA_BITS_PER_LONG == 32)
210 if (!consumerd32_bin
[0]) {
211 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
213 if (!consumerd32_libdir
[0]) {
214 consumerd32_libdir
= INSTALL_LIB_PATH
;
216 #elif (CAA_BITS_PER_LONG == 64)
217 if (!consumerd64_bin
[0]) {
218 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
220 if (!consumerd64_libdir
[0]) {
221 consumerd64_libdir
= INSTALL_LIB_PATH
;
224 #error "Unknown bitness"
228 * runtime env. var. overrides the build default.
230 bin
= getenv("LTTNG_CONSUMERD32_BIN");
232 consumerd32_bin
= bin
;
234 bin
= getenv("LTTNG_CONSUMERD64_BIN");
236 consumerd64_bin
= bin
;
238 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
240 consumerd32_libdir
= libdir
;
242 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
244 consumerd64_libdir
= libdir
;
249 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
251 static int create_thread_poll_set(struct lttng_poll_event
*events
,
256 if (events
== NULL
|| size
== 0) {
261 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
267 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
279 * Check if the thread quit pipe was triggered.
281 * Return 1 if it was triggered else 0;
283 static int check_thread_quit_pipe(int fd
, uint32_t events
)
285 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
293 * Return group ID of the tracing group or -1 if not found.
295 static gid_t
allowed_group(void)
299 if (opt_tracing_group
) {
300 grp
= getgrnam(opt_tracing_group
);
302 grp
= getgrnam(default_tracing_group
);
312 * Init thread quit pipe.
314 * Return -1 on error or 0 if all pipes are created.
316 static int init_thread_quit_pipe(void)
320 ret
= pipe(thread_quit_pipe
);
322 PERROR("thread quit pipe");
326 for (i
= 0; i
< 2; i
++) {
327 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
339 * Complete teardown of a kernel session. This free all data structure related
340 * to a kernel session and update counter.
342 static void teardown_kernel_session(struct ltt_session
*session
)
344 if (!session
->kernel_session
) {
345 DBG3("No kernel session when tearing down session");
349 DBG("Tearing down kernel session");
352 * If a custom kernel consumer was registered, close the socket before
353 * tearing down the complete kernel session structure
355 if (kconsumer_data
.cmd_sock
>= 0 &&
356 session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
357 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
360 trace_kernel_destroy_session(session
->kernel_session
);
364 * Complete teardown of all UST sessions. This will free everything on his path
365 * and destroy the core essence of all ust sessions :)
367 static void teardown_ust_session(struct ltt_session
*session
)
371 if (!session
->ust_session
) {
372 DBG3("No UST session when tearing down session");
376 DBG("Tearing down UST session(s)");
378 ret
= ust_app_destroy_trace_all(session
->ust_session
);
380 ERR("Error in ust_app_destroy_trace_all");
383 trace_ust_destroy_session(session
->ust_session
);
387 * Stop all threads by closing the thread quit pipe.
389 static void stop_threads(void)
393 /* Stopping all threads */
394 DBG("Terminating all threads");
395 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
397 ERR("write error on thread quit pipe");
400 /* Dispatch thread */
401 dispatch_thread_exit
= 1;
402 futex_nto1_wake(&ust_cmd_queue
.futex
);
408 static void cleanup(void)
412 struct ltt_session
*sess
, *stmp
;
416 DBG("Removing %s directory", rundir
);
417 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
419 ERR("asprintf failed. Something is really wrong!");
422 /* Remove lttng run directory */
425 ERR("Unable to clean %s", rundir
);
429 DBG("Cleaning up all sessions");
431 /* Destroy session list mutex */
432 if (session_list_ptr
!= NULL
) {
433 pthread_mutex_destroy(&session_list_ptr
->lock
);
435 /* Cleanup ALL session */
436 cds_list_for_each_entry_safe(sess
, stmp
,
437 &session_list_ptr
->head
, list
) {
438 teardown_kernel_session(sess
);
439 teardown_ust_session(sess
);
444 DBG("Closing all UST sockets");
445 ust_app_clean_list();
447 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
449 if (is_root
&& !opt_no_kernel
) {
450 DBG2("Closing kernel fd");
451 if (kernel_tracer_fd
>= 0) {
452 ret
= close(kernel_tracer_fd
);
457 DBG("Unloading kernel modules");
458 modprobe_remove_lttng_all();
460 utils_close_pipe(kernel_poll_pipe
);
461 utils_close_pipe(thread_quit_pipe
);
462 utils_close_pipe(apps_cmd_pipe
);
465 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
466 "Matthew, BEET driven development works!%c[%dm",
467 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
472 * Send data on a unix socket using the liblttsessiondcomm API.
474 * Return lttcomm error code.
476 static int send_unix_sock(int sock
, void *buf
, size_t len
)
478 /* Check valid length */
483 return lttcomm_send_unix_sock(sock
, buf
, len
);
487 * Free memory of a command context structure.
489 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
491 DBG("Clean command context structure");
493 if ((*cmd_ctx
)->llm
) {
494 free((*cmd_ctx
)->llm
);
496 if ((*cmd_ctx
)->lsm
) {
497 free((*cmd_ctx
)->lsm
);
505 * Notify UST applications using the shm mmap futex.
507 static int notify_ust_apps(int active
)
511 DBG("Notifying applications of session daemon state: %d", active
);
513 /* See shm.c for this call implying mmap, shm and futex calls */
514 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
515 if (wait_shm_mmap
== NULL
) {
519 /* Wake waiting process */
520 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
522 /* Apps notified successfully */
530 * Setup the outgoing data buffer for the response (llm) by allocating the
531 * right amount of memory and copying the original information from the lsm
534 * Return total size of the buffer pointed by buf.
536 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
542 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
543 if (cmd_ctx
->llm
== NULL
) {
549 /* Copy common data */
550 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
551 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
553 cmd_ctx
->llm
->data_size
= size
;
554 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
563 * Update the kernel poll set of all channel fd available over all tracing
564 * session. Add the wakeup pipe at the end of the set.
566 static int update_kernel_poll(struct lttng_poll_event
*events
)
569 struct ltt_session
*session
;
570 struct ltt_kernel_channel
*channel
;
572 DBG("Updating kernel poll set");
575 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
576 session_lock(session
);
577 if (session
->kernel_session
== NULL
) {
578 session_unlock(session
);
582 cds_list_for_each_entry(channel
,
583 &session
->kernel_session
->channel_list
.head
, list
) {
584 /* Add channel fd to the kernel poll set */
585 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
587 session_unlock(session
);
590 DBG("Channel fd %d added to kernel set", channel
->fd
);
592 session_unlock(session
);
594 session_unlock_list();
599 session_unlock_list();
604 * Find the channel fd from 'fd' over all tracing session. When found, check
605 * for new channel stream and send those stream fds to the kernel consumer.
607 * Useful for CPU hotplug feature.
609 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
612 struct ltt_session
*session
;
613 struct ltt_kernel_channel
*channel
;
615 DBG("Updating kernel streams for channel fd %d", fd
);
618 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
619 session_lock(session
);
620 if (session
->kernel_session
== NULL
) {
621 session_unlock(session
);
625 /* This is not suppose to be -1 but this is an extra security check */
626 if (session
->kernel_session
->consumer_fd
< 0) {
627 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
630 cds_list_for_each_entry(channel
,
631 &session
->kernel_session
->channel_list
.head
, list
) {
632 if (channel
->fd
== fd
) {
633 DBG("Channel found, updating kernel streams");
634 ret
= kernel_open_channel_stream(channel
);
640 * Have we already sent fds to the consumer? If yes, it means
641 * that tracing is started so it is safe to send our updated
644 if (session
->kernel_session
->consumer_fds_sent
== 1) {
645 ret
= kernel_consumer_send_channel_stream(consumer_data
,
646 session
->kernel_session
->consumer_fd
, channel
,
647 session
->uid
, session
->gid
);
655 session_unlock(session
);
657 session_unlock_list();
661 session_unlock(session
);
662 session_unlock_list();
667 * For each tracing session, update newly registered apps.
669 static void update_ust_app(int app_sock
)
671 struct ltt_session
*sess
, *stmp
;
675 /* For all tracing session(s) */
676 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
678 if (sess
->ust_session
) {
679 ust_app_global_update(sess
->ust_session
, app_sock
);
681 session_unlock(sess
);
684 session_unlock_list();
688 * This thread manage event coming from the kernel.
690 * Features supported in this thread:
693 static void *thread_manage_kernel(void *data
)
695 int ret
, i
, pollfd
, update_poll_flag
= 1;
696 uint32_t revents
, nb_fd
;
698 struct lttng_poll_event events
;
700 DBG("Thread manage kernel started");
702 ret
= create_thread_poll_set(&events
, 2);
704 goto error_poll_create
;
707 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
713 if (update_poll_flag
== 1) {
715 * Reset number of fd in the poll set. Always 2 since there is the thread
716 * quit pipe and the kernel pipe.
720 ret
= update_kernel_poll(&events
);
724 update_poll_flag
= 0;
727 nb_fd
= LTTNG_POLL_GETNB(&events
);
729 DBG("Thread kernel polling on %d fds", nb_fd
);
731 /* Zeroed the poll events */
732 lttng_poll_reset(&events
);
734 /* Poll infinite value of time */
736 ret
= lttng_poll_wait(&events
, -1);
739 * Restart interrupted system call.
741 if (errno
== EINTR
) {
745 } else if (ret
== 0) {
746 /* Should not happen since timeout is infinite */
747 ERR("Return value of poll is 0 with an infinite timeout.\n"
748 "This should not have happened! Continuing...");
752 for (i
= 0; i
< nb_fd
; i
++) {
753 /* Fetch once the poll data */
754 revents
= LTTNG_POLL_GETEV(&events
, i
);
755 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
757 /* Thread quit pipe has been closed. Killing thread. */
758 ret
= check_thread_quit_pipe(pollfd
, revents
);
763 /* Check for data on kernel pipe */
764 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
765 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
766 update_poll_flag
= 1;
770 * New CPU detected by the kernel. Adding kernel stream to
771 * kernel session and updating the kernel consumer
773 if (revents
& LPOLLIN
) {
774 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
780 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
781 * and unregister kernel stream at this point.
789 lttng_poll_clean(&events
);
791 DBG("Kernel thread dying");
796 * This thread manage the consumer error sent back to the session daemon.
798 static void *thread_manage_consumer(void *data
)
800 int sock
= -1, i
, ret
, pollfd
;
801 uint32_t revents
, nb_fd
;
802 enum lttcomm_return_code code
;
803 struct lttng_poll_event events
;
804 struct consumer_data
*consumer_data
= data
;
806 DBG("[thread] Manage consumer started");
808 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
814 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
815 * Nothing more will be added to this poll set.
817 ret
= create_thread_poll_set(&events
, 2);
822 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
827 nb_fd
= LTTNG_POLL_GETNB(&events
);
829 /* Inifinite blocking call, waiting for transmission */
831 ret
= lttng_poll_wait(&events
, -1);
834 * Restart interrupted system call.
836 if (errno
== EINTR
) {
842 for (i
= 0; i
< nb_fd
; i
++) {
843 /* Fetch once the poll data */
844 revents
= LTTNG_POLL_GETEV(&events
, i
);
845 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
847 /* Thread quit pipe has been closed. Killing thread. */
848 ret
= check_thread_quit_pipe(pollfd
, revents
);
853 /* Event on the registration socket */
854 if (pollfd
== consumer_data
->err_sock
) {
855 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
856 ERR("consumer err socket poll error");
862 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
867 DBG2("Receiving code from consumer err_sock");
869 /* Getting status code from kconsumerd */
870 ret
= lttcomm_recv_unix_sock(sock
, &code
,
871 sizeof(enum lttcomm_return_code
));
876 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
877 consumer_data
->cmd_sock
=
878 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
879 if (consumer_data
->cmd_sock
< 0) {
880 sem_post(&consumer_data
->sem
);
881 PERROR("consumer connect");
884 /* Signal condition to tell that the kconsumerd is ready */
885 sem_post(&consumer_data
->sem
);
886 DBG("consumer command socket ready");
888 ERR("consumer error when waiting for SOCK_READY : %s",
889 lttcomm_get_readable_code(-code
));
893 /* Remove the kconsumerd error sock since we've established a connexion */
894 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
899 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
904 /* Update number of fd */
905 nb_fd
= LTTNG_POLL_GETNB(&events
);
907 /* Inifinite blocking call, waiting for transmission */
909 ret
= lttng_poll_wait(&events
, -1);
912 * Restart interrupted system call.
914 if (errno
== EINTR
) {
920 for (i
= 0; i
< nb_fd
; i
++) {
921 /* Fetch once the poll data */
922 revents
= LTTNG_POLL_GETEV(&events
, i
);
923 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
925 /* Thread quit pipe has been closed. Killing thread. */
926 ret
= check_thread_quit_pipe(pollfd
, revents
);
931 /* Event on the kconsumerd socket */
932 if (pollfd
== sock
) {
933 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
934 ERR("consumer err socket second poll error");
940 /* Wait for any kconsumerd error */
941 ret
= lttcomm_recv_unix_sock(sock
, &code
,
942 sizeof(enum lttcomm_return_code
));
944 ERR("consumer closed the command socket");
948 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
951 /* Immediately set the consumerd state to stopped */
952 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
953 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
954 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
955 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
956 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
958 /* Code flow error... */
962 if (consumer_data
->err_sock
>= 0) {
963 ret
= close(consumer_data
->err_sock
);
968 if (consumer_data
->cmd_sock
>= 0) {
969 ret
= close(consumer_data
->cmd_sock
);
981 unlink(consumer_data
->err_unix_sock_path
);
982 unlink(consumer_data
->cmd_unix_sock_path
);
983 consumer_data
->pid
= 0;
985 lttng_poll_clean(&events
);
988 DBG("consumer thread cleanup completed");
994 * This thread manage application communication.
996 static void *thread_manage_apps(void *data
)
999 uint32_t revents
, nb_fd
;
1000 struct ust_command ust_cmd
;
1001 struct lttng_poll_event events
;
1003 DBG("[thread] Manage application started");
1005 rcu_register_thread();
1006 rcu_thread_online();
1008 ret
= create_thread_poll_set(&events
, 2);
1010 goto error_poll_create
;
1013 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1019 /* Zeroed the events structure */
1020 lttng_poll_reset(&events
);
1022 nb_fd
= LTTNG_POLL_GETNB(&events
);
1024 DBG("Apps thread polling on %d fds", nb_fd
);
1026 /* Inifinite blocking call, waiting for transmission */
1028 ret
= lttng_poll_wait(&events
, -1);
1031 * Restart interrupted system call.
1033 if (errno
== EINTR
) {
1039 for (i
= 0; i
< nb_fd
; i
++) {
1040 /* Fetch once the poll data */
1041 revents
= LTTNG_POLL_GETEV(&events
, i
);
1042 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1044 /* Thread quit pipe has been closed. Killing thread. */
1045 ret
= check_thread_quit_pipe(pollfd
, revents
);
1050 /* Inspect the apps cmd pipe */
1051 if (pollfd
== apps_cmd_pipe
[0]) {
1052 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1053 ERR("Apps command pipe error");
1055 } else if (revents
& LPOLLIN
) {
1057 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1058 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1059 PERROR("read apps cmd pipe");
1063 /* Register applicaton to the session daemon */
1064 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1066 if (ret
== -ENOMEM
) {
1068 } else if (ret
< 0) {
1073 * Validate UST version compatibility.
1075 ret
= ust_app_validate_version(ust_cmd
.sock
);
1078 * Add channel(s) and event(s) to newly registered apps
1079 * from lttng global UST domain.
1081 update_ust_app(ust_cmd
.sock
);
1084 ret
= ust_app_register_done(ust_cmd
.sock
);
1087 * If the registration is not possible, we simply
1088 * unregister the apps and continue
1090 ust_app_unregister(ust_cmd
.sock
);
1093 * We just need here to monitor the close of the UST
1094 * socket and poll set monitor those by default.
1095 * Listen on POLLIN (even if we never expect any
1096 * data) to ensure that hangup wakes us.
1098 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1103 DBG("Apps with sock %d added to poll set",
1111 * At this point, we know that a registered application made
1112 * the event at poll_wait.
1114 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1115 /* Removing from the poll set */
1116 ret
= lttng_poll_del(&events
, pollfd
);
1121 /* Socket closed on remote end. */
1122 ust_app_unregister(pollfd
);
1130 lttng_poll_clean(&events
);
1132 DBG("Application communication apps thread cleanup complete");
1133 rcu_thread_offline();
1134 rcu_unregister_thread();
1139 * Dispatch request from the registration threads to the application
1140 * communication thread.
1142 static void *thread_dispatch_ust_registration(void *data
)
1145 struct cds_wfq_node
*node
;
1146 struct ust_command
*ust_cmd
= NULL
;
1148 DBG("[thread] Dispatch UST command started");
1150 while (!dispatch_thread_exit
) {
1151 /* Atomically prepare the queue futex */
1152 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1155 /* Dequeue command for registration */
1156 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1158 DBG("Woken up but nothing in the UST command queue");
1159 /* Continue thread execution */
1163 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1165 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1166 " gid:%d sock:%d name:%s (version %d.%d)",
1167 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1168 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1169 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1170 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1172 * Inform apps thread of the new application registration. This
1173 * call is blocking so we can be assured that the data will be read
1174 * at some point in time or wait to the end of the world :)
1176 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1177 sizeof(struct ust_command
));
1179 PERROR("write apps cmd pipe");
1180 if (errno
== EBADF
) {
1182 * We can't inform the application thread to process
1183 * registration. We will exit or else application
1184 * registration will not occur and tracing will never
1191 } while (node
!= NULL
);
1193 /* Futex wait on queue. Blocking call on futex() */
1194 futex_nto1_wait(&ust_cmd_queue
.futex
);
1198 DBG("Dispatch thread dying");
1203 * This thread manage application registration.
1205 static void *thread_registration_apps(void *data
)
1207 int sock
= -1, i
, ret
, pollfd
;
1208 uint32_t revents
, nb_fd
;
1209 struct lttng_poll_event events
;
1211 * Get allocated in this thread, enqueued to a global queue, dequeued and
1212 * freed in the manage apps thread.
1214 struct ust_command
*ust_cmd
= NULL
;
1216 DBG("[thread] Manage application registration started");
1218 ret
= lttcomm_listen_unix_sock(apps_sock
);
1224 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1225 * more will be added to this poll set.
1227 ret
= create_thread_poll_set(&events
, 2);
1229 goto error_create_poll
;
1232 /* Add the application registration socket */
1233 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1235 goto error_poll_add
;
1238 /* Notify all applications to register */
1239 ret
= notify_ust_apps(1);
1241 ERR("Failed to notify applications or create the wait shared memory.\n"
1242 "Execution continues but there might be problem for already\n"
1243 "running applications that wishes to register.");
1247 DBG("Accepting application registration");
1249 nb_fd
= LTTNG_POLL_GETNB(&events
);
1251 /* Inifinite blocking call, waiting for transmission */
1253 ret
= lttng_poll_wait(&events
, -1);
1256 * Restart interrupted system call.
1258 if (errno
== EINTR
) {
1264 for (i
= 0; i
< nb_fd
; i
++) {
1265 /* Fetch once the poll data */
1266 revents
= LTTNG_POLL_GETEV(&events
, i
);
1267 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1269 /* Thread quit pipe has been closed. Killing thread. */
1270 ret
= check_thread_quit_pipe(pollfd
, revents
);
1275 /* Event on the registration socket */
1276 if (pollfd
== apps_sock
) {
1277 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1278 ERR("Register apps socket poll error");
1280 } else if (revents
& LPOLLIN
) {
1281 sock
= lttcomm_accept_unix_sock(apps_sock
);
1286 /* Create UST registration command for enqueuing */
1287 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1288 if (ust_cmd
== NULL
) {
1289 PERROR("ust command zmalloc");
1294 * Using message-based transmissions to ensure we don't
1295 * have to deal with partially received messages.
1297 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1299 ERR("Exhausted file descriptors allowed for applications.");
1308 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1309 sizeof(struct ust_register_msg
));
1310 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1312 PERROR("lttcomm_recv_unix_sock register apps");
1314 ERR("Wrong size received on apps register");
1321 lttng_fd_put(LTTNG_FD_APPS
, 1);
1326 ust_cmd
->sock
= sock
;
1329 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1330 " gid:%d sock:%d name:%s (version %d.%d)",
1331 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1332 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1333 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1334 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1337 * Lock free enqueue the registration request. The red pill
1338 * has been taken! This apps will be part of the *system*.
1340 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1343 * Wake the registration queue futex. Implicit memory
1344 * barrier with the exchange in cds_wfq_enqueue.
1346 futex_nto1_wake(&ust_cmd_queue
.futex
);
1353 /* Notify that the registration thread is gone */
1356 if (apps_sock
>= 0) {
1357 ret
= close(apps_sock
);
1367 lttng_fd_put(LTTNG_FD_APPS
, 1);
1369 unlink(apps_unix_sock_path
);
1372 lttng_poll_clean(&events
);
1375 DBG("UST Registration thread cleanup complete");
1381 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1382 * exec or it will fails.
1384 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1387 struct timespec timeout
;
1389 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1390 timeout
.tv_nsec
= 0;
1392 /* Setup semaphore */
1393 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1395 PERROR("sem_init consumer semaphore");
1399 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1400 thread_manage_consumer
, consumer_data
);
1402 PERROR("pthread_create consumer");
1407 /* Get time for sem_timedwait absolute timeout */
1408 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1410 PERROR("clock_gettime spawn consumer");
1411 /* Infinite wait for the kconsumerd thread to be ready */
1412 ret
= sem_wait(&consumer_data
->sem
);
1414 /* Normal timeout if the gettime was successful */
1415 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1416 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1420 if (errno
== ETIMEDOUT
) {
1422 * Call has timed out so we kill the kconsumerd_thread and return
1425 ERR("The consumer thread was never ready. Killing it");
1426 ret
= pthread_cancel(consumer_data
->thread
);
1428 PERROR("pthread_cancel consumer thread");
1431 PERROR("semaphore wait failed consumer thread");
1436 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1437 if (consumer_data
->pid
== 0) {
1438 ERR("Kconsumerd did not start");
1439 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1442 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1451 * Join consumer thread
1453 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1458 if (consumer_data
->pid
!= 0) {
1459 ret
= kill(consumer_data
->pid
, SIGTERM
);
1461 ERR("Error killing consumer daemon");
1464 return pthread_join(consumer_data
->thread
, &status
);
1471 * Fork and exec a consumer daemon (consumerd).
1473 * Return pid if successful else -1.
1475 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1479 const char *consumer_to_use
;
1480 const char *verbosity
;
1483 DBG("Spawning consumerd");
1490 if (opt_verbose_consumer
) {
1491 verbosity
= "--verbose";
1493 verbosity
= "--quiet";
1495 switch (consumer_data
->type
) {
1496 case LTTNG_CONSUMER_KERNEL
:
1498 * Find out which consumerd to execute. We will first try the
1499 * 64-bit path, then the sessiond's installation directory, and
1500 * fallback on the 32-bit one,
1502 DBG3("Looking for a kernel consumer at these locations:");
1503 DBG3(" 1) %s", consumerd64_bin
);
1504 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1505 DBG3(" 3) %s", consumerd32_bin
);
1506 if (stat(consumerd64_bin
, &st
) == 0) {
1507 DBG3("Found location #1");
1508 consumer_to_use
= consumerd64_bin
;
1509 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1510 DBG3("Found location #2");
1511 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1512 } else if (stat(consumerd32_bin
, &st
) == 0) {
1513 DBG3("Found location #3");
1514 consumer_to_use
= consumerd32_bin
;
1516 DBG("Could not find any valid consumerd executable");
1519 DBG("Using kernel consumer at: %s", consumer_to_use
);
1520 execl(consumer_to_use
,
1521 "lttng-consumerd", verbosity
, "-k",
1522 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1523 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1526 case LTTNG_CONSUMER64_UST
:
1528 char *tmpnew
= NULL
;
1530 if (consumerd64_libdir
[0] != '\0') {
1534 tmp
= getenv("LD_LIBRARY_PATH");
1538 tmplen
= strlen("LD_LIBRARY_PATH=")
1539 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1540 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1545 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1546 strcat(tmpnew
, consumerd64_libdir
);
1547 if (tmp
[0] != '\0') {
1548 strcat(tmpnew
, ":");
1549 strcat(tmpnew
, tmp
);
1551 ret
= putenv(tmpnew
);
1557 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1558 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1559 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1560 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1562 if (consumerd64_libdir
[0] != '\0') {
1570 case LTTNG_CONSUMER32_UST
:
1572 char *tmpnew
= NULL
;
1574 if (consumerd32_libdir
[0] != '\0') {
1578 tmp
= getenv("LD_LIBRARY_PATH");
1582 tmplen
= strlen("LD_LIBRARY_PATH=")
1583 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1584 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1589 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1590 strcat(tmpnew
, consumerd32_libdir
);
1591 if (tmp
[0] != '\0') {
1592 strcat(tmpnew
, ":");
1593 strcat(tmpnew
, tmp
);
1595 ret
= putenv(tmpnew
);
1601 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1602 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1603 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1604 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1606 if (consumerd32_libdir
[0] != '\0') {
1615 PERROR("unknown consumer type");
1619 PERROR("kernel start consumer exec");
1622 } else if (pid
> 0) {
1625 PERROR("start consumer fork");
1633 * Spawn the consumerd daemon and session daemon thread.
1635 static int start_consumerd(struct consumer_data
*consumer_data
)
1639 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1640 if (consumer_data
->pid
!= 0) {
1641 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1645 ret
= spawn_consumerd(consumer_data
);
1647 ERR("Spawning consumerd failed");
1648 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1652 /* Setting up the consumer_data pid */
1653 consumer_data
->pid
= ret
;
1654 DBG2("Consumer pid %d", consumer_data
->pid
);
1655 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1657 DBG2("Spawning consumer control thread");
1658 ret
= spawn_consumer_thread(consumer_data
);
1660 ERR("Fatal error spawning consumer control thread");
1672 * Check version of the lttng-modules.
1674 static int validate_lttng_modules_version(void)
1676 return kernel_validate_version(kernel_tracer_fd
);
1680 * Setup necessary data for kernel tracer action.
1682 static int init_kernel_tracer(void)
1686 /* Modprobe lttng kernel modules */
1687 ret
= modprobe_lttng_control();
1692 /* Open debugfs lttng */
1693 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1694 if (kernel_tracer_fd
< 0) {
1695 DBG("Failed to open %s", module_proc_lttng
);
1700 /* Validate kernel version */
1701 ret
= validate_lttng_modules_version();
1706 ret
= modprobe_lttng_data();
1711 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1715 modprobe_remove_lttng_control();
1716 ret
= close(kernel_tracer_fd
);
1720 kernel_tracer_fd
= -1;
1721 return LTTCOMM_KERN_VERSION
;
1724 ret
= close(kernel_tracer_fd
);
1730 modprobe_remove_lttng_control();
1733 WARN("No kernel tracer available");
1734 kernel_tracer_fd
= -1;
1736 return LTTCOMM_NEED_ROOT_SESSIOND
;
1738 return LTTCOMM_KERN_NA
;
1743 * Init tracing by creating trace directory and sending fds kernel consumer.
1745 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1749 if (session
->consumer_fds_sent
== 0) {
1751 * Assign default kernel consumer socket if no consumer assigned to the
1752 * kernel session. At this point, it's NOT supposed to be -1 but this is
1753 * an extra security check.
1755 if (session
->consumer_fd
< 0) {
1756 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1759 ret
= kernel_consumer_send_session(&kconsumer_data
, session
);
1761 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1765 session
->consumer_fds_sent
= 1;
1773 * Create an UST session and add it to the session ust list.
1775 static int create_ust_session(struct ltt_session
*session
,
1776 struct lttng_domain
*domain
)
1778 struct ltt_ust_session
*lus
= NULL
;
1781 switch (domain
->type
) {
1782 case LTTNG_DOMAIN_UST
:
1785 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1789 DBG("Creating UST session");
1791 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1793 ret
= LTTCOMM_UST_SESS_FAIL
;
1797 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1798 session
->uid
, session
->gid
);
1800 if (ret
!= -EEXIST
) {
1801 ERR("Trace directory creation error");
1802 ret
= LTTCOMM_UST_SESS_FAIL
;
1807 /* The domain type dictate different actions on session creation */
1808 switch (domain
->type
) {
1809 case LTTNG_DOMAIN_UST
:
1810 /* No ustctl for the global UST domain */
1813 ERR("Unknown UST domain on create session %d", domain
->type
);
1816 lus
->uid
= session
->uid
;
1817 lus
->gid
= session
->gid
;
1818 session
->ust_session
= lus
;
1828 * Create a kernel tracer session then create the default channel.
1830 static int create_kernel_session(struct ltt_session
*session
)
1834 DBG("Creating kernel session");
1836 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1838 ret
= LTTCOMM_KERN_SESS_FAIL
;
1842 /* Set kernel consumer socket fd */
1843 if (kconsumer_data
.cmd_sock
>= 0) {
1844 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1847 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1848 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1850 if (ret
!= -EEXIST
) {
1851 ERR("Trace directory creation error");
1855 session
->kernel_session
->uid
= session
->uid
;
1856 session
->kernel_session
->gid
= session
->gid
;
1863 * Check if the UID or GID match the session. Root user has access to all
1866 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1868 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1875 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1878 struct ltt_session
*session
;
1880 DBG("Counting number of available session for UID %d GID %d",
1882 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1884 * Only list the sessions the user can control.
1886 if (!session_access_ok(session
, uid
, gid
)) {
1895 * Using the session list, filled a lttng_session array to send back to the
1896 * client for session listing.
1898 * The session list lock MUST be acquired before calling this function. Use
1899 * session_lock_list() and session_unlock_list().
1901 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1905 struct ltt_session
*session
;
1907 DBG("Getting all available session for UID %d GID %d",
1910 * Iterate over session list and append data after the control struct in
1913 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1915 * Only list the sessions the user can control.
1917 if (!session_access_ok(session
, uid
, gid
)) {
1920 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1921 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1922 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1923 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1924 sessions
[i
].enabled
= session
->enabled
;
1930 * Fill lttng_channel array of all channels.
1932 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1933 struct lttng_channel
*channels
)
1936 struct ltt_kernel_channel
*kchan
;
1938 DBG("Listing channels for session %s", session
->name
);
1941 case LTTNG_DOMAIN_KERNEL
:
1942 /* Kernel channels */
1943 if (session
->kernel_session
!= NULL
) {
1944 cds_list_for_each_entry(kchan
,
1945 &session
->kernel_session
->channel_list
.head
, list
) {
1946 /* Copy lttng_channel struct to array */
1947 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1948 channels
[i
].enabled
= kchan
->enabled
;
1953 case LTTNG_DOMAIN_UST
:
1955 struct lttng_ht_iter iter
;
1956 struct ltt_ust_channel
*uchan
;
1958 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1959 &iter
.iter
, uchan
, node
.node
) {
1960 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1961 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1962 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1963 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1964 channels
[i
].attr
.switch_timer_interval
=
1965 uchan
->attr
.switch_timer_interval
;
1966 channels
[i
].attr
.read_timer_interval
=
1967 uchan
->attr
.read_timer_interval
;
1968 channels
[i
].enabled
= uchan
->enabled
;
1969 switch (uchan
->attr
.output
) {
1970 case LTTNG_UST_MMAP
:
1972 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
1985 * Create a list of ust global domain events.
1987 static int list_lttng_ust_global_events(char *channel_name
,
1988 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
1991 unsigned int nb_event
= 0;
1992 struct lttng_ht_iter iter
;
1993 struct lttng_ht_node_str
*node
;
1994 struct ltt_ust_channel
*uchan
;
1995 struct ltt_ust_event
*uevent
;
1996 struct lttng_event
*tmp
;
1998 DBG("Listing UST global events for channel %s", channel_name
);
2002 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2003 node
= lttng_ht_iter_get_node_str(&iter
);
2005 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2009 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2011 nb_event
+= lttng_ht_get_count(uchan
->events
);
2013 if (nb_event
== 0) {
2018 DBG3("Listing UST global %d events", nb_event
);
2020 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2022 ret
= -LTTCOMM_FATAL
;
2026 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2027 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2028 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2029 tmp
[i
].enabled
= uevent
->enabled
;
2030 switch (uevent
->attr
.instrumentation
) {
2031 case LTTNG_UST_TRACEPOINT
:
2032 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2034 case LTTNG_UST_PROBE
:
2035 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2037 case LTTNG_UST_FUNCTION
:
2038 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2041 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2042 switch (uevent
->attr
.loglevel_type
) {
2043 case LTTNG_UST_LOGLEVEL_ALL
:
2044 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2046 case LTTNG_UST_LOGLEVEL_RANGE
:
2047 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2049 case LTTNG_UST_LOGLEVEL_SINGLE
:
2050 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2065 * Fill lttng_event array of all kernel events in the channel.
2067 static int list_lttng_kernel_events(char *channel_name
,
2068 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2071 unsigned int nb_event
;
2072 struct ltt_kernel_event
*event
;
2073 struct ltt_kernel_channel
*kchan
;
2075 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2076 if (kchan
== NULL
) {
2077 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2081 nb_event
= kchan
->event_count
;
2083 DBG("Listing events for channel %s", kchan
->channel
->name
);
2085 if (nb_event
== 0) {
2090 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2091 if (*events
== NULL
) {
2092 ret
= LTTCOMM_FATAL
;
2096 /* Kernel channels */
2097 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2098 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2099 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2100 (*events
)[i
].enabled
= event
->enabled
;
2101 switch (event
->event
->instrumentation
) {
2102 case LTTNG_KERNEL_TRACEPOINT
:
2103 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2105 case LTTNG_KERNEL_KPROBE
:
2106 case LTTNG_KERNEL_KRETPROBE
:
2107 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2108 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2109 sizeof(struct lttng_kernel_kprobe
));
2111 case LTTNG_KERNEL_FUNCTION
:
2112 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2113 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2114 sizeof(struct lttng_kernel_function
));
2116 case LTTNG_KERNEL_NOOP
:
2117 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2119 case LTTNG_KERNEL_SYSCALL
:
2120 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2122 case LTTNG_KERNEL_ALL
:
2136 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2138 static int cmd_disable_channel(struct ltt_session
*session
,
2139 int domain
, char *channel_name
)
2142 struct ltt_ust_session
*usess
;
2144 usess
= session
->ust_session
;
2147 case LTTNG_DOMAIN_KERNEL
:
2149 ret
= channel_kernel_disable(session
->kernel_session
,
2151 if (ret
!= LTTCOMM_OK
) {
2155 kernel_wait_quiescent(kernel_tracer_fd
);
2158 case LTTNG_DOMAIN_UST
:
2160 struct ltt_ust_channel
*uchan
;
2161 struct lttng_ht
*chan_ht
;
2163 chan_ht
= usess
->domain_global
.channels
;
2165 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2166 if (uchan
== NULL
) {
2167 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2171 ret
= channel_ust_disable(usess
, domain
, uchan
);
2172 if (ret
!= LTTCOMM_OK
) {
2178 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2179 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2180 case LTTNG_DOMAIN_UST_PID
:
2183 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2194 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2196 static int cmd_enable_channel(struct ltt_session
*session
,
2197 int domain
, struct lttng_channel
*attr
)
2200 struct ltt_ust_session
*usess
= session
->ust_session
;
2201 struct lttng_ht
*chan_ht
;
2203 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2206 case LTTNG_DOMAIN_KERNEL
:
2208 struct ltt_kernel_channel
*kchan
;
2210 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2211 session
->kernel_session
);
2212 if (kchan
== NULL
) {
2213 ret
= channel_kernel_create(session
->kernel_session
,
2214 attr
, kernel_poll_pipe
[1]);
2216 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2219 if (ret
!= LTTCOMM_OK
) {
2223 kernel_wait_quiescent(kernel_tracer_fd
);
2226 case LTTNG_DOMAIN_UST
:
2228 struct ltt_ust_channel
*uchan
;
2230 chan_ht
= usess
->domain_global
.channels
;
2232 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2233 if (uchan
== NULL
) {
2234 ret
= channel_ust_create(usess
, domain
, attr
);
2236 ret
= channel_ust_enable(usess
, domain
, uchan
);
2241 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2242 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2243 case LTTNG_DOMAIN_UST_PID
:
2246 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2255 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2257 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2258 char *channel_name
, char *event_name
)
2263 case LTTNG_DOMAIN_KERNEL
:
2265 struct ltt_kernel_channel
*kchan
;
2266 struct ltt_kernel_session
*ksess
;
2268 ksess
= session
->kernel_session
;
2270 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2271 if (kchan
== NULL
) {
2272 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2276 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2277 if (ret
!= LTTCOMM_OK
) {
2281 kernel_wait_quiescent(kernel_tracer_fd
);
2284 case LTTNG_DOMAIN_UST
:
2286 struct ltt_ust_channel
*uchan
;
2287 struct ltt_ust_session
*usess
;
2289 usess
= session
->ust_session
;
2291 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2293 if (uchan
== NULL
) {
2294 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2298 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2299 if (ret
!= LTTCOMM_OK
) {
2303 DBG3("Disable UST event %s in channel %s completed", event_name
,
2308 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2309 case LTTNG_DOMAIN_UST_PID
:
2310 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2324 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2326 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2332 case LTTNG_DOMAIN_KERNEL
:
2334 struct ltt_kernel_session
*ksess
;
2335 struct ltt_kernel_channel
*kchan
;
2337 ksess
= session
->kernel_session
;
2339 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2340 if (kchan
== NULL
) {
2341 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2345 ret
= event_kernel_disable_all(ksess
, kchan
);
2346 if (ret
!= LTTCOMM_OK
) {
2350 kernel_wait_quiescent(kernel_tracer_fd
);
2353 case LTTNG_DOMAIN_UST
:
2355 struct ltt_ust_session
*usess
;
2356 struct ltt_ust_channel
*uchan
;
2358 usess
= session
->ust_session
;
2360 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2362 if (uchan
== NULL
) {
2363 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2367 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2372 DBG3("Disable all UST events in channel %s completed", channel_name
);
2377 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2378 case LTTNG_DOMAIN_UST_PID
:
2379 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2393 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2395 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2396 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2401 case LTTNG_DOMAIN_KERNEL
:
2402 /* Add kernel context to kernel tracer */
2403 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2404 event_name
, channel_name
);
2405 if (ret
!= LTTCOMM_OK
) {
2409 case LTTNG_DOMAIN_UST
:
2411 struct ltt_ust_session
*usess
= session
->ust_session
;
2413 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2414 if (ret
!= LTTCOMM_OK
) {
2420 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2421 case LTTNG_DOMAIN_UST_PID
:
2422 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2436 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2438 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2439 char *channel_name
, struct lttng_event
*event
)
2442 struct lttng_channel
*attr
;
2443 struct ltt_ust_session
*usess
= session
->ust_session
;
2446 case LTTNG_DOMAIN_KERNEL
:
2448 struct ltt_kernel_channel
*kchan
;
2450 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2451 session
->kernel_session
);
2452 if (kchan
== NULL
) {
2453 attr
= channel_new_default_attr(domain
);
2455 ret
= LTTCOMM_FATAL
;
2458 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2460 /* This call will notify the kernel thread */
2461 ret
= channel_kernel_create(session
->kernel_session
,
2462 attr
, kernel_poll_pipe
[1]);
2463 if (ret
!= LTTCOMM_OK
) {
2470 /* Get the newly created kernel channel pointer */
2471 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2472 session
->kernel_session
);
2473 if (kchan
== NULL
) {
2474 /* This sould not happen... */
2475 ret
= LTTCOMM_FATAL
;
2479 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2481 if (ret
!= LTTCOMM_OK
) {
2485 kernel_wait_quiescent(kernel_tracer_fd
);
2488 case LTTNG_DOMAIN_UST
:
2490 struct lttng_channel
*attr
;
2491 struct ltt_ust_channel
*uchan
;
2493 /* Get channel from global UST domain */
2494 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2496 if (uchan
== NULL
) {
2497 /* Create default channel */
2498 attr
= channel_new_default_attr(domain
);
2500 ret
= LTTCOMM_FATAL
;
2503 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2504 attr
->name
[NAME_MAX
- 1] = '\0';
2506 ret
= channel_ust_create(usess
, domain
, attr
);
2507 if (ret
!= LTTCOMM_OK
) {
2513 /* Get the newly created channel reference back */
2514 uchan
= trace_ust_find_channel_by_name(
2515 usess
->domain_global
.channels
, channel_name
);
2516 if (uchan
== NULL
) {
2517 /* Something is really wrong */
2518 ret
= LTTCOMM_FATAL
;
2523 /* At this point, the session and channel exist on the tracer */
2524 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2525 if (ret
!= LTTCOMM_OK
) {
2531 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2532 case LTTNG_DOMAIN_UST_PID
:
2533 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2547 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2549 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2550 char *channel_name
, int event_type
)
2553 struct ltt_kernel_channel
*kchan
;
2556 case LTTNG_DOMAIN_KERNEL
:
2557 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2558 session
->kernel_session
);
2559 if (kchan
== NULL
) {
2560 /* This call will notify the kernel thread */
2561 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2562 kernel_poll_pipe
[1]);
2563 if (ret
!= LTTCOMM_OK
) {
2567 /* Get the newly created kernel channel pointer */
2568 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2569 session
->kernel_session
);
2570 if (kchan
== NULL
) {
2571 /* This sould not happen... */
2572 ret
= LTTCOMM_FATAL
;
2578 switch (event_type
) {
2579 case LTTNG_EVENT_SYSCALL
:
2580 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2581 kchan
, kernel_tracer_fd
);
2583 case LTTNG_EVENT_TRACEPOINT
:
2585 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2586 * events already registered to the channel.
2588 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2589 kchan
, kernel_tracer_fd
);
2591 case LTTNG_EVENT_ALL
:
2592 /* Enable syscalls and tracepoints */
2593 ret
= event_kernel_enable_all(session
->kernel_session
,
2594 kchan
, kernel_tracer_fd
);
2597 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2601 /* Manage return value */
2602 if (ret
!= LTTCOMM_OK
) {
2606 kernel_wait_quiescent(kernel_tracer_fd
);
2608 case LTTNG_DOMAIN_UST
:
2610 struct lttng_channel
*attr
;
2611 struct ltt_ust_channel
*uchan
;
2612 struct ltt_ust_session
*usess
= session
->ust_session
;
2614 /* Get channel from global UST domain */
2615 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2617 if (uchan
== NULL
) {
2618 /* Create default channel */
2619 attr
= channel_new_default_attr(domain
);
2621 ret
= LTTCOMM_FATAL
;
2624 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2625 attr
->name
[NAME_MAX
- 1] = '\0';
2627 /* Use the internal command enable channel */
2628 ret
= channel_ust_create(usess
, domain
, attr
);
2629 if (ret
!= LTTCOMM_OK
) {
2635 /* Get the newly created channel reference back */
2636 uchan
= trace_ust_find_channel_by_name(
2637 usess
->domain_global
.channels
, channel_name
);
2638 if (uchan
== NULL
) {
2639 /* Something is really wrong */
2640 ret
= LTTCOMM_FATAL
;
2645 /* At this point, the session and channel exist on the tracer */
2647 switch (event_type
) {
2648 case LTTNG_EVENT_ALL
:
2649 case LTTNG_EVENT_TRACEPOINT
:
2650 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2651 if (ret
!= LTTCOMM_OK
) {
2656 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2660 /* Manage return value */
2661 if (ret
!= LTTCOMM_OK
) {
2668 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2669 case LTTNG_DOMAIN_UST_PID
:
2670 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2684 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2686 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2689 ssize_t nb_events
= 0;
2692 case LTTNG_DOMAIN_KERNEL
:
2693 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2694 if (nb_events
< 0) {
2695 ret
= LTTCOMM_KERN_LIST_FAIL
;
2699 case LTTNG_DOMAIN_UST
:
2700 nb_events
= ust_app_list_events(events
);
2701 if (nb_events
< 0) {
2702 ret
= LTTCOMM_UST_LIST_FAIL
;
2714 /* Return negative value to differentiate return code */
2719 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2721 static ssize_t
cmd_list_tracepoint_fields(int domain
,
2722 struct lttng_event_field
**fields
)
2725 ssize_t nb_fields
= 0;
2728 case LTTNG_DOMAIN_UST
:
2729 nb_fields
= ust_app_list_event_fields(fields
);
2730 if (nb_fields
< 0) {
2731 ret
= LTTCOMM_UST_LIST_FAIL
;
2735 case LTTNG_DOMAIN_KERNEL
:
2736 default: /* fall-through */
2744 /* Return negative value to differentiate return code */
2749 * Command LTTNG_START_TRACE processed by the client thread.
2751 static int cmd_start_trace(struct ltt_session
*session
)
2754 struct ltt_kernel_session
*ksession
;
2755 struct ltt_ust_session
*usess
;
2758 ksession
= session
->kernel_session
;
2759 usess
= session
->ust_session
;
2761 if (session
->enabled
) {
2762 /* Already started. */
2763 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
2767 session
->enabled
= 1;
2769 /* Kernel tracing */
2770 if (ksession
!= NULL
) {
2771 struct ltt_kernel_channel
*kchan
;
2773 /* Open kernel metadata */
2774 if (ksession
->metadata
== NULL
) {
2775 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2777 ret
= LTTCOMM_KERN_META_FAIL
;
2782 /* Open kernel metadata stream */
2783 if (ksession
->metadata_stream_fd
< 0) {
2784 ret
= kernel_open_metadata_stream(ksession
);
2786 ERR("Kernel create metadata stream failed");
2787 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2792 /* For each channel */
2793 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2794 if (kchan
->stream_count
== 0) {
2795 ret
= kernel_open_channel_stream(kchan
);
2797 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2800 /* Update the stream global counter */
2801 ksession
->stream_count_global
+= ret
;
2805 /* Setup kernel consumer socket and send fds to it */
2806 ret
= init_kernel_tracing(ksession
);
2808 ret
= LTTCOMM_KERN_START_FAIL
;
2812 /* This start the kernel tracing */
2813 ret
= kernel_start_session(ksession
);
2815 ret
= LTTCOMM_KERN_START_FAIL
;
2819 /* Quiescent wait after starting trace */
2820 kernel_wait_quiescent(kernel_tracer_fd
);
2823 /* Flag session that trace should start automatically */
2825 usess
->start_trace
= 1;
2827 ret
= ust_app_start_trace_all(usess
);
2829 ret
= LTTCOMM_UST_START_FAIL
;
2841 * Command LTTNG_STOP_TRACE processed by the client thread.
2843 static int cmd_stop_trace(struct ltt_session
*session
)
2846 struct ltt_kernel_channel
*kchan
;
2847 struct ltt_kernel_session
*ksession
;
2848 struct ltt_ust_session
*usess
;
2851 ksession
= session
->kernel_session
;
2852 usess
= session
->ust_session
;
2854 if (!session
->enabled
) {
2855 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
2859 session
->enabled
= 0;
2862 if (ksession
!= NULL
) {
2863 DBG("Stop kernel tracing");
2865 /* Flush all buffers before stopping */
2866 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2868 ERR("Kernel metadata flush failed");
2871 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2872 ret
= kernel_flush_buffer(kchan
);
2874 ERR("Kernel flush buffer error");
2878 ret
= kernel_stop_session(ksession
);
2880 ret
= LTTCOMM_KERN_STOP_FAIL
;
2884 kernel_wait_quiescent(kernel_tracer_fd
);
2888 usess
->start_trace
= 0;
2890 ret
= ust_app_stop_trace_all(usess
);
2892 ret
= LTTCOMM_UST_STOP_FAIL
;
2904 * Command LTTNG_CREATE_SESSION processed by the client thread.
2906 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2910 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2911 LTTNG_SOCK_GET_GID_CRED(creds
));
2912 if (ret
!= LTTCOMM_OK
) {
2923 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2925 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2929 /* Clean kernel session teardown */
2930 teardown_kernel_session(session
);
2931 /* UST session teardown */
2932 teardown_ust_session(session
);
2935 * Must notify the kernel thread here to update it's poll setin order
2936 * to remove the channel(s)' fd just destroyed.
2938 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2940 PERROR("write kernel poll pipe");
2943 ret
= session_destroy(session
);
2949 * Command LTTNG_CALIBRATE processed by the client thread.
2951 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2956 case LTTNG_DOMAIN_KERNEL
:
2958 struct lttng_kernel_calibrate kcalibrate
;
2960 kcalibrate
.type
= calibrate
->type
;
2961 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2963 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2968 case LTTNG_DOMAIN_UST
:
2970 struct lttng_ust_calibrate ucalibrate
;
2972 ucalibrate
.type
= calibrate
->type
;
2973 ret
= ust_app_calibrate_glb(&ucalibrate
);
2975 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2992 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2994 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3000 case LTTNG_DOMAIN_KERNEL
:
3001 /* Can't register a consumer if there is already one */
3002 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3003 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3007 sock
= lttcomm_connect_unix_sock(sock_path
);
3009 ret
= LTTCOMM_CONNECT_FAIL
;
3013 session
->kernel_session
->consumer_fd
= sock
;
3016 /* TODO: Userspace tracing */
3028 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3030 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3031 struct lttng_domain
**domains
)
3036 if (session
->kernel_session
!= NULL
) {
3037 DBG3("Listing domains found kernel domain");
3041 if (session
->ust_session
!= NULL
) {
3042 DBG3("Listing domains found UST global domain");
3046 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3047 if (*domains
== NULL
) {
3048 ret
= -LTTCOMM_FATAL
;
3052 if (session
->kernel_session
!= NULL
) {
3053 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3057 if (session
->ust_session
!= NULL
) {
3058 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3069 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3071 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3072 struct lttng_channel
**channels
)
3075 ssize_t nb_chan
= 0;
3078 case LTTNG_DOMAIN_KERNEL
:
3079 if (session
->kernel_session
!= NULL
) {
3080 nb_chan
= session
->kernel_session
->channel_count
;
3082 DBG3("Number of kernel channels %zd", nb_chan
);
3084 case LTTNG_DOMAIN_UST
:
3085 if (session
->ust_session
!= NULL
) {
3086 nb_chan
= lttng_ht_get_count(
3087 session
->ust_session
->domain_global
.channels
);
3089 DBG3("Number of UST global channels %zd", nb_chan
);
3098 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3099 if (*channels
== NULL
) {
3100 ret
= -LTTCOMM_FATAL
;
3104 list_lttng_channels(domain
, session
, *channels
);
3116 * Command LTTNG_LIST_EVENTS processed by the client thread.
3118 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3119 char *channel_name
, struct lttng_event
**events
)
3122 ssize_t nb_event
= 0;
3125 case LTTNG_DOMAIN_KERNEL
:
3126 if (session
->kernel_session
!= NULL
) {
3127 nb_event
= list_lttng_kernel_events(channel_name
,
3128 session
->kernel_session
, events
);
3131 case LTTNG_DOMAIN_UST
:
3133 if (session
->ust_session
!= NULL
) {
3134 nb_event
= list_lttng_ust_global_events(channel_name
,
3135 &session
->ust_session
->domain_global
, events
);
3151 * Process the command requested by the lttng client within the command
3152 * context structure. This function make sure that the return structure (llm)
3153 * is set and ready for transmission before returning.
3155 * Return any error encountered or 0 for success.
3157 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3159 int ret
= LTTCOMM_OK
;
3160 int need_tracing_session
= 1;
3163 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3165 switch (cmd_ctx
->lsm
->cmd_type
) {
3166 case LTTNG_CREATE_SESSION
:
3167 case LTTNG_DESTROY_SESSION
:
3168 case LTTNG_LIST_SESSIONS
:
3169 case LTTNG_LIST_DOMAINS
:
3170 case LTTNG_START_TRACE
:
3171 case LTTNG_STOP_TRACE
:
3178 if (opt_no_kernel
&& need_domain
3179 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3181 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3183 ret
= LTTCOMM_KERN_NA
;
3189 * Check for command that don't needs to allocate a returned payload. We do
3190 * this here so we don't have to make the call for no payload at each
3193 switch(cmd_ctx
->lsm
->cmd_type
) {
3194 case LTTNG_LIST_SESSIONS
:
3195 case LTTNG_LIST_TRACEPOINTS
:
3196 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3197 case LTTNG_LIST_DOMAINS
:
3198 case LTTNG_LIST_CHANNELS
:
3199 case LTTNG_LIST_EVENTS
:
3202 /* Setup lttng message with no payload */
3203 ret
= setup_lttng_msg(cmd_ctx
, 0);
3205 /* This label does not try to unlock the session */
3206 goto init_setup_error
;
3210 /* Commands that DO NOT need a session. */
3211 switch (cmd_ctx
->lsm
->cmd_type
) {
3212 case LTTNG_CREATE_SESSION
:
3213 case LTTNG_CALIBRATE
:
3214 case LTTNG_LIST_SESSIONS
:
3215 case LTTNG_LIST_TRACEPOINTS
:
3216 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3217 need_tracing_session
= 0;
3220 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3222 * We keep the session list lock across _all_ commands
3223 * for now, because the per-session lock does not
3224 * handle teardown properly.
3226 session_lock_list();
3227 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3228 if (cmd_ctx
->session
== NULL
) {
3229 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3230 ret
= LTTCOMM_SESS_NOT_FOUND
;
3232 /* If no session name specified */
3233 ret
= LTTCOMM_SELECT_SESS
;
3237 /* Acquire lock for the session */
3238 session_lock(cmd_ctx
->session
);
3247 * Check domain type for specific "pre-action".
3249 switch (cmd_ctx
->lsm
->domain
.type
) {
3250 case LTTNG_DOMAIN_KERNEL
:
3252 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3256 /* Kernel tracer check */
3257 if (kernel_tracer_fd
== -1) {
3258 /* Basically, load kernel tracer modules */
3259 ret
= init_kernel_tracer();
3265 /* Consumer is in an ERROR state. Report back to client */
3266 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3267 ret
= LTTCOMM_NO_KERNCONSUMERD
;
3271 /* Need a session for kernel command */
3272 if (need_tracing_session
) {
3273 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3274 ret
= create_kernel_session(cmd_ctx
->session
);
3276 ret
= LTTCOMM_KERN_SESS_FAIL
;
3281 /* Start the kernel consumer daemon */
3282 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3283 if (kconsumer_data
.pid
== 0 &&
3284 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3285 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3286 ret
= start_consumerd(&kconsumer_data
);
3288 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3291 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3293 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3298 case LTTNG_DOMAIN_UST
:
3300 /* Consumer is in an ERROR state. Report back to client */
3301 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3302 ret
= LTTCOMM_NO_USTCONSUMERD
;
3306 if (need_tracing_session
) {
3307 if (cmd_ctx
->session
->ust_session
== NULL
) {
3308 ret
= create_ust_session(cmd_ctx
->session
,
3309 &cmd_ctx
->lsm
->domain
);
3310 if (ret
!= LTTCOMM_OK
) {
3314 /* Start the UST consumer daemons */
3316 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3317 if (consumerd64_bin
[0] != '\0' &&
3318 ustconsumer64_data
.pid
== 0 &&
3319 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3320 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3321 ret
= start_consumerd(&ustconsumer64_data
);
3323 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3324 ust_consumerd64_fd
= -EINVAL
;
3328 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3329 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3331 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3334 if (consumerd32_bin
[0] != '\0' &&
3335 ustconsumer32_data
.pid
== 0 &&
3336 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3337 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3338 ret
= start_consumerd(&ustconsumer32_data
);
3340 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3341 ust_consumerd32_fd
= -EINVAL
;
3345 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3346 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3348 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3358 /* Validate consumer daemon state when start/stop trace command */
3359 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3360 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3361 switch (cmd_ctx
->lsm
->domain
.type
) {
3362 case LTTNG_DOMAIN_UST
:
3363 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3364 ret
= LTTCOMM_NO_USTCONSUMERD
;
3368 case LTTNG_DOMAIN_KERNEL
:
3369 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3370 ret
= LTTCOMM_NO_KERNCONSUMERD
;
3378 * Check that the UID or GID match that of the tracing session.
3379 * The root user can interact with all sessions.
3381 if (need_tracing_session
) {
3382 if (!session_access_ok(cmd_ctx
->session
,
3383 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3384 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3385 ret
= LTTCOMM_EPERM
;
3390 /* Process by command type */
3391 switch (cmd_ctx
->lsm
->cmd_type
) {
3392 case LTTNG_ADD_CONTEXT
:
3394 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3395 cmd_ctx
->lsm
->u
.context
.channel_name
,
3396 cmd_ctx
->lsm
->u
.context
.event_name
,
3397 &cmd_ctx
->lsm
->u
.context
.ctx
);
3400 case LTTNG_DISABLE_CHANNEL
:
3402 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3403 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3406 case LTTNG_DISABLE_EVENT
:
3408 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3409 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3410 cmd_ctx
->lsm
->u
.disable
.name
);
3413 case LTTNG_DISABLE_ALL_EVENT
:
3415 DBG("Disabling all events");
3417 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3418 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3421 case LTTNG_ENABLE_CHANNEL
:
3423 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3424 &cmd_ctx
->lsm
->u
.channel
.chan
);
3427 case LTTNG_ENABLE_EVENT
:
3429 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3430 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3431 &cmd_ctx
->lsm
->u
.enable
.event
);
3434 case LTTNG_ENABLE_ALL_EVENT
:
3436 DBG("Enabling all events");
3438 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3439 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3440 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3443 case LTTNG_LIST_TRACEPOINTS
:
3445 struct lttng_event
*events
;
3448 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3449 if (nb_events
< 0) {
3455 * Setup lttng message with payload size set to the event list size in
3456 * bytes and then copy list into the llm payload.
3458 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3464 /* Copy event list into message payload */
3465 memcpy(cmd_ctx
->llm
->payload
, events
,
3466 sizeof(struct lttng_event
) * nb_events
);
3473 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3475 struct lttng_event_field
*fields
;
3478 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
, &fields
);
3479 if (nb_fields
< 0) {
3485 * Setup lttng message with payload size set to the event list size in
3486 * bytes and then copy list into the llm payload.
3488 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event_field
) * nb_fields
);
3494 /* Copy event list into message payload */
3495 memcpy(cmd_ctx
->llm
->payload
, fields
,
3496 sizeof(struct lttng_event_field
) * nb_fields
);
3504 case LTTNG_START_TRACE
:
3506 ret
= cmd_start_trace(cmd_ctx
->session
);
3509 case LTTNG_STOP_TRACE
:
3511 ret
= cmd_stop_trace(cmd_ctx
->session
);
3514 case LTTNG_CREATE_SESSION
:
3516 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3517 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3520 case LTTNG_DESTROY_SESSION
:
3522 ret
= cmd_destroy_session(cmd_ctx
->session
,
3523 cmd_ctx
->lsm
->session
.name
);
3525 * Set session to NULL so we do not unlock it after
3528 cmd_ctx
->session
= NULL
;
3531 case LTTNG_LIST_DOMAINS
:
3534 struct lttng_domain
*domains
;
3536 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3542 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3547 /* Copy event list into message payload */
3548 memcpy(cmd_ctx
->llm
->payload
, domains
,
3549 nb_dom
* sizeof(struct lttng_domain
));
3556 case LTTNG_LIST_CHANNELS
:
3559 struct lttng_channel
*channels
;
3561 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3562 cmd_ctx
->session
, &channels
);
3568 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3573 /* Copy event list into message payload */
3574 memcpy(cmd_ctx
->llm
->payload
, channels
,
3575 nb_chan
* sizeof(struct lttng_channel
));
3582 case LTTNG_LIST_EVENTS
:
3585 struct lttng_event
*events
= NULL
;
3587 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3588 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3594 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3599 /* Copy event list into message payload */
3600 memcpy(cmd_ctx
->llm
->payload
, events
,
3601 nb_event
* sizeof(struct lttng_event
));
3608 case LTTNG_LIST_SESSIONS
:
3610 unsigned int nr_sessions
;
3612 session_lock_list();
3613 nr_sessions
= lttng_sessions_count(
3614 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3615 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3617 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3619 session_unlock_list();
3623 /* Filled the session array */
3624 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3625 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3626 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3628 session_unlock_list();
3633 case LTTNG_CALIBRATE
:
3635 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3636 &cmd_ctx
->lsm
->u
.calibrate
);
3639 case LTTNG_REGISTER_CONSUMER
:
3641 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3642 cmd_ctx
->lsm
->u
.reg
.path
);
3651 if (cmd_ctx
->llm
== NULL
) {
3652 DBG("Missing llm structure. Allocating one.");
3653 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3657 /* Set return code */
3658 cmd_ctx
->llm
->ret_code
= ret
;
3660 if (cmd_ctx
->session
) {
3661 session_unlock(cmd_ctx
->session
);
3663 if (need_tracing_session
) {
3664 session_unlock_list();
3671 * This thread manage all clients request using the unix client socket for
3674 static void *thread_manage_clients(void *data
)
3676 int sock
= -1, ret
, i
, pollfd
;
3677 uint32_t revents
, nb_fd
;
3678 struct command_ctx
*cmd_ctx
= NULL
;
3679 struct lttng_poll_event events
;
3681 DBG("[thread] Manage client started");
3683 rcu_register_thread();
3685 ret
= lttcomm_listen_unix_sock(client_sock
);
3691 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3692 * more will be added to this poll set.
3694 ret
= create_thread_poll_set(&events
, 2);
3699 /* Add the application registration socket */
3700 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3706 * Notify parent pid that we are ready to accept command for client side.
3708 if (opt_sig_parent
) {
3709 kill(ppid
, SIGUSR1
);
3713 DBG("Accepting client command ...");
3715 nb_fd
= LTTNG_POLL_GETNB(&events
);
3717 /* Inifinite blocking call, waiting for transmission */
3719 ret
= lttng_poll_wait(&events
, -1);
3722 * Restart interrupted system call.
3724 if (errno
== EINTR
) {
3730 for (i
= 0; i
< nb_fd
; i
++) {
3731 /* Fetch once the poll data */
3732 revents
= LTTNG_POLL_GETEV(&events
, i
);
3733 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3735 /* Thread quit pipe has been closed. Killing thread. */
3736 ret
= check_thread_quit_pipe(pollfd
, revents
);
3741 /* Event on the registration socket */
3742 if (pollfd
== client_sock
) {
3743 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3744 ERR("Client socket poll error");
3750 DBG("Wait for client response");
3752 sock
= lttcomm_accept_unix_sock(client_sock
);
3757 /* Set socket option for credentials retrieval */
3758 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3763 /* Allocate context command to process the client request */
3764 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3765 if (cmd_ctx
== NULL
) {
3766 PERROR("zmalloc cmd_ctx");
3770 /* Allocate data buffer for reception */
3771 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3772 if (cmd_ctx
->lsm
== NULL
) {
3773 PERROR("zmalloc cmd_ctx->lsm");
3777 cmd_ctx
->llm
= NULL
;
3778 cmd_ctx
->session
= NULL
;
3781 * Data is received from the lttng client. The struct
3782 * lttcomm_session_msg (lsm) contains the command and data request of
3785 DBG("Receiving data from client ...");
3786 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3787 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3789 DBG("Nothing recv() from client... continuing");
3795 clean_command_ctx(&cmd_ctx
);
3799 // TODO: Validate cmd_ctx including sanity check for
3800 // security purpose.
3802 rcu_thread_online();
3804 * This function dispatch the work to the kernel or userspace tracer
3805 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3806 * informations for the client. The command context struct contains
3807 * everything this function may needs.
3809 ret
= process_client_msg(cmd_ctx
);
3810 rcu_thread_offline();
3813 * TODO: Inform client somehow of the fatal error. At
3814 * this point, ret < 0 means that a zmalloc failed
3815 * (ENOMEM). Error detected but still accept command.
3817 clean_command_ctx(&cmd_ctx
);
3821 DBG("Sending response (size: %d, retcode: %s)",
3822 cmd_ctx
->lttng_msg_size
,
3823 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3824 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3826 ERR("Failed to send data back to client");
3829 /* End of transmission */
3836 clean_command_ctx(&cmd_ctx
);
3840 DBG("Client thread dying");
3841 unlink(client_unix_sock_path
);
3842 if (client_sock
>= 0) {
3843 ret
= close(client_sock
);
3855 lttng_poll_clean(&events
);
3856 clean_command_ctx(&cmd_ctx
);
3858 rcu_unregister_thread();
3864 * usage function on stderr
3866 static void usage(void)
3868 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3869 fprintf(stderr
, " -h, --help Display this usage.\n");
3870 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3871 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3872 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3873 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3874 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3875 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3876 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3877 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3878 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3879 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3880 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3881 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3882 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3883 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3884 fprintf(stderr
, " -V, --version Show version number.\n");
3885 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3886 fprintf(stderr
, " -q, --quiet No output at all.\n");
3887 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3888 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3889 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3893 * daemon argument parsing
3895 static int parse_args(int argc
, char **argv
)
3899 static struct option long_options
[] = {
3900 { "client-sock", 1, 0, 'c' },
3901 { "apps-sock", 1, 0, 'a' },
3902 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3903 { "kconsumerd-err-sock", 1, 0, 'E' },
3904 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3905 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3906 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3907 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3908 { "consumerd32-path", 1, 0, 'u' },
3909 { "consumerd32-libdir", 1, 0, 'U' },
3910 { "consumerd64-path", 1, 0, 't' },
3911 { "consumerd64-libdir", 1, 0, 'T' },
3912 { "daemonize", 0, 0, 'd' },
3913 { "sig-parent", 0, 0, 'S' },
3914 { "help", 0, 0, 'h' },
3915 { "group", 1, 0, 'g' },
3916 { "version", 0, 0, 'V' },
3917 { "quiet", 0, 0, 'q' },
3918 { "verbose", 0, 0, 'v' },
3919 { "verbose-consumer", 0, 0, 'Z' },
3920 { "no-kernel", 0, 0, 'N' },
3925 int option_index
= 0;
3926 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3927 long_options
, &option_index
);
3934 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3936 fprintf(stderr
, " with arg %s\n", optarg
);
3940 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3943 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3949 opt_tracing_group
= optarg
;
3955 fprintf(stdout
, "%s\n", VERSION
);
3961 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3964 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3967 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3970 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3973 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3976 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3982 lttng_opt_quiet
= 1;
3985 /* Verbose level can increase using multiple -v */
3986 lttng_opt_verbose
+= 1;
3989 opt_verbose_consumer
+= 1;
3992 consumerd32_bin
= optarg
;
3995 consumerd32_libdir
= optarg
;
3998 consumerd64_bin
= optarg
;
4001 consumerd64_libdir
= optarg
;
4004 /* Unknown option or other error.
4005 * Error is printed by getopt, just return */
4014 * Creates the two needed socket by the daemon.
4015 * apps_sock - The communication socket for all UST apps.
4016 * client_sock - The communication of the cli tool (lttng).
4018 static int init_daemon_socket(void)
4023 old_umask
= umask(0);
4025 /* Create client tool unix socket */
4026 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4027 if (client_sock
< 0) {
4028 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4033 /* File permission MUST be 660 */
4034 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4036 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4041 /* Create the application unix socket */
4042 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4043 if (apps_sock
< 0) {
4044 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4049 /* File permission MUST be 666 */
4050 ret
= chmod(apps_unix_sock_path
,
4051 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4053 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4064 * Check if the global socket is available, and if a daemon is answering at the
4065 * other side. If yes, error is returned.
4067 static int check_existing_daemon(void)
4069 /* Is there anybody out there ? */
4070 if (lttng_session_daemon_alive()) {
4078 * Set the tracing group gid onto the client socket.
4080 * Race window between mkdir and chown is OK because we are going from more
4081 * permissive (root.root) to less permissive (root.tracing).
4083 static int set_permissions(char *rundir
)
4088 ret
= allowed_group();
4090 WARN("No tracing group detected");
4097 /* Set lttng run dir */
4098 ret
= chown(rundir
, 0, gid
);
4100 ERR("Unable to set group on %s", rundir
);
4104 /* Ensure tracing group can search the run dir */
4105 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4107 ERR("Unable to set permissions on %s", rundir
);
4111 /* lttng client socket path */
4112 ret
= chown(client_unix_sock_path
, 0, gid
);
4114 ERR("Unable to set group on %s", client_unix_sock_path
);
4118 /* kconsumer error socket path */
4119 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4121 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4125 /* 64-bit ustconsumer error socket path */
4126 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4128 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4132 /* 32-bit ustconsumer compat32 error socket path */
4133 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4135 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4139 DBG("All permissions are set");
4146 * Create the lttng run directory needed for all global sockets and pipe.
4148 static int create_lttng_rundir(const char *rundir
)
4152 DBG3("Creating LTTng run directory: %s", rundir
);
4154 ret
= mkdir(rundir
, S_IRWXU
);
4156 if (errno
!= EEXIST
) {
4157 ERR("Unable to create %s", rundir
);
4169 * Setup sockets and directory needed by the kconsumerd communication with the
4172 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4176 char path
[PATH_MAX
];
4178 switch (consumer_data
->type
) {
4179 case LTTNG_CONSUMER_KERNEL
:
4180 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4182 case LTTNG_CONSUMER64_UST
:
4183 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4185 case LTTNG_CONSUMER32_UST
:
4186 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4189 ERR("Consumer type unknown");
4194 DBG2("Creating consumer directory: %s", path
);
4196 ret
= mkdir(path
, S_IRWXU
);
4198 if (errno
!= EEXIST
) {
4200 ERR("Failed to create %s", path
);
4206 /* Create the kconsumerd error unix socket */
4207 consumer_data
->err_sock
=
4208 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4209 if (consumer_data
->err_sock
< 0) {
4210 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4215 /* File permission MUST be 660 */
4216 ret
= chmod(consumer_data
->err_unix_sock_path
,
4217 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4219 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4229 * Signal handler for the daemon
4231 * Simply stop all worker threads, leaving main() return gracefully after
4232 * joining all threads and calling cleanup().
4234 static void sighandler(int sig
)
4238 DBG("SIGPIPE caught");
4241 DBG("SIGINT caught");
4245 DBG("SIGTERM caught");
4254 * Setup signal handler for :
4255 * SIGINT, SIGTERM, SIGPIPE
4257 static int set_signal_handler(void)
4260 struct sigaction sa
;
4263 if ((ret
= sigemptyset(&sigset
)) < 0) {
4264 PERROR("sigemptyset");
4268 sa
.sa_handler
= sighandler
;
4269 sa
.sa_mask
= sigset
;
4271 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4272 PERROR("sigaction");
4276 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4277 PERROR("sigaction");
4281 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4282 PERROR("sigaction");
4286 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4292 * Set open files limit to unlimited. This daemon can open a large number of
4293 * file descriptors in order to consumer multiple kernel traces.
4295 static void set_ulimit(void)
4300 /* The kernel does not allowed an infinite limit for open files */
4301 lim
.rlim_cur
= 65535;
4302 lim
.rlim_max
= 65535;
4304 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4306 PERROR("failed to set open files limit");
4313 int main(int argc
, char **argv
)
4317 const char *home_path
;
4319 init_kernel_workarounds();
4321 rcu_register_thread();
4323 setup_consumerd_path();
4325 /* Parse arguments */
4327 if ((ret
= parse_args(argc
, argv
) < 0)) {
4337 * child: setsid, close FD 0, 1, 2, chdir /
4338 * parent: exit (if fork is successful)
4346 * We are in the child. Make sure all other file
4347 * descriptors are closed, in case we are called with
4348 * more opened file descriptors than the standard ones.
4350 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
4355 /* Create thread quit pipe */
4356 if ((ret
= init_thread_quit_pipe()) < 0) {
4360 /* Check if daemon is UID = 0 */
4361 is_root
= !getuid();
4364 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4366 /* Create global run dir with root access */
4367 ret
= create_lttng_rundir(rundir
);
4372 if (strlen(apps_unix_sock_path
) == 0) {
4373 snprintf(apps_unix_sock_path
, PATH_MAX
,
4374 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4377 if (strlen(client_unix_sock_path
) == 0) {
4378 snprintf(client_unix_sock_path
, PATH_MAX
,
4379 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4382 /* Set global SHM for ust */
4383 if (strlen(wait_shm_path
) == 0) {
4384 snprintf(wait_shm_path
, PATH_MAX
,
4385 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4388 /* Setup kernel consumerd path */
4389 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4390 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4391 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4392 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4394 DBG2("Kernel consumer err path: %s",
4395 kconsumer_data
.err_unix_sock_path
);
4396 DBG2("Kernel consumer cmd path: %s",
4397 kconsumer_data
.cmd_unix_sock_path
);
4399 home_path
= get_home_dir();
4400 if (home_path
== NULL
) {
4401 /* TODO: Add --socket PATH option */
4402 ERR("Can't get HOME directory for sockets creation.");
4408 * Create rundir from home path. This will create something like
4411 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4417 ret
= create_lttng_rundir(rundir
);
4422 if (strlen(apps_unix_sock_path
) == 0) {
4423 snprintf(apps_unix_sock_path
, PATH_MAX
,
4424 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4427 /* Set the cli tool unix socket path */
4428 if (strlen(client_unix_sock_path
) == 0) {
4429 snprintf(client_unix_sock_path
, PATH_MAX
,
4430 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4433 /* Set global SHM for ust */
4434 if (strlen(wait_shm_path
) == 0) {
4435 snprintf(wait_shm_path
, PATH_MAX
,
4436 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4440 /* Set consumer initial state */
4441 kernel_consumerd_state
= CONSUMER_STOPPED
;
4442 ust_consumerd_state
= CONSUMER_STOPPED
;
4444 DBG("Client socket path %s", client_unix_sock_path
);
4445 DBG("Application socket path %s", apps_unix_sock_path
);
4446 DBG("LTTng run directory path: %s", rundir
);
4448 /* 32 bits consumerd path setup */
4449 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4450 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4451 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4452 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4454 DBG2("UST consumer 32 bits err path: %s",
4455 ustconsumer32_data
.err_unix_sock_path
);
4456 DBG2("UST consumer 32 bits cmd path: %s",
4457 ustconsumer32_data
.cmd_unix_sock_path
);
4459 /* 64 bits consumerd path setup */
4460 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4461 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4462 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4463 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4465 DBG2("UST consumer 64 bits err path: %s",
4466 ustconsumer64_data
.err_unix_sock_path
);
4467 DBG2("UST consumer 64 bits cmd path: %s",
4468 ustconsumer64_data
.cmd_unix_sock_path
);
4471 * See if daemon already exist.
4473 if ((ret
= check_existing_daemon()) < 0) {
4474 ERR("Already running daemon.\n");
4476 * We do not goto exit because we must not cleanup()
4477 * because a daemon is already running.
4483 * Init UST app hash table. Alloc hash table before this point since
4484 * cleanup() can get called after that point.
4488 /* After this point, we can safely call cleanup() with "goto exit" */
4491 * These actions must be executed as root. We do that *after* setting up
4492 * the sockets path because we MUST make the check for another daemon using
4493 * those paths *before* trying to set the kernel consumer sockets and init
4497 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4502 /* Setup kernel tracer */
4503 if (!opt_no_kernel
) {
4504 init_kernel_tracer();
4507 /* Set ulimit for open files */
4510 /* init lttng_fd tracking must be done after set_ulimit. */
4513 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4518 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4523 if ((ret
= set_signal_handler()) < 0) {
4527 /* Setup the needed unix socket */
4528 if ((ret
= init_daemon_socket()) < 0) {
4532 /* Set credentials to socket */
4533 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4537 /* Get parent pid if -S, --sig-parent is specified. */
4538 if (opt_sig_parent
) {
4542 /* Setup the kernel pipe for waking up the kernel thread */
4543 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
4547 /* Setup the thread apps communication pipe. */
4548 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
4552 /* Init UST command queue. */
4553 cds_wfq_init(&ust_cmd_queue
.queue
);
4556 * Get session list pointer. This pointer MUST NOT be free(). This list is
4557 * statically declared in session.c
4559 session_list_ptr
= session_get_list();
4561 /* Set up max poll set size */
4562 lttng_poll_set_max_size();
4564 /* Create thread to manage the client socket */
4565 ret
= pthread_create(&client_thread
, NULL
,
4566 thread_manage_clients
, (void *) NULL
);
4568 PERROR("pthread_create clients");
4572 /* Create thread to dispatch registration */
4573 ret
= pthread_create(&dispatch_thread
, NULL
,
4574 thread_dispatch_ust_registration
, (void *) NULL
);
4576 PERROR("pthread_create dispatch");
4580 /* Create thread to manage application registration. */
4581 ret
= pthread_create(®_apps_thread
, NULL
,
4582 thread_registration_apps
, (void *) NULL
);
4584 PERROR("pthread_create registration");
4588 /* Create thread to manage application socket */
4589 ret
= pthread_create(&apps_thread
, NULL
,
4590 thread_manage_apps
, (void *) NULL
);
4592 PERROR("pthread_create apps");
4596 /* Create kernel thread to manage kernel event */
4597 ret
= pthread_create(&kernel_thread
, NULL
,
4598 thread_manage_kernel
, (void *) NULL
);
4600 PERROR("pthread_create kernel");
4604 ret
= pthread_join(kernel_thread
, &status
);
4606 PERROR("pthread_join");
4607 goto error
; /* join error, exit without cleanup */
4611 ret
= pthread_join(apps_thread
, &status
);
4613 PERROR("pthread_join");
4614 goto error
; /* join error, exit without cleanup */
4618 ret
= pthread_join(reg_apps_thread
, &status
);
4620 PERROR("pthread_join");
4621 goto error
; /* join error, exit without cleanup */
4625 ret
= pthread_join(dispatch_thread
, &status
);
4627 PERROR("pthread_join");
4628 goto error
; /* join error, exit without cleanup */
4632 ret
= pthread_join(client_thread
, &status
);
4634 PERROR("pthread_join");
4635 goto error
; /* join error, exit without cleanup */
4638 ret
= join_consumer_thread(&kconsumer_data
);
4640 PERROR("join_consumer");
4641 goto error
; /* join error, exit without cleanup */
4647 * cleanup() is called when no other thread is running.
4649 rcu_thread_online();
4651 rcu_thread_offline();
4652 rcu_unregister_thread();