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 it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <common/common.h>
42 #include <common/compat/poll.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
];
78 #include "benchmark.h"
81 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
82 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
83 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
84 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
87 int opt_verbose
; /* Not static for lttngerr.h */
88 int opt_verbose_consumer
; /* Not static for lttngerr.h */
89 int opt_quiet
; /* Not static for lttngerr.h */
92 const char *opt_tracing_group
;
93 static int opt_sig_parent
;
94 static int opt_daemon
;
95 static int opt_no_kernel
;
96 static int is_root
; /* Set to 1 if the daemon is running as root */
97 static pid_t ppid
; /* Parent PID for --sig-parent option */
100 /* Consumer daemon specific control data */
101 static struct consumer_data kconsumer_data
= {
102 .type
= LTTNG_CONSUMER_KERNEL
,
103 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
104 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
106 static struct consumer_data ustconsumer64_data
= {
107 .type
= LTTNG_CONSUMER64_UST
,
108 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
109 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
111 static struct consumer_data ustconsumer32_data
= {
112 .type
= LTTNG_CONSUMER32_UST
,
113 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
114 .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
;
128 static int apps_sock
;
129 static int kernel_tracer_fd
;
130 static int kernel_poll_pipe
[2];
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];
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];
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
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
304 perror("thread quit pipe");
313 * Complete teardown of a kernel session. This free all data structure related
314 * to a kernel session and update counter.
316 static void teardown_kernel_session(struct ltt_session
*session
)
318 if (!session
->kernel_session
) {
319 DBG3("No kernel session when tearing down session");
323 DBG("Tearing down kernel session");
326 * If a custom kernel consumer was registered, close the socket before
327 * tearing down the complete kernel session structure
329 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
330 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
333 trace_kernel_destroy_session(session
->kernel_session
);
337 * Complete teardown of all UST sessions. This will free everything on his path
338 * and destroy the core essence of all ust sessions :)
340 static void teardown_ust_session(struct ltt_session
*session
)
344 if (!session
->ust_session
) {
345 DBG3("No UST session when tearing down session");
349 DBG("Tearing down UST session(s)");
351 ret
= ust_app_destroy_trace_all(session
->ust_session
);
353 ERR("Error in ust_app_destroy_trace_all");
356 trace_ust_destroy_session(session
->ust_session
);
360 * Stop all threads by closing the thread quit pipe.
362 static void stop_threads(void)
366 /* Stopping all threads */
367 DBG("Terminating all threads");
368 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
370 ERR("write error on thread quit pipe");
373 /* Dispatch thread */
374 dispatch_thread_exit
= 1;
375 futex_nto1_wake(&ust_cmd_queue
.futex
);
381 static void cleanup(void)
385 struct ltt_session
*sess
, *stmp
;
389 DBG("Removing %s directory", rundir
);
390 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
392 ERR("asprintf failed. Something is really wrong!");
395 /* Remove lttng run directory */
398 ERR("Unable to clean %s", rundir
);
402 DBG("Cleaning up all sessions");
404 /* Destroy session list mutex */
405 if (session_list_ptr
!= NULL
) {
406 pthread_mutex_destroy(&session_list_ptr
->lock
);
408 /* Cleanup ALL session */
409 cds_list_for_each_entry_safe(sess
, stmp
,
410 &session_list_ptr
->head
, list
) {
411 teardown_kernel_session(sess
);
412 teardown_ust_session(sess
);
417 DBG("Closing all UST sockets");
418 ust_app_clean_list();
420 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
422 if (is_root
&& !opt_no_kernel
) {
423 DBG2("Closing kernel fd");
424 close(kernel_tracer_fd
);
425 DBG("Unloading kernel modules");
426 modprobe_remove_lttng_all();
429 close(thread_quit_pipe
[0]);
430 close(thread_quit_pipe
[1]);
432 /* OUTPUT BENCHMARK RESULTS */
435 if (getenv("BENCH_UST_NOTIFY")) {
436 bench_print_ust_notification();
439 if (getenv("BENCH_UST_REGISTER")) {
440 bench_print_ust_register();
441 bench_print_ust_unregister();
444 if (getenv("BENCH_BOOT_PROCESS")) {
445 bench_print_boot_process();
452 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
453 "Matthew, BEET driven development works!%c[%dm",
454 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
459 * Send data on a unix socket using the liblttsessiondcomm API.
461 * Return lttcomm error code.
463 static int send_unix_sock(int sock
, void *buf
, size_t len
)
465 /* Check valid length */
470 return lttcomm_send_unix_sock(sock
, buf
, len
);
474 * Free memory of a command context structure.
476 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
478 DBG("Clean command context structure");
480 if ((*cmd_ctx
)->llm
) {
481 free((*cmd_ctx
)->llm
);
483 if ((*cmd_ctx
)->lsm
) {
484 free((*cmd_ctx
)->lsm
);
492 * Send all stream fds of kernel channel to the consumer.
494 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
495 int sock
, struct ltt_kernel_channel
*channel
,
496 uid_t uid
, gid_t gid
)
499 struct ltt_kernel_stream
*stream
;
500 struct lttcomm_consumer_msg lkm
;
502 DBG("Sending streams of channel %s to kernel consumer",
503 channel
->channel
->name
);
506 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
507 lkm
.u
.channel
.channel_key
= channel
->fd
;
508 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
509 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
510 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
511 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
513 perror("send consumer channel");
518 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
522 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
523 lkm
.u
.stream
.channel_key
= channel
->fd
;
524 lkm
.u
.stream
.stream_key
= stream
->fd
;
525 lkm
.u
.stream
.state
= stream
->state
;
526 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
527 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
528 lkm
.u
.stream
.uid
= uid
;
529 lkm
.u
.stream
.gid
= gid
;
530 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
531 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
532 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
533 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
535 perror("send consumer stream");
538 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
540 perror("send consumer stream ancillary data");
545 DBG("consumer channel streams sent");
554 * Send all stream fds of the kernel session to the consumer.
556 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
557 struct ltt_kernel_session
*session
)
560 struct ltt_kernel_channel
*chan
;
561 struct lttcomm_consumer_msg lkm
;
562 int sock
= session
->consumer_fd
;
564 DBG("Sending metadata stream fd");
566 /* Extra protection. It's NOT supposed to be set to 0 at this point */
567 if (session
->consumer_fd
== 0) {
568 session
->consumer_fd
= consumer_data
->cmd_sock
;
571 if (session
->metadata_stream_fd
!= 0) {
572 /* Send metadata channel fd */
573 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
574 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
575 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
576 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
577 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
578 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
580 perror("send consumer channel");
584 /* Send metadata stream fd */
585 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
586 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
587 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
588 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
589 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
590 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
591 lkm
.u
.stream
.uid
= session
->uid
;
592 lkm
.u
.stream
.gid
= session
->gid
;
593 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
594 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
595 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
596 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
598 perror("send consumer stream");
601 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
603 perror("send consumer stream");
608 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
609 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
610 session
->uid
, session
->gid
);
616 DBG("consumer fds (metadata and channel streams) sent");
625 * Notify UST applications using the shm mmap futex.
627 static int notify_ust_apps(int active
)
631 DBG("Notifying applications of session daemon state: %d", active
);
633 tracepoint(ust_notify_apps_start
);
635 /* See shm.c for this call implying mmap, shm and futex calls */
636 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
637 if (wait_shm_mmap
== NULL
) {
641 /* Wake waiting process */
642 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
644 tracepoint(ust_notify_apps_stop
);
646 /* Apps notified successfully */
654 * Setup the outgoing data buffer for the response (llm) by allocating the
655 * right amount of memory and copying the original information from the lsm
658 * Return total size of the buffer pointed by buf.
660 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
666 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
667 if (cmd_ctx
->llm
== NULL
) {
673 /* Copy common data */
674 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
675 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
677 cmd_ctx
->llm
->data_size
= size
;
678 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
687 * Update the kernel poll set of all channel fd available over all tracing
688 * session. Add the wakeup pipe at the end of the set.
690 static int update_kernel_poll(struct lttng_poll_event
*events
)
693 struct ltt_session
*session
;
694 struct ltt_kernel_channel
*channel
;
696 DBG("Updating kernel poll set");
699 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
700 session_lock(session
);
701 if (session
->kernel_session
== NULL
) {
702 session_unlock(session
);
706 cds_list_for_each_entry(channel
,
707 &session
->kernel_session
->channel_list
.head
, list
) {
708 /* Add channel fd to the kernel poll set */
709 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
711 session_unlock(session
);
714 DBG("Channel fd %d added to kernel set", channel
->fd
);
716 session_unlock(session
);
718 session_unlock_list();
723 session_unlock_list();
728 * Find the channel fd from 'fd' over all tracing session. When found, check
729 * for new channel stream and send those stream fds to the kernel consumer.
731 * Useful for CPU hotplug feature.
733 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
736 struct ltt_session
*session
;
737 struct ltt_kernel_channel
*channel
;
739 DBG("Updating kernel streams for channel fd %d", fd
);
742 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
743 session_lock(session
);
744 if (session
->kernel_session
== NULL
) {
745 session_unlock(session
);
749 /* This is not suppose to be 0 but this is an extra security check */
750 if (session
->kernel_session
->consumer_fd
== 0) {
751 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
754 cds_list_for_each_entry(channel
,
755 &session
->kernel_session
->channel_list
.head
, list
) {
756 if (channel
->fd
== fd
) {
757 DBG("Channel found, updating kernel streams");
758 ret
= kernel_open_channel_stream(channel
);
764 * Have we already sent fds to the consumer? If yes, it means
765 * that tracing is started so it is safe to send our updated
768 if (session
->kernel_session
->consumer_fds_sent
== 1) {
769 ret
= send_kconsumer_channel_streams(consumer_data
,
770 session
->kernel_session
->consumer_fd
, channel
,
771 session
->uid
, session
->gid
);
779 session_unlock(session
);
781 session_unlock_list();
785 session_unlock(session
);
786 session_unlock_list();
791 * For each tracing session, update newly registered apps.
793 static void update_ust_app(int app_sock
)
795 struct ltt_session
*sess
, *stmp
;
799 /* For all tracing session(s) */
800 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
802 if (sess
->ust_session
) {
803 ust_app_global_update(sess
->ust_session
, app_sock
);
805 session_unlock(sess
);
808 session_unlock_list();
812 * This thread manage event coming from the kernel.
814 * Features supported in this thread:
817 static void *thread_manage_kernel(void *data
)
819 int ret
, i
, pollfd
, update_poll_flag
= 1;
820 uint32_t revents
, nb_fd
;
822 struct lttng_poll_event events
;
824 tracepoint(sessiond_th_kern_start
);
826 DBG("Thread manage kernel started");
828 ret
= create_thread_poll_set(&events
, 2);
833 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
839 if (update_poll_flag
== 1) {
841 * Reset number of fd in the poll set. Always 2 since there is the thread
842 * quit pipe and the kernel pipe.
846 ret
= update_kernel_poll(&events
);
850 update_poll_flag
= 0;
853 nb_fd
= LTTNG_POLL_GETNB(&events
);
855 DBG("Thread kernel polling on %d fds", nb_fd
);
857 /* Zeroed the poll events */
858 lttng_poll_reset(&events
);
860 tracepoint(sessiond_th_kern_poll
);
862 /* Poll infinite value of time */
863 ret
= lttng_poll_wait(&events
, -1);
866 } else if (ret
== 0) {
867 /* Should not happen since timeout is infinite */
868 ERR("Return value of poll is 0 with an infinite timeout.\n"
869 "This should not have happened! Continuing...");
873 for (i
= 0; i
< nb_fd
; i
++) {
874 /* Fetch once the poll data */
875 revents
= LTTNG_POLL_GETEV(&events
, i
);
876 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
878 /* Thread quit pipe has been closed. Killing thread. */
879 ret
= check_thread_quit_pipe(pollfd
, revents
);
884 /* Check for data on kernel pipe */
885 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
886 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
887 update_poll_flag
= 1;
891 * New CPU detected by the kernel. Adding kernel stream to
892 * kernel session and updating the kernel consumer
894 if (revents
& LPOLLIN
) {
895 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
901 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
902 * and unregister kernel stream at this point.
910 DBG("Kernel thread dying");
911 close(kernel_poll_pipe
[0]);
912 close(kernel_poll_pipe
[1]);
914 lttng_poll_clean(&events
);
920 * This thread manage the consumer error sent back to the session daemon.
922 static void *thread_manage_consumer(void *data
)
924 int sock
= 0, i
, ret
, pollfd
;
925 uint32_t revents
, nb_fd
;
926 enum lttcomm_return_code code
;
927 struct lttng_poll_event events
;
928 struct consumer_data
*consumer_data
= data
;
930 tracepoint(sessiond_th_kcon_start
);
932 DBG("[thread] Manage consumer started");
934 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
940 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
941 * Nothing more will be added to this poll set.
943 ret
= create_thread_poll_set(&events
, 2);
948 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
953 nb_fd
= LTTNG_POLL_GETNB(&events
);
955 tracepoint(sessiond_th_kcon_poll
);
957 /* Inifinite blocking call, waiting for transmission */
958 ret
= lttng_poll_wait(&events
, -1);
963 for (i
= 0; i
< nb_fd
; i
++) {
964 /* Fetch once the poll data */
965 revents
= LTTNG_POLL_GETEV(&events
, i
);
966 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
968 /* Thread quit pipe has been closed. Killing thread. */
969 ret
= check_thread_quit_pipe(pollfd
, revents
);
974 /* Event on the registration socket */
975 if (pollfd
== consumer_data
->err_sock
) {
976 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
977 ERR("consumer err socket poll error");
983 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
988 DBG2("Receiving code from consumer err_sock");
990 /* Getting status code from kconsumerd */
991 ret
= lttcomm_recv_unix_sock(sock
, &code
,
992 sizeof(enum lttcomm_return_code
));
997 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
998 consumer_data
->cmd_sock
=
999 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1000 if (consumer_data
->cmd_sock
< 0) {
1001 sem_post(&consumer_data
->sem
);
1002 PERROR("consumer connect");
1005 /* Signal condition to tell that the kconsumerd is ready */
1006 sem_post(&consumer_data
->sem
);
1007 DBG("consumer command socket ready");
1009 ERR("consumer error when waiting for SOCK_READY : %s",
1010 lttcomm_get_readable_code(-code
));
1014 /* Remove the kconsumerd error sock since we've established a connexion */
1015 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1020 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1025 /* Update number of fd */
1026 nb_fd
= LTTNG_POLL_GETNB(&events
);
1028 /* Inifinite blocking call, waiting for transmission */
1029 ret
= lttng_poll_wait(&events
, -1);
1034 for (i
= 0; i
< nb_fd
; i
++) {
1035 /* Fetch once the poll data */
1036 revents
= LTTNG_POLL_GETEV(&events
, i
);
1037 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1039 /* Thread quit pipe has been closed. Killing thread. */
1040 ret
= check_thread_quit_pipe(pollfd
, revents
);
1045 /* Event on the kconsumerd socket */
1046 if (pollfd
== sock
) {
1047 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1048 ERR("consumer err socket second poll error");
1054 /* Wait for any kconsumerd error */
1055 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1056 sizeof(enum lttcomm_return_code
));
1058 ERR("consumer closed the command socket");
1062 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1065 DBG("consumer thread dying");
1066 close(consumer_data
->err_sock
);
1067 close(consumer_data
->cmd_sock
);
1070 unlink(consumer_data
->err_unix_sock_path
);
1071 unlink(consumer_data
->cmd_unix_sock_path
);
1072 consumer_data
->pid
= 0;
1074 lttng_poll_clean(&events
);
1080 * This thread manage application communication.
1082 static void *thread_manage_apps(void *data
)
1085 uint32_t revents
, nb_fd
;
1086 struct ust_command ust_cmd
;
1087 struct lttng_poll_event events
;
1089 tracepoint(sessiond_th_apps_start
);
1091 DBG("[thread] Manage application started");
1093 rcu_register_thread();
1094 rcu_thread_online();
1096 ret
= create_thread_poll_set(&events
, 2);
1101 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1107 /* Zeroed the events structure */
1108 lttng_poll_reset(&events
);
1110 nb_fd
= LTTNG_POLL_GETNB(&events
);
1112 DBG("Apps thread polling on %d fds", nb_fd
);
1114 tracepoint(sessiond_th_apps_poll
);
1116 /* Inifinite blocking call, waiting for transmission */
1117 ret
= lttng_poll_wait(&events
, -1);
1122 for (i
= 0; i
< nb_fd
; i
++) {
1123 /* Fetch once the poll data */
1124 revents
= LTTNG_POLL_GETEV(&events
, i
);
1125 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1127 /* Thread quit pipe has been closed. Killing thread. */
1128 ret
= check_thread_quit_pipe(pollfd
, revents
);
1133 /* Inspect the apps cmd pipe */
1134 if (pollfd
== apps_cmd_pipe
[0]) {
1135 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1136 ERR("Apps command pipe error");
1138 } else if (revents
& LPOLLIN
) {
1139 tracepoint(ust_register_read_start
);
1141 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1142 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1143 perror("read apps cmd pipe");
1146 tracepoint(ust_register_read_stop
);
1148 tracepoint(ust_register_add_start
);
1149 /* Register applicaton to the session daemon */
1150 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1152 if (ret
== -ENOMEM
) {
1154 } else if (ret
< 0) {
1157 tracepoint(ust_register_add_stop
);
1159 tracepoint(ust_register_done_start
);
1161 * Validate UST version compatibility.
1163 ret
= ust_app_validate_version(ust_cmd
.sock
);
1166 * Add channel(s) and event(s) to newly registered apps
1167 * from lttng global UST domain.
1169 update_ust_app(ust_cmd
.sock
);
1172 ret
= ust_app_register_done(ust_cmd
.sock
);
1175 * If the registration is not possible, we simply
1176 * unregister the apps and continue
1178 ust_app_unregister(ust_cmd
.sock
);
1181 * We just need here to monitor the close of the UST
1182 * socket and poll set monitor those by default.
1184 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1189 DBG("Apps with sock %d added to poll set",
1192 tracepoint(ust_register_done_stop
);
1197 * At this point, we know that a registered application made
1198 * the event at poll_wait.
1200 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1201 tracepoint(ust_unregister_start
);
1203 /* Removing from the poll set */
1204 ret
= lttng_poll_del(&events
, pollfd
);
1209 /* Socket closed on remote end. */
1210 ust_app_unregister(pollfd
);
1212 tracepoint(ust_unregister_stop
);
1220 DBG("Application communication apps dying");
1221 close(apps_cmd_pipe
[0]);
1222 close(apps_cmd_pipe
[1]);
1224 lttng_poll_clean(&events
);
1226 rcu_thread_offline();
1227 rcu_unregister_thread();
1232 * Dispatch request from the registration threads to the application
1233 * communication thread.
1235 static void *thread_dispatch_ust_registration(void *data
)
1238 struct cds_wfq_node
*node
;
1239 struct ust_command
*ust_cmd
= NULL
;
1241 tracepoint(sessiond_th_dispatch_start
);
1243 DBG("[thread] Dispatch UST command started");
1245 while (!dispatch_thread_exit
) {
1246 /* Atomically prepare the queue futex */
1247 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1250 tracepoint(sessiond_th_dispatch_block
);
1252 /* Dequeue command for registration */
1253 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1255 DBG("Woken up but nothing in the UST command queue");
1256 /* Continue thread execution */
1260 tracepoint(ust_dispatch_register_start
);
1262 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1264 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1265 " gid:%d sock:%d name:%s (version %d.%d)",
1266 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1267 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1268 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1269 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1271 * Inform apps thread of the new application registration. This
1272 * call is blocking so we can be assured that the data will be read
1273 * at some point in time or wait to the end of the world :)
1275 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1276 sizeof(struct ust_command
));
1278 perror("write apps cmd pipe");
1279 if (errno
== EBADF
) {
1281 * We can't inform the application thread to process
1282 * registration. We will exit or else application
1283 * registration will not occur and tracing will never
1290 } while (node
!= NULL
);
1292 tracepoint(ust_dispatch_register_stop
);
1294 /* Futex wait on queue. Blocking call on futex() */
1295 futex_nto1_wait(&ust_cmd_queue
.futex
);
1299 DBG("Dispatch thread dying");
1304 * This thread manage application registration.
1306 static void *thread_registration_apps(void *data
)
1308 int sock
= 0, i
, ret
, pollfd
;
1309 uint32_t revents
, nb_fd
;
1310 struct lttng_poll_event events
;
1312 * Get allocated in this thread, enqueued to a global queue, dequeued and
1313 * freed in the manage apps thread.
1315 struct ust_command
*ust_cmd
= NULL
;
1317 tracepoint(sessiond_th_reg_start
);
1319 DBG("[thread] Manage application registration started");
1321 ret
= lttcomm_listen_unix_sock(apps_sock
);
1327 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1328 * more will be added to this poll set.
1330 ret
= create_thread_poll_set(&events
, 2);
1335 /* Add the application registration socket */
1336 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1341 /* Notify all applications to register */
1342 ret
= notify_ust_apps(1);
1344 ERR("Failed to notify applications or create the wait shared memory.\n"
1345 "Execution continues but there might be problem for already\n"
1346 "running applications that wishes to register.");
1350 DBG("Accepting application registration");
1352 tracepoint(sessiond_th_reg_poll
);
1354 nb_fd
= LTTNG_POLL_GETNB(&events
);
1356 /* Inifinite blocking call, waiting for transmission */
1357 ret
= lttng_poll_wait(&events
, -1);
1362 for (i
= 0; i
< nb_fd
; i
++) {
1363 /* Fetch once the poll data */
1364 revents
= LTTNG_POLL_GETEV(&events
, i
);
1365 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1367 /* Thread quit pipe has been closed. Killing thread. */
1368 ret
= check_thread_quit_pipe(pollfd
, revents
);
1373 /* Event on the registration socket */
1374 if (pollfd
== apps_sock
) {
1375 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1376 ERR("Register apps socket poll error");
1378 } else if (revents
& LPOLLIN
) {
1379 /* Registration starts here. Recording cycles */
1380 tracepoint(ust_register_start
);
1382 sock
= lttcomm_accept_unix_sock(apps_sock
);
1387 /* Create UST registration command for enqueuing */
1388 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1389 if (ust_cmd
== NULL
) {
1390 perror("ust command zmalloc");
1395 * Using message-based transmissions to ensure we don't
1396 * have to deal with partially received messages.
1398 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1399 sizeof(struct ust_register_msg
));
1400 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1402 perror("lttcomm_recv_unix_sock register apps");
1404 ERR("Wrong size received on apps register");
1411 ust_cmd
->sock
= sock
;
1413 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1414 " gid:%d sock:%d name:%s (version %d.%d)",
1415 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1416 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1417 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1418 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1421 * Lock free enqueue the registration request. The red pill
1422 * has been taken! This apps will be part of the *system*.
1424 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1427 * Wake the registration queue futex. Implicit memory
1428 * barrier with the exchange in cds_wfq_enqueue.
1430 futex_nto1_wake(&ust_cmd_queue
.futex
);
1432 tracepoint(ust_register_stop
);
1439 DBG("UST Registration thread dying");
1441 /* Notify that the registration thread is gone */
1446 unlink(apps_unix_sock_path
);
1448 lttng_poll_clean(&events
);
1454 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1455 * exec or it will fails.
1457 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1460 struct timespec timeout
;
1462 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1463 timeout
.tv_nsec
= 0;
1465 /* Setup semaphore */
1466 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1468 PERROR("sem_init consumer semaphore");
1472 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1473 thread_manage_consumer
, consumer_data
);
1475 PERROR("pthread_create consumer");
1480 /* Get time for sem_timedwait absolute timeout */
1481 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1483 PERROR("clock_gettime spawn consumer");
1484 /* Infinite wait for the kconsumerd thread to be ready */
1485 ret
= sem_wait(&consumer_data
->sem
);
1487 /* Normal timeout if the gettime was successful */
1488 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1489 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1493 if (errno
== ETIMEDOUT
) {
1495 * Call has timed out so we kill the kconsumerd_thread and return
1498 ERR("The consumer thread was never ready. Killing it");
1499 ret
= pthread_cancel(consumer_data
->thread
);
1501 PERROR("pthread_cancel consumer thread");
1504 PERROR("semaphore wait failed consumer thread");
1509 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1510 if (consumer_data
->pid
== 0) {
1511 ERR("Kconsumerd did not start");
1512 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1515 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1524 * Join consumer thread
1526 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1531 if (consumer_data
->pid
!= 0) {
1532 ret
= kill(consumer_data
->pid
, SIGTERM
);
1534 ERR("Error killing consumer daemon");
1537 return pthread_join(consumer_data
->thread
, &status
);
1544 * Fork and exec a consumer daemon (consumerd).
1546 * Return pid if successful else -1.
1548 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1552 const char *consumer_to_use
;
1553 const char *verbosity
;
1556 DBG("Spawning consumerd");
1563 if (opt_verbose_consumer
) {
1564 verbosity
= "--verbose";
1566 verbosity
= "--quiet";
1568 switch (consumer_data
->type
) {
1569 case LTTNG_CONSUMER_KERNEL
:
1571 * Find out which consumerd to execute. We will first try the
1572 * 64-bit path, then the sessiond's installation directory, and
1573 * fallback on the 32-bit one,
1575 DBG3("Looking for a kernel consumer at these locations:");
1576 DBG3(" 1) %s", consumerd64_bin
);
1577 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1578 DBG3(" 3) %s", consumerd32_bin
);
1579 if (stat(consumerd64_bin
, &st
) == 0) {
1580 DBG3("Found location #1");
1581 consumer_to_use
= consumerd64_bin
;
1582 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1583 DBG3("Found location #2");
1584 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1585 } else if (stat(consumerd32_bin
, &st
) == 0) {
1586 DBG3("Found location #3");
1587 consumer_to_use
= consumerd32_bin
;
1589 DBG("Could not find any valid consumerd executable");
1592 DBG("Using kernel consumer at: %s", consumer_to_use
);
1593 execl(consumer_to_use
,
1594 "lttng-consumerd", verbosity
, "-k",
1595 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1596 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1599 case LTTNG_CONSUMER64_UST
:
1601 char *tmpnew
= NULL
;
1603 if (consumerd64_libdir
[0] != '\0') {
1607 tmp
= getenv("LD_LIBRARY_PATH");
1611 tmplen
= strlen("LD_LIBRARY_PATH=")
1612 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1613 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1618 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1619 strcat(tmpnew
, consumerd64_libdir
);
1620 if (tmp
[0] != '\0') {
1621 strcat(tmpnew
, ":");
1622 strcat(tmpnew
, tmp
);
1624 ret
= putenv(tmpnew
);
1630 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1631 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1632 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1633 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1635 if (consumerd64_libdir
[0] != '\0') {
1643 case LTTNG_CONSUMER32_UST
:
1645 char *tmpnew
= NULL
;
1647 if (consumerd32_libdir
[0] != '\0') {
1651 tmp
= getenv("LD_LIBRARY_PATH");
1655 tmplen
= strlen("LD_LIBRARY_PATH=")
1656 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1657 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1662 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1663 strcat(tmpnew
, consumerd32_libdir
);
1664 if (tmp
[0] != '\0') {
1665 strcat(tmpnew
, ":");
1666 strcat(tmpnew
, tmp
);
1668 ret
= putenv(tmpnew
);
1674 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1675 ret
= execl(consumerd32_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 (consumerd32_libdir
[0] != '\0') {
1688 perror("unknown consumer type");
1692 perror("kernel start consumer exec");
1695 } else if (pid
> 0) {
1698 perror("start consumer fork");
1706 * Spawn the consumerd daemon and session daemon thread.
1708 static int start_consumerd(struct consumer_data
*consumer_data
)
1712 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1713 if (consumer_data
->pid
!= 0) {
1714 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1718 ret
= spawn_consumerd(consumer_data
);
1720 ERR("Spawning consumerd failed");
1721 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1725 /* Setting up the consumer_data pid */
1726 consumer_data
->pid
= ret
;
1727 DBG2("Consumer pid %d", consumer_data
->pid
);
1728 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1730 DBG2("Spawning consumer control thread");
1731 ret
= spawn_consumer_thread(consumer_data
);
1733 ERR("Fatal error spawning consumer control thread");
1745 * Check version of the lttng-modules.
1747 static int validate_lttng_modules_version(void)
1749 return kernel_validate_version(kernel_tracer_fd
);
1753 * Setup necessary data for kernel tracer action.
1755 static int init_kernel_tracer(void)
1759 /* Modprobe lttng kernel modules */
1760 ret
= modprobe_lttng_control();
1765 /* Open debugfs lttng */
1766 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1767 if (kernel_tracer_fd
< 0) {
1768 DBG("Failed to open %s", module_proc_lttng
);
1773 /* Validate kernel version */
1774 ret
= validate_lttng_modules_version();
1779 ret
= modprobe_lttng_data();
1784 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1788 modprobe_remove_lttng_control();
1789 close(kernel_tracer_fd
);
1790 kernel_tracer_fd
= 0;
1791 return LTTCOMM_KERN_VERSION
;
1794 close(kernel_tracer_fd
);
1797 modprobe_remove_lttng_control();
1800 WARN("No kernel tracer available");
1801 kernel_tracer_fd
= 0;
1802 return LTTCOMM_KERN_NA
;
1806 * Init tracing by creating trace directory and sending fds kernel consumer.
1808 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1812 if (session
->consumer_fds_sent
== 0) {
1814 * Assign default kernel consumer socket if no consumer assigned to the
1815 * kernel session. At this point, it's NOT suppose to be 0 but this is
1816 * an extra security check.
1818 if (session
->consumer_fd
== 0) {
1819 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1822 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1824 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1828 session
->consumer_fds_sent
= 1;
1836 * Create an UST session and add it to the session ust list.
1838 static int create_ust_session(struct ltt_session
*session
,
1839 struct lttng_domain
*domain
)
1841 struct ltt_ust_session
*lus
= NULL
;
1844 switch (domain
->type
) {
1845 case LTTNG_DOMAIN_UST
:
1848 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1852 DBG("Creating UST session");
1854 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1856 ret
= LTTCOMM_UST_SESS_FAIL
;
1860 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1861 session
->uid
, session
->gid
);
1863 if (ret
!= -EEXIST
) {
1864 ERR("Trace directory creation error");
1865 ret
= LTTCOMM_UST_SESS_FAIL
;
1870 /* The domain type dictate different actions on session creation */
1871 switch (domain
->type
) {
1872 case LTTNG_DOMAIN_UST
:
1873 /* No ustctl for the global UST domain */
1876 ERR("Unknown UST domain on create session %d", domain
->type
);
1879 lus
->uid
= session
->uid
;
1880 lus
->gid
= session
->gid
;
1881 session
->ust_session
= lus
;
1891 * Create a kernel tracer session then create the default channel.
1893 static int create_kernel_session(struct ltt_session
*session
)
1897 DBG("Creating kernel session");
1899 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1901 ret
= LTTCOMM_KERN_SESS_FAIL
;
1905 /* Set kernel consumer socket fd */
1906 if (kconsumer_data
.cmd_sock
) {
1907 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1910 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1911 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1913 if (ret
!= -EEXIST
) {
1914 ERR("Trace directory creation error");
1918 session
->kernel_session
->uid
= session
->uid
;
1919 session
->kernel_session
->gid
= session
->gid
;
1926 * Check if the UID or GID match the session. Root user has access to all
1929 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1931 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1938 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1941 struct ltt_session
*session
;
1943 DBG("Counting number of available session for UID %d GID %d",
1945 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1947 * Only list the sessions the user can control.
1949 if (!session_access_ok(session
, uid
, gid
)) {
1958 * Using the session list, filled a lttng_session array to send back to the
1959 * client for session listing.
1961 * The session list lock MUST be acquired before calling this function. Use
1962 * session_lock_list() and session_unlock_list().
1964 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1968 struct ltt_session
*session
;
1970 DBG("Getting all available session for UID %d GID %d",
1973 * Iterate over session list and append data after the control struct in
1976 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1978 * Only list the sessions the user can control.
1980 if (!session_access_ok(session
, uid
, gid
)) {
1983 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1984 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1985 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1986 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1987 sessions
[i
].enabled
= session
->enabled
;
1993 * Fill lttng_channel array of all channels.
1995 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1996 struct lttng_channel
*channels
)
1999 struct ltt_kernel_channel
*kchan
;
2001 DBG("Listing channels for session %s", session
->name
);
2004 case LTTNG_DOMAIN_KERNEL
:
2005 /* Kernel channels */
2006 if (session
->kernel_session
!= NULL
) {
2007 cds_list_for_each_entry(kchan
,
2008 &session
->kernel_session
->channel_list
.head
, list
) {
2009 /* Copy lttng_channel struct to array */
2010 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2011 channels
[i
].enabled
= kchan
->enabled
;
2016 case LTTNG_DOMAIN_UST
:
2018 struct lttng_ht_iter iter
;
2019 struct ltt_ust_channel
*uchan
;
2021 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2022 &iter
.iter
, uchan
, node
.node
) {
2023 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2024 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2025 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2026 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2027 channels
[i
].attr
.switch_timer_interval
=
2028 uchan
->attr
.switch_timer_interval
;
2029 channels
[i
].attr
.read_timer_interval
=
2030 uchan
->attr
.read_timer_interval
;
2031 channels
[i
].enabled
= uchan
->enabled
;
2032 switch (uchan
->attr
.output
) {
2033 case LTTNG_UST_MMAP
:
2035 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2048 * Create a list of ust global domain events.
2050 static int list_lttng_ust_global_events(char *channel_name
,
2051 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2054 unsigned int nb_event
= 0;
2055 struct lttng_ht_iter iter
;
2056 struct lttng_ht_node_str
*node
;
2057 struct ltt_ust_channel
*uchan
;
2058 struct ltt_ust_event
*uevent
;
2059 struct lttng_event
*tmp
;
2061 DBG("Listing UST global events for channel %s", channel_name
);
2065 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2066 node
= lttng_ht_iter_get_node_str(&iter
);
2068 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2072 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2074 nb_event
+= lttng_ht_get_count(uchan
->events
);
2076 if (nb_event
== 0) {
2081 DBG3("Listing UST global %d events", nb_event
);
2083 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2085 ret
= -LTTCOMM_FATAL
;
2089 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2090 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2091 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2092 tmp
[i
].enabled
= uevent
->enabled
;
2093 switch (uevent
->attr
.instrumentation
) {
2094 case LTTNG_UST_TRACEPOINT
:
2095 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2097 case LTTNG_UST_PROBE
:
2098 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2100 case LTTNG_UST_FUNCTION
:
2101 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2104 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2105 switch (uevent
->attr
.loglevel_type
) {
2106 case LTTNG_UST_LOGLEVEL_ALL
:
2107 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2109 case LTTNG_UST_LOGLEVEL_RANGE
:
2110 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2112 case LTTNG_UST_LOGLEVEL_SINGLE
:
2113 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2128 * Fill lttng_event array of all kernel events in the channel.
2130 static int list_lttng_kernel_events(char *channel_name
,
2131 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2134 unsigned int nb_event
;
2135 struct ltt_kernel_event
*event
;
2136 struct ltt_kernel_channel
*kchan
;
2138 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2139 if (kchan
== NULL
) {
2140 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2144 nb_event
= kchan
->event_count
;
2146 DBG("Listing events for channel %s", kchan
->channel
->name
);
2148 if (nb_event
== 0) {
2153 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2154 if (*events
== NULL
) {
2155 ret
= LTTCOMM_FATAL
;
2159 /* Kernel channels */
2160 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2161 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2162 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2163 (*events
)[i
].enabled
= event
->enabled
;
2164 switch (event
->event
->instrumentation
) {
2165 case LTTNG_KERNEL_TRACEPOINT
:
2166 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2168 case LTTNG_KERNEL_KPROBE
:
2169 case LTTNG_KERNEL_KRETPROBE
:
2170 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2171 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2172 sizeof(struct lttng_kernel_kprobe
));
2174 case LTTNG_KERNEL_FUNCTION
:
2175 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2176 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2177 sizeof(struct lttng_kernel_function
));
2179 case LTTNG_KERNEL_NOOP
:
2180 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2182 case LTTNG_KERNEL_SYSCALL
:
2183 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2185 case LTTNG_KERNEL_ALL
:
2199 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2201 static int cmd_disable_channel(struct ltt_session
*session
,
2202 int domain
, char *channel_name
)
2205 struct ltt_ust_session
*usess
;
2207 usess
= session
->ust_session
;
2210 case LTTNG_DOMAIN_KERNEL
:
2212 ret
= channel_kernel_disable(session
->kernel_session
,
2214 if (ret
!= LTTCOMM_OK
) {
2218 kernel_wait_quiescent(kernel_tracer_fd
);
2221 case LTTNG_DOMAIN_UST
:
2223 struct ltt_ust_channel
*uchan
;
2224 struct lttng_ht
*chan_ht
;
2226 chan_ht
= usess
->domain_global
.channels
;
2228 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2229 if (uchan
== NULL
) {
2230 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2234 ret
= channel_ust_disable(usess
, domain
, uchan
);
2235 if (ret
!= LTTCOMM_OK
) {
2241 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2242 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2243 case LTTNG_DOMAIN_UST_PID
:
2246 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2257 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2259 static int cmd_enable_channel(struct ltt_session
*session
,
2260 int domain
, struct lttng_channel
*attr
)
2263 struct ltt_ust_session
*usess
= session
->ust_session
;
2264 struct lttng_ht
*chan_ht
;
2266 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2269 case LTTNG_DOMAIN_KERNEL
:
2271 struct ltt_kernel_channel
*kchan
;
2273 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2274 session
->kernel_session
);
2275 if (kchan
== NULL
) {
2276 ret
= channel_kernel_create(session
->kernel_session
,
2277 attr
, kernel_poll_pipe
[1]);
2279 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2282 if (ret
!= LTTCOMM_OK
) {
2286 kernel_wait_quiescent(kernel_tracer_fd
);
2289 case LTTNG_DOMAIN_UST
:
2291 struct ltt_ust_channel
*uchan
;
2293 chan_ht
= usess
->domain_global
.channels
;
2295 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2296 if (uchan
== NULL
) {
2297 ret
= channel_ust_create(usess
, domain
, attr
);
2299 ret
= channel_ust_enable(usess
, domain
, uchan
);
2304 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2305 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2306 case LTTNG_DOMAIN_UST_PID
:
2309 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2318 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2320 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2321 char *channel_name
, char *event_name
)
2326 case LTTNG_DOMAIN_KERNEL
:
2328 struct ltt_kernel_channel
*kchan
;
2329 struct ltt_kernel_session
*ksess
;
2331 ksess
= session
->kernel_session
;
2333 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2334 if (kchan
== NULL
) {
2335 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2339 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2340 if (ret
!= LTTCOMM_OK
) {
2344 kernel_wait_quiescent(kernel_tracer_fd
);
2347 case LTTNG_DOMAIN_UST
:
2349 struct ltt_ust_channel
*uchan
;
2350 struct ltt_ust_session
*usess
;
2352 usess
= session
->ust_session
;
2354 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2356 if (uchan
== NULL
) {
2357 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2361 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2362 if (ret
!= LTTCOMM_OK
) {
2366 DBG3("Disable UST event %s in channel %s completed", event_name
,
2371 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2372 case LTTNG_DOMAIN_UST_PID
:
2373 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2387 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2389 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2395 case LTTNG_DOMAIN_KERNEL
:
2397 struct ltt_kernel_session
*ksess
;
2398 struct ltt_kernel_channel
*kchan
;
2400 ksess
= session
->kernel_session
;
2402 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2403 if (kchan
== NULL
) {
2404 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2408 ret
= event_kernel_disable_all(ksess
, kchan
);
2409 if (ret
!= LTTCOMM_OK
) {
2413 kernel_wait_quiescent(kernel_tracer_fd
);
2416 case LTTNG_DOMAIN_UST
:
2418 struct ltt_ust_session
*usess
;
2419 struct ltt_ust_channel
*uchan
;
2421 usess
= session
->ust_session
;
2423 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2425 if (uchan
== NULL
) {
2426 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2430 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2435 DBG3("Disable all UST events in channel %s completed", channel_name
);
2440 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2441 case LTTNG_DOMAIN_UST_PID
:
2442 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2456 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2458 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2459 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2464 case LTTNG_DOMAIN_KERNEL
:
2465 /* Add kernel context to kernel tracer */
2466 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2467 event_name
, channel_name
);
2468 if (ret
!= LTTCOMM_OK
) {
2472 case LTTNG_DOMAIN_UST
:
2474 struct ltt_ust_session
*usess
= session
->ust_session
;
2476 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2477 if (ret
!= LTTCOMM_OK
) {
2483 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2484 case LTTNG_DOMAIN_UST_PID
:
2485 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2499 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2501 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2502 char *channel_name
, struct lttng_event
*event
)
2505 struct lttng_channel
*attr
;
2506 struct ltt_ust_session
*usess
= session
->ust_session
;
2509 case LTTNG_DOMAIN_KERNEL
:
2511 struct ltt_kernel_channel
*kchan
;
2513 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2514 session
->kernel_session
);
2515 if (kchan
== NULL
) {
2516 attr
= channel_new_default_attr(domain
);
2518 ret
= LTTCOMM_FATAL
;
2521 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2523 /* This call will notify the kernel thread */
2524 ret
= channel_kernel_create(session
->kernel_session
,
2525 attr
, kernel_poll_pipe
[1]);
2526 if (ret
!= LTTCOMM_OK
) {
2533 /* Get the newly created kernel channel pointer */
2534 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2535 session
->kernel_session
);
2536 if (kchan
== NULL
) {
2537 /* This sould not happen... */
2538 ret
= LTTCOMM_FATAL
;
2542 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2544 if (ret
!= LTTCOMM_OK
) {
2548 kernel_wait_quiescent(kernel_tracer_fd
);
2551 case LTTNG_DOMAIN_UST
:
2553 struct lttng_channel
*attr
;
2554 struct ltt_ust_channel
*uchan
;
2556 /* Get channel from global UST domain */
2557 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2559 if (uchan
== NULL
) {
2560 /* Create default channel */
2561 attr
= channel_new_default_attr(domain
);
2563 ret
= LTTCOMM_FATAL
;
2566 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2567 attr
->name
[NAME_MAX
- 1] = '\0';
2569 ret
= channel_ust_create(usess
, domain
, attr
);
2570 if (ret
!= LTTCOMM_OK
) {
2576 /* Get the newly created channel reference back */
2577 uchan
= trace_ust_find_channel_by_name(
2578 usess
->domain_global
.channels
, channel_name
);
2579 if (uchan
== NULL
) {
2580 /* Something is really wrong */
2581 ret
= LTTCOMM_FATAL
;
2586 /* At this point, the session and channel exist on the tracer */
2587 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2588 if (ret
!= LTTCOMM_OK
) {
2594 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2595 case LTTNG_DOMAIN_UST_PID
:
2596 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2610 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2612 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2613 char *channel_name
, int event_type
)
2616 struct ltt_kernel_channel
*kchan
;
2619 case LTTNG_DOMAIN_KERNEL
:
2620 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2621 session
->kernel_session
);
2622 if (kchan
== NULL
) {
2623 /* This call will notify the kernel thread */
2624 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2625 kernel_poll_pipe
[1]);
2626 if (ret
!= LTTCOMM_OK
) {
2630 /* Get the newly created kernel channel pointer */
2631 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2632 session
->kernel_session
);
2633 if (kchan
== NULL
) {
2634 /* This sould not happen... */
2635 ret
= LTTCOMM_FATAL
;
2641 switch (event_type
) {
2642 case LTTNG_EVENT_SYSCALL
:
2643 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2644 kchan
, kernel_tracer_fd
);
2646 case LTTNG_EVENT_TRACEPOINT
:
2648 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2649 * events already registered to the channel.
2651 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2652 kchan
, kernel_tracer_fd
);
2654 case LTTNG_EVENT_ALL
:
2655 /* Enable syscalls and tracepoints */
2656 ret
= event_kernel_enable_all(session
->kernel_session
,
2657 kchan
, kernel_tracer_fd
);
2660 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2664 /* Manage return value */
2665 if (ret
!= LTTCOMM_OK
) {
2669 kernel_wait_quiescent(kernel_tracer_fd
);
2671 case LTTNG_DOMAIN_UST
:
2673 struct lttng_channel
*attr
;
2674 struct ltt_ust_channel
*uchan
;
2675 struct ltt_ust_session
*usess
= session
->ust_session
;
2677 /* Get channel from global UST domain */
2678 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2680 if (uchan
== NULL
) {
2681 /* Create default channel */
2682 attr
= channel_new_default_attr(domain
);
2684 ret
= LTTCOMM_FATAL
;
2687 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2688 attr
->name
[NAME_MAX
- 1] = '\0';
2690 /* Use the internal command enable channel */
2691 ret
= channel_ust_create(usess
, domain
, attr
);
2692 if (ret
!= LTTCOMM_OK
) {
2698 /* Get the newly created channel reference back */
2699 uchan
= trace_ust_find_channel_by_name(
2700 usess
->domain_global
.channels
, channel_name
);
2701 if (uchan
== NULL
) {
2702 /* Something is really wrong */
2703 ret
= LTTCOMM_FATAL
;
2708 /* At this point, the session and channel exist on the tracer */
2710 switch (event_type
) {
2711 case LTTNG_EVENT_ALL
:
2712 case LTTNG_EVENT_TRACEPOINT
:
2713 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2714 if (ret
!= LTTCOMM_OK
) {
2719 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2723 /* Manage return value */
2724 if (ret
!= LTTCOMM_OK
) {
2731 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2732 case LTTNG_DOMAIN_UST_PID
:
2733 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2747 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2749 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2752 ssize_t nb_events
= 0;
2755 case LTTNG_DOMAIN_KERNEL
:
2756 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2757 if (nb_events
< 0) {
2758 ret
= LTTCOMM_KERN_LIST_FAIL
;
2762 case LTTNG_DOMAIN_UST
:
2763 nb_events
= ust_app_list_events(events
);
2764 if (nb_events
< 0) {
2765 ret
= LTTCOMM_UST_LIST_FAIL
;
2777 /* Return negative value to differentiate return code */
2782 * Command LTTNG_START_TRACE processed by the client thread.
2784 static int cmd_start_trace(struct ltt_session
*session
)
2787 struct ltt_kernel_session
*ksession
;
2788 struct ltt_ust_session
*usess
;
2791 ksession
= session
->kernel_session
;
2792 usess
= session
->ust_session
;
2794 if (session
->enabled
) {
2795 ret
= LTTCOMM_UST_START_FAIL
;
2799 session
->enabled
= 1;
2801 /* Kernel tracing */
2802 if (ksession
!= NULL
) {
2803 struct ltt_kernel_channel
*kchan
;
2805 /* Open kernel metadata */
2806 if (ksession
->metadata
== NULL
) {
2807 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2809 ret
= LTTCOMM_KERN_META_FAIL
;
2814 /* Open kernel metadata stream */
2815 if (ksession
->metadata_stream_fd
== 0) {
2816 ret
= kernel_open_metadata_stream(ksession
);
2818 ERR("Kernel create metadata stream failed");
2819 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2824 /* For each channel */
2825 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2826 if (kchan
->stream_count
== 0) {
2827 ret
= kernel_open_channel_stream(kchan
);
2829 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2832 /* Update the stream global counter */
2833 ksession
->stream_count_global
+= ret
;
2837 /* Setup kernel consumer socket and send fds to it */
2838 ret
= init_kernel_tracing(ksession
);
2840 ret
= LTTCOMM_KERN_START_FAIL
;
2844 /* This start the kernel tracing */
2845 ret
= kernel_start_session(ksession
);
2847 ret
= LTTCOMM_KERN_START_FAIL
;
2851 /* Quiescent wait after starting trace */
2852 kernel_wait_quiescent(kernel_tracer_fd
);
2855 /* Flag session that trace should start automatically */
2857 usess
->start_trace
= 1;
2859 ret
= ust_app_start_trace_all(usess
);
2861 ret
= LTTCOMM_UST_START_FAIL
;
2873 * Command LTTNG_STOP_TRACE processed by the client thread.
2875 static int cmd_stop_trace(struct ltt_session
*session
)
2878 struct ltt_kernel_channel
*kchan
;
2879 struct ltt_kernel_session
*ksession
;
2880 struct ltt_ust_session
*usess
;
2883 ksession
= session
->kernel_session
;
2884 usess
= session
->ust_session
;
2886 if (!session
->enabled
) {
2887 ret
= LTTCOMM_UST_STOP_FAIL
;
2891 session
->enabled
= 0;
2894 if (ksession
!= NULL
) {
2895 DBG("Stop kernel tracing");
2897 /* Flush all buffers before stopping */
2898 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2900 ERR("Kernel metadata flush failed");
2903 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2904 ret
= kernel_flush_buffer(kchan
);
2906 ERR("Kernel flush buffer error");
2910 ret
= kernel_stop_session(ksession
);
2912 ret
= LTTCOMM_KERN_STOP_FAIL
;
2916 kernel_wait_quiescent(kernel_tracer_fd
);
2920 usess
->start_trace
= 0;
2922 ret
= ust_app_stop_trace_all(usess
);
2924 ret
= LTTCOMM_UST_STOP_FAIL
;
2936 * Command LTTNG_CREATE_SESSION processed by the client thread.
2938 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2942 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2943 if (ret
!= LTTCOMM_OK
) {
2954 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2956 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2960 /* Clean kernel session teardown */
2961 teardown_kernel_session(session
);
2962 /* UST session teardown */
2963 teardown_ust_session(session
);
2966 * Must notify the kernel thread here to update it's poll setin order
2967 * to remove the channel(s)' fd just destroyed.
2969 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2971 perror("write kernel poll pipe");
2974 ret
= session_destroy(session
);
2980 * Command LTTNG_CALIBRATE processed by the client thread.
2982 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2987 case LTTNG_DOMAIN_KERNEL
:
2989 struct lttng_kernel_calibrate kcalibrate
;
2991 kcalibrate
.type
= calibrate
->type
;
2992 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2994 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2999 case LTTNG_DOMAIN_UST
:
3001 struct lttng_ust_calibrate ucalibrate
;
3003 ucalibrate
.type
= calibrate
->type
;
3004 ret
= ust_app_calibrate_glb(&ucalibrate
);
3006 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3023 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3025 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3031 case LTTNG_DOMAIN_KERNEL
:
3032 /* Can't register a consumer if there is already one */
3033 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3034 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3038 sock
= lttcomm_connect_unix_sock(sock_path
);
3040 ret
= LTTCOMM_CONNECT_FAIL
;
3044 session
->kernel_session
->consumer_fd
= sock
;
3047 /* TODO: Userspace tracing */
3059 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3061 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3062 struct lttng_domain
**domains
)
3067 if (session
->kernel_session
!= NULL
) {
3068 DBG3("Listing domains found kernel domain");
3072 if (session
->ust_session
!= NULL
) {
3073 DBG3("Listing domains found UST global domain");
3077 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3078 if (*domains
== NULL
) {
3079 ret
= -LTTCOMM_FATAL
;
3083 if (session
->kernel_session
!= NULL
) {
3084 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3088 if (session
->ust_session
!= NULL
) {
3089 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3100 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3102 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3103 struct lttng_channel
**channels
)
3106 ssize_t nb_chan
= 0;
3109 case LTTNG_DOMAIN_KERNEL
:
3110 if (session
->kernel_session
!= NULL
) {
3111 nb_chan
= session
->kernel_session
->channel_count
;
3113 DBG3("Number of kernel channels %zd", nb_chan
);
3115 case LTTNG_DOMAIN_UST
:
3116 if (session
->ust_session
!= NULL
) {
3117 nb_chan
= lttng_ht_get_count(
3118 session
->ust_session
->domain_global
.channels
);
3120 DBG3("Number of UST global channels %zd", nb_chan
);
3129 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3130 if (*channels
== NULL
) {
3131 ret
= -LTTCOMM_FATAL
;
3135 list_lttng_channels(domain
, session
, *channels
);
3147 * Command LTTNG_LIST_EVENTS processed by the client thread.
3149 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3150 char *channel_name
, struct lttng_event
**events
)
3153 ssize_t nb_event
= 0;
3156 case LTTNG_DOMAIN_KERNEL
:
3157 if (session
->kernel_session
!= NULL
) {
3158 nb_event
= list_lttng_kernel_events(channel_name
,
3159 session
->kernel_session
, events
);
3162 case LTTNG_DOMAIN_UST
:
3164 if (session
->ust_session
!= NULL
) {
3165 nb_event
= list_lttng_ust_global_events(channel_name
,
3166 &session
->ust_session
->domain_global
, events
);
3182 * Process the command requested by the lttng client within the command
3183 * context structure. This function make sure that the return structure (llm)
3184 * is set and ready for transmission before returning.
3186 * Return any error encountered or 0 for success.
3188 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3190 int ret
= LTTCOMM_OK
;
3191 int need_tracing_session
= 1;
3193 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3195 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3196 ret
= LTTCOMM_KERN_NA
;
3201 * Check for command that don't needs to allocate a returned payload. We do
3202 * this here so we don't have to make the call for no payload at each
3205 switch(cmd_ctx
->lsm
->cmd_type
) {
3206 case LTTNG_LIST_SESSIONS
:
3207 case LTTNG_LIST_TRACEPOINTS
:
3208 case LTTNG_LIST_DOMAINS
:
3209 case LTTNG_LIST_CHANNELS
:
3210 case LTTNG_LIST_EVENTS
:
3213 /* Setup lttng message with no payload */
3214 ret
= setup_lttng_msg(cmd_ctx
, 0);
3216 /* This label does not try to unlock the session */
3217 goto init_setup_error
;
3221 /* Commands that DO NOT need a session. */
3222 switch (cmd_ctx
->lsm
->cmd_type
) {
3223 case LTTNG_CALIBRATE
:
3224 case LTTNG_CREATE_SESSION
:
3225 case LTTNG_LIST_SESSIONS
:
3226 case LTTNG_LIST_TRACEPOINTS
:
3227 need_tracing_session
= 0;
3230 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3231 session_lock_list();
3232 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3233 session_unlock_list();
3234 if (cmd_ctx
->session
== NULL
) {
3235 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3236 ret
= LTTCOMM_SESS_NOT_FOUND
;
3238 /* If no session name specified */
3239 ret
= LTTCOMM_SELECT_SESS
;
3243 /* Acquire lock for the session */
3244 session_lock(cmd_ctx
->session
);
3250 * Check domain type for specific "pre-action".
3252 switch (cmd_ctx
->lsm
->domain
.type
) {
3253 case LTTNG_DOMAIN_KERNEL
:
3255 ret
= LTTCOMM_KERN_NA
;
3259 /* Kernel tracer check */
3260 if (kernel_tracer_fd
== 0) {
3261 /* Basically, load kernel tracer modules */
3262 ret
= init_kernel_tracer();
3268 /* Need a session for kernel command */
3269 if (need_tracing_session
) {
3270 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3271 ret
= create_kernel_session(cmd_ctx
->session
);
3273 ret
= LTTCOMM_KERN_SESS_FAIL
;
3278 /* Start the kernel consumer daemon */
3279 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3280 if (kconsumer_data
.pid
== 0 &&
3281 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3282 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3283 ret
= start_consumerd(&kconsumer_data
);
3285 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3289 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3293 case LTTNG_DOMAIN_UST
:
3295 if (need_tracing_session
) {
3296 if (cmd_ctx
->session
->ust_session
== NULL
) {
3297 ret
= create_ust_session(cmd_ctx
->session
,
3298 &cmd_ctx
->lsm
->domain
);
3299 if (ret
!= LTTCOMM_OK
) {
3303 /* Start the UST consumer daemons */
3305 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3306 if (consumerd64_bin
[0] != '\0' &&
3307 ustconsumer64_data
.pid
== 0 &&
3308 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3309 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3310 ret
= start_consumerd(&ustconsumer64_data
);
3312 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3313 ust_consumerd64_fd
= -EINVAL
;
3317 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3319 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3322 if (consumerd32_bin
[0] != '\0' &&
3323 ustconsumer32_data
.pid
== 0 &&
3324 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3325 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3326 ret
= start_consumerd(&ustconsumer32_data
);
3328 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3329 ust_consumerd32_fd
= -EINVAL
;
3332 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3334 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3344 * Check that the UID or GID match that of the tracing session.
3345 * The root user can interact with all sessions.
3347 if (need_tracing_session
) {
3348 if (!session_access_ok(cmd_ctx
->session
,
3349 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3350 ret
= LTTCOMM_EPERM
;
3355 /* Process by command type */
3356 switch (cmd_ctx
->lsm
->cmd_type
) {
3357 case LTTNG_ADD_CONTEXT
:
3359 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3360 cmd_ctx
->lsm
->u
.context
.channel_name
,
3361 cmd_ctx
->lsm
->u
.context
.event_name
,
3362 &cmd_ctx
->lsm
->u
.context
.ctx
);
3365 case LTTNG_DISABLE_CHANNEL
:
3367 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3368 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3371 case LTTNG_DISABLE_EVENT
:
3373 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3374 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3375 cmd_ctx
->lsm
->u
.disable
.name
);
3378 case LTTNG_DISABLE_ALL_EVENT
:
3380 DBG("Disabling all events");
3382 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3383 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3386 case LTTNG_ENABLE_CHANNEL
:
3388 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3389 &cmd_ctx
->lsm
->u
.channel
.chan
);
3392 case LTTNG_ENABLE_EVENT
:
3394 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3395 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3396 &cmd_ctx
->lsm
->u
.enable
.event
);
3399 case LTTNG_ENABLE_ALL_EVENT
:
3401 DBG("Enabling all events");
3403 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3404 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3405 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3408 case LTTNG_LIST_TRACEPOINTS
:
3410 struct lttng_event
*events
;
3413 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3414 if (nb_events
< 0) {
3420 * Setup lttng message with payload size set to the event list size in
3421 * bytes and then copy list into the llm payload.
3423 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3429 /* Copy event list into message payload */
3430 memcpy(cmd_ctx
->llm
->payload
, events
,
3431 sizeof(struct lttng_event
) * nb_events
);
3438 case LTTNG_START_TRACE
:
3440 ret
= cmd_start_trace(cmd_ctx
->session
);
3443 case LTTNG_STOP_TRACE
:
3445 ret
= cmd_stop_trace(cmd_ctx
->session
);
3448 case LTTNG_CREATE_SESSION
:
3450 tracepoint(create_session_start
);
3451 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3452 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3453 tracepoint(create_session_end
);
3456 case LTTNG_DESTROY_SESSION
:
3458 tracepoint(destroy_session_start
);
3459 ret
= cmd_destroy_session(cmd_ctx
->session
,
3460 cmd_ctx
->lsm
->session
.name
);
3461 tracepoint(destroy_session_end
);
3464 case LTTNG_LIST_DOMAINS
:
3467 struct lttng_domain
*domains
;
3469 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3475 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3480 /* Copy event list into message payload */
3481 memcpy(cmd_ctx
->llm
->payload
, domains
,
3482 nb_dom
* sizeof(struct lttng_domain
));
3489 case LTTNG_LIST_CHANNELS
:
3492 struct lttng_channel
*channels
;
3494 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3495 cmd_ctx
->session
, &channels
);
3501 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3506 /* Copy event list into message payload */
3507 memcpy(cmd_ctx
->llm
->payload
, channels
,
3508 nb_chan
* sizeof(struct lttng_channel
));
3515 case LTTNG_LIST_EVENTS
:
3518 struct lttng_event
*events
= NULL
;
3520 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3521 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3527 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3532 /* Copy event list into message payload */
3533 memcpy(cmd_ctx
->llm
->payload
, events
,
3534 nb_event
* sizeof(struct lttng_event
));
3541 case LTTNG_LIST_SESSIONS
:
3543 unsigned int nr_sessions
;
3545 session_lock_list();
3546 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3548 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3550 session_unlock_list();
3554 /* Filled the session array */
3555 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3556 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3558 session_unlock_list();
3563 case LTTNG_CALIBRATE
:
3565 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3566 &cmd_ctx
->lsm
->u
.calibrate
);
3569 case LTTNG_REGISTER_CONSUMER
:
3571 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3572 cmd_ctx
->lsm
->u
.reg
.path
);
3581 if (cmd_ctx
->llm
== NULL
) {
3582 DBG("Missing llm structure. Allocating one.");
3583 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3587 /* Set return code */
3588 cmd_ctx
->llm
->ret_code
= ret
;
3590 if (cmd_ctx
->session
) {
3591 session_unlock(cmd_ctx
->session
);
3598 * This thread manage all clients request using the unix client socket for
3601 static void *thread_manage_clients(void *data
)
3603 int sock
= 0, ret
, i
, pollfd
;
3604 uint32_t revents
, nb_fd
;
3605 struct command_ctx
*cmd_ctx
= NULL
;
3606 struct lttng_poll_event events
;
3608 tracepoint(sessiond_th_cli_start
);
3610 DBG("[thread] Manage client started");
3612 rcu_register_thread();
3614 ret
= lttcomm_listen_unix_sock(client_sock
);
3620 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3621 * more will be added to this poll set.
3623 ret
= create_thread_poll_set(&events
, 2);
3628 /* Add the application registration socket */
3629 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3635 * Notify parent pid that we are ready to accept command for client side.
3637 if (opt_sig_parent
) {
3638 kill(ppid
, SIGUSR1
);
3642 DBG("Accepting client command ...");
3644 tracepoint(sessiond_th_cli_poll
);
3646 nb_fd
= LTTNG_POLL_GETNB(&events
);
3648 /* Inifinite blocking call, waiting for transmission */
3649 ret
= lttng_poll_wait(&events
, -1);
3654 for (i
= 0; i
< nb_fd
; i
++) {
3655 /* Fetch once the poll data */
3656 revents
= LTTNG_POLL_GETEV(&events
, i
);
3657 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3659 /* Thread quit pipe has been closed. Killing thread. */
3660 ret
= check_thread_quit_pipe(pollfd
, revents
);
3665 /* Event on the registration socket */
3666 if (pollfd
== client_sock
) {
3667 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3668 ERR("Client socket poll error");
3674 DBG("Wait for client response");
3676 sock
= lttcomm_accept_unix_sock(client_sock
);
3681 /* Set socket option for credentials retrieval */
3682 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3687 /* Allocate context command to process the client request */
3688 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3689 if (cmd_ctx
== NULL
) {
3690 perror("zmalloc cmd_ctx");
3694 /* Allocate data buffer for reception */
3695 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3696 if (cmd_ctx
->lsm
== NULL
) {
3697 perror("zmalloc cmd_ctx->lsm");
3701 cmd_ctx
->llm
= NULL
;
3702 cmd_ctx
->session
= NULL
;
3705 * Data is received from the lttng client. The struct
3706 * lttcomm_session_msg (lsm) contains the command and data request of
3709 DBG("Receiving data from client ...");
3710 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3711 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3713 DBG("Nothing recv() from client... continuing");
3719 // TODO: Validate cmd_ctx including sanity check for
3720 // security purpose.
3722 rcu_thread_online();
3724 * This function dispatch the work to the kernel or userspace tracer
3725 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3726 * informations for the client. The command context struct contains
3727 * everything this function may needs.
3729 ret
= process_client_msg(cmd_ctx
);
3730 rcu_thread_offline();
3733 * TODO: Inform client somehow of the fatal error. At
3734 * this point, ret < 0 means that a zmalloc failed
3735 * (ENOMEM). Error detected but still accept command.
3737 clean_command_ctx(&cmd_ctx
);
3741 DBG("Sending response (size: %d, retcode: %s)",
3742 cmd_ctx
->lttng_msg_size
,
3743 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3744 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3746 ERR("Failed to send data back to client");
3749 /* End of transmission */
3752 clean_command_ctx(&cmd_ctx
);
3756 DBG("Client thread dying");
3757 unlink(client_unix_sock_path
);
3761 lttng_poll_clean(&events
);
3762 clean_command_ctx(&cmd_ctx
);
3764 rcu_unregister_thread();
3770 * usage function on stderr
3772 static void usage(void)
3774 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3775 fprintf(stderr
, " -h, --help Display this usage.\n");
3776 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3777 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3778 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3779 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3780 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3781 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3782 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3783 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3784 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3785 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3786 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3787 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3788 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3789 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3790 fprintf(stderr
, " -V, --version Show version number.\n");
3791 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3792 fprintf(stderr
, " -q, --quiet No output at all.\n");
3793 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3794 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3795 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3799 * daemon argument parsing
3801 static int parse_args(int argc
, char **argv
)
3805 static struct option long_options
[] = {
3806 { "client-sock", 1, 0, 'c' },
3807 { "apps-sock", 1, 0, 'a' },
3808 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3809 { "kconsumerd-err-sock", 1, 0, 'E' },
3810 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3811 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3812 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3813 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3814 { "consumerd32-path", 1, 0, 'u' },
3815 { "consumerd32-libdir", 1, 0, 'U' },
3816 { "consumerd64-path", 1, 0, 't' },
3817 { "consumerd64-libdir", 1, 0, 'T' },
3818 { "daemonize", 0, 0, 'd' },
3819 { "sig-parent", 0, 0, 'S' },
3820 { "help", 0, 0, 'h' },
3821 { "group", 1, 0, 'g' },
3822 { "version", 0, 0, 'V' },
3823 { "quiet", 0, 0, 'q' },
3824 { "verbose", 0, 0, 'v' },
3825 { "verbose-consumer", 0, 0, 'Z' },
3826 { "no-kernel", 0, 0, 'N' },
3831 int option_index
= 0;
3832 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3833 long_options
, &option_index
);
3840 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3842 fprintf(stderr
, " with arg %s\n", optarg
);
3846 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3849 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3855 opt_tracing_group
= optarg
;
3861 fprintf(stdout
, "%s\n", VERSION
);
3867 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3870 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3873 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3876 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3879 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3882 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3891 /* Verbose level can increase using multiple -v */
3895 opt_verbose_consumer
+= 1;
3898 consumerd32_bin
= optarg
;
3901 consumerd32_libdir
= optarg
;
3904 consumerd64_bin
= optarg
;
3907 consumerd64_libdir
= optarg
;
3910 /* Unknown option or other error.
3911 * Error is printed by getopt, just return */
3920 * Creates the two needed socket by the daemon.
3921 * apps_sock - The communication socket for all UST apps.
3922 * client_sock - The communication of the cli tool (lttng).
3924 static int init_daemon_socket(void)
3929 old_umask
= umask(0);
3931 /* Create client tool unix socket */
3932 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3933 if (client_sock
< 0) {
3934 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3939 /* File permission MUST be 660 */
3940 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3942 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3947 /* Create the application unix socket */
3948 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3949 if (apps_sock
< 0) {
3950 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3955 /* File permission MUST be 666 */
3956 ret
= chmod(apps_unix_sock_path
,
3957 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3959 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3970 * Check if the global socket is available, and if a daemon is answering at the
3971 * other side. If yes, error is returned.
3973 static int check_existing_daemon(void)
3975 /* Is there anybody out there ? */
3976 if (lttng_session_daemon_alive()) {
3984 * Set the tracing group gid onto the client socket.
3986 * Race window between mkdir and chown is OK because we are going from more
3987 * permissive (root.root) to less permissive (root.tracing).
3989 static int set_permissions(char *rundir
)
3994 gid
= allowed_group();
3996 WARN("No tracing group detected");
4001 /* Set lttng run dir */
4002 ret
= chown(rundir
, 0, gid
);
4004 ERR("Unable to set group on %s", rundir
);
4008 /* Ensure tracing group can search the run dir */
4009 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
);
4011 ERR("Unable to set permissions on %s", rundir
);
4015 /* lttng client socket path */
4016 ret
= chown(client_unix_sock_path
, 0, gid
);
4018 ERR("Unable to set group on %s", client_unix_sock_path
);
4022 /* kconsumer error socket path */
4023 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4025 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4029 /* 64-bit ustconsumer error socket path */
4030 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4032 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4036 /* 32-bit ustconsumer compat32 error socket path */
4037 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4039 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4043 DBG("All permissions are set");
4050 * Create the pipe used to wake up the kernel thread.
4052 static int create_kernel_poll_pipe(void)
4054 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4058 * Create the application command pipe to wake thread_manage_apps.
4060 static int create_apps_cmd_pipe(void)
4062 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4066 * Create the lttng run directory needed for all global sockets and pipe.
4068 static int create_lttng_rundir(const char *rundir
)
4072 DBG3("Creating LTTng run directory: %s", rundir
);
4074 ret
= mkdir(rundir
, S_IRWXU
);
4076 if (errno
!= EEXIST
) {
4077 ERR("Unable to create %s", rundir
);
4089 * Setup sockets and directory needed by the kconsumerd communication with the
4092 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4096 char path
[PATH_MAX
];
4098 switch (consumer_data
->type
) {
4099 case LTTNG_CONSUMER_KERNEL
:
4100 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4102 case LTTNG_CONSUMER64_UST
:
4103 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4105 case LTTNG_CONSUMER32_UST
:
4106 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4109 ERR("Consumer type unknown");
4114 DBG2("Creating consumer directory: %s", path
);
4116 ret
= mkdir(path
, S_IRWXU
);
4118 if (errno
!= EEXIST
) {
4119 ERR("Failed to create %s", path
);
4125 /* Create the kconsumerd error unix socket */
4126 consumer_data
->err_sock
=
4127 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4128 if (consumer_data
->err_sock
< 0) {
4129 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4134 /* File permission MUST be 660 */
4135 ret
= chmod(consumer_data
->err_unix_sock_path
,
4136 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4138 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4148 * Signal handler for the daemon
4150 * Simply stop all worker threads, leaving main() return gracefully after
4151 * joining all threads and calling cleanup().
4153 static void sighandler(int sig
)
4157 DBG("SIGPIPE caught");
4160 DBG("SIGINT caught");
4164 DBG("SIGTERM caught");
4173 * Setup signal handler for :
4174 * SIGINT, SIGTERM, SIGPIPE
4176 static int set_signal_handler(void)
4179 struct sigaction sa
;
4182 if ((ret
= sigemptyset(&sigset
)) < 0) {
4183 perror("sigemptyset");
4187 sa
.sa_handler
= sighandler
;
4188 sa
.sa_mask
= sigset
;
4190 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4191 perror("sigaction");
4195 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4196 perror("sigaction");
4200 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4201 perror("sigaction");
4205 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4211 * Set open files limit to unlimited. This daemon can open a large number of
4212 * file descriptors in order to consumer multiple kernel traces.
4214 static void set_ulimit(void)
4219 /* The kernel does not allowed an infinite limit for open files */
4220 lim
.rlim_cur
= 65535;
4221 lim
.rlim_max
= 65535;
4223 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4225 perror("failed to set open files limit");
4232 int main(int argc
, char **argv
)
4236 const char *home_path
;
4238 tracepoint(sessiond_boot_start
);
4240 init_kernel_workarounds();
4242 rcu_register_thread();
4244 /* Create thread quit pipe */
4245 if ((ret
= init_thread_quit_pipe()) < 0) {
4249 setup_consumerd_path();
4251 /* Parse arguments */
4253 if ((ret
= parse_args(argc
, argv
) < 0)) {
4266 /* Check if daemon is UID = 0 */
4267 is_root
= !getuid();
4270 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4272 /* Create global run dir with root access */
4273 ret
= create_lttng_rundir(rundir
);
4278 if (strlen(apps_unix_sock_path
) == 0) {
4279 snprintf(apps_unix_sock_path
, PATH_MAX
,
4280 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4283 if (strlen(client_unix_sock_path
) == 0) {
4284 snprintf(client_unix_sock_path
, PATH_MAX
,
4285 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4288 /* Set global SHM for ust */
4289 if (strlen(wait_shm_path
) == 0) {
4290 snprintf(wait_shm_path
, PATH_MAX
,
4291 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4294 /* Setup kernel consumerd path */
4295 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4296 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4297 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4298 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4300 DBG2("Kernel consumer err path: %s",
4301 kconsumer_data
.err_unix_sock_path
);
4302 DBG2("Kernel consumer cmd path: %s",
4303 kconsumer_data
.cmd_unix_sock_path
);
4305 home_path
= get_home_dir();
4306 if (home_path
== NULL
) {
4307 /* TODO: Add --socket PATH option */
4308 ERR("Can't get HOME directory for sockets creation.");
4314 * Create rundir from home path. This will create something like
4317 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4323 ret
= create_lttng_rundir(rundir
);
4328 if (strlen(apps_unix_sock_path
) == 0) {
4329 snprintf(apps_unix_sock_path
, PATH_MAX
,
4330 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4333 /* Set the cli tool unix socket path */
4334 if (strlen(client_unix_sock_path
) == 0) {
4335 snprintf(client_unix_sock_path
, PATH_MAX
,
4336 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4339 /* Set global SHM for ust */
4340 if (strlen(wait_shm_path
) == 0) {
4341 snprintf(wait_shm_path
, PATH_MAX
,
4342 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4346 DBG("Client socket path %s", client_unix_sock_path
);
4347 DBG("Application socket path %s", apps_unix_sock_path
);
4348 DBG("LTTng run directory path: %s", rundir
);
4350 /* 32 bits consumerd path setup */
4351 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4352 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4353 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4354 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4356 DBG2("UST consumer 32 bits err path: %s",
4357 ustconsumer32_data
.err_unix_sock_path
);
4358 DBG2("UST consumer 32 bits cmd path: %s",
4359 ustconsumer32_data
.cmd_unix_sock_path
);
4361 /* 64 bits consumerd path setup */
4362 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4363 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4364 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4365 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4367 DBG2("UST consumer 64 bits err path: %s",
4368 ustconsumer64_data
.err_unix_sock_path
);
4369 DBG2("UST consumer 64 bits cmd path: %s",
4370 ustconsumer64_data
.cmd_unix_sock_path
);
4373 * See if daemon already exist.
4375 if ((ret
= check_existing_daemon()) < 0) {
4376 ERR("Already running daemon.\n");
4378 * We do not goto exit because we must not cleanup()
4379 * because a daemon is already running.
4384 /* After this point, we can safely call cleanup() with "goto exit" */
4387 * These actions must be executed as root. We do that *after* setting up
4388 * the sockets path because we MUST make the check for another daemon using
4389 * those paths *before* trying to set the kernel consumer sockets and init
4393 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4398 /* Setup kernel tracer */
4399 if (!opt_no_kernel
) {
4400 init_kernel_tracer();
4403 /* Set ulimit for open files */
4407 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4412 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4417 if ((ret
= set_signal_handler()) < 0) {
4421 /* Setup the needed unix socket */
4422 if ((ret
= init_daemon_socket()) < 0) {
4426 /* Set credentials to socket */
4427 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4431 /* Get parent pid if -S, --sig-parent is specified. */
4432 if (opt_sig_parent
) {
4436 /* Setup the kernel pipe for waking up the kernel thread */
4437 if ((ret
= create_kernel_poll_pipe()) < 0) {
4441 /* Setup the thread apps communication pipe. */
4442 if ((ret
= create_apps_cmd_pipe()) < 0) {
4446 /* Init UST command queue. */
4447 cds_wfq_init(&ust_cmd_queue
.queue
);
4449 /* Init UST app hash table */
4453 * Get session list pointer. This pointer MUST NOT be free(). This list is
4454 * statically declared in session.c
4456 session_list_ptr
= session_get_list();
4458 /* Set up max poll set size */
4459 lttng_poll_set_max_size();
4461 /* Create thread to manage the client socket */
4462 ret
= pthread_create(&client_thread
, NULL
,
4463 thread_manage_clients
, (void *) NULL
);
4465 perror("pthread_create clients");
4469 /* Create thread to dispatch registration */
4470 ret
= pthread_create(&dispatch_thread
, NULL
,
4471 thread_dispatch_ust_registration
, (void *) NULL
);
4473 perror("pthread_create dispatch");
4477 /* Create thread to manage application registration. */
4478 ret
= pthread_create(®_apps_thread
, NULL
,
4479 thread_registration_apps
, (void *) NULL
);
4481 perror("pthread_create registration");
4485 /* Create thread to manage application socket */
4486 ret
= pthread_create(&apps_thread
, NULL
,
4487 thread_manage_apps
, (void *) NULL
);
4489 perror("pthread_create apps");
4493 /* Create kernel thread to manage kernel event */
4494 ret
= pthread_create(&kernel_thread
, NULL
,
4495 thread_manage_kernel
, (void *) NULL
);
4497 perror("pthread_create kernel");
4501 tracepoint(sessiond_boot_end
);
4503 ret
= pthread_join(kernel_thread
, &status
);
4505 perror("pthread_join");
4506 goto error
; /* join error, exit without cleanup */
4510 ret
= pthread_join(apps_thread
, &status
);
4512 perror("pthread_join");
4513 goto error
; /* join error, exit without cleanup */
4517 ret
= pthread_join(reg_apps_thread
, &status
);
4519 perror("pthread_join");
4520 goto error
; /* join error, exit without cleanup */
4524 ret
= pthread_join(dispatch_thread
, &status
);
4526 perror("pthread_join");
4527 goto error
; /* join error, exit without cleanup */
4531 ret
= pthread_join(client_thread
, &status
);
4533 perror("pthread_join");
4534 goto error
; /* join error, exit without cleanup */
4537 ret
= join_consumer_thread(&kconsumer_data
);
4539 perror("join_consumer");
4540 goto error
; /* join error, exit without cleanup */
4546 * cleanup() is called when no other thread is running.
4548 rcu_thread_online();
4550 rcu_thread_offline();
4551 rcu_unregister_thread();