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/futex.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>
47 #include "lttng-sessiond.h"
58 #define CONSUMERD_FILE "lttng-consumerd"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
79 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
80 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
81 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
82 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
85 const char *opt_tracing_group
;
86 static int opt_sig_parent
;
87 static int opt_verbose_consumer
;
88 static int opt_daemon
;
89 static int opt_no_kernel
;
90 static int is_root
; /* Set to 1 if the daemon is running as root */
91 static pid_t ppid
; /* Parent PID for --sig-parent option */
94 /* Consumer daemon specific control data */
95 static struct consumer_data kconsumer_data
= {
96 .type
= LTTNG_CONSUMER_KERNEL
,
97 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
98 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
102 static struct consumer_data ustconsumer64_data
= {
103 .type
= LTTNG_CONSUMER64_UST
,
104 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
105 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
109 static struct consumer_data ustconsumer32_data
= {
110 .type
= LTTNG_CONSUMER32_UST
,
111 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
112 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
117 static int dispatch_thread_exit
;
119 /* Global application Unix socket path */
120 static char apps_unix_sock_path
[PATH_MAX
];
121 /* Global client Unix socket path */
122 static char client_unix_sock_path
[PATH_MAX
];
123 /* global wait shm path for UST */
124 static char wait_shm_path
[PATH_MAX
];
126 /* Sockets and FDs */
127 static int client_sock
= -1;
128 static int apps_sock
= -1;
129 static int kernel_tracer_fd
= -1;
130 static int kernel_poll_pipe
[2] = { -1, -1 };
133 * Quit pipe for all threads. This permits a single cancellation point
134 * for all threads when receiving an event on the pipe.
136 static int thread_quit_pipe
[2] = { -1, -1 };
139 * This pipe is used to inform the thread managing application communication
140 * that a command is queued and ready to be processed.
142 static int apps_cmd_pipe
[2] = { -1, -1 };
144 /* Pthread, Mutexes and Semaphores */
145 static pthread_t apps_thread
;
146 static pthread_t reg_apps_thread
;
147 static pthread_t client_thread
;
148 static pthread_t kernel_thread
;
149 static pthread_t dispatch_thread
;
153 * UST registration command queue. This queue is tied with a futex and uses a N
154 * wakers / 1 waiter implemented and detailed in futex.c/.h
156 * The thread_manage_apps and thread_dispatch_ust_registration interact with
157 * this queue and the wait/wake scheme.
159 static struct ust_cmd_queue ust_cmd_queue
;
162 * Pointer initialized before thread creation.
164 * This points to the tracing session list containing the session count and a
165 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
166 * MUST NOT be taken if you call a public function in session.c.
168 * The lock is nested inside the structure: session_list_ptr->lock. Please use
169 * session_lock_list and session_unlock_list for lock acquisition.
171 static struct ltt_session_list
*session_list_ptr
;
173 int ust_consumerd64_fd
= -1;
174 int ust_consumerd32_fd
= -1;
176 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
177 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
178 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
179 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
182 void setup_consumerd_path(void)
184 const char *bin
, *libdir
;
187 * Allow INSTALL_BIN_PATH to be used as a target path for the
188 * native architecture size consumer if CONFIG_CONSUMER*_PATH
189 * has not been defined.
191 #if (CAA_BITS_PER_LONG == 32)
192 if (!consumerd32_bin
[0]) {
193 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
195 if (!consumerd32_libdir
[0]) {
196 consumerd32_libdir
= INSTALL_LIB_PATH
;
198 #elif (CAA_BITS_PER_LONG == 64)
199 if (!consumerd64_bin
[0]) {
200 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
202 if (!consumerd64_libdir
[0]) {
203 consumerd64_libdir
= INSTALL_LIB_PATH
;
206 #error "Unknown bitness"
210 * runtime env. var. overrides the build default.
212 bin
= getenv("LTTNG_CONSUMERD32_BIN");
214 consumerd32_bin
= bin
;
216 bin
= getenv("LTTNG_CONSUMERD64_BIN");
218 consumerd64_bin
= bin
;
220 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
222 consumerd32_libdir
= libdir
;
224 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
226 consumerd64_libdir
= libdir
;
231 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
233 static int create_thread_poll_set(struct lttng_poll_event
*events
,
238 if (events
== NULL
|| size
== 0) {
243 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
249 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
261 * Check if the thread quit pipe was triggered.
263 * Return 1 if it was triggered else 0;
265 static int check_thread_quit_pipe(int fd
, uint32_t events
)
267 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
275 * Return group ID of the tracing group or -1 if not found.
277 static gid_t
allowed_group(void)
281 if (opt_tracing_group
) {
282 grp
= getgrnam(opt_tracing_group
);
284 grp
= getgrnam(default_tracing_group
);
294 * Init thread quit pipe.
296 * Return -1 on error or 0 if all pipes are created.
298 static int init_thread_quit_pipe(void)
302 ret
= pipe(thread_quit_pipe
);
304 PERROR("thread quit pipe");
308 for (i
= 0; i
< 2; i
++) {
309 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
321 * Complete teardown of a kernel session. This free all data structure related
322 * to a kernel session and update counter.
324 static void teardown_kernel_session(struct ltt_session
*session
)
326 if (!session
->kernel_session
) {
327 DBG3("No kernel session when tearing down session");
331 DBG("Tearing down kernel session");
334 * If a custom kernel consumer was registered, close the socket before
335 * tearing down the complete kernel session structure
337 if (kconsumer_data
.cmd_sock
>= 0 &&
338 session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
339 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
342 trace_kernel_destroy_session(session
->kernel_session
);
346 * Complete teardown of all UST sessions. This will free everything on his path
347 * and destroy the core essence of all ust sessions :)
349 static void teardown_ust_session(struct ltt_session
*session
)
353 if (!session
->ust_session
) {
354 DBG3("No UST session when tearing down session");
358 DBG("Tearing down UST session(s)");
360 ret
= ust_app_destroy_trace_all(session
->ust_session
);
362 ERR("Error in ust_app_destroy_trace_all");
365 trace_ust_destroy_session(session
->ust_session
);
369 * Stop all threads by closing the thread quit pipe.
371 static void stop_threads(void)
375 /* Stopping all threads */
376 DBG("Terminating all threads");
377 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
379 ERR("write error on thread quit pipe");
382 /* Dispatch thread */
383 dispatch_thread_exit
= 1;
384 futex_nto1_wake(&ust_cmd_queue
.futex
);
390 static void cleanup(void)
394 struct ltt_session
*sess
, *stmp
;
398 DBG("Removing %s directory", rundir
);
399 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
401 ERR("asprintf failed. Something is really wrong!");
404 /* Remove lttng run directory */
407 ERR("Unable to clean %s", rundir
);
411 DBG("Cleaning up all sessions");
413 /* Destroy session list mutex */
414 if (session_list_ptr
!= NULL
) {
415 pthread_mutex_destroy(&session_list_ptr
->lock
);
417 /* Cleanup ALL session */
418 cds_list_for_each_entry_safe(sess
, stmp
,
419 &session_list_ptr
->head
, list
) {
420 teardown_kernel_session(sess
);
421 teardown_ust_session(sess
);
426 DBG("Closing all UST sockets");
427 ust_app_clean_list();
429 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
431 if (is_root
&& !opt_no_kernel
) {
432 DBG2("Closing kernel fd");
433 if (kernel_tracer_fd
>= 0) {
434 ret
= close(kernel_tracer_fd
);
439 DBG("Unloading kernel modules");
440 modprobe_remove_lttng_all();
444 * Closing all pipes used for communication between threads.
446 for (i
= 0; i
< 2; i
++) {
447 if (kernel_poll_pipe
[i
] >= 0) {
448 ret
= close(kernel_poll_pipe
[i
]);
455 for (i
= 0; i
< 2; i
++) {
456 if (thread_quit_pipe
[i
] >= 0) {
457 ret
= close(thread_quit_pipe
[i
]);
463 for (i
= 0; i
< 2; i
++) {
464 if (apps_cmd_pipe
[i
] >= 0) {
465 ret
= close(apps_cmd_pipe
[i
]);
473 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
474 "Matthew, BEET driven development works!%c[%dm",
475 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
480 * Send data on a unix socket using the liblttsessiondcomm API.
482 * Return lttcomm error code.
484 static int send_unix_sock(int sock
, void *buf
, size_t len
)
486 /* Check valid length */
491 return lttcomm_send_unix_sock(sock
, buf
, len
);
495 * Free memory of a command context structure.
497 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
499 DBG("Clean command context structure");
501 if ((*cmd_ctx
)->llm
) {
502 free((*cmd_ctx
)->llm
);
504 if ((*cmd_ctx
)->lsm
) {
505 free((*cmd_ctx
)->lsm
);
513 * Send all stream fds of kernel channel to the consumer.
515 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
516 int sock
, struct ltt_kernel_channel
*channel
,
517 uid_t uid
, gid_t gid
)
520 struct ltt_kernel_stream
*stream
;
521 struct lttcomm_consumer_msg lkm
;
523 DBG("Sending streams of channel %s to kernel consumer",
524 channel
->channel
->name
);
527 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
528 lkm
.u
.channel
.channel_key
= channel
->fd
;
529 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
530 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
531 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
532 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
534 PERROR("send consumer channel");
539 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
543 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
544 lkm
.u
.stream
.channel_key
= channel
->fd
;
545 lkm
.u
.stream
.stream_key
= stream
->fd
;
546 lkm
.u
.stream
.state
= stream
->state
;
547 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
548 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
549 lkm
.u
.stream
.uid
= uid
;
550 lkm
.u
.stream
.gid
= gid
;
551 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
552 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
553 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
554 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
556 PERROR("send consumer stream");
559 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
561 PERROR("send consumer stream ancillary data");
566 DBG("consumer channel streams sent");
575 * Send all stream fds of the kernel session to the consumer.
577 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
578 struct ltt_kernel_session
*session
)
581 struct ltt_kernel_channel
*chan
;
582 struct lttcomm_consumer_msg lkm
;
583 int sock
= session
->consumer_fd
;
585 DBG("Sending metadata stream fd");
587 /* Extra protection. It's NOT supposed to be set to -1 at this point */
588 if (session
->consumer_fd
< 0) {
589 session
->consumer_fd
= consumer_data
->cmd_sock
;
592 if (session
->metadata_stream_fd
>= 0) {
593 /* Send metadata channel fd */
594 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
595 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
596 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
597 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
598 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
599 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
601 PERROR("send consumer channel");
605 /* Send metadata stream fd */
606 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
607 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
608 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
609 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
610 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
611 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
612 lkm
.u
.stream
.uid
= session
->uid
;
613 lkm
.u
.stream
.gid
= session
->gid
;
614 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
615 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
616 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
617 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
619 PERROR("send consumer stream");
622 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
624 PERROR("send consumer stream");
629 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
630 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
631 session
->uid
, session
->gid
);
637 DBG("consumer fds (metadata and channel streams) sent");
646 * Notify UST applications using the shm mmap futex.
648 static int notify_ust_apps(int active
)
652 DBG("Notifying applications of session daemon state: %d", active
);
654 /* See shm.c for this call implying mmap, shm and futex calls */
655 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
656 if (wait_shm_mmap
== NULL
) {
660 /* Wake waiting process */
661 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
663 /* Apps notified successfully */
671 * Setup the outgoing data buffer for the response (llm) by allocating the
672 * right amount of memory and copying the original information from the lsm
675 * Return total size of the buffer pointed by buf.
677 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
683 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
684 if (cmd_ctx
->llm
== NULL
) {
690 /* Copy common data */
691 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
692 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
694 cmd_ctx
->llm
->data_size
= size
;
695 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
704 * Update the kernel poll set of all channel fd available over all tracing
705 * session. Add the wakeup pipe at the end of the set.
707 static int update_kernel_poll(struct lttng_poll_event
*events
)
710 struct ltt_session
*session
;
711 struct ltt_kernel_channel
*channel
;
713 DBG("Updating kernel poll set");
716 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
717 session_lock(session
);
718 if (session
->kernel_session
== NULL
) {
719 session_unlock(session
);
723 cds_list_for_each_entry(channel
,
724 &session
->kernel_session
->channel_list
.head
, list
) {
725 /* Add channel fd to the kernel poll set */
726 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
728 session_unlock(session
);
731 DBG("Channel fd %d added to kernel set", channel
->fd
);
733 session_unlock(session
);
735 session_unlock_list();
740 session_unlock_list();
745 * Find the channel fd from 'fd' over all tracing session. When found, check
746 * for new channel stream and send those stream fds to the kernel consumer.
748 * Useful for CPU hotplug feature.
750 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
753 struct ltt_session
*session
;
754 struct ltt_kernel_channel
*channel
;
756 DBG("Updating kernel streams for channel fd %d", fd
);
759 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
760 session_lock(session
);
761 if (session
->kernel_session
== NULL
) {
762 session_unlock(session
);
766 /* This is not suppose to be -1 but this is an extra security check */
767 if (session
->kernel_session
->consumer_fd
< 0) {
768 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
771 cds_list_for_each_entry(channel
,
772 &session
->kernel_session
->channel_list
.head
, list
) {
773 if (channel
->fd
== fd
) {
774 DBG("Channel found, updating kernel streams");
775 ret
= kernel_open_channel_stream(channel
);
781 * Have we already sent fds to the consumer? If yes, it means
782 * that tracing is started so it is safe to send our updated
785 if (session
->kernel_session
->consumer_fds_sent
== 1) {
786 ret
= send_kconsumer_channel_streams(consumer_data
,
787 session
->kernel_session
->consumer_fd
, channel
,
788 session
->uid
, session
->gid
);
796 session_unlock(session
);
798 session_unlock_list();
802 session_unlock(session
);
803 session_unlock_list();
808 * For each tracing session, update newly registered apps.
810 static void update_ust_app(int app_sock
)
812 struct ltt_session
*sess
, *stmp
;
816 /* For all tracing session(s) */
817 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
819 if (sess
->ust_session
) {
820 ust_app_global_update(sess
->ust_session
, app_sock
);
822 session_unlock(sess
);
825 session_unlock_list();
829 * This thread manage event coming from the kernel.
831 * Features supported in this thread:
834 static void *thread_manage_kernel(void *data
)
836 int ret
, i
, pollfd
, update_poll_flag
= 1;
837 uint32_t revents
, nb_fd
;
839 struct lttng_poll_event events
;
841 DBG("Thread manage kernel started");
843 ret
= create_thread_poll_set(&events
, 2);
845 goto error_poll_create
;
848 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
854 if (update_poll_flag
== 1) {
856 * Reset number of fd in the poll set. Always 2 since there is the thread
857 * quit pipe and the kernel pipe.
861 ret
= update_kernel_poll(&events
);
865 update_poll_flag
= 0;
868 nb_fd
= LTTNG_POLL_GETNB(&events
);
870 DBG("Thread kernel polling on %d fds", nb_fd
);
872 /* Zeroed the poll events */
873 lttng_poll_reset(&events
);
875 /* Poll infinite value of time */
877 ret
= lttng_poll_wait(&events
, -1);
880 * Restart interrupted system call.
882 if (errno
== EINTR
) {
886 } else if (ret
== 0) {
887 /* Should not happen since timeout is infinite */
888 ERR("Return value of poll is 0 with an infinite timeout.\n"
889 "This should not have happened! Continuing...");
893 for (i
= 0; i
< nb_fd
; i
++) {
894 /* Fetch once the poll data */
895 revents
= LTTNG_POLL_GETEV(&events
, i
);
896 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
898 /* Thread quit pipe has been closed. Killing thread. */
899 ret
= check_thread_quit_pipe(pollfd
, revents
);
904 /* Check for data on kernel pipe */
905 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
906 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
907 update_poll_flag
= 1;
911 * New CPU detected by the kernel. Adding kernel stream to
912 * kernel session and updating the kernel consumer
914 if (revents
& LPOLLIN
) {
915 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
921 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
922 * and unregister kernel stream at this point.
930 lttng_poll_clean(&events
);
932 DBG("Kernel thread dying");
937 * This thread manage the consumer error sent back to the session daemon.
939 static void *thread_manage_consumer(void *data
)
941 int sock
= -1, i
, ret
, pollfd
;
942 uint32_t revents
, nb_fd
;
943 enum lttcomm_return_code code
;
944 struct lttng_poll_event events
;
945 struct consumer_data
*consumer_data
= data
;
947 DBG("[thread] Manage consumer started");
949 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
955 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
956 * Nothing more will be added to this poll set.
958 ret
= create_thread_poll_set(&events
, 2);
963 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
968 nb_fd
= LTTNG_POLL_GETNB(&events
);
970 /* Inifinite blocking call, waiting for transmission */
972 ret
= lttng_poll_wait(&events
, -1);
975 * Restart interrupted system call.
977 if (errno
== EINTR
) {
983 for (i
= 0; i
< nb_fd
; i
++) {
984 /* Fetch once the poll data */
985 revents
= LTTNG_POLL_GETEV(&events
, i
);
986 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
988 /* Thread quit pipe has been closed. Killing thread. */
989 ret
= check_thread_quit_pipe(pollfd
, revents
);
994 /* Event on the registration socket */
995 if (pollfd
== consumer_data
->err_sock
) {
996 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
997 ERR("consumer err socket poll error");
1003 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1008 DBG2("Receiving code from consumer err_sock");
1010 /* Getting status code from kconsumerd */
1011 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1012 sizeof(enum lttcomm_return_code
));
1017 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1018 consumer_data
->cmd_sock
=
1019 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1020 if (consumer_data
->cmd_sock
< 0) {
1021 sem_post(&consumer_data
->sem
);
1022 PERROR("consumer connect");
1025 /* Signal condition to tell that the kconsumerd is ready */
1026 sem_post(&consumer_data
->sem
);
1027 DBG("consumer command socket ready");
1029 ERR("consumer error when waiting for SOCK_READY : %s",
1030 lttcomm_get_readable_code(-code
));
1034 /* Remove the kconsumerd error sock since we've established a connexion */
1035 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1040 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1045 /* Update number of fd */
1046 nb_fd
= LTTNG_POLL_GETNB(&events
);
1048 /* Inifinite blocking call, waiting for transmission */
1050 ret
= lttng_poll_wait(&events
, -1);
1053 * Restart interrupted system call.
1055 if (errno
== EINTR
) {
1061 for (i
= 0; i
< nb_fd
; i
++) {
1062 /* Fetch once the poll data */
1063 revents
= LTTNG_POLL_GETEV(&events
, i
);
1064 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1066 /* Thread quit pipe has been closed. Killing thread. */
1067 ret
= check_thread_quit_pipe(pollfd
, revents
);
1072 /* Event on the kconsumerd socket */
1073 if (pollfd
== sock
) {
1074 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1075 ERR("consumer err socket second poll error");
1081 /* Wait for any kconsumerd error */
1082 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1083 sizeof(enum lttcomm_return_code
));
1085 ERR("consumer closed the command socket");
1089 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1092 if (consumer_data
->err_sock
>= 0) {
1093 ret
= close(consumer_data
->err_sock
);
1098 if (consumer_data
->cmd_sock
>= 0) {
1099 ret
= close(consumer_data
->cmd_sock
);
1111 unlink(consumer_data
->err_unix_sock_path
);
1112 unlink(consumer_data
->cmd_unix_sock_path
);
1113 consumer_data
->pid
= 0;
1115 lttng_poll_clean(&events
);
1118 DBG("consumer thread cleanup completed");
1124 * This thread manage application communication.
1126 static void *thread_manage_apps(void *data
)
1129 uint32_t revents
, nb_fd
;
1130 struct ust_command ust_cmd
;
1131 struct lttng_poll_event events
;
1133 DBG("[thread] Manage application started");
1135 rcu_register_thread();
1136 rcu_thread_online();
1138 ret
= create_thread_poll_set(&events
, 2);
1140 goto error_poll_create
;
1143 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1149 /* Zeroed the events structure */
1150 lttng_poll_reset(&events
);
1152 nb_fd
= LTTNG_POLL_GETNB(&events
);
1154 DBG("Apps thread polling on %d fds", nb_fd
);
1156 /* Inifinite blocking call, waiting for transmission */
1158 ret
= lttng_poll_wait(&events
, -1);
1161 * Restart interrupted system call.
1163 if (errno
== EINTR
) {
1169 for (i
= 0; i
< nb_fd
; i
++) {
1170 /* Fetch once the poll data */
1171 revents
= LTTNG_POLL_GETEV(&events
, i
);
1172 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1174 /* Thread quit pipe has been closed. Killing thread. */
1175 ret
= check_thread_quit_pipe(pollfd
, revents
);
1180 /* Inspect the apps cmd pipe */
1181 if (pollfd
== apps_cmd_pipe
[0]) {
1182 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1183 ERR("Apps command pipe error");
1185 } else if (revents
& LPOLLIN
) {
1187 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1188 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1189 PERROR("read apps cmd pipe");
1193 /* Register applicaton to the session daemon */
1194 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1196 if (ret
== -ENOMEM
) {
1198 } else if (ret
< 0) {
1203 * Validate UST version compatibility.
1205 ret
= ust_app_validate_version(ust_cmd
.sock
);
1208 * Add channel(s) and event(s) to newly registered apps
1209 * from lttng global UST domain.
1211 update_ust_app(ust_cmd
.sock
);
1214 ret
= ust_app_register_done(ust_cmd
.sock
);
1217 * If the registration is not possible, we simply
1218 * unregister the apps and continue
1220 ust_app_unregister(ust_cmd
.sock
);
1223 * We just need here to monitor the close of the UST
1224 * socket and poll set monitor those by default.
1225 * Listen on POLLIN (even if we never expect any
1226 * data) to ensure that hangup wakes us.
1228 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1233 DBG("Apps with sock %d added to poll set",
1241 * At this point, we know that a registered application made
1242 * the event at poll_wait.
1244 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1245 /* Removing from the poll set */
1246 ret
= lttng_poll_del(&events
, pollfd
);
1251 /* Socket closed on remote end. */
1252 ust_app_unregister(pollfd
);
1260 lttng_poll_clean(&events
);
1262 DBG("Application communication apps thread cleanup complete");
1263 rcu_thread_offline();
1264 rcu_unregister_thread();
1269 * Dispatch request from the registration threads to the application
1270 * communication thread.
1272 static void *thread_dispatch_ust_registration(void *data
)
1275 struct cds_wfq_node
*node
;
1276 struct ust_command
*ust_cmd
= NULL
;
1278 DBG("[thread] Dispatch UST command started");
1280 while (!dispatch_thread_exit
) {
1281 /* Atomically prepare the queue futex */
1282 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1285 /* Dequeue command for registration */
1286 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1288 DBG("Woken up but nothing in the UST command queue");
1289 /* Continue thread execution */
1293 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1295 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1296 " gid:%d sock:%d name:%s (version %d.%d)",
1297 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1298 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1299 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1300 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1302 * Inform apps thread of the new application registration. This
1303 * call is blocking so we can be assured that the data will be read
1304 * at some point in time or wait to the end of the world :)
1306 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1307 sizeof(struct ust_command
));
1309 PERROR("write apps cmd pipe");
1310 if (errno
== EBADF
) {
1312 * We can't inform the application thread to process
1313 * registration. We will exit or else application
1314 * registration will not occur and tracing will never
1321 } while (node
!= NULL
);
1323 /* Futex wait on queue. Blocking call on futex() */
1324 futex_nto1_wait(&ust_cmd_queue
.futex
);
1328 DBG("Dispatch thread dying");
1333 * This thread manage application registration.
1335 static void *thread_registration_apps(void *data
)
1337 int sock
= -1, i
, ret
, pollfd
;
1338 uint32_t revents
, nb_fd
;
1339 struct lttng_poll_event events
;
1341 * Get allocated in this thread, enqueued to a global queue, dequeued and
1342 * freed in the manage apps thread.
1344 struct ust_command
*ust_cmd
= NULL
;
1346 DBG("[thread] Manage application registration started");
1348 ret
= lttcomm_listen_unix_sock(apps_sock
);
1354 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1355 * more will be added to this poll set.
1357 ret
= create_thread_poll_set(&events
, 2);
1359 goto error_create_poll
;
1362 /* Add the application registration socket */
1363 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1365 goto error_poll_add
;
1368 /* Notify all applications to register */
1369 ret
= notify_ust_apps(1);
1371 ERR("Failed to notify applications or create the wait shared memory.\n"
1372 "Execution continues but there might be problem for already\n"
1373 "running applications that wishes to register.");
1377 DBG("Accepting application registration");
1379 nb_fd
= LTTNG_POLL_GETNB(&events
);
1381 /* Inifinite blocking call, waiting for transmission */
1383 ret
= lttng_poll_wait(&events
, -1);
1386 * Restart interrupted system call.
1388 if (errno
== EINTR
) {
1394 for (i
= 0; i
< nb_fd
; i
++) {
1395 /* Fetch once the poll data */
1396 revents
= LTTNG_POLL_GETEV(&events
, i
);
1397 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1399 /* Thread quit pipe has been closed. Killing thread. */
1400 ret
= check_thread_quit_pipe(pollfd
, revents
);
1405 /* Event on the registration socket */
1406 if (pollfd
== apps_sock
) {
1407 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1408 ERR("Register apps socket poll error");
1410 } else if (revents
& LPOLLIN
) {
1411 sock
= lttcomm_accept_unix_sock(apps_sock
);
1416 /* Create UST registration command for enqueuing */
1417 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1418 if (ust_cmd
== NULL
) {
1419 PERROR("ust command zmalloc");
1424 * Using message-based transmissions to ensure we don't
1425 * have to deal with partially received messages.
1427 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1428 sizeof(struct ust_register_msg
));
1429 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1431 PERROR("lttcomm_recv_unix_sock register apps");
1433 ERR("Wrong size received on apps register");
1444 ust_cmd
->sock
= sock
;
1447 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1448 " gid:%d sock:%d name:%s (version %d.%d)",
1449 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1450 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1451 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1452 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1455 * Lock free enqueue the registration request. The red pill
1456 * has been taken! This apps will be part of the *system*.
1458 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1461 * Wake the registration queue futex. Implicit memory
1462 * barrier with the exchange in cds_wfq_enqueue.
1464 futex_nto1_wake(&ust_cmd_queue
.futex
);
1471 /* Notify that the registration thread is gone */
1474 if (apps_sock
>= 0) {
1475 ret
= close(apps_sock
);
1486 unlink(apps_unix_sock_path
);
1489 lttng_poll_clean(&events
);
1492 DBG("UST Registration thread cleanup complete");
1498 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1499 * exec or it will fails.
1501 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1504 struct timespec timeout
;
1506 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1507 timeout
.tv_nsec
= 0;
1509 /* Setup semaphore */
1510 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1512 PERROR("sem_init consumer semaphore");
1516 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1517 thread_manage_consumer
, consumer_data
);
1519 PERROR("pthread_create consumer");
1524 /* Get time for sem_timedwait absolute timeout */
1525 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1527 PERROR("clock_gettime spawn consumer");
1528 /* Infinite wait for the kconsumerd thread to be ready */
1529 ret
= sem_wait(&consumer_data
->sem
);
1531 /* Normal timeout if the gettime was successful */
1532 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1533 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1537 if (errno
== ETIMEDOUT
) {
1539 * Call has timed out so we kill the kconsumerd_thread and return
1542 ERR("The consumer thread was never ready. Killing it");
1543 ret
= pthread_cancel(consumer_data
->thread
);
1545 PERROR("pthread_cancel consumer thread");
1548 PERROR("semaphore wait failed consumer thread");
1553 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1554 if (consumer_data
->pid
== 0) {
1555 ERR("Kconsumerd did not start");
1556 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1559 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1568 * Join consumer thread
1570 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1575 if (consumer_data
->pid
!= 0) {
1576 ret
= kill(consumer_data
->pid
, SIGTERM
);
1578 ERR("Error killing consumer daemon");
1581 return pthread_join(consumer_data
->thread
, &status
);
1588 * Fork and exec a consumer daemon (consumerd).
1590 * Return pid if successful else -1.
1592 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1596 const char *consumer_to_use
;
1597 const char *verbosity
;
1600 DBG("Spawning consumerd");
1607 if (opt_verbose_consumer
) {
1608 verbosity
= "--verbose";
1610 verbosity
= "--quiet";
1612 switch (consumer_data
->type
) {
1613 case LTTNG_CONSUMER_KERNEL
:
1615 * Find out which consumerd to execute. We will first try the
1616 * 64-bit path, then the sessiond's installation directory, and
1617 * fallback on the 32-bit one,
1619 DBG3("Looking for a kernel consumer at these locations:");
1620 DBG3(" 1) %s", consumerd64_bin
);
1621 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1622 DBG3(" 3) %s", consumerd32_bin
);
1623 if (stat(consumerd64_bin
, &st
) == 0) {
1624 DBG3("Found location #1");
1625 consumer_to_use
= consumerd64_bin
;
1626 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1627 DBG3("Found location #2");
1628 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1629 } else if (stat(consumerd32_bin
, &st
) == 0) {
1630 DBG3("Found location #3");
1631 consumer_to_use
= consumerd32_bin
;
1633 DBG("Could not find any valid consumerd executable");
1636 DBG("Using kernel consumer at: %s", consumer_to_use
);
1637 execl(consumer_to_use
,
1638 "lttng-consumerd", verbosity
, "-k",
1639 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1640 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1643 case LTTNG_CONSUMER64_UST
:
1645 char *tmpnew
= NULL
;
1647 if (consumerd64_libdir
[0] != '\0') {
1651 tmp
= getenv("LD_LIBRARY_PATH");
1655 tmplen
= strlen("LD_LIBRARY_PATH=")
1656 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1657 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1662 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1663 strcat(tmpnew
, consumerd64_libdir
);
1664 if (tmp
[0] != '\0') {
1665 strcat(tmpnew
, ":");
1666 strcat(tmpnew
, tmp
);
1668 ret
= putenv(tmpnew
);
1674 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1675 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1676 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1677 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1679 if (consumerd64_libdir
[0] != '\0') {
1687 case LTTNG_CONSUMER32_UST
:
1689 char *tmpnew
= NULL
;
1691 if (consumerd32_libdir
[0] != '\0') {
1695 tmp
= getenv("LD_LIBRARY_PATH");
1699 tmplen
= strlen("LD_LIBRARY_PATH=")
1700 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1701 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1706 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1707 strcat(tmpnew
, consumerd32_libdir
);
1708 if (tmp
[0] != '\0') {
1709 strcat(tmpnew
, ":");
1710 strcat(tmpnew
, tmp
);
1712 ret
= putenv(tmpnew
);
1718 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1719 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1720 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1721 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1723 if (consumerd32_libdir
[0] != '\0') {
1732 PERROR("unknown consumer type");
1736 PERROR("kernel start consumer exec");
1739 } else if (pid
> 0) {
1742 PERROR("start consumer fork");
1750 * Spawn the consumerd daemon and session daemon thread.
1752 static int start_consumerd(struct consumer_data
*consumer_data
)
1756 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1757 if (consumer_data
->pid
!= 0) {
1758 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1762 ret
= spawn_consumerd(consumer_data
);
1764 ERR("Spawning consumerd failed");
1765 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1769 /* Setting up the consumer_data pid */
1770 consumer_data
->pid
= ret
;
1771 DBG2("Consumer pid %d", consumer_data
->pid
);
1772 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1774 DBG2("Spawning consumer control thread");
1775 ret
= spawn_consumer_thread(consumer_data
);
1777 ERR("Fatal error spawning consumer control thread");
1789 * Check version of the lttng-modules.
1791 static int validate_lttng_modules_version(void)
1793 return kernel_validate_version(kernel_tracer_fd
);
1797 * Setup necessary data for kernel tracer action.
1799 static int init_kernel_tracer(void)
1803 /* Modprobe lttng kernel modules */
1804 ret
= modprobe_lttng_control();
1809 /* Open debugfs lttng */
1810 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1811 if (kernel_tracer_fd
< 0) {
1812 DBG("Failed to open %s", module_proc_lttng
);
1817 /* Validate kernel version */
1818 ret
= validate_lttng_modules_version();
1823 ret
= modprobe_lttng_data();
1828 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1832 modprobe_remove_lttng_control();
1833 ret
= close(kernel_tracer_fd
);
1837 kernel_tracer_fd
= -1;
1838 return LTTCOMM_KERN_VERSION
;
1841 ret
= close(kernel_tracer_fd
);
1847 modprobe_remove_lttng_control();
1850 WARN("No kernel tracer available");
1851 kernel_tracer_fd
= -1;
1853 return LTTCOMM_NEED_ROOT_SESSIOND
;
1855 return LTTCOMM_KERN_NA
;
1860 * Init tracing by creating trace directory and sending fds kernel consumer.
1862 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1866 if (session
->consumer_fds_sent
== 0) {
1868 * Assign default kernel consumer socket if no consumer assigned to the
1869 * kernel session. At this point, it's NOT supposed to be -1 but this is
1870 * an extra security check.
1872 if (session
->consumer_fd
< 0) {
1873 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1876 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1878 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1882 session
->consumer_fds_sent
= 1;
1890 * Create an UST session and add it to the session ust list.
1892 static int create_ust_session(struct ltt_session
*session
,
1893 struct lttng_domain
*domain
)
1895 struct ltt_ust_session
*lus
= NULL
;
1898 switch (domain
->type
) {
1899 case LTTNG_DOMAIN_UST
:
1902 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1906 DBG("Creating UST session");
1908 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1910 ret
= LTTCOMM_UST_SESS_FAIL
;
1914 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1915 session
->uid
, session
->gid
);
1917 if (ret
!= -EEXIST
) {
1918 ERR("Trace directory creation error");
1919 ret
= LTTCOMM_UST_SESS_FAIL
;
1924 /* The domain type dictate different actions on session creation */
1925 switch (domain
->type
) {
1926 case LTTNG_DOMAIN_UST
:
1927 /* No ustctl for the global UST domain */
1930 ERR("Unknown UST domain on create session %d", domain
->type
);
1933 lus
->uid
= session
->uid
;
1934 lus
->gid
= session
->gid
;
1935 session
->ust_session
= lus
;
1945 * Create a kernel tracer session then create the default channel.
1947 static int create_kernel_session(struct ltt_session
*session
)
1951 DBG("Creating kernel session");
1953 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1955 ret
= LTTCOMM_KERN_SESS_FAIL
;
1959 /* Set kernel consumer socket fd */
1960 if (kconsumer_data
.cmd_sock
>= 0) {
1961 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1964 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1965 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1967 if (ret
!= -EEXIST
) {
1968 ERR("Trace directory creation error");
1972 session
->kernel_session
->uid
= session
->uid
;
1973 session
->kernel_session
->gid
= session
->gid
;
1980 * Check if the UID or GID match the session. Root user has access to all
1983 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1985 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1992 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1995 struct ltt_session
*session
;
1997 DBG("Counting number of available session for UID %d GID %d",
1999 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2001 * Only list the sessions the user can control.
2003 if (!session_access_ok(session
, uid
, gid
)) {
2012 * Using the session list, filled a lttng_session array to send back to the
2013 * client for session listing.
2015 * The session list lock MUST be acquired before calling this function. Use
2016 * session_lock_list() and session_unlock_list().
2018 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2022 struct ltt_session
*session
;
2024 DBG("Getting all available session for UID %d GID %d",
2027 * Iterate over session list and append data after the control struct in
2030 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2032 * Only list the sessions the user can control.
2034 if (!session_access_ok(session
, uid
, gid
)) {
2037 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2038 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2039 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2040 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2041 sessions
[i
].enabled
= session
->enabled
;
2047 * Fill lttng_channel array of all channels.
2049 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2050 struct lttng_channel
*channels
)
2053 struct ltt_kernel_channel
*kchan
;
2055 DBG("Listing channels for session %s", session
->name
);
2058 case LTTNG_DOMAIN_KERNEL
:
2059 /* Kernel channels */
2060 if (session
->kernel_session
!= NULL
) {
2061 cds_list_for_each_entry(kchan
,
2062 &session
->kernel_session
->channel_list
.head
, list
) {
2063 /* Copy lttng_channel struct to array */
2064 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2065 channels
[i
].enabled
= kchan
->enabled
;
2070 case LTTNG_DOMAIN_UST
:
2072 struct lttng_ht_iter iter
;
2073 struct ltt_ust_channel
*uchan
;
2075 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2076 &iter
.iter
, uchan
, node
.node
) {
2077 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2078 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2079 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2080 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2081 channels
[i
].attr
.switch_timer_interval
=
2082 uchan
->attr
.switch_timer_interval
;
2083 channels
[i
].attr
.read_timer_interval
=
2084 uchan
->attr
.read_timer_interval
;
2085 channels
[i
].enabled
= uchan
->enabled
;
2086 switch (uchan
->attr
.output
) {
2087 case LTTNG_UST_MMAP
:
2089 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2102 * Create a list of ust global domain events.
2104 static int list_lttng_ust_global_events(char *channel_name
,
2105 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2108 unsigned int nb_event
= 0;
2109 struct lttng_ht_iter iter
;
2110 struct lttng_ht_node_str
*node
;
2111 struct ltt_ust_channel
*uchan
;
2112 struct ltt_ust_event
*uevent
;
2113 struct lttng_event
*tmp
;
2115 DBG("Listing UST global events for channel %s", channel_name
);
2119 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2120 node
= lttng_ht_iter_get_node_str(&iter
);
2122 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2126 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2128 nb_event
+= lttng_ht_get_count(uchan
->events
);
2130 if (nb_event
== 0) {
2135 DBG3("Listing UST global %d events", nb_event
);
2137 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2139 ret
= -LTTCOMM_FATAL
;
2143 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2144 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2145 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2146 tmp
[i
].enabled
= uevent
->enabled
;
2147 switch (uevent
->attr
.instrumentation
) {
2148 case LTTNG_UST_TRACEPOINT
:
2149 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2151 case LTTNG_UST_PROBE
:
2152 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2154 case LTTNG_UST_FUNCTION
:
2155 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2158 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2159 switch (uevent
->attr
.loglevel_type
) {
2160 case LTTNG_UST_LOGLEVEL_ALL
:
2161 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2163 case LTTNG_UST_LOGLEVEL_RANGE
:
2164 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2166 case LTTNG_UST_LOGLEVEL_SINGLE
:
2167 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2182 * Fill lttng_event array of all kernel events in the channel.
2184 static int list_lttng_kernel_events(char *channel_name
,
2185 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2188 unsigned int nb_event
;
2189 struct ltt_kernel_event
*event
;
2190 struct ltt_kernel_channel
*kchan
;
2192 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2193 if (kchan
== NULL
) {
2194 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2198 nb_event
= kchan
->event_count
;
2200 DBG("Listing events for channel %s", kchan
->channel
->name
);
2202 if (nb_event
== 0) {
2207 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2208 if (*events
== NULL
) {
2209 ret
= LTTCOMM_FATAL
;
2213 /* Kernel channels */
2214 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2215 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2216 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2217 (*events
)[i
].enabled
= event
->enabled
;
2218 switch (event
->event
->instrumentation
) {
2219 case LTTNG_KERNEL_TRACEPOINT
:
2220 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2222 case LTTNG_KERNEL_KPROBE
:
2223 case LTTNG_KERNEL_KRETPROBE
:
2224 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2225 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2226 sizeof(struct lttng_kernel_kprobe
));
2228 case LTTNG_KERNEL_FUNCTION
:
2229 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2230 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2231 sizeof(struct lttng_kernel_function
));
2233 case LTTNG_KERNEL_NOOP
:
2234 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2236 case LTTNG_KERNEL_SYSCALL
:
2237 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2239 case LTTNG_KERNEL_ALL
:
2253 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2255 static int cmd_disable_channel(struct ltt_session
*session
,
2256 int domain
, char *channel_name
)
2259 struct ltt_ust_session
*usess
;
2261 usess
= session
->ust_session
;
2264 case LTTNG_DOMAIN_KERNEL
:
2266 ret
= channel_kernel_disable(session
->kernel_session
,
2268 if (ret
!= LTTCOMM_OK
) {
2272 kernel_wait_quiescent(kernel_tracer_fd
);
2275 case LTTNG_DOMAIN_UST
:
2277 struct ltt_ust_channel
*uchan
;
2278 struct lttng_ht
*chan_ht
;
2280 chan_ht
= usess
->domain_global
.channels
;
2282 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2283 if (uchan
== NULL
) {
2284 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2288 ret
= channel_ust_disable(usess
, domain
, uchan
);
2289 if (ret
!= LTTCOMM_OK
) {
2295 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2296 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2297 case LTTNG_DOMAIN_UST_PID
:
2300 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2311 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2313 static int cmd_enable_channel(struct ltt_session
*session
,
2314 int domain
, struct lttng_channel
*attr
)
2317 struct ltt_ust_session
*usess
= session
->ust_session
;
2318 struct lttng_ht
*chan_ht
;
2320 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2323 case LTTNG_DOMAIN_KERNEL
:
2325 struct ltt_kernel_channel
*kchan
;
2327 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2328 session
->kernel_session
);
2329 if (kchan
== NULL
) {
2330 ret
= channel_kernel_create(session
->kernel_session
,
2331 attr
, kernel_poll_pipe
[1]);
2333 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2336 if (ret
!= LTTCOMM_OK
) {
2340 kernel_wait_quiescent(kernel_tracer_fd
);
2343 case LTTNG_DOMAIN_UST
:
2345 struct ltt_ust_channel
*uchan
;
2347 chan_ht
= usess
->domain_global
.channels
;
2349 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2350 if (uchan
== NULL
) {
2351 ret
= channel_ust_create(usess
, domain
, attr
);
2353 ret
= channel_ust_enable(usess
, domain
, uchan
);
2358 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2359 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2360 case LTTNG_DOMAIN_UST_PID
:
2363 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2372 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2374 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2375 char *channel_name
, char *event_name
)
2380 case LTTNG_DOMAIN_KERNEL
:
2382 struct ltt_kernel_channel
*kchan
;
2383 struct ltt_kernel_session
*ksess
;
2385 ksess
= session
->kernel_session
;
2387 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2388 if (kchan
== NULL
) {
2389 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2393 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2394 if (ret
!= LTTCOMM_OK
) {
2398 kernel_wait_quiescent(kernel_tracer_fd
);
2401 case LTTNG_DOMAIN_UST
:
2403 struct ltt_ust_channel
*uchan
;
2404 struct ltt_ust_session
*usess
;
2406 usess
= session
->ust_session
;
2408 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2410 if (uchan
== NULL
) {
2411 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2415 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2416 if (ret
!= LTTCOMM_OK
) {
2420 DBG3("Disable UST event %s in channel %s completed", event_name
,
2425 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2426 case LTTNG_DOMAIN_UST_PID
:
2427 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2441 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2443 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2449 case LTTNG_DOMAIN_KERNEL
:
2451 struct ltt_kernel_session
*ksess
;
2452 struct ltt_kernel_channel
*kchan
;
2454 ksess
= session
->kernel_session
;
2456 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2457 if (kchan
== NULL
) {
2458 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2462 ret
= event_kernel_disable_all(ksess
, kchan
);
2463 if (ret
!= LTTCOMM_OK
) {
2467 kernel_wait_quiescent(kernel_tracer_fd
);
2470 case LTTNG_DOMAIN_UST
:
2472 struct ltt_ust_session
*usess
;
2473 struct ltt_ust_channel
*uchan
;
2475 usess
= session
->ust_session
;
2477 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2479 if (uchan
== NULL
) {
2480 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2484 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2489 DBG3("Disable all UST events in channel %s completed", channel_name
);
2494 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2495 case LTTNG_DOMAIN_UST_PID
:
2496 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2510 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2512 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2513 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2518 case LTTNG_DOMAIN_KERNEL
:
2519 /* Add kernel context to kernel tracer */
2520 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2521 event_name
, channel_name
);
2522 if (ret
!= LTTCOMM_OK
) {
2526 case LTTNG_DOMAIN_UST
:
2528 struct ltt_ust_session
*usess
= session
->ust_session
;
2530 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2531 if (ret
!= LTTCOMM_OK
) {
2537 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2538 case LTTNG_DOMAIN_UST_PID
:
2539 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2553 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2555 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2556 char *channel_name
, struct lttng_event
*event
)
2559 struct lttng_channel
*attr
;
2560 struct ltt_ust_session
*usess
= session
->ust_session
;
2563 case LTTNG_DOMAIN_KERNEL
:
2565 struct ltt_kernel_channel
*kchan
;
2567 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2568 session
->kernel_session
);
2569 if (kchan
== NULL
) {
2570 attr
= channel_new_default_attr(domain
);
2572 ret
= LTTCOMM_FATAL
;
2575 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2577 /* This call will notify the kernel thread */
2578 ret
= channel_kernel_create(session
->kernel_session
,
2579 attr
, kernel_poll_pipe
[1]);
2580 if (ret
!= LTTCOMM_OK
) {
2587 /* Get the newly created kernel channel pointer */
2588 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2589 session
->kernel_session
);
2590 if (kchan
== NULL
) {
2591 /* This sould not happen... */
2592 ret
= LTTCOMM_FATAL
;
2596 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2598 if (ret
!= LTTCOMM_OK
) {
2602 kernel_wait_quiescent(kernel_tracer_fd
);
2605 case LTTNG_DOMAIN_UST
:
2607 struct lttng_channel
*attr
;
2608 struct ltt_ust_channel
*uchan
;
2610 /* Get channel from global UST domain */
2611 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2613 if (uchan
== NULL
) {
2614 /* Create default channel */
2615 attr
= channel_new_default_attr(domain
);
2617 ret
= LTTCOMM_FATAL
;
2620 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2621 attr
->name
[NAME_MAX
- 1] = '\0';
2623 ret
= channel_ust_create(usess
, domain
, attr
);
2624 if (ret
!= LTTCOMM_OK
) {
2630 /* Get the newly created channel reference back */
2631 uchan
= trace_ust_find_channel_by_name(
2632 usess
->domain_global
.channels
, channel_name
);
2633 if (uchan
== NULL
) {
2634 /* Something is really wrong */
2635 ret
= LTTCOMM_FATAL
;
2640 /* At this point, the session and channel exist on the tracer */
2641 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2642 if (ret
!= LTTCOMM_OK
) {
2648 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2649 case LTTNG_DOMAIN_UST_PID
:
2650 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2664 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2666 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2667 char *channel_name
, int event_type
)
2670 struct ltt_kernel_channel
*kchan
;
2673 case LTTNG_DOMAIN_KERNEL
:
2674 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2675 session
->kernel_session
);
2676 if (kchan
== NULL
) {
2677 /* This call will notify the kernel thread */
2678 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2679 kernel_poll_pipe
[1]);
2680 if (ret
!= LTTCOMM_OK
) {
2684 /* Get the newly created kernel channel pointer */
2685 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2686 session
->kernel_session
);
2687 if (kchan
== NULL
) {
2688 /* This sould not happen... */
2689 ret
= LTTCOMM_FATAL
;
2695 switch (event_type
) {
2696 case LTTNG_EVENT_SYSCALL
:
2697 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2698 kchan
, kernel_tracer_fd
);
2700 case LTTNG_EVENT_TRACEPOINT
:
2702 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2703 * events already registered to the channel.
2705 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2706 kchan
, kernel_tracer_fd
);
2708 case LTTNG_EVENT_ALL
:
2709 /* Enable syscalls and tracepoints */
2710 ret
= event_kernel_enable_all(session
->kernel_session
,
2711 kchan
, kernel_tracer_fd
);
2714 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2718 /* Manage return value */
2719 if (ret
!= LTTCOMM_OK
) {
2723 kernel_wait_quiescent(kernel_tracer_fd
);
2725 case LTTNG_DOMAIN_UST
:
2727 struct lttng_channel
*attr
;
2728 struct ltt_ust_channel
*uchan
;
2729 struct ltt_ust_session
*usess
= session
->ust_session
;
2731 /* Get channel from global UST domain */
2732 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2734 if (uchan
== NULL
) {
2735 /* Create default channel */
2736 attr
= channel_new_default_attr(domain
);
2738 ret
= LTTCOMM_FATAL
;
2741 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2742 attr
->name
[NAME_MAX
- 1] = '\0';
2744 /* Use the internal command enable channel */
2745 ret
= channel_ust_create(usess
, domain
, attr
);
2746 if (ret
!= LTTCOMM_OK
) {
2752 /* Get the newly created channel reference back */
2753 uchan
= trace_ust_find_channel_by_name(
2754 usess
->domain_global
.channels
, channel_name
);
2755 if (uchan
== NULL
) {
2756 /* Something is really wrong */
2757 ret
= LTTCOMM_FATAL
;
2762 /* At this point, the session and channel exist on the tracer */
2764 switch (event_type
) {
2765 case LTTNG_EVENT_ALL
:
2766 case LTTNG_EVENT_TRACEPOINT
:
2767 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2768 if (ret
!= LTTCOMM_OK
) {
2773 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2777 /* Manage return value */
2778 if (ret
!= LTTCOMM_OK
) {
2785 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2786 case LTTNG_DOMAIN_UST_PID
:
2787 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2801 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2803 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2806 ssize_t nb_events
= 0;
2809 case LTTNG_DOMAIN_KERNEL
:
2810 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2811 if (nb_events
< 0) {
2812 ret
= LTTCOMM_KERN_LIST_FAIL
;
2816 case LTTNG_DOMAIN_UST
:
2817 nb_events
= ust_app_list_events(events
);
2818 if (nb_events
< 0) {
2819 ret
= LTTCOMM_UST_LIST_FAIL
;
2831 /* Return negative value to differentiate return code */
2836 * Command LTTNG_START_TRACE processed by the client thread.
2838 static int cmd_start_trace(struct ltt_session
*session
)
2841 struct ltt_kernel_session
*ksession
;
2842 struct ltt_ust_session
*usess
;
2845 ksession
= session
->kernel_session
;
2846 usess
= session
->ust_session
;
2848 if (session
->enabled
) {
2849 /* Already started. */
2850 ret
= LTTCOMM_TRACE_ALREADY_STARTED
;
2854 session
->enabled
= 1;
2856 /* Kernel tracing */
2857 if (ksession
!= NULL
) {
2858 struct ltt_kernel_channel
*kchan
;
2860 /* Open kernel metadata */
2861 if (ksession
->metadata
== NULL
) {
2862 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2864 ret
= LTTCOMM_KERN_META_FAIL
;
2869 /* Open kernel metadata stream */
2870 if (ksession
->metadata_stream_fd
< 0) {
2871 ret
= kernel_open_metadata_stream(ksession
);
2873 ERR("Kernel create metadata stream failed");
2874 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2879 /* For each channel */
2880 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2881 if (kchan
->stream_count
== 0) {
2882 ret
= kernel_open_channel_stream(kchan
);
2884 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2887 /* Update the stream global counter */
2888 ksession
->stream_count_global
+= ret
;
2892 /* Setup kernel consumer socket and send fds to it */
2893 ret
= init_kernel_tracing(ksession
);
2895 ret
= LTTCOMM_KERN_START_FAIL
;
2899 /* This start the kernel tracing */
2900 ret
= kernel_start_session(ksession
);
2902 ret
= LTTCOMM_KERN_START_FAIL
;
2906 /* Quiescent wait after starting trace */
2907 kernel_wait_quiescent(kernel_tracer_fd
);
2910 /* Flag session that trace should start automatically */
2912 usess
->start_trace
= 1;
2914 ret
= ust_app_start_trace_all(usess
);
2916 ret
= LTTCOMM_UST_START_FAIL
;
2928 * Command LTTNG_STOP_TRACE processed by the client thread.
2930 static int cmd_stop_trace(struct ltt_session
*session
)
2933 struct ltt_kernel_channel
*kchan
;
2934 struct ltt_kernel_session
*ksession
;
2935 struct ltt_ust_session
*usess
;
2938 ksession
= session
->kernel_session
;
2939 usess
= session
->ust_session
;
2941 if (!session
->enabled
) {
2942 ret
= LTTCOMM_TRACE_ALREADY_STOPPED
;
2946 session
->enabled
= 0;
2949 if (ksession
!= NULL
) {
2950 DBG("Stop kernel tracing");
2952 /* Flush all buffers before stopping */
2953 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2955 ERR("Kernel metadata flush failed");
2958 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2959 ret
= kernel_flush_buffer(kchan
);
2961 ERR("Kernel flush buffer error");
2965 ret
= kernel_stop_session(ksession
);
2967 ret
= LTTCOMM_KERN_STOP_FAIL
;
2971 kernel_wait_quiescent(kernel_tracer_fd
);
2975 usess
->start_trace
= 0;
2977 ret
= ust_app_stop_trace_all(usess
);
2979 ret
= LTTCOMM_UST_STOP_FAIL
;
2991 * Command LTTNG_CREATE_SESSION processed by the client thread.
2993 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2997 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2998 LTTNG_SOCK_GET_GID_CRED(creds
));
2999 if (ret
!= LTTCOMM_OK
) {
3010 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3012 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3016 /* Clean kernel session teardown */
3017 teardown_kernel_session(session
);
3018 /* UST session teardown */
3019 teardown_ust_session(session
);
3022 * Must notify the kernel thread here to update it's poll setin order
3023 * to remove the channel(s)' fd just destroyed.
3025 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3027 PERROR("write kernel poll pipe");
3030 ret
= session_destroy(session
);
3036 * Command LTTNG_CALIBRATE processed by the client thread.
3038 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3043 case LTTNG_DOMAIN_KERNEL
:
3045 struct lttng_kernel_calibrate kcalibrate
;
3047 kcalibrate
.type
= calibrate
->type
;
3048 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3050 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3055 case LTTNG_DOMAIN_UST
:
3057 struct lttng_ust_calibrate ucalibrate
;
3059 ucalibrate
.type
= calibrate
->type
;
3060 ret
= ust_app_calibrate_glb(&ucalibrate
);
3062 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3079 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3081 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3087 case LTTNG_DOMAIN_KERNEL
:
3088 /* Can't register a consumer if there is already one */
3089 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3090 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3094 sock
= lttcomm_connect_unix_sock(sock_path
);
3096 ret
= LTTCOMM_CONNECT_FAIL
;
3100 session
->kernel_session
->consumer_fd
= sock
;
3103 /* TODO: Userspace tracing */
3115 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3117 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3118 struct lttng_domain
**domains
)
3123 if (session
->kernel_session
!= NULL
) {
3124 DBG3("Listing domains found kernel domain");
3128 if (session
->ust_session
!= NULL
) {
3129 DBG3("Listing domains found UST global domain");
3133 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3134 if (*domains
== NULL
) {
3135 ret
= -LTTCOMM_FATAL
;
3139 if (session
->kernel_session
!= NULL
) {
3140 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3144 if (session
->ust_session
!= NULL
) {
3145 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3156 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3158 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3159 struct lttng_channel
**channels
)
3162 ssize_t nb_chan
= 0;
3165 case LTTNG_DOMAIN_KERNEL
:
3166 if (session
->kernel_session
!= NULL
) {
3167 nb_chan
= session
->kernel_session
->channel_count
;
3169 DBG3("Number of kernel channels %zd", nb_chan
);
3171 case LTTNG_DOMAIN_UST
:
3172 if (session
->ust_session
!= NULL
) {
3173 nb_chan
= lttng_ht_get_count(
3174 session
->ust_session
->domain_global
.channels
);
3176 DBG3("Number of UST global channels %zd", nb_chan
);
3185 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3186 if (*channels
== NULL
) {
3187 ret
= -LTTCOMM_FATAL
;
3191 list_lttng_channels(domain
, session
, *channels
);
3203 * Command LTTNG_LIST_EVENTS processed by the client thread.
3205 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3206 char *channel_name
, struct lttng_event
**events
)
3209 ssize_t nb_event
= 0;
3212 case LTTNG_DOMAIN_KERNEL
:
3213 if (session
->kernel_session
!= NULL
) {
3214 nb_event
= list_lttng_kernel_events(channel_name
,
3215 session
->kernel_session
, events
);
3218 case LTTNG_DOMAIN_UST
:
3220 if (session
->ust_session
!= NULL
) {
3221 nb_event
= list_lttng_ust_global_events(channel_name
,
3222 &session
->ust_session
->domain_global
, events
);
3238 * Process the command requested by the lttng client within the command
3239 * context structure. This function make sure that the return structure (llm)
3240 * is set and ready for transmission before returning.
3242 * Return any error encountered or 0 for success.
3244 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3246 int ret
= LTTCOMM_OK
;
3247 int need_tracing_session
= 1;
3250 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3252 switch (cmd_ctx
->lsm
->cmd_type
) {
3253 case LTTNG_CREATE_SESSION
:
3254 case LTTNG_DESTROY_SESSION
:
3255 case LTTNG_LIST_SESSIONS
:
3256 case LTTNG_LIST_DOMAINS
:
3257 case LTTNG_START_TRACE
:
3258 case LTTNG_STOP_TRACE
:
3265 if (opt_no_kernel
&& need_domain
3266 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3268 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3270 ret
= LTTCOMM_KERN_NA
;
3276 * Check for command that don't needs to allocate a returned payload. We do
3277 * this here so we don't have to make the call for no payload at each
3280 switch(cmd_ctx
->lsm
->cmd_type
) {
3281 case LTTNG_LIST_SESSIONS
:
3282 case LTTNG_LIST_TRACEPOINTS
:
3283 case LTTNG_LIST_DOMAINS
:
3284 case LTTNG_LIST_CHANNELS
:
3285 case LTTNG_LIST_EVENTS
:
3288 /* Setup lttng message with no payload */
3289 ret
= setup_lttng_msg(cmd_ctx
, 0);
3291 /* This label does not try to unlock the session */
3292 goto init_setup_error
;
3296 /* Commands that DO NOT need a session. */
3297 switch (cmd_ctx
->lsm
->cmd_type
) {
3298 case LTTNG_CREATE_SESSION
:
3299 case LTTNG_CALIBRATE
:
3300 case LTTNG_LIST_SESSIONS
:
3301 case LTTNG_LIST_TRACEPOINTS
:
3302 need_tracing_session
= 0;
3305 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3306 session_lock_list();
3307 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3308 session_unlock_list();
3309 if (cmd_ctx
->session
== NULL
) {
3310 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3311 ret
= LTTCOMM_SESS_NOT_FOUND
;
3313 /* If no session name specified */
3314 ret
= LTTCOMM_SELECT_SESS
;
3318 /* Acquire lock for the session */
3319 session_lock(cmd_ctx
->session
);
3328 * Check domain type for specific "pre-action".
3330 switch (cmd_ctx
->lsm
->domain
.type
) {
3331 case LTTNG_DOMAIN_KERNEL
:
3333 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3337 /* Kernel tracer check */
3338 if (kernel_tracer_fd
== -1) {
3339 /* Basically, load kernel tracer modules */
3340 ret
= init_kernel_tracer();
3346 /* Need a session for kernel command */
3347 if (need_tracing_session
) {
3348 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3349 ret
= create_kernel_session(cmd_ctx
->session
);
3351 ret
= LTTCOMM_KERN_SESS_FAIL
;
3356 /* Start the kernel consumer daemon */
3357 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3358 if (kconsumer_data
.pid
== 0 &&
3359 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3360 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3361 ret
= start_consumerd(&kconsumer_data
);
3363 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3367 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3371 case LTTNG_DOMAIN_UST
:
3373 if (need_tracing_session
) {
3374 if (cmd_ctx
->session
->ust_session
== NULL
) {
3375 ret
= create_ust_session(cmd_ctx
->session
,
3376 &cmd_ctx
->lsm
->domain
);
3377 if (ret
!= LTTCOMM_OK
) {
3381 /* Start the UST consumer daemons */
3383 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3384 if (consumerd64_bin
[0] != '\0' &&
3385 ustconsumer64_data
.pid
== 0 &&
3386 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3387 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3388 ret
= start_consumerd(&ustconsumer64_data
);
3390 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3391 ust_consumerd64_fd
= -EINVAL
;
3395 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3397 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3400 if (consumerd32_bin
[0] != '\0' &&
3401 ustconsumer32_data
.pid
== 0 &&
3402 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3403 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3404 ret
= start_consumerd(&ustconsumer32_data
);
3406 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3407 ust_consumerd32_fd
= -EINVAL
;
3410 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3412 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3423 * Check that the UID or GID match that of the tracing session.
3424 * The root user can interact with all sessions.
3426 if (need_tracing_session
) {
3427 if (!session_access_ok(cmd_ctx
->session
,
3428 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3429 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3430 ret
= LTTCOMM_EPERM
;
3435 /* Process by command type */
3436 switch (cmd_ctx
->lsm
->cmd_type
) {
3437 case LTTNG_ADD_CONTEXT
:
3439 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3440 cmd_ctx
->lsm
->u
.context
.channel_name
,
3441 cmd_ctx
->lsm
->u
.context
.event_name
,
3442 &cmd_ctx
->lsm
->u
.context
.ctx
);
3445 case LTTNG_DISABLE_CHANNEL
:
3447 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3448 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3451 case LTTNG_DISABLE_EVENT
:
3453 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3454 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3455 cmd_ctx
->lsm
->u
.disable
.name
);
3458 case LTTNG_DISABLE_ALL_EVENT
:
3460 DBG("Disabling all events");
3462 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3463 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3466 case LTTNG_ENABLE_CHANNEL
:
3468 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3469 &cmd_ctx
->lsm
->u
.channel
.chan
);
3472 case LTTNG_ENABLE_EVENT
:
3474 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3475 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3476 &cmd_ctx
->lsm
->u
.enable
.event
);
3479 case LTTNG_ENABLE_ALL_EVENT
:
3481 DBG("Enabling all events");
3483 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3484 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3485 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3488 case LTTNG_LIST_TRACEPOINTS
:
3490 struct lttng_event
*events
;
3493 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3494 if (nb_events
< 0) {
3500 * Setup lttng message with payload size set to the event list size in
3501 * bytes and then copy list into the llm payload.
3503 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3509 /* Copy event list into message payload */
3510 memcpy(cmd_ctx
->llm
->payload
, events
,
3511 sizeof(struct lttng_event
) * nb_events
);
3518 case LTTNG_START_TRACE
:
3520 ret
= cmd_start_trace(cmd_ctx
->session
);
3523 case LTTNG_STOP_TRACE
:
3525 ret
= cmd_stop_trace(cmd_ctx
->session
);
3528 case LTTNG_CREATE_SESSION
:
3530 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3531 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3534 case LTTNG_DESTROY_SESSION
:
3536 ret
= cmd_destroy_session(cmd_ctx
->session
,
3537 cmd_ctx
->lsm
->session
.name
);
3540 case LTTNG_LIST_DOMAINS
:
3543 struct lttng_domain
*domains
;
3545 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3551 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3556 /* Copy event list into message payload */
3557 memcpy(cmd_ctx
->llm
->payload
, domains
,
3558 nb_dom
* sizeof(struct lttng_domain
));
3565 case LTTNG_LIST_CHANNELS
:
3568 struct lttng_channel
*channels
;
3570 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3571 cmd_ctx
->session
, &channels
);
3577 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3582 /* Copy event list into message payload */
3583 memcpy(cmd_ctx
->llm
->payload
, channels
,
3584 nb_chan
* sizeof(struct lttng_channel
));
3591 case LTTNG_LIST_EVENTS
:
3594 struct lttng_event
*events
= NULL
;
3596 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3597 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3603 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3608 /* Copy event list into message payload */
3609 memcpy(cmd_ctx
->llm
->payload
, events
,
3610 nb_event
* sizeof(struct lttng_event
));
3617 case LTTNG_LIST_SESSIONS
:
3619 unsigned int nr_sessions
;
3621 session_lock_list();
3622 nr_sessions
= lttng_sessions_count(
3623 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3624 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3626 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3628 session_unlock_list();
3632 /* Filled the session array */
3633 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3634 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3635 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3637 session_unlock_list();
3642 case LTTNG_CALIBRATE
:
3644 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3645 &cmd_ctx
->lsm
->u
.calibrate
);
3648 case LTTNG_REGISTER_CONSUMER
:
3650 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3651 cmd_ctx
->lsm
->u
.reg
.path
);
3660 if (cmd_ctx
->llm
== NULL
) {
3661 DBG("Missing llm structure. Allocating one.");
3662 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3666 /* Set return code */
3667 cmd_ctx
->llm
->ret_code
= ret
;
3669 if (cmd_ctx
->session
) {
3670 session_unlock(cmd_ctx
->session
);
3677 * This thread manage all clients request using the unix client socket for
3680 static void *thread_manage_clients(void *data
)
3682 int sock
= -1, ret
, i
, pollfd
;
3683 uint32_t revents
, nb_fd
;
3684 struct command_ctx
*cmd_ctx
= NULL
;
3685 struct lttng_poll_event events
;
3687 DBG("[thread] Manage client started");
3689 rcu_register_thread();
3691 ret
= lttcomm_listen_unix_sock(client_sock
);
3697 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3698 * more will be added to this poll set.
3700 ret
= create_thread_poll_set(&events
, 2);
3705 /* Add the application registration socket */
3706 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3712 * Notify parent pid that we are ready to accept command for client side.
3714 if (opt_sig_parent
) {
3715 kill(ppid
, SIGUSR1
);
3719 DBG("Accepting client command ...");
3721 nb_fd
= LTTNG_POLL_GETNB(&events
);
3723 /* Inifinite blocking call, waiting for transmission */
3725 ret
= lttng_poll_wait(&events
, -1);
3728 * Restart interrupted system call.
3730 if (errno
== EINTR
) {
3736 for (i
= 0; i
< nb_fd
; i
++) {
3737 /* Fetch once the poll data */
3738 revents
= LTTNG_POLL_GETEV(&events
, i
);
3739 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3741 /* Thread quit pipe has been closed. Killing thread. */
3742 ret
= check_thread_quit_pipe(pollfd
, revents
);
3747 /* Event on the registration socket */
3748 if (pollfd
== client_sock
) {
3749 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3750 ERR("Client socket poll error");
3756 DBG("Wait for client response");
3758 sock
= lttcomm_accept_unix_sock(client_sock
);
3763 /* Set socket option for credentials retrieval */
3764 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3769 /* Allocate context command to process the client request */
3770 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3771 if (cmd_ctx
== NULL
) {
3772 PERROR("zmalloc cmd_ctx");
3776 /* Allocate data buffer for reception */
3777 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3778 if (cmd_ctx
->lsm
== NULL
) {
3779 PERROR("zmalloc cmd_ctx->lsm");
3783 cmd_ctx
->llm
= NULL
;
3784 cmd_ctx
->session
= NULL
;
3787 * Data is received from the lttng client. The struct
3788 * lttcomm_session_msg (lsm) contains the command and data request of
3791 DBG("Receiving data from client ...");
3792 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3793 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3795 DBG("Nothing recv() from client... continuing");
3801 clean_command_ctx(&cmd_ctx
);
3805 // TODO: Validate cmd_ctx including sanity check for
3806 // security purpose.
3808 rcu_thread_online();
3810 * This function dispatch the work to the kernel or userspace tracer
3811 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3812 * informations for the client. The command context struct contains
3813 * everything this function may needs.
3815 ret
= process_client_msg(cmd_ctx
);
3816 rcu_thread_offline();
3819 * TODO: Inform client somehow of the fatal error. At
3820 * this point, ret < 0 means that a zmalloc failed
3821 * (ENOMEM). Error detected but still accept command.
3823 clean_command_ctx(&cmd_ctx
);
3827 DBG("Sending response (size: %d, retcode: %s)",
3828 cmd_ctx
->lttng_msg_size
,
3829 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3830 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3832 ERR("Failed to send data back to client");
3835 /* End of transmission */
3842 clean_command_ctx(&cmd_ctx
);
3846 DBG("Client thread dying");
3847 unlink(client_unix_sock_path
);
3848 if (client_sock
>= 0) {
3849 ret
= close(client_sock
);
3861 lttng_poll_clean(&events
);
3862 clean_command_ctx(&cmd_ctx
);
3864 rcu_unregister_thread();
3870 * usage function on stderr
3872 static void usage(void)
3874 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3875 fprintf(stderr
, " -h, --help Display this usage.\n");
3876 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3877 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3878 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3879 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3880 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3881 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3882 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3883 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3884 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3885 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3886 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3887 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3888 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3889 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3890 fprintf(stderr
, " -V, --version Show version number.\n");
3891 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3892 fprintf(stderr
, " -q, --quiet No output at all.\n");
3893 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3894 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3895 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3899 * daemon argument parsing
3901 static int parse_args(int argc
, char **argv
)
3905 static struct option long_options
[] = {
3906 { "client-sock", 1, 0, 'c' },
3907 { "apps-sock", 1, 0, 'a' },
3908 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3909 { "kconsumerd-err-sock", 1, 0, 'E' },
3910 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3911 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3912 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3913 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3914 { "consumerd32-path", 1, 0, 'u' },
3915 { "consumerd32-libdir", 1, 0, 'U' },
3916 { "consumerd64-path", 1, 0, 't' },
3917 { "consumerd64-libdir", 1, 0, 'T' },
3918 { "daemonize", 0, 0, 'd' },
3919 { "sig-parent", 0, 0, 'S' },
3920 { "help", 0, 0, 'h' },
3921 { "group", 1, 0, 'g' },
3922 { "version", 0, 0, 'V' },
3923 { "quiet", 0, 0, 'q' },
3924 { "verbose", 0, 0, 'v' },
3925 { "verbose-consumer", 0, 0, 'Z' },
3926 { "no-kernel", 0, 0, 'N' },
3931 int option_index
= 0;
3932 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3933 long_options
, &option_index
);
3940 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3942 fprintf(stderr
, " with arg %s\n", optarg
);
3946 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3949 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3955 opt_tracing_group
= optarg
;
3961 fprintf(stdout
, "%s\n", VERSION
);
3967 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3970 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3973 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3976 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3979 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3982 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3988 lttng_opt_quiet
= 1;
3991 /* Verbose level can increase using multiple -v */
3992 lttng_opt_verbose
+= 1;
3995 opt_verbose_consumer
+= 1;
3998 consumerd32_bin
= optarg
;
4001 consumerd32_libdir
= optarg
;
4004 consumerd64_bin
= optarg
;
4007 consumerd64_libdir
= optarg
;
4010 /* Unknown option or other error.
4011 * Error is printed by getopt, just return */
4020 * Creates the two needed socket by the daemon.
4021 * apps_sock - The communication socket for all UST apps.
4022 * client_sock - The communication of the cli tool (lttng).
4024 static int init_daemon_socket(void)
4029 old_umask
= umask(0);
4031 /* Create client tool unix socket */
4032 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4033 if (client_sock
< 0) {
4034 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4039 /* File permission MUST be 660 */
4040 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4042 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4047 /* Create the application unix socket */
4048 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4049 if (apps_sock
< 0) {
4050 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4055 /* File permission MUST be 666 */
4056 ret
= chmod(apps_unix_sock_path
,
4057 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4059 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4070 * Check if the global socket is available, and if a daemon is answering at the
4071 * other side. If yes, error is returned.
4073 static int check_existing_daemon(void)
4075 /* Is there anybody out there ? */
4076 if (lttng_session_daemon_alive()) {
4084 * Set the tracing group gid onto the client socket.
4086 * Race window between mkdir and chown is OK because we are going from more
4087 * permissive (root.root) to less permissive (root.tracing).
4089 static int set_permissions(char *rundir
)
4094 gid
= allowed_group();
4096 WARN("No tracing group detected");
4101 /* Set lttng run dir */
4102 ret
= chown(rundir
, 0, gid
);
4104 ERR("Unable to set group on %s", rundir
);
4108 /* Ensure tracing group can search the run dir */
4109 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4111 ERR("Unable to set permissions on %s", rundir
);
4115 /* lttng client socket path */
4116 ret
= chown(client_unix_sock_path
, 0, gid
);
4118 ERR("Unable to set group on %s", client_unix_sock_path
);
4122 /* kconsumer error socket path */
4123 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4125 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4129 /* 64-bit ustconsumer error socket path */
4130 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4132 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4136 /* 32-bit ustconsumer compat32 error socket path */
4137 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4139 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4143 DBG("All permissions are set");
4150 * Create the pipe used to wake up the kernel thread.
4151 * Closed in cleanup().
4153 static int create_kernel_poll_pipe(void)
4157 ret
= pipe(kernel_poll_pipe
);
4159 PERROR("kernel poll pipe");
4163 for (i
= 0; i
< 2; i
++) {
4164 ret
= fcntl(kernel_poll_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4166 PERROR("fcntl kernel_poll_pipe");
4176 * Create the application command pipe to wake thread_manage_apps.
4177 * Closed in cleanup().
4179 static int create_apps_cmd_pipe(void)
4183 ret
= pipe(apps_cmd_pipe
);
4185 PERROR("apps cmd pipe");
4189 for (i
= 0; i
< 2; i
++) {
4190 ret
= fcntl(apps_cmd_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4192 PERROR("fcntl apps_cmd_pipe");
4202 * Create the lttng run directory needed for all global sockets and pipe.
4204 static int create_lttng_rundir(const char *rundir
)
4208 DBG3("Creating LTTng run directory: %s", rundir
);
4210 ret
= mkdir(rundir
, S_IRWXU
);
4212 if (errno
!= EEXIST
) {
4213 ERR("Unable to create %s", rundir
);
4225 * Setup sockets and directory needed by the kconsumerd communication with the
4228 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4232 char path
[PATH_MAX
];
4234 switch (consumer_data
->type
) {
4235 case LTTNG_CONSUMER_KERNEL
:
4236 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4238 case LTTNG_CONSUMER64_UST
:
4239 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4241 case LTTNG_CONSUMER32_UST
:
4242 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4245 ERR("Consumer type unknown");
4250 DBG2("Creating consumer directory: %s", path
);
4252 ret
= mkdir(path
, S_IRWXU
);
4254 if (errno
!= EEXIST
) {
4256 ERR("Failed to create %s", path
);
4262 /* Create the kconsumerd error unix socket */
4263 consumer_data
->err_sock
=
4264 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4265 if (consumer_data
->err_sock
< 0) {
4266 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4271 /* File permission MUST be 660 */
4272 ret
= chmod(consumer_data
->err_unix_sock_path
,
4273 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4275 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4285 * Signal handler for the daemon
4287 * Simply stop all worker threads, leaving main() return gracefully after
4288 * joining all threads and calling cleanup().
4290 static void sighandler(int sig
)
4294 DBG("SIGPIPE caught");
4297 DBG("SIGINT caught");
4301 DBG("SIGTERM caught");
4310 * Setup signal handler for :
4311 * SIGINT, SIGTERM, SIGPIPE
4313 static int set_signal_handler(void)
4316 struct sigaction sa
;
4319 if ((ret
= sigemptyset(&sigset
)) < 0) {
4320 PERROR("sigemptyset");
4324 sa
.sa_handler
= sighandler
;
4325 sa
.sa_mask
= sigset
;
4327 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4328 PERROR("sigaction");
4332 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4333 PERROR("sigaction");
4337 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4338 PERROR("sigaction");
4342 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4348 * Set open files limit to unlimited. This daemon can open a large number of
4349 * file descriptors in order to consumer multiple kernel traces.
4351 static void set_ulimit(void)
4356 /* The kernel does not allowed an infinite limit for open files */
4357 lim
.rlim_cur
= 65535;
4358 lim
.rlim_max
= 65535;
4360 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4362 PERROR("failed to set open files limit");
4369 int main(int argc
, char **argv
)
4373 const char *home_path
;
4375 init_kernel_workarounds();
4377 rcu_register_thread();
4379 /* Create thread quit pipe */
4380 if ((ret
= init_thread_quit_pipe()) < 0) {
4384 setup_consumerd_path();
4386 /* Parse arguments */
4388 if ((ret
= parse_args(argc
, argv
) < 0)) {
4401 /* Check if daemon is UID = 0 */
4402 is_root
= !getuid();
4405 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4407 /* Create global run dir with root access */
4408 ret
= create_lttng_rundir(rundir
);
4413 if (strlen(apps_unix_sock_path
) == 0) {
4414 snprintf(apps_unix_sock_path
, PATH_MAX
,
4415 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4418 if (strlen(client_unix_sock_path
) == 0) {
4419 snprintf(client_unix_sock_path
, PATH_MAX
,
4420 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4423 /* Set global SHM for ust */
4424 if (strlen(wait_shm_path
) == 0) {
4425 snprintf(wait_shm_path
, PATH_MAX
,
4426 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4429 /* Setup kernel consumerd path */
4430 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4431 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4432 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4433 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4435 DBG2("Kernel consumer err path: %s",
4436 kconsumer_data
.err_unix_sock_path
);
4437 DBG2("Kernel consumer cmd path: %s",
4438 kconsumer_data
.cmd_unix_sock_path
);
4440 home_path
= get_home_dir();
4441 if (home_path
== NULL
) {
4442 /* TODO: Add --socket PATH option */
4443 ERR("Can't get HOME directory for sockets creation.");
4449 * Create rundir from home path. This will create something like
4452 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4458 ret
= create_lttng_rundir(rundir
);
4463 if (strlen(apps_unix_sock_path
) == 0) {
4464 snprintf(apps_unix_sock_path
, PATH_MAX
,
4465 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4468 /* Set the cli tool unix socket path */
4469 if (strlen(client_unix_sock_path
) == 0) {
4470 snprintf(client_unix_sock_path
, PATH_MAX
,
4471 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4474 /* Set global SHM for ust */
4475 if (strlen(wait_shm_path
) == 0) {
4476 snprintf(wait_shm_path
, PATH_MAX
,
4477 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4481 DBG("Client socket path %s", client_unix_sock_path
);
4482 DBG("Application socket path %s", apps_unix_sock_path
);
4483 DBG("LTTng run directory path: %s", rundir
);
4485 /* 32 bits consumerd path setup */
4486 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4487 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4488 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4489 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4491 DBG2("UST consumer 32 bits err path: %s",
4492 ustconsumer32_data
.err_unix_sock_path
);
4493 DBG2("UST consumer 32 bits cmd path: %s",
4494 ustconsumer32_data
.cmd_unix_sock_path
);
4496 /* 64 bits consumerd path setup */
4497 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4498 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4499 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4500 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4502 DBG2("UST consumer 64 bits err path: %s",
4503 ustconsumer64_data
.err_unix_sock_path
);
4504 DBG2("UST consumer 64 bits cmd path: %s",
4505 ustconsumer64_data
.cmd_unix_sock_path
);
4508 * See if daemon already exist.
4510 if ((ret
= check_existing_daemon()) < 0) {
4511 ERR("Already running daemon.\n");
4513 * We do not goto exit because we must not cleanup()
4514 * because a daemon is already running.
4520 * Init UST app hash table. Alloc hash table before this point since
4521 * cleanup() can get called after that point.
4525 /* After this point, we can safely call cleanup() with "goto exit" */
4528 * These actions must be executed as root. We do that *after* setting up
4529 * the sockets path because we MUST make the check for another daemon using
4530 * those paths *before* trying to set the kernel consumer sockets and init
4534 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4539 /* Setup kernel tracer */
4540 if (!opt_no_kernel
) {
4541 init_kernel_tracer();
4544 /* Set ulimit for open files */
4548 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4553 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4558 if ((ret
= set_signal_handler()) < 0) {
4562 /* Setup the needed unix socket */
4563 if ((ret
= init_daemon_socket()) < 0) {
4567 /* Set credentials to socket */
4568 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4572 /* Get parent pid if -S, --sig-parent is specified. */
4573 if (opt_sig_parent
) {
4577 /* Setup the kernel pipe for waking up the kernel thread */
4578 if ((ret
= create_kernel_poll_pipe()) < 0) {
4582 /* Setup the thread apps communication pipe. */
4583 if ((ret
= create_apps_cmd_pipe()) < 0) {
4587 /* Init UST command queue. */
4588 cds_wfq_init(&ust_cmd_queue
.queue
);
4591 * Get session list pointer. This pointer MUST NOT be free(). This list is
4592 * statically declared in session.c
4594 session_list_ptr
= session_get_list();
4596 /* Set up max poll set size */
4597 lttng_poll_set_max_size();
4599 /* Create thread to manage the client socket */
4600 ret
= pthread_create(&client_thread
, NULL
,
4601 thread_manage_clients
, (void *) NULL
);
4603 PERROR("pthread_create clients");
4607 /* Create thread to dispatch registration */
4608 ret
= pthread_create(&dispatch_thread
, NULL
,
4609 thread_dispatch_ust_registration
, (void *) NULL
);
4611 PERROR("pthread_create dispatch");
4615 /* Create thread to manage application registration. */
4616 ret
= pthread_create(®_apps_thread
, NULL
,
4617 thread_registration_apps
, (void *) NULL
);
4619 PERROR("pthread_create registration");
4623 /* Create thread to manage application socket */
4624 ret
= pthread_create(&apps_thread
, NULL
,
4625 thread_manage_apps
, (void *) NULL
);
4627 PERROR("pthread_create apps");
4631 /* Create kernel thread to manage kernel event */
4632 ret
= pthread_create(&kernel_thread
, NULL
,
4633 thread_manage_kernel
, (void *) NULL
);
4635 PERROR("pthread_create kernel");
4639 ret
= pthread_join(kernel_thread
, &status
);
4641 PERROR("pthread_join");
4642 goto error
; /* join error, exit without cleanup */
4646 ret
= pthread_join(apps_thread
, &status
);
4648 PERROR("pthread_join");
4649 goto error
; /* join error, exit without cleanup */
4653 ret
= pthread_join(reg_apps_thread
, &status
);
4655 PERROR("pthread_join");
4656 goto error
; /* join error, exit without cleanup */
4660 ret
= pthread_join(dispatch_thread
, &status
);
4662 PERROR("pthread_join");
4663 goto error
; /* join error, exit without cleanup */
4667 ret
= pthread_join(client_thread
, &status
);
4669 PERROR("pthread_join");
4670 goto error
; /* join error, exit without cleanup */
4673 ret
= join_consumer_thread(&kconsumer_data
);
4675 PERROR("join_consumer");
4676 goto error
; /* join error, exit without cleanup */
4682 * cleanup() is called when no other thread is running.
4684 rcu_thread_online();
4686 rcu_thread_offline();
4687 rcu_unregister_thread();