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 channel
, session
->uid
, session
->gid
);
654 session_unlock(session
);
656 session_unlock_list();
660 session_unlock(session
);
661 session_unlock_list();
666 * For each tracing session, update newly registered apps.
668 static void update_ust_app(int app_sock
)
670 struct ltt_session
*sess
, *stmp
;
674 /* For all tracing session(s) */
675 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
677 if (sess
->ust_session
) {
678 ust_app_global_update(sess
->ust_session
, app_sock
);
680 session_unlock(sess
);
683 session_unlock_list();
687 * This thread manage event coming from the kernel.
689 * Features supported in this thread:
692 static void *thread_manage_kernel(void *data
)
694 int ret
, i
, pollfd
, update_poll_flag
= 1;
695 uint32_t revents
, nb_fd
;
697 struct lttng_poll_event events
;
699 DBG("Thread manage kernel started");
701 ret
= create_thread_poll_set(&events
, 2);
703 goto error_poll_create
;
706 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
712 if (update_poll_flag
== 1) {
714 * Reset number of fd in the poll set. Always 2 since there is the thread
715 * quit pipe and the kernel pipe.
719 ret
= update_kernel_poll(&events
);
723 update_poll_flag
= 0;
726 nb_fd
= LTTNG_POLL_GETNB(&events
);
728 DBG("Thread kernel polling on %d fds", nb_fd
);
730 /* Zeroed the poll events */
731 lttng_poll_reset(&events
);
733 /* Poll infinite value of time */
735 ret
= lttng_poll_wait(&events
, -1);
738 * Restart interrupted system call.
740 if (errno
== EINTR
) {
744 } else if (ret
== 0) {
745 /* Should not happen since timeout is infinite */
746 ERR("Return value of poll is 0 with an infinite timeout.\n"
747 "This should not have happened! Continuing...");
751 for (i
= 0; i
< nb_fd
; i
++) {
752 /* Fetch once the poll data */
753 revents
= LTTNG_POLL_GETEV(&events
, i
);
754 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
756 /* Thread quit pipe has been closed. Killing thread. */
757 ret
= check_thread_quit_pipe(pollfd
, revents
);
762 /* Check for data on kernel pipe */
763 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
764 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
765 update_poll_flag
= 1;
769 * New CPU detected by the kernel. Adding kernel stream to
770 * kernel session and updating the kernel consumer
772 if (revents
& LPOLLIN
) {
773 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
779 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
780 * and unregister kernel stream at this point.
788 lttng_poll_clean(&events
);
790 DBG("Kernel thread dying");
795 * This thread manage the consumer error sent back to the session daemon.
797 static void *thread_manage_consumer(void *data
)
799 int sock
= -1, i
, ret
, pollfd
;
800 uint32_t revents
, nb_fd
;
801 enum lttcomm_return_code code
;
802 struct lttng_poll_event events
;
803 struct consumer_data
*consumer_data
= data
;
805 DBG("[thread] Manage consumer started");
807 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
813 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
814 * Nothing more will be added to this poll set.
816 ret
= create_thread_poll_set(&events
, 2);
821 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
826 nb_fd
= LTTNG_POLL_GETNB(&events
);
828 /* Inifinite blocking call, waiting for transmission */
830 ret
= lttng_poll_wait(&events
, -1);
833 * Restart interrupted system call.
835 if (errno
== EINTR
) {
841 for (i
= 0; i
< nb_fd
; i
++) {
842 /* Fetch once the poll data */
843 revents
= LTTNG_POLL_GETEV(&events
, i
);
844 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
846 /* Thread quit pipe has been closed. Killing thread. */
847 ret
= check_thread_quit_pipe(pollfd
, revents
);
852 /* Event on the registration socket */
853 if (pollfd
== consumer_data
->err_sock
) {
854 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
855 ERR("consumer err socket poll error");
861 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
866 DBG2("Receiving code from consumer err_sock");
868 /* Getting status code from kconsumerd */
869 ret
= lttcomm_recv_unix_sock(sock
, &code
,
870 sizeof(enum lttcomm_return_code
));
875 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
876 consumer_data
->cmd_sock
=
877 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
878 if (consumer_data
->cmd_sock
< 0) {
879 sem_post(&consumer_data
->sem
);
880 PERROR("consumer connect");
883 /* Signal condition to tell that the kconsumerd is ready */
884 sem_post(&consumer_data
->sem
);
885 DBG("consumer command socket ready");
887 ERR("consumer error when waiting for SOCK_READY : %s",
888 lttcomm_get_readable_code(-code
));
892 /* Remove the kconsumerd error sock since we've established a connexion */
893 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
898 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
903 /* Update number of fd */
904 nb_fd
= LTTNG_POLL_GETNB(&events
);
906 /* Inifinite blocking call, waiting for transmission */
908 ret
= lttng_poll_wait(&events
, -1);
911 * Restart interrupted system call.
913 if (errno
== EINTR
) {
919 for (i
= 0; i
< nb_fd
; i
++) {
920 /* Fetch once the poll data */
921 revents
= LTTNG_POLL_GETEV(&events
, i
);
922 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
924 /* Thread quit pipe has been closed. Killing thread. */
925 ret
= check_thread_quit_pipe(pollfd
, revents
);
930 /* Event on the kconsumerd socket */
931 if (pollfd
== sock
) {
932 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
933 ERR("consumer err socket second poll error");
939 /* Wait for any kconsumerd error */
940 ret
= lttcomm_recv_unix_sock(sock
, &code
,
941 sizeof(enum lttcomm_return_code
));
943 ERR("consumer closed the command socket");
947 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
950 /* Immediately set the consumerd state to stopped */
951 if (consumer_data
->type
== LTTNG_CONSUMER_KERNEL
) {
952 uatomic_set(&kernel_consumerd_state
, CONSUMER_ERROR
);
953 } else if (consumer_data
->type
== LTTNG_CONSUMER64_UST
||
954 consumer_data
->type
== LTTNG_CONSUMER32_UST
) {
955 uatomic_set(&ust_consumerd_state
, CONSUMER_ERROR
);
957 /* Code flow error... */
961 if (consumer_data
->err_sock
>= 0) {
962 ret
= close(consumer_data
->err_sock
);
967 if (consumer_data
->cmd_sock
>= 0) {
968 ret
= close(consumer_data
->cmd_sock
);
980 unlink(consumer_data
->err_unix_sock_path
);
981 unlink(consumer_data
->cmd_unix_sock_path
);
982 consumer_data
->pid
= 0;
984 lttng_poll_clean(&events
);
987 DBG("consumer thread cleanup completed");
993 * This thread manage application communication.
995 static void *thread_manage_apps(void *data
)
998 uint32_t revents
, nb_fd
;
999 struct ust_command ust_cmd
;
1000 struct lttng_poll_event events
;
1002 DBG("[thread] Manage application started");
1004 rcu_register_thread();
1005 rcu_thread_online();
1007 ret
= create_thread_poll_set(&events
, 2);
1009 goto error_poll_create
;
1012 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1018 /* Zeroed the events structure */
1019 lttng_poll_reset(&events
);
1021 nb_fd
= LTTNG_POLL_GETNB(&events
);
1023 DBG("Apps thread polling on %d fds", nb_fd
);
1025 /* Inifinite blocking call, waiting for transmission */
1027 ret
= lttng_poll_wait(&events
, -1);
1030 * Restart interrupted system call.
1032 if (errno
== EINTR
) {
1038 for (i
= 0; i
< nb_fd
; i
++) {
1039 /* Fetch once the poll data */
1040 revents
= LTTNG_POLL_GETEV(&events
, i
);
1041 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1043 /* Thread quit pipe has been closed. Killing thread. */
1044 ret
= check_thread_quit_pipe(pollfd
, revents
);
1049 /* Inspect the apps cmd pipe */
1050 if (pollfd
== apps_cmd_pipe
[0]) {
1051 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1052 ERR("Apps command pipe error");
1054 } else if (revents
& LPOLLIN
) {
1056 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1057 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1058 PERROR("read apps cmd pipe");
1062 /* Register applicaton to the session daemon */
1063 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1065 if (ret
== -ENOMEM
) {
1067 } else if (ret
< 0) {
1072 * Validate UST version compatibility.
1074 ret
= ust_app_validate_version(ust_cmd
.sock
);
1077 * Add channel(s) and event(s) to newly registered apps
1078 * from lttng global UST domain.
1080 update_ust_app(ust_cmd
.sock
);
1083 ret
= ust_app_register_done(ust_cmd
.sock
);
1086 * If the registration is not possible, we simply
1087 * unregister the apps and continue
1089 ust_app_unregister(ust_cmd
.sock
);
1092 * We just need here to monitor the close of the UST
1093 * socket and poll set monitor those by default.
1094 * Listen on POLLIN (even if we never expect any
1095 * data) to ensure that hangup wakes us.
1097 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1102 DBG("Apps with sock %d added to poll set",
1110 * At this point, we know that a registered application made
1111 * the event at poll_wait.
1113 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1114 /* Removing from the poll set */
1115 ret
= lttng_poll_del(&events
, pollfd
);
1120 /* Socket closed on remote end. */
1121 ust_app_unregister(pollfd
);
1129 lttng_poll_clean(&events
);
1131 DBG("Application communication apps thread cleanup complete");
1132 rcu_thread_offline();
1133 rcu_unregister_thread();
1138 * Dispatch request from the registration threads to the application
1139 * communication thread.
1141 static void *thread_dispatch_ust_registration(void *data
)
1144 struct cds_wfq_node
*node
;
1145 struct ust_command
*ust_cmd
= NULL
;
1147 DBG("[thread] Dispatch UST command started");
1149 while (!dispatch_thread_exit
) {
1150 /* Atomically prepare the queue futex */
1151 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1154 /* Dequeue command for registration */
1155 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1157 DBG("Woken up but nothing in the UST command queue");
1158 /* Continue thread execution */
1162 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1164 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1165 " gid:%d sock:%d name:%s (version %d.%d)",
1166 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1167 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1168 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1169 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1171 * Inform apps thread of the new application registration. This
1172 * call is blocking so we can be assured that the data will be read
1173 * at some point in time or wait to the end of the world :)
1175 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1176 sizeof(struct ust_command
));
1178 PERROR("write apps cmd pipe");
1179 if (errno
== EBADF
) {
1181 * We can't inform the application thread to process
1182 * registration. We will exit or else application
1183 * registration will not occur and tracing will never
1190 } while (node
!= NULL
);
1192 /* Futex wait on queue. Blocking call on futex() */
1193 futex_nto1_wait(&ust_cmd_queue
.futex
);
1197 DBG("Dispatch thread dying");
1202 * This thread manage application registration.
1204 static void *thread_registration_apps(void *data
)
1206 int sock
= -1, i
, ret
, pollfd
;
1207 uint32_t revents
, nb_fd
;
1208 struct lttng_poll_event events
;
1210 * Get allocated in this thread, enqueued to a global queue, dequeued and
1211 * freed in the manage apps thread.
1213 struct ust_command
*ust_cmd
= NULL
;
1215 DBG("[thread] Manage application registration started");
1217 ret
= lttcomm_listen_unix_sock(apps_sock
);
1223 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1224 * more will be added to this poll set.
1226 ret
= create_thread_poll_set(&events
, 2);
1228 goto error_create_poll
;
1231 /* Add the application registration socket */
1232 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1234 goto error_poll_add
;
1237 /* Notify all applications to register */
1238 ret
= notify_ust_apps(1);
1240 ERR("Failed to notify applications or create the wait shared memory.\n"
1241 "Execution continues but there might be problem for already\n"
1242 "running applications that wishes to register.");
1246 DBG("Accepting application registration");
1248 nb_fd
= LTTNG_POLL_GETNB(&events
);
1250 /* Inifinite blocking call, waiting for transmission */
1252 ret
= lttng_poll_wait(&events
, -1);
1255 * Restart interrupted system call.
1257 if (errno
== EINTR
) {
1263 for (i
= 0; i
< nb_fd
; i
++) {
1264 /* Fetch once the poll data */
1265 revents
= LTTNG_POLL_GETEV(&events
, i
);
1266 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1268 /* Thread quit pipe has been closed. Killing thread. */
1269 ret
= check_thread_quit_pipe(pollfd
, revents
);
1274 /* Event on the registration socket */
1275 if (pollfd
== apps_sock
) {
1276 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1277 ERR("Register apps socket poll error");
1279 } else if (revents
& LPOLLIN
) {
1280 sock
= lttcomm_accept_unix_sock(apps_sock
);
1285 /* Create UST registration command for enqueuing */
1286 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1287 if (ust_cmd
== NULL
) {
1288 PERROR("ust command zmalloc");
1293 * Using message-based transmissions to ensure we don't
1294 * have to deal with partially received messages.
1296 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1298 ERR("Exhausted file descriptors allowed for applications.");
1307 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1308 sizeof(struct ust_register_msg
));
1309 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1311 PERROR("lttcomm_recv_unix_sock register apps");
1313 ERR("Wrong size received on apps register");
1320 lttng_fd_put(LTTNG_FD_APPS
, 1);
1325 ust_cmd
->sock
= sock
;
1328 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1329 " gid:%d sock:%d name:%s (version %d.%d)",
1330 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1331 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1332 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1333 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1336 * Lock free enqueue the registration request. The red pill
1337 * has been taken! This apps will be part of the *system*.
1339 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1342 * Wake the registration queue futex. Implicit memory
1343 * barrier with the exchange in cds_wfq_enqueue.
1345 futex_nto1_wake(&ust_cmd_queue
.futex
);
1352 /* Notify that the registration thread is gone */
1355 if (apps_sock
>= 0) {
1356 ret
= close(apps_sock
);
1366 lttng_fd_put(LTTNG_FD_APPS
, 1);
1368 unlink(apps_unix_sock_path
);
1371 lttng_poll_clean(&events
);
1374 DBG("UST Registration thread cleanup complete");
1380 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1381 * exec or it will fails.
1383 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1386 struct timespec timeout
;
1388 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1389 timeout
.tv_nsec
= 0;
1391 /* Setup semaphore */
1392 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1394 PERROR("sem_init consumer semaphore");
1398 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1399 thread_manage_consumer
, consumer_data
);
1401 PERROR("pthread_create consumer");
1406 /* Get time for sem_timedwait absolute timeout */
1407 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1409 PERROR("clock_gettime spawn consumer");
1410 /* Infinite wait for the kconsumerd thread to be ready */
1411 ret
= sem_wait(&consumer_data
->sem
);
1413 /* Normal timeout if the gettime was successful */
1414 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1415 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1419 if (errno
== ETIMEDOUT
) {
1421 * Call has timed out so we kill the kconsumerd_thread and return
1424 ERR("The consumer thread was never ready. Killing it");
1425 ret
= pthread_cancel(consumer_data
->thread
);
1427 PERROR("pthread_cancel consumer thread");
1430 PERROR("semaphore wait failed consumer thread");
1435 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1436 if (consumer_data
->pid
== 0) {
1437 ERR("Kconsumerd did not start");
1438 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1441 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1450 * Join consumer thread
1452 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1457 if (consumer_data
->pid
!= 0) {
1458 ret
= kill(consumer_data
->pid
, SIGTERM
);
1460 ERR("Error killing consumer daemon");
1463 return pthread_join(consumer_data
->thread
, &status
);
1470 * Fork and exec a consumer daemon (consumerd).
1472 * Return pid if successful else -1.
1474 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1478 const char *consumer_to_use
;
1479 const char *verbosity
;
1482 DBG("Spawning consumerd");
1489 if (opt_verbose_consumer
) {
1490 verbosity
= "--verbose";
1492 verbosity
= "--quiet";
1494 switch (consumer_data
->type
) {
1495 case LTTNG_CONSUMER_KERNEL
:
1497 * Find out which consumerd to execute. We will first try the
1498 * 64-bit path, then the sessiond's installation directory, and
1499 * fallback on the 32-bit one,
1501 DBG3("Looking for a kernel consumer at these locations:");
1502 DBG3(" 1) %s", consumerd64_bin
);
1503 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1504 DBG3(" 3) %s", consumerd32_bin
);
1505 if (stat(consumerd64_bin
, &st
) == 0) {
1506 DBG3("Found location #1");
1507 consumer_to_use
= consumerd64_bin
;
1508 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1509 DBG3("Found location #2");
1510 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1511 } else if (stat(consumerd32_bin
, &st
) == 0) {
1512 DBG3("Found location #3");
1513 consumer_to_use
= consumerd32_bin
;
1515 DBG("Could not find any valid consumerd executable");
1518 DBG("Using kernel consumer at: %s", consumer_to_use
);
1519 execl(consumer_to_use
,
1520 "lttng-consumerd", verbosity
, "-k",
1521 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1522 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1525 case LTTNG_CONSUMER64_UST
:
1527 char *tmpnew
= NULL
;
1529 if (consumerd64_libdir
[0] != '\0') {
1533 tmp
= getenv("LD_LIBRARY_PATH");
1537 tmplen
= strlen("LD_LIBRARY_PATH=")
1538 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1539 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1544 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1545 strcat(tmpnew
, consumerd64_libdir
);
1546 if (tmp
[0] != '\0') {
1547 strcat(tmpnew
, ":");
1548 strcat(tmpnew
, tmp
);
1550 ret
= putenv(tmpnew
);
1556 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1557 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1558 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1559 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1561 if (consumerd64_libdir
[0] != '\0') {
1569 case LTTNG_CONSUMER32_UST
:
1571 char *tmpnew
= NULL
;
1573 if (consumerd32_libdir
[0] != '\0') {
1577 tmp
= getenv("LD_LIBRARY_PATH");
1581 tmplen
= strlen("LD_LIBRARY_PATH=")
1582 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1583 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1588 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1589 strcat(tmpnew
, consumerd32_libdir
);
1590 if (tmp
[0] != '\0') {
1591 strcat(tmpnew
, ":");
1592 strcat(tmpnew
, tmp
);
1594 ret
= putenv(tmpnew
);
1600 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1601 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1602 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1603 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1605 if (consumerd32_libdir
[0] != '\0') {
1614 PERROR("unknown consumer type");
1618 PERROR("kernel start consumer exec");
1621 } else if (pid
> 0) {
1624 PERROR("start consumer fork");
1632 * Spawn the consumerd daemon and session daemon thread.
1634 static int start_consumerd(struct consumer_data
*consumer_data
)
1638 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1639 if (consumer_data
->pid
!= 0) {
1640 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1644 ret
= spawn_consumerd(consumer_data
);
1646 ERR("Spawning consumerd failed");
1647 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1651 /* Setting up the consumer_data pid */
1652 consumer_data
->pid
= ret
;
1653 DBG2("Consumer pid %d", consumer_data
->pid
);
1654 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1656 DBG2("Spawning consumer control thread");
1657 ret
= spawn_consumer_thread(consumer_data
);
1659 ERR("Fatal error spawning consumer control thread");
1671 * Check version of the lttng-modules.
1673 static int validate_lttng_modules_version(void)
1675 return kernel_validate_version(kernel_tracer_fd
);
1679 * Setup necessary data for kernel tracer action.
1681 static int init_kernel_tracer(void)
1685 /* Modprobe lttng kernel modules */
1686 ret
= modprobe_lttng_control();
1691 /* Open debugfs lttng */
1692 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1693 if (kernel_tracer_fd
< 0) {
1694 DBG("Failed to open %s", module_proc_lttng
);
1699 /* Validate kernel version */
1700 ret
= validate_lttng_modules_version();
1705 ret
= modprobe_lttng_data();
1710 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1714 modprobe_remove_lttng_control();
1715 ret
= close(kernel_tracer_fd
);
1719 kernel_tracer_fd
= -1;
1720 return LTTCOMM_KERN_VERSION
;
1723 ret
= close(kernel_tracer_fd
);
1729 modprobe_remove_lttng_control();
1732 WARN("No kernel tracer available");
1733 kernel_tracer_fd
= -1;
1735 return LTTCOMM_NEED_ROOT_SESSIOND
;
1737 return LTTCOMM_KERN_NA
;
1742 * Init tracing by creating trace directory and sending fds kernel consumer.
1744 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1748 if (session
->consumer_fds_sent
== 0) {
1750 * Assign default kernel consumer socket if no consumer assigned to the
1751 * kernel session. At this point, it's NOT supposed to be -1 but this is
1752 * an extra security check.
1754 if (session
->consumer_fd
< 0) {
1755 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1758 ret
= kernel_consumer_send_session(&kconsumer_data
, session
);
1760 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1764 session
->consumer_fds_sent
= 1;
1772 * Create an UST session and add it to the session ust list.
1774 static int create_ust_session(struct ltt_session
*session
,
1775 struct lttng_domain
*domain
)
1777 struct ltt_ust_session
*lus
= NULL
;
1780 switch (domain
->type
) {
1781 case LTTNG_DOMAIN_UST
:
1784 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1788 DBG("Creating UST session");
1790 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1792 ret
= LTTCOMM_UST_SESS_FAIL
;
1796 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1797 session
->uid
, session
->gid
);
1799 if (ret
!= -EEXIST
) {
1800 ERR("Trace directory creation error");
1801 ret
= LTTCOMM_UST_SESS_FAIL
;
1806 /* The domain type dictate different actions on session creation */
1807 switch (domain
->type
) {
1808 case LTTNG_DOMAIN_UST
:
1809 /* No ustctl for the global UST domain */
1812 ERR("Unknown UST domain on create session %d", domain
->type
);
1815 lus
->uid
= session
->uid
;
1816 lus
->gid
= session
->gid
;
1817 session
->ust_session
= lus
;
1827 * Create a kernel tracer session then create the default channel.
1829 static int create_kernel_session(struct ltt_session
*session
)
1833 DBG("Creating kernel session");
1835 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1837 ret
= LTTCOMM_KERN_SESS_FAIL
;
1841 /* Set kernel consumer socket fd */
1842 if (kconsumer_data
.cmd_sock
>= 0) {
1843 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1846 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1847 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1849 if (ret
!= -EEXIST
) {
1850 ERR("Trace directory creation error");
1854 session
->kernel_session
->uid
= session
->uid
;
1855 session
->kernel_session
->gid
= session
->gid
;
1862 * Check if the UID or GID match the session. Root user has access to all
1865 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1867 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1874 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1877 struct ltt_session
*session
;
1879 DBG("Counting number of available session for UID %d GID %d",
1881 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1883 * Only list the sessions the user can control.
1885 if (!session_access_ok(session
, uid
, gid
)) {
1894 * Using the session list, filled a lttng_session array to send back to the
1895 * client for session listing.
1897 * The session list lock MUST be acquired before calling this function. Use
1898 * session_lock_list() and session_unlock_list().
1900 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1904 struct ltt_session
*session
;
1906 DBG("Getting all available session for UID %d GID %d",
1909 * Iterate over session list and append data after the control struct in
1912 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1914 * Only list the sessions the user can control.
1916 if (!session_access_ok(session
, uid
, gid
)) {
1919 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1920 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1921 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1922 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1923 sessions
[i
].enabled
= session
->enabled
;
1929 * Fill lttng_channel array of all channels.
1931 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1932 struct lttng_channel
*channels
)
1935 struct ltt_kernel_channel
*kchan
;
1937 DBG("Listing channels for session %s", session
->name
);
1940 case LTTNG_DOMAIN_KERNEL
:
1941 /* Kernel channels */
1942 if (session
->kernel_session
!= NULL
) {
1943 cds_list_for_each_entry(kchan
,
1944 &session
->kernel_session
->channel_list
.head
, list
) {
1945 /* Copy lttng_channel struct to array */
1946 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1947 channels
[i
].enabled
= kchan
->enabled
;
1952 case LTTNG_DOMAIN_UST
:
1954 struct lttng_ht_iter iter
;
1955 struct ltt_ust_channel
*uchan
;
1957 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1958 &iter
.iter
, uchan
, node
.node
) {
1959 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1960 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1961 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1962 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1963 channels
[i
].attr
.switch_timer_interval
=
1964 uchan
->attr
.switch_timer_interval
;
1965 channels
[i
].attr
.read_timer_interval
=
1966 uchan
->attr
.read_timer_interval
;
1967 channels
[i
].enabled
= uchan
->enabled
;
1968 switch (uchan
->attr
.output
) {
1969 case LTTNG_UST_MMAP
:
1971 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
1984 * Create a list of ust global domain events.
1986 static int list_lttng_ust_global_events(char *channel_name
,
1987 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
1990 unsigned int nb_event
= 0;
1991 struct lttng_ht_iter iter
;
1992 struct lttng_ht_node_str
*node
;
1993 struct ltt_ust_channel
*uchan
;
1994 struct ltt_ust_event
*uevent
;
1995 struct lttng_event
*tmp
;
1997 DBG("Listing UST global events for channel %s", channel_name
);
2001 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2002 node
= lttng_ht_iter_get_node_str(&iter
);
2004 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2008 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2010 nb_event
+= lttng_ht_get_count(uchan
->events
);
2012 if (nb_event
== 0) {
2017 DBG3("Listing UST global %d events", nb_event
);
2019 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2021 ret
= -LTTCOMM_FATAL
;
2025 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2026 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2027 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2028 tmp
[i
].enabled
= uevent
->enabled
;
2029 switch (uevent
->attr
.instrumentation
) {
2030 case LTTNG_UST_TRACEPOINT
:
2031 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2033 case LTTNG_UST_PROBE
:
2034 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2036 case LTTNG_UST_FUNCTION
:
2037 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2040 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2041 switch (uevent
->attr
.loglevel_type
) {
2042 case LTTNG_UST_LOGLEVEL_ALL
:
2043 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2045 case LTTNG_UST_LOGLEVEL_RANGE
:
2046 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2048 case LTTNG_UST_LOGLEVEL_SINGLE
:
2049 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2064 * Fill lttng_event array of all kernel events in the channel.
2066 static int list_lttng_kernel_events(char *channel_name
,
2067 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2070 unsigned int nb_event
;
2071 struct ltt_kernel_event
*event
;
2072 struct ltt_kernel_channel
*kchan
;
2074 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2075 if (kchan
== NULL
) {
2076 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2080 nb_event
= kchan
->event_count
;
2082 DBG("Listing events for channel %s", kchan
->channel
->name
);
2084 if (nb_event
== 0) {
2089 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2090 if (*events
== NULL
) {
2091 ret
= LTTCOMM_FATAL
;
2095 /* Kernel channels */
2096 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2097 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2098 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2099 (*events
)[i
].enabled
= event
->enabled
;
2100 switch (event
->event
->instrumentation
) {
2101 case LTTNG_KERNEL_TRACEPOINT
:
2102 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2104 case LTTNG_KERNEL_KPROBE
:
2105 case LTTNG_KERNEL_KRETPROBE
:
2106 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2107 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2108 sizeof(struct lttng_kernel_kprobe
));
2110 case LTTNG_KERNEL_FUNCTION
:
2111 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2112 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2113 sizeof(struct lttng_kernel_function
));
2115 case LTTNG_KERNEL_NOOP
:
2116 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2118 case LTTNG_KERNEL_SYSCALL
:
2119 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2121 case LTTNG_KERNEL_ALL
:
2135 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2137 static int cmd_disable_channel(struct ltt_session
*session
,
2138 int domain
, char *channel_name
)
2141 struct ltt_ust_session
*usess
;
2143 usess
= session
->ust_session
;
2146 case LTTNG_DOMAIN_KERNEL
:
2148 ret
= channel_kernel_disable(session
->kernel_session
,
2150 if (ret
!= LTTCOMM_OK
) {
2154 kernel_wait_quiescent(kernel_tracer_fd
);
2157 case LTTNG_DOMAIN_UST
:
2159 struct ltt_ust_channel
*uchan
;
2160 struct lttng_ht
*chan_ht
;
2162 chan_ht
= usess
->domain_global
.channels
;
2164 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2165 if (uchan
== NULL
) {
2166 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2170 ret
= channel_ust_disable(usess
, domain
, uchan
);
2171 if (ret
!= LTTCOMM_OK
) {
2177 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2178 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2179 case LTTNG_DOMAIN_UST_PID
:
2182 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2193 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2195 static int cmd_enable_channel(struct ltt_session
*session
,
2196 int domain
, struct lttng_channel
*attr
)
2199 struct ltt_ust_session
*usess
= session
->ust_session
;
2200 struct lttng_ht
*chan_ht
;
2202 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2205 case LTTNG_DOMAIN_KERNEL
:
2207 struct ltt_kernel_channel
*kchan
;
2209 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2210 session
->kernel_session
);
2211 if (kchan
== NULL
) {
2212 ret
= channel_kernel_create(session
->kernel_session
,
2213 attr
, kernel_poll_pipe
[1]);
2215 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2218 if (ret
!= LTTCOMM_OK
) {
2222 kernel_wait_quiescent(kernel_tracer_fd
);
2225 case LTTNG_DOMAIN_UST
:
2227 struct ltt_ust_channel
*uchan
;
2229 chan_ht
= usess
->domain_global
.channels
;
2231 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2232 if (uchan
== NULL
) {
2233 ret
= channel_ust_create(usess
, domain
, attr
);
2235 ret
= channel_ust_enable(usess
, domain
, uchan
);
2240 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2241 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2242 case LTTNG_DOMAIN_UST_PID
:
2245 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2254 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2256 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2257 char *channel_name
, char *event_name
)
2262 case LTTNG_DOMAIN_KERNEL
:
2264 struct ltt_kernel_channel
*kchan
;
2265 struct ltt_kernel_session
*ksess
;
2267 ksess
= session
->kernel_session
;
2269 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2270 if (kchan
== NULL
) {
2271 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2275 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2276 if (ret
!= LTTCOMM_OK
) {
2280 kernel_wait_quiescent(kernel_tracer_fd
);
2283 case LTTNG_DOMAIN_UST
:
2285 struct ltt_ust_channel
*uchan
;
2286 struct ltt_ust_session
*usess
;
2288 usess
= session
->ust_session
;
2290 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2292 if (uchan
== NULL
) {
2293 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2297 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2298 if (ret
!= LTTCOMM_OK
) {
2302 DBG3("Disable UST event %s in channel %s completed", event_name
,
2307 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2308 case LTTNG_DOMAIN_UST_PID
:
2309 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2323 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2325 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2331 case LTTNG_DOMAIN_KERNEL
:
2333 struct ltt_kernel_session
*ksess
;
2334 struct ltt_kernel_channel
*kchan
;
2336 ksess
= session
->kernel_session
;
2338 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2339 if (kchan
== NULL
) {
2340 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2344 ret
= event_kernel_disable_all(ksess
, kchan
);
2345 if (ret
!= LTTCOMM_OK
) {
2349 kernel_wait_quiescent(kernel_tracer_fd
);
2352 case LTTNG_DOMAIN_UST
:
2354 struct ltt_ust_session
*usess
;
2355 struct ltt_ust_channel
*uchan
;
2357 usess
= session
->ust_session
;
2359 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2361 if (uchan
== NULL
) {
2362 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2366 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2371 DBG3("Disable all UST events in channel %s completed", channel_name
);
2376 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2377 case LTTNG_DOMAIN_UST_PID
:
2378 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2392 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2394 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2395 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2400 case LTTNG_DOMAIN_KERNEL
:
2401 /* Add kernel context to kernel tracer */
2402 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2403 event_name
, channel_name
);
2404 if (ret
!= LTTCOMM_OK
) {
2408 case LTTNG_DOMAIN_UST
:
2410 struct ltt_ust_session
*usess
= session
->ust_session
;
2412 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2413 if (ret
!= LTTCOMM_OK
) {
2419 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2420 case LTTNG_DOMAIN_UST_PID
:
2421 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2435 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2437 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2438 char *channel_name
, struct lttng_event
*event
)
2441 struct lttng_channel
*attr
;
2442 struct ltt_ust_session
*usess
= session
->ust_session
;
2445 case LTTNG_DOMAIN_KERNEL
:
2447 struct ltt_kernel_channel
*kchan
;
2449 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2450 session
->kernel_session
);
2451 if (kchan
== NULL
) {
2452 attr
= channel_new_default_attr(domain
);
2454 ret
= LTTCOMM_FATAL
;
2457 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2459 /* This call will notify the kernel thread */
2460 ret
= channel_kernel_create(session
->kernel_session
,
2461 attr
, kernel_poll_pipe
[1]);
2462 if (ret
!= LTTCOMM_OK
) {
2469 /* Get the newly created kernel channel pointer */
2470 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2471 session
->kernel_session
);
2472 if (kchan
== NULL
) {
2473 /* This sould not happen... */
2474 ret
= LTTCOMM_FATAL
;
2478 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2480 if (ret
!= LTTCOMM_OK
) {
2484 kernel_wait_quiescent(kernel_tracer_fd
);
2487 case LTTNG_DOMAIN_UST
:
2489 struct lttng_channel
*attr
;
2490 struct ltt_ust_channel
*uchan
;
2492 /* Get channel from global UST domain */
2493 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2495 if (uchan
== NULL
) {
2496 /* Create default channel */
2497 attr
= channel_new_default_attr(domain
);
2499 ret
= LTTCOMM_FATAL
;
2502 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2503 attr
->name
[NAME_MAX
- 1] = '\0';
2505 ret
= channel_ust_create(usess
, domain
, attr
);
2506 if (ret
!= LTTCOMM_OK
) {
2512 /* Get the newly created channel reference back */
2513 uchan
= trace_ust_find_channel_by_name(
2514 usess
->domain_global
.channels
, channel_name
);
2515 if (uchan
== NULL
) {
2516 /* Something is really wrong */
2517 ret
= LTTCOMM_FATAL
;
2522 /* At this point, the session and channel exist on the tracer */
2523 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2524 if (ret
!= LTTCOMM_OK
) {
2530 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2531 case LTTNG_DOMAIN_UST_PID
:
2532 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2546 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2548 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2549 char *channel_name
, int event_type
)
2552 struct ltt_kernel_channel
*kchan
;
2555 case LTTNG_DOMAIN_KERNEL
:
2556 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2557 session
->kernel_session
);
2558 if (kchan
== NULL
) {
2559 /* This call will notify the kernel thread */
2560 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2561 kernel_poll_pipe
[1]);
2562 if (ret
!= LTTCOMM_OK
) {
2566 /* Get the newly created kernel channel pointer */
2567 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2568 session
->kernel_session
);
2569 if (kchan
== NULL
) {
2570 /* This sould not happen... */
2571 ret
= LTTCOMM_FATAL
;
2577 switch (event_type
) {
2578 case LTTNG_EVENT_SYSCALL
:
2579 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2580 kchan
, kernel_tracer_fd
);
2582 case LTTNG_EVENT_TRACEPOINT
:
2584 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2585 * events already registered to the channel.
2587 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2588 kchan
, kernel_tracer_fd
);
2590 case LTTNG_EVENT_ALL
:
2591 /* Enable syscalls and tracepoints */
2592 ret
= event_kernel_enable_all(session
->kernel_session
,
2593 kchan
, kernel_tracer_fd
);
2596 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2600 /* Manage return value */
2601 if (ret
!= LTTCOMM_OK
) {
2605 kernel_wait_quiescent(kernel_tracer_fd
);
2607 case LTTNG_DOMAIN_UST
:
2609 struct lttng_channel
*attr
;
2610 struct ltt_ust_channel
*uchan
;
2611 struct ltt_ust_session
*usess
= session
->ust_session
;
2613 /* Get channel from global UST domain */
2614 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2616 if (uchan
== NULL
) {
2617 /* Create default channel */
2618 attr
= channel_new_default_attr(domain
);
2620 ret
= LTTCOMM_FATAL
;
2623 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2624 attr
->name
[NAME_MAX
- 1] = '\0';
2626 /* Use the internal command enable channel */
2627 ret
= channel_ust_create(usess
, domain
, attr
);
2628 if (ret
!= LTTCOMM_OK
) {
2634 /* Get the newly created channel reference back */
2635 uchan
= trace_ust_find_channel_by_name(
2636 usess
->domain_global
.channels
, channel_name
);
2637 if (uchan
== NULL
) {
2638 /* Something is really wrong */
2639 ret
= LTTCOMM_FATAL
;
2644 /* At this point, the session and channel exist on the tracer */
2646 switch (event_type
) {
2647 case LTTNG_EVENT_ALL
:
2648 case LTTNG_EVENT_TRACEPOINT
:
2649 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2650 if (ret
!= LTTCOMM_OK
) {
2655 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2659 /* Manage return value */
2660 if (ret
!= LTTCOMM_OK
) {
2667 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2668 case LTTNG_DOMAIN_UST_PID
:
2669 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2683 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2685 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2688 ssize_t nb_events
= 0;
2691 case LTTNG_DOMAIN_KERNEL
:
2692 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2693 if (nb_events
< 0) {
2694 ret
= LTTCOMM_KERN_LIST_FAIL
;
2698 case LTTNG_DOMAIN_UST
:
2699 nb_events
= ust_app_list_events(events
);
2700 if (nb_events
< 0) {
2701 ret
= LTTCOMM_UST_LIST_FAIL
;
2713 /* Return negative value to differentiate return code */
2718 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2720 static ssize_t
cmd_list_tracepoint_fields(int domain
,
2721 struct lttng_event_field
**fields
)
2724 ssize_t nb_fields
= 0;
2727 case LTTNG_DOMAIN_UST
:
2728 nb_fields
= ust_app_list_event_fields(fields
);
2729 if (nb_fields
< 0) {
2730 ret
= LTTCOMM_UST_LIST_FAIL
;
2734 case LTTNG_DOMAIN_KERNEL
:
2735 default: /* fall-through */
2743 /* Return negative value to differentiate return code */
2748 * Command LTTNG_START_TRACE processed by the client thread.
2750 static int cmd_start_trace(struct ltt_session
*session
)
2753 struct ltt_kernel_session
*ksession
;
2754 struct ltt_ust_session
*usess
;
2757 ksession
= session
->kernel_session
;
2758 usess
= session
->ust_session
;
2760 if (session
->enabled
) {
2761 /* Already started. */
2762 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
2766 session
->enabled
= 1;
2768 /* Kernel tracing */
2769 if (ksession
!= NULL
) {
2770 struct ltt_kernel_channel
*kchan
;
2772 /* Open kernel metadata */
2773 if (ksession
->metadata
== NULL
) {
2774 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2776 ret
= LTTCOMM_KERN_META_FAIL
;
2781 /* Open kernel metadata stream */
2782 if (ksession
->metadata_stream_fd
< 0) {
2783 ret
= kernel_open_metadata_stream(ksession
);
2785 ERR("Kernel create metadata stream failed");
2786 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2791 /* For each channel */
2792 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2793 if (kchan
->stream_count
== 0) {
2794 ret
= kernel_open_channel_stream(kchan
);
2796 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2799 /* Update the stream global counter */
2800 ksession
->stream_count_global
+= ret
;
2804 /* Setup kernel consumer socket and send fds to it */
2805 ret
= init_kernel_tracing(ksession
);
2807 ret
= LTTCOMM_KERN_START_FAIL
;
2811 /* This start the kernel tracing */
2812 ret
= kernel_start_session(ksession
);
2814 ret
= LTTCOMM_KERN_START_FAIL
;
2818 /* Quiescent wait after starting trace */
2819 kernel_wait_quiescent(kernel_tracer_fd
);
2822 /* Flag session that trace should start automatically */
2824 usess
->start_trace
= 1;
2826 ret
= ust_app_start_trace_all(usess
);
2828 ret
= LTTCOMM_UST_START_FAIL
;
2840 * Command LTTNG_STOP_TRACE processed by the client thread.
2842 static int cmd_stop_trace(struct ltt_session
*session
)
2845 struct ltt_kernel_channel
*kchan
;
2846 struct ltt_kernel_session
*ksession
;
2847 struct ltt_ust_session
*usess
;
2850 ksession
= session
->kernel_session
;
2851 usess
= session
->ust_session
;
2853 if (!session
->enabled
) {
2854 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
2858 session
->enabled
= 0;
2861 if (ksession
!= NULL
) {
2862 DBG("Stop kernel tracing");
2864 /* Flush all buffers before stopping */
2865 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2867 ERR("Kernel metadata flush failed");
2870 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2871 ret
= kernel_flush_buffer(kchan
);
2873 ERR("Kernel flush buffer error");
2877 ret
= kernel_stop_session(ksession
);
2879 ret
= LTTCOMM_KERN_STOP_FAIL
;
2883 kernel_wait_quiescent(kernel_tracer_fd
);
2887 usess
->start_trace
= 0;
2889 ret
= ust_app_stop_trace_all(usess
);
2891 ret
= LTTCOMM_UST_STOP_FAIL
;
2903 * Command LTTNG_CREATE_SESSION processed by the client thread.
2905 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2909 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2910 LTTNG_SOCK_GET_GID_CRED(creds
));
2911 if (ret
!= LTTCOMM_OK
) {
2922 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2924 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2928 /* Clean kernel session teardown */
2929 teardown_kernel_session(session
);
2930 /* UST session teardown */
2931 teardown_ust_session(session
);
2934 * Must notify the kernel thread here to update it's poll setin order
2935 * to remove the channel(s)' fd just destroyed.
2937 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2939 PERROR("write kernel poll pipe");
2942 ret
= session_destroy(session
);
2948 * Command LTTNG_CALIBRATE processed by the client thread.
2950 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2955 case LTTNG_DOMAIN_KERNEL
:
2957 struct lttng_kernel_calibrate kcalibrate
;
2959 kcalibrate
.type
= calibrate
->type
;
2960 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2962 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2967 case LTTNG_DOMAIN_UST
:
2969 struct lttng_ust_calibrate ucalibrate
;
2971 ucalibrate
.type
= calibrate
->type
;
2972 ret
= ust_app_calibrate_glb(&ucalibrate
);
2974 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2991 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2993 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2999 case LTTNG_DOMAIN_KERNEL
:
3000 /* Can't register a consumer if there is already one */
3001 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3002 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3006 sock
= lttcomm_connect_unix_sock(sock_path
);
3008 ret
= LTTCOMM_CONNECT_FAIL
;
3012 session
->kernel_session
->consumer_fd
= sock
;
3015 /* TODO: Userspace tracing */
3027 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3029 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3030 struct lttng_domain
**domains
)
3035 if (session
->kernel_session
!= NULL
) {
3036 DBG3("Listing domains found kernel domain");
3040 if (session
->ust_session
!= NULL
) {
3041 DBG3("Listing domains found UST global domain");
3045 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3046 if (*domains
== NULL
) {
3047 ret
= -LTTCOMM_FATAL
;
3051 if (session
->kernel_session
!= NULL
) {
3052 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3056 if (session
->ust_session
!= NULL
) {
3057 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3068 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3070 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3071 struct lttng_channel
**channels
)
3074 ssize_t nb_chan
= 0;
3077 case LTTNG_DOMAIN_KERNEL
:
3078 if (session
->kernel_session
!= NULL
) {
3079 nb_chan
= session
->kernel_session
->channel_count
;
3081 DBG3("Number of kernel channels %zd", nb_chan
);
3083 case LTTNG_DOMAIN_UST
:
3084 if (session
->ust_session
!= NULL
) {
3085 nb_chan
= lttng_ht_get_count(
3086 session
->ust_session
->domain_global
.channels
);
3088 DBG3("Number of UST global channels %zd", nb_chan
);
3097 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3098 if (*channels
== NULL
) {
3099 ret
= -LTTCOMM_FATAL
;
3103 list_lttng_channels(domain
, session
, *channels
);
3115 * Command LTTNG_LIST_EVENTS processed by the client thread.
3117 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3118 char *channel_name
, struct lttng_event
**events
)
3121 ssize_t nb_event
= 0;
3124 case LTTNG_DOMAIN_KERNEL
:
3125 if (session
->kernel_session
!= NULL
) {
3126 nb_event
= list_lttng_kernel_events(channel_name
,
3127 session
->kernel_session
, events
);
3130 case LTTNG_DOMAIN_UST
:
3132 if (session
->ust_session
!= NULL
) {
3133 nb_event
= list_lttng_ust_global_events(channel_name
,
3134 &session
->ust_session
->domain_global
, events
);
3150 * Process the command requested by the lttng client within the command
3151 * context structure. This function make sure that the return structure (llm)
3152 * is set and ready for transmission before returning.
3154 * Return any error encountered or 0 for success.
3156 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3158 int ret
= LTTCOMM_OK
;
3159 int need_tracing_session
= 1;
3162 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3164 switch (cmd_ctx
->lsm
->cmd_type
) {
3165 case LTTNG_CREATE_SESSION
:
3166 case LTTNG_DESTROY_SESSION
:
3167 case LTTNG_LIST_SESSIONS
:
3168 case LTTNG_LIST_DOMAINS
:
3169 case LTTNG_START_TRACE
:
3170 case LTTNG_STOP_TRACE
:
3177 if (opt_no_kernel
&& need_domain
3178 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3180 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3182 ret
= LTTCOMM_KERN_NA
;
3188 * Check for command that don't needs to allocate a returned payload. We do
3189 * this here so we don't have to make the call for no payload at each
3192 switch(cmd_ctx
->lsm
->cmd_type
) {
3193 case LTTNG_LIST_SESSIONS
:
3194 case LTTNG_LIST_TRACEPOINTS
:
3195 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3196 case LTTNG_LIST_DOMAINS
:
3197 case LTTNG_LIST_CHANNELS
:
3198 case LTTNG_LIST_EVENTS
:
3201 /* Setup lttng message with no payload */
3202 ret
= setup_lttng_msg(cmd_ctx
, 0);
3204 /* This label does not try to unlock the session */
3205 goto init_setup_error
;
3209 /* Commands that DO NOT need a session. */
3210 switch (cmd_ctx
->lsm
->cmd_type
) {
3211 case LTTNG_CREATE_SESSION
:
3212 case LTTNG_CALIBRATE
:
3213 case LTTNG_LIST_SESSIONS
:
3214 case LTTNG_LIST_TRACEPOINTS
:
3215 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3216 need_tracing_session
= 0;
3219 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3221 * We keep the session list lock across _all_ commands
3222 * for now, because the per-session lock does not
3223 * handle teardown properly.
3225 session_lock_list();
3226 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3227 if (cmd_ctx
->session
== NULL
) {
3228 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3229 ret
= LTTCOMM_SESS_NOT_FOUND
;
3231 /* If no session name specified */
3232 ret
= LTTCOMM_SELECT_SESS
;
3236 /* Acquire lock for the session */
3237 session_lock(cmd_ctx
->session
);
3246 * Check domain type for specific "pre-action".
3248 switch (cmd_ctx
->lsm
->domain
.type
) {
3249 case LTTNG_DOMAIN_KERNEL
:
3251 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3255 /* Kernel tracer check */
3256 if (kernel_tracer_fd
== -1) {
3257 /* Basically, load kernel tracer modules */
3258 ret
= init_kernel_tracer();
3264 /* Consumer is in an ERROR state. Report back to client */
3265 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
3266 ret
= LTTCOMM_NO_KERNCONSUMERD
;
3270 /* Need a session for kernel command */
3271 if (need_tracing_session
) {
3272 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3273 ret
= create_kernel_session(cmd_ctx
->session
);
3275 ret
= LTTCOMM_KERN_SESS_FAIL
;
3280 /* Start the kernel consumer daemon */
3281 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3282 if (kconsumer_data
.pid
== 0 &&
3283 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3284 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3285 ret
= start_consumerd(&kconsumer_data
);
3287 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3290 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
3292 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3297 case LTTNG_DOMAIN_UST
:
3299 /* Consumer is in an ERROR state. Report back to client */
3300 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
3301 ret
= LTTCOMM_NO_USTCONSUMERD
;
3305 if (need_tracing_session
) {
3306 if (cmd_ctx
->session
->ust_session
== NULL
) {
3307 ret
= create_ust_session(cmd_ctx
->session
,
3308 &cmd_ctx
->lsm
->domain
);
3309 if (ret
!= LTTCOMM_OK
) {
3313 /* Start the UST consumer daemons */
3315 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3316 if (consumerd64_bin
[0] != '\0' &&
3317 ustconsumer64_data
.pid
== 0 &&
3318 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3319 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3320 ret
= start_consumerd(&ustconsumer64_data
);
3322 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3323 ust_consumerd64_fd
= -EINVAL
;
3327 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3328 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3330 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3333 if (consumerd32_bin
[0] != '\0' &&
3334 ustconsumer32_data
.pid
== 0 &&
3335 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3336 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3337 ret
= start_consumerd(&ustconsumer32_data
);
3339 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3340 ust_consumerd32_fd
= -EINVAL
;
3344 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3345 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
3347 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3357 /* Validate consumer daemon state when start/stop trace command */
3358 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
3359 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
3360 switch (cmd_ctx
->lsm
->domain
.type
) {
3361 case LTTNG_DOMAIN_UST
:
3362 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
3363 ret
= LTTCOMM_NO_USTCONSUMERD
;
3367 case LTTNG_DOMAIN_KERNEL
:
3368 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
3369 ret
= LTTCOMM_NO_KERNCONSUMERD
;
3377 * Check that the UID or GID match that of the tracing session.
3378 * The root user can interact with all sessions.
3380 if (need_tracing_session
) {
3381 if (!session_access_ok(cmd_ctx
->session
,
3382 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3383 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3384 ret
= LTTCOMM_EPERM
;
3389 /* Process by command type */
3390 switch (cmd_ctx
->lsm
->cmd_type
) {
3391 case LTTNG_ADD_CONTEXT
:
3393 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3394 cmd_ctx
->lsm
->u
.context
.channel_name
,
3395 cmd_ctx
->lsm
->u
.context
.event_name
,
3396 &cmd_ctx
->lsm
->u
.context
.ctx
);
3399 case LTTNG_DISABLE_CHANNEL
:
3401 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3402 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3405 case LTTNG_DISABLE_EVENT
:
3407 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3408 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3409 cmd_ctx
->lsm
->u
.disable
.name
);
3412 case LTTNG_DISABLE_ALL_EVENT
:
3414 DBG("Disabling all events");
3416 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3417 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3420 case LTTNG_ENABLE_CHANNEL
:
3422 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3423 &cmd_ctx
->lsm
->u
.channel
.chan
);
3426 case LTTNG_ENABLE_EVENT
:
3428 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3429 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3430 &cmd_ctx
->lsm
->u
.enable
.event
);
3433 case LTTNG_ENABLE_ALL_EVENT
:
3435 DBG("Enabling all events");
3437 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3438 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3439 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3442 case LTTNG_LIST_TRACEPOINTS
:
3444 struct lttng_event
*events
;
3447 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3448 if (nb_events
< 0) {
3454 * Setup lttng message with payload size set to the event list size in
3455 * bytes and then copy list into the llm payload.
3457 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3463 /* Copy event list into message payload */
3464 memcpy(cmd_ctx
->llm
->payload
, events
,
3465 sizeof(struct lttng_event
) * nb_events
);
3472 case LTTNG_LIST_TRACEPOINT_FIELDS
:
3474 struct lttng_event_field
*fields
;
3477 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
, &fields
);
3478 if (nb_fields
< 0) {
3484 * Setup lttng message with payload size set to the event list size in
3485 * bytes and then copy list into the llm payload.
3487 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event_field
) * nb_fields
);
3493 /* Copy event list into message payload */
3494 memcpy(cmd_ctx
->llm
->payload
, fields
,
3495 sizeof(struct lttng_event_field
) * nb_fields
);
3503 case LTTNG_START_TRACE
:
3505 ret
= cmd_start_trace(cmd_ctx
->session
);
3508 case LTTNG_STOP_TRACE
:
3510 ret
= cmd_stop_trace(cmd_ctx
->session
);
3513 case LTTNG_CREATE_SESSION
:
3515 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3516 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3519 case LTTNG_DESTROY_SESSION
:
3521 ret
= cmd_destroy_session(cmd_ctx
->session
,
3522 cmd_ctx
->lsm
->session
.name
);
3524 * Set session to NULL so we do not unlock it after
3527 cmd_ctx
->session
= NULL
;
3530 case LTTNG_LIST_DOMAINS
:
3533 struct lttng_domain
*domains
;
3535 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3541 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3546 /* Copy event list into message payload */
3547 memcpy(cmd_ctx
->llm
->payload
, domains
,
3548 nb_dom
* sizeof(struct lttng_domain
));
3555 case LTTNG_LIST_CHANNELS
:
3558 struct lttng_channel
*channels
;
3560 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3561 cmd_ctx
->session
, &channels
);
3567 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3572 /* Copy event list into message payload */
3573 memcpy(cmd_ctx
->llm
->payload
, channels
,
3574 nb_chan
* sizeof(struct lttng_channel
));
3581 case LTTNG_LIST_EVENTS
:
3584 struct lttng_event
*events
= NULL
;
3586 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3587 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3593 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3598 /* Copy event list into message payload */
3599 memcpy(cmd_ctx
->llm
->payload
, events
,
3600 nb_event
* sizeof(struct lttng_event
));
3607 case LTTNG_LIST_SESSIONS
:
3609 unsigned int nr_sessions
;
3611 session_lock_list();
3612 nr_sessions
= lttng_sessions_count(
3613 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3614 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3616 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3618 session_unlock_list();
3622 /* Filled the session array */
3623 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3624 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3625 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3627 session_unlock_list();
3632 case LTTNG_CALIBRATE
:
3634 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3635 &cmd_ctx
->lsm
->u
.calibrate
);
3638 case LTTNG_REGISTER_CONSUMER
:
3640 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3641 cmd_ctx
->lsm
->u
.reg
.path
);
3650 if (cmd_ctx
->llm
== NULL
) {
3651 DBG("Missing llm structure. Allocating one.");
3652 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3656 /* Set return code */
3657 cmd_ctx
->llm
->ret_code
= ret
;
3659 if (cmd_ctx
->session
) {
3660 session_unlock(cmd_ctx
->session
);
3662 if (need_tracing_session
) {
3663 session_unlock_list();
3670 * This thread manage all clients request using the unix client socket for
3673 static void *thread_manage_clients(void *data
)
3675 int sock
= -1, ret
, i
, pollfd
;
3676 uint32_t revents
, nb_fd
;
3677 struct command_ctx
*cmd_ctx
= NULL
;
3678 struct lttng_poll_event events
;
3680 DBG("[thread] Manage client started");
3682 rcu_register_thread();
3684 ret
= lttcomm_listen_unix_sock(client_sock
);
3690 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3691 * more will be added to this poll set.
3693 ret
= create_thread_poll_set(&events
, 2);
3698 /* Add the application registration socket */
3699 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3705 * Notify parent pid that we are ready to accept command for client side.
3707 if (opt_sig_parent
) {
3708 kill(ppid
, SIGUSR1
);
3712 DBG("Accepting client command ...");
3714 nb_fd
= LTTNG_POLL_GETNB(&events
);
3716 /* Inifinite blocking call, waiting for transmission */
3718 ret
= lttng_poll_wait(&events
, -1);
3721 * Restart interrupted system call.
3723 if (errno
== EINTR
) {
3729 for (i
= 0; i
< nb_fd
; i
++) {
3730 /* Fetch once the poll data */
3731 revents
= LTTNG_POLL_GETEV(&events
, i
);
3732 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3734 /* Thread quit pipe has been closed. Killing thread. */
3735 ret
= check_thread_quit_pipe(pollfd
, revents
);
3740 /* Event on the registration socket */
3741 if (pollfd
== client_sock
) {
3742 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3743 ERR("Client socket poll error");
3749 DBG("Wait for client response");
3751 sock
= lttcomm_accept_unix_sock(client_sock
);
3756 /* Set socket option for credentials retrieval */
3757 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3762 /* Allocate context command to process the client request */
3763 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3764 if (cmd_ctx
== NULL
) {
3765 PERROR("zmalloc cmd_ctx");
3769 /* Allocate data buffer for reception */
3770 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3771 if (cmd_ctx
->lsm
== NULL
) {
3772 PERROR("zmalloc cmd_ctx->lsm");
3776 cmd_ctx
->llm
= NULL
;
3777 cmd_ctx
->session
= NULL
;
3780 * Data is received from the lttng client. The struct
3781 * lttcomm_session_msg (lsm) contains the command and data request of
3784 DBG("Receiving data from client ...");
3785 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3786 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3788 DBG("Nothing recv() from client... continuing");
3794 clean_command_ctx(&cmd_ctx
);
3798 // TODO: Validate cmd_ctx including sanity check for
3799 // security purpose.
3801 rcu_thread_online();
3803 * This function dispatch the work to the kernel or userspace tracer
3804 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3805 * informations for the client. The command context struct contains
3806 * everything this function may needs.
3808 ret
= process_client_msg(cmd_ctx
);
3809 rcu_thread_offline();
3812 * TODO: Inform client somehow of the fatal error. At
3813 * this point, ret < 0 means that a zmalloc failed
3814 * (ENOMEM). Error detected but still accept command.
3816 clean_command_ctx(&cmd_ctx
);
3820 DBG("Sending response (size: %d, retcode: %s)",
3821 cmd_ctx
->lttng_msg_size
,
3822 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3823 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3825 ERR("Failed to send data back to client");
3828 /* End of transmission */
3835 clean_command_ctx(&cmd_ctx
);
3839 DBG("Client thread dying");
3840 unlink(client_unix_sock_path
);
3841 if (client_sock
>= 0) {
3842 ret
= close(client_sock
);
3854 lttng_poll_clean(&events
);
3855 clean_command_ctx(&cmd_ctx
);
3857 rcu_unregister_thread();
3863 * usage function on stderr
3865 static void usage(void)
3867 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3868 fprintf(stderr
, " -h, --help Display this usage.\n");
3869 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3870 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3871 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3872 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3873 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3874 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3875 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3876 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3877 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3878 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3879 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3880 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3881 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3882 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3883 fprintf(stderr
, " -V, --version Show version number.\n");
3884 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3885 fprintf(stderr
, " -q, --quiet No output at all.\n");
3886 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3887 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3888 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3892 * daemon argument parsing
3894 static int parse_args(int argc
, char **argv
)
3898 static struct option long_options
[] = {
3899 { "client-sock", 1, 0, 'c' },
3900 { "apps-sock", 1, 0, 'a' },
3901 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3902 { "kconsumerd-err-sock", 1, 0, 'E' },
3903 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3904 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3905 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3906 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3907 { "consumerd32-path", 1, 0, 'u' },
3908 { "consumerd32-libdir", 1, 0, 'U' },
3909 { "consumerd64-path", 1, 0, 't' },
3910 { "consumerd64-libdir", 1, 0, 'T' },
3911 { "daemonize", 0, 0, 'd' },
3912 { "sig-parent", 0, 0, 'S' },
3913 { "help", 0, 0, 'h' },
3914 { "group", 1, 0, 'g' },
3915 { "version", 0, 0, 'V' },
3916 { "quiet", 0, 0, 'q' },
3917 { "verbose", 0, 0, 'v' },
3918 { "verbose-consumer", 0, 0, 'Z' },
3919 { "no-kernel", 0, 0, 'N' },
3924 int option_index
= 0;
3925 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3926 long_options
, &option_index
);
3933 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3935 fprintf(stderr
, " with arg %s\n", optarg
);
3939 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3942 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3948 opt_tracing_group
= optarg
;
3954 fprintf(stdout
, "%s\n", VERSION
);
3960 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3963 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3966 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3969 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3972 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3975 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3981 lttng_opt_quiet
= 1;
3984 /* Verbose level can increase using multiple -v */
3985 lttng_opt_verbose
+= 1;
3988 opt_verbose_consumer
+= 1;
3991 consumerd32_bin
= optarg
;
3994 consumerd32_libdir
= optarg
;
3997 consumerd64_bin
= optarg
;
4000 consumerd64_libdir
= optarg
;
4003 /* Unknown option or other error.
4004 * Error is printed by getopt, just return */
4013 * Creates the two needed socket by the daemon.
4014 * apps_sock - The communication socket for all UST apps.
4015 * client_sock - The communication of the cli tool (lttng).
4017 static int init_daemon_socket(void)
4022 old_umask
= umask(0);
4024 /* Create client tool unix socket */
4025 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4026 if (client_sock
< 0) {
4027 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4032 /* File permission MUST be 660 */
4033 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4035 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4040 /* Create the application unix socket */
4041 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4042 if (apps_sock
< 0) {
4043 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4048 /* File permission MUST be 666 */
4049 ret
= chmod(apps_unix_sock_path
,
4050 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4052 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4063 * Check if the global socket is available, and if a daemon is answering at the
4064 * other side. If yes, error is returned.
4066 static int check_existing_daemon(void)
4068 /* Is there anybody out there ? */
4069 if (lttng_session_daemon_alive()) {
4077 * Set the tracing group gid onto the client socket.
4079 * Race window between mkdir and chown is OK because we are going from more
4080 * permissive (root.root) to less permissive (root.tracing).
4082 static int set_permissions(char *rundir
)
4087 ret
= allowed_group();
4089 WARN("No tracing group detected");
4096 /* Set lttng run dir */
4097 ret
= chown(rundir
, 0, gid
);
4099 ERR("Unable to set group on %s", rundir
);
4103 /* Ensure tracing group can search the run dir */
4104 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4106 ERR("Unable to set permissions on %s", rundir
);
4110 /* lttng client socket path */
4111 ret
= chown(client_unix_sock_path
, 0, gid
);
4113 ERR("Unable to set group on %s", client_unix_sock_path
);
4117 /* kconsumer error socket path */
4118 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4120 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4124 /* 64-bit ustconsumer error socket path */
4125 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4127 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4131 /* 32-bit ustconsumer compat32 error socket path */
4132 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4134 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4138 DBG("All permissions are set");
4145 * Create the lttng run directory needed for all global sockets and pipe.
4147 static int create_lttng_rundir(const char *rundir
)
4151 DBG3("Creating LTTng run directory: %s", rundir
);
4153 ret
= mkdir(rundir
, S_IRWXU
);
4155 if (errno
!= EEXIST
) {
4156 ERR("Unable to create %s", rundir
);
4168 * Setup sockets and directory needed by the kconsumerd communication with the
4171 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4175 char path
[PATH_MAX
];
4177 switch (consumer_data
->type
) {
4178 case LTTNG_CONSUMER_KERNEL
:
4179 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4181 case LTTNG_CONSUMER64_UST
:
4182 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4184 case LTTNG_CONSUMER32_UST
:
4185 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4188 ERR("Consumer type unknown");
4193 DBG2("Creating consumer directory: %s", path
);
4195 ret
= mkdir(path
, S_IRWXU
);
4197 if (errno
!= EEXIST
) {
4199 ERR("Failed to create %s", path
);
4205 /* Create the kconsumerd error unix socket */
4206 consumer_data
->err_sock
=
4207 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4208 if (consumer_data
->err_sock
< 0) {
4209 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4214 /* File permission MUST be 660 */
4215 ret
= chmod(consumer_data
->err_unix_sock_path
,
4216 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4218 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4228 * Signal handler for the daemon
4230 * Simply stop all worker threads, leaving main() return gracefully after
4231 * joining all threads and calling cleanup().
4233 static void sighandler(int sig
)
4237 DBG("SIGPIPE caught");
4240 DBG("SIGINT caught");
4244 DBG("SIGTERM caught");
4253 * Setup signal handler for :
4254 * SIGINT, SIGTERM, SIGPIPE
4256 static int set_signal_handler(void)
4259 struct sigaction sa
;
4262 if ((ret
= sigemptyset(&sigset
)) < 0) {
4263 PERROR("sigemptyset");
4267 sa
.sa_handler
= sighandler
;
4268 sa
.sa_mask
= sigset
;
4270 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4271 PERROR("sigaction");
4275 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4276 PERROR("sigaction");
4280 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4281 PERROR("sigaction");
4285 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4291 * Set open files limit to unlimited. This daemon can open a large number of
4292 * file descriptors in order to consumer multiple kernel traces.
4294 static void set_ulimit(void)
4299 /* The kernel does not allowed an infinite limit for open files */
4300 lim
.rlim_cur
= 65535;
4301 lim
.rlim_max
= 65535;
4303 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4305 PERROR("failed to set open files limit");
4312 int main(int argc
, char **argv
)
4316 const char *home_path
;
4318 init_kernel_workarounds();
4320 rcu_register_thread();
4322 setup_consumerd_path();
4324 /* Parse arguments */
4326 if ((ret
= parse_args(argc
, argv
) < 0)) {
4336 * child: setsid, close FD 0, 1, 2, chdir /
4337 * parent: exit (if fork is successful)
4345 * We are in the child. Make sure all other file
4346 * descriptors are closed, in case we are called with
4347 * more opened file descriptors than the standard ones.
4349 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
4354 /* Create thread quit pipe */
4355 if ((ret
= init_thread_quit_pipe()) < 0) {
4359 /* Check if daemon is UID = 0 */
4360 is_root
= !getuid();
4363 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4365 /* Create global run dir with root access */
4366 ret
= create_lttng_rundir(rundir
);
4371 if (strlen(apps_unix_sock_path
) == 0) {
4372 snprintf(apps_unix_sock_path
, PATH_MAX
,
4373 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4376 if (strlen(client_unix_sock_path
) == 0) {
4377 snprintf(client_unix_sock_path
, PATH_MAX
,
4378 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4381 /* Set global SHM for ust */
4382 if (strlen(wait_shm_path
) == 0) {
4383 snprintf(wait_shm_path
, PATH_MAX
,
4384 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4387 /* Setup kernel consumerd path */
4388 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4389 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4390 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4391 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4393 DBG2("Kernel consumer err path: %s",
4394 kconsumer_data
.err_unix_sock_path
);
4395 DBG2("Kernel consumer cmd path: %s",
4396 kconsumer_data
.cmd_unix_sock_path
);
4398 home_path
= get_home_dir();
4399 if (home_path
== NULL
) {
4400 /* TODO: Add --socket PATH option */
4401 ERR("Can't get HOME directory for sockets creation.");
4407 * Create rundir from home path. This will create something like
4410 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4416 ret
= create_lttng_rundir(rundir
);
4421 if (strlen(apps_unix_sock_path
) == 0) {
4422 snprintf(apps_unix_sock_path
, PATH_MAX
,
4423 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4426 /* Set the cli tool unix socket path */
4427 if (strlen(client_unix_sock_path
) == 0) {
4428 snprintf(client_unix_sock_path
, PATH_MAX
,
4429 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4432 /* Set global SHM for ust */
4433 if (strlen(wait_shm_path
) == 0) {
4434 snprintf(wait_shm_path
, PATH_MAX
,
4435 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4439 /* Set consumer initial state */
4440 kernel_consumerd_state
= CONSUMER_STOPPED
;
4441 ust_consumerd_state
= CONSUMER_STOPPED
;
4443 DBG("Client socket path %s", client_unix_sock_path
);
4444 DBG("Application socket path %s", apps_unix_sock_path
);
4445 DBG("LTTng run directory path: %s", rundir
);
4447 /* 32 bits consumerd path setup */
4448 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4449 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4450 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4451 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4453 DBG2("UST consumer 32 bits err path: %s",
4454 ustconsumer32_data
.err_unix_sock_path
);
4455 DBG2("UST consumer 32 bits cmd path: %s",
4456 ustconsumer32_data
.cmd_unix_sock_path
);
4458 /* 64 bits consumerd path setup */
4459 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4460 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4461 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4462 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4464 DBG2("UST consumer 64 bits err path: %s",
4465 ustconsumer64_data
.err_unix_sock_path
);
4466 DBG2("UST consumer 64 bits cmd path: %s",
4467 ustconsumer64_data
.cmd_unix_sock_path
);
4470 * See if daemon already exist.
4472 if ((ret
= check_existing_daemon()) < 0) {
4473 ERR("Already running daemon.\n");
4475 * We do not goto exit because we must not cleanup()
4476 * because a daemon is already running.
4482 * Init UST app hash table. Alloc hash table before this point since
4483 * cleanup() can get called after that point.
4487 /* After this point, we can safely call cleanup() with "goto exit" */
4490 * These actions must be executed as root. We do that *after* setting up
4491 * the sockets path because we MUST make the check for another daemon using
4492 * those paths *before* trying to set the kernel consumer sockets and init
4496 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4501 /* Setup kernel tracer */
4502 if (!opt_no_kernel
) {
4503 init_kernel_tracer();
4506 /* Set ulimit for open files */
4509 /* init lttng_fd tracking must be done after set_ulimit. */
4512 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4517 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4522 if ((ret
= set_signal_handler()) < 0) {
4526 /* Setup the needed unix socket */
4527 if ((ret
= init_daemon_socket()) < 0) {
4531 /* Set credentials to socket */
4532 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4536 /* Get parent pid if -S, --sig-parent is specified. */
4537 if (opt_sig_parent
) {
4541 /* Setup the kernel pipe for waking up the kernel thread */
4542 if ((ret
= utils_create_pipe_cloexec(kernel_poll_pipe
)) < 0) {
4546 /* Setup the thread apps communication pipe. */
4547 if ((ret
= utils_create_pipe_cloexec(apps_cmd_pipe
)) < 0) {
4551 /* Init UST command queue. */
4552 cds_wfq_init(&ust_cmd_queue
.queue
);
4555 * Get session list pointer. This pointer MUST NOT be free(). This list is
4556 * statically declared in session.c
4558 session_list_ptr
= session_get_list();
4560 /* Set up max poll set size */
4561 lttng_poll_set_max_size();
4563 /* Create thread to manage the client socket */
4564 ret
= pthread_create(&client_thread
, NULL
,
4565 thread_manage_clients
, (void *) NULL
);
4567 PERROR("pthread_create clients");
4571 /* Create thread to dispatch registration */
4572 ret
= pthread_create(&dispatch_thread
, NULL
,
4573 thread_dispatch_ust_registration
, (void *) NULL
);
4575 PERROR("pthread_create dispatch");
4579 /* Create thread to manage application registration. */
4580 ret
= pthread_create(®_apps_thread
, NULL
,
4581 thread_registration_apps
, (void *) NULL
);
4583 PERROR("pthread_create registration");
4587 /* Create thread to manage application socket */
4588 ret
= pthread_create(&apps_thread
, NULL
,
4589 thread_manage_apps
, (void *) NULL
);
4591 PERROR("pthread_create apps");
4595 /* Create kernel thread to manage kernel event */
4596 ret
= pthread_create(&kernel_thread
, NULL
,
4597 thread_manage_kernel
, (void *) NULL
);
4599 PERROR("pthread_create kernel");
4603 ret
= pthread_join(kernel_thread
, &status
);
4605 PERROR("pthread_join");
4606 goto error
; /* join error, exit without cleanup */
4610 ret
= pthread_join(apps_thread
, &status
);
4612 PERROR("pthread_join");
4613 goto error
; /* join error, exit without cleanup */
4617 ret
= pthread_join(reg_apps_thread
, &status
);
4619 PERROR("pthread_join");
4620 goto error
; /* join error, exit without cleanup */
4624 ret
= pthread_join(dispatch_thread
, &status
);
4626 PERROR("pthread_join");
4627 goto error
; /* join error, exit without cleanup */
4631 ret
= pthread_join(client_thread
, &status
);
4633 PERROR("pthread_join");
4634 goto error
; /* join error, exit without cleanup */
4637 ret
= join_consumer_thread(&kconsumer_data
);
4639 PERROR("join_consumer");
4640 goto error
; /* join error, exit without cleanup */
4646 * cleanup() is called when no other thread is running.
4648 rcu_thread_online();
4650 rcu_thread_offline();
4651 rcu_unregister_thread();