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 /* See shm.c for this call implying mmap, shm and futex calls */
634 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
635 if (wait_shm_mmap
== NULL
) {
639 tracepoint(ust_notify_apps_start
);
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 */
864 ret
= lttng_poll_wait(&events
, -1);
867 * Restart interrupted system call.
869 if (errno
== EINTR
) {
873 } else if (ret
== 0) {
874 /* Should not happen since timeout is infinite */
875 ERR("Return value of poll is 0 with an infinite timeout.\n"
876 "This should not have happened! Continuing...");
880 for (i
= 0; i
< nb_fd
; i
++) {
881 /* Fetch once the poll data */
882 revents
= LTTNG_POLL_GETEV(&events
, i
);
883 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
885 /* Thread quit pipe has been closed. Killing thread. */
886 ret
= check_thread_quit_pipe(pollfd
, revents
);
891 /* Check for data on kernel pipe */
892 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
893 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
894 update_poll_flag
= 1;
898 * New CPU detected by the kernel. Adding kernel stream to
899 * kernel session and updating the kernel consumer
901 if (revents
& LPOLLIN
) {
902 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
908 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
909 * and unregister kernel stream at this point.
917 DBG("Kernel thread dying");
918 close(kernel_poll_pipe
[0]);
919 close(kernel_poll_pipe
[1]);
921 lttng_poll_clean(&events
);
927 * This thread manage the consumer error sent back to the session daemon.
929 static void *thread_manage_consumer(void *data
)
931 int sock
= 0, i
, ret
, pollfd
;
932 uint32_t revents
, nb_fd
;
933 enum lttcomm_return_code code
;
934 struct lttng_poll_event events
;
935 struct consumer_data
*consumer_data
= data
;
937 tracepoint(sessiond_th_kcon_start
);
939 DBG("[thread] Manage consumer started");
941 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
947 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
948 * Nothing more will be added to this poll set.
950 ret
= create_thread_poll_set(&events
, 2);
955 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
960 nb_fd
= LTTNG_POLL_GETNB(&events
);
962 tracepoint(sessiond_th_kcon_poll
);
964 /* Inifinite blocking call, waiting for transmission */
966 ret
= lttng_poll_wait(&events
, -1);
969 * Restart interrupted system call.
971 if (errno
== EINTR
) {
977 for (i
= 0; i
< nb_fd
; i
++) {
978 /* Fetch once the poll data */
979 revents
= LTTNG_POLL_GETEV(&events
, i
);
980 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
982 /* Thread quit pipe has been closed. Killing thread. */
983 ret
= check_thread_quit_pipe(pollfd
, revents
);
988 /* Event on the registration socket */
989 if (pollfd
== consumer_data
->err_sock
) {
990 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
991 ERR("consumer err socket poll error");
997 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1002 DBG2("Receiving code from consumer err_sock");
1004 /* Getting status code from kconsumerd */
1005 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1006 sizeof(enum lttcomm_return_code
));
1011 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1012 consumer_data
->cmd_sock
=
1013 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1014 if (consumer_data
->cmd_sock
< 0) {
1015 sem_post(&consumer_data
->sem
);
1016 PERROR("consumer connect");
1019 /* Signal condition to tell that the kconsumerd is ready */
1020 sem_post(&consumer_data
->sem
);
1021 DBG("consumer command socket ready");
1023 ERR("consumer error when waiting for SOCK_READY : %s",
1024 lttcomm_get_readable_code(-code
));
1028 /* Remove the kconsumerd error sock since we've established a connexion */
1029 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1034 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1039 /* Update number of fd */
1040 nb_fd
= LTTNG_POLL_GETNB(&events
);
1042 /* Inifinite blocking call, waiting for transmission */
1044 ret
= lttng_poll_wait(&events
, -1);
1047 * Restart interrupted system call.
1049 if (errno
== EINTR
) {
1055 for (i
= 0; i
< nb_fd
; i
++) {
1056 /* Fetch once the poll data */
1057 revents
= LTTNG_POLL_GETEV(&events
, i
);
1058 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1060 /* Thread quit pipe has been closed. Killing thread. */
1061 ret
= check_thread_quit_pipe(pollfd
, revents
);
1066 /* Event on the kconsumerd socket */
1067 if (pollfd
== sock
) {
1068 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1069 ERR("consumer err socket second poll error");
1075 /* Wait for any kconsumerd error */
1076 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1077 sizeof(enum lttcomm_return_code
));
1079 ERR("consumer closed the command socket");
1083 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1086 DBG("consumer thread dying");
1087 close(consumer_data
->err_sock
);
1088 close(consumer_data
->cmd_sock
);
1091 unlink(consumer_data
->err_unix_sock_path
);
1092 unlink(consumer_data
->cmd_unix_sock_path
);
1093 consumer_data
->pid
= 0;
1095 lttng_poll_clean(&events
);
1101 * This thread manage application communication.
1103 static void *thread_manage_apps(void *data
)
1106 uint32_t revents
, nb_fd
;
1107 struct ust_command ust_cmd
;
1108 struct lttng_poll_event events
;
1110 tracepoint(sessiond_th_apps_start
);
1112 DBG("[thread] Manage application started");
1114 rcu_register_thread();
1115 rcu_thread_online();
1117 ret
= create_thread_poll_set(&events
, 2);
1122 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1128 /* Zeroed the events structure */
1129 lttng_poll_reset(&events
);
1131 nb_fd
= LTTNG_POLL_GETNB(&events
);
1133 DBG("Apps thread polling on %d fds", nb_fd
);
1135 tracepoint(sessiond_th_apps_poll
);
1137 /* Inifinite blocking call, waiting for transmission */
1139 ret
= lttng_poll_wait(&events
, -1);
1142 * Restart interrupted system call.
1144 if (errno
== EINTR
) {
1150 for (i
= 0; i
< nb_fd
; i
++) {
1151 /* Fetch once the poll data */
1152 revents
= LTTNG_POLL_GETEV(&events
, i
);
1153 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1155 /* Thread quit pipe has been closed. Killing thread. */
1156 ret
= check_thread_quit_pipe(pollfd
, revents
);
1161 /* Inspect the apps cmd pipe */
1162 if (pollfd
== apps_cmd_pipe
[0]) {
1163 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1164 ERR("Apps command pipe error");
1166 } else if (revents
& LPOLLIN
) {
1167 system("sysctl vm.drop_caches=3");
1168 tracepoint(ust_register_read_start
);
1170 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1171 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1172 perror("read apps cmd pipe");
1175 tracepoint(ust_register_read_stop
);
1177 tracepoint(ust_register_add_start
);
1178 /* Register applicaton to the session daemon */
1179 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1181 if (ret
== -ENOMEM
) {
1183 } else if (ret
< 0) {
1186 tracepoint(ust_register_add_stop
);
1189 * Validate UST version compatibility.
1191 ret
= ust_app_validate_version(ust_cmd
.sock
);
1194 * Add channel(s) and event(s) to newly registered apps
1195 * from lttng global UST domain.
1197 update_ust_app(ust_cmd
.sock
);
1200 tracepoint(ust_register_done_start
);
1201 ret
= ust_app_register_done(ust_cmd
.sock
);
1204 * If the registration is not possible, we simply
1205 * unregister the apps and continue
1207 ust_app_unregister(ust_cmd
.sock
);
1209 tracepoint(ust_register_done_stop
);
1211 * We just need here to monitor the close of the UST
1212 * socket and poll set monitor those by default.
1214 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1219 DBG("Apps with sock %d added to poll set",
1226 * At this point, we know that a registered application made
1227 * the event at poll_wait.
1229 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1230 tracepoint(ust_unregister_start
);
1232 /* Removing from the poll set */
1233 ret
= lttng_poll_del(&events
, pollfd
);
1238 /* Socket closed on remote end. */
1239 ust_app_unregister(pollfd
);
1241 tracepoint(ust_unregister_stop
);
1249 DBG("Application communication apps dying");
1250 close(apps_cmd_pipe
[0]);
1251 close(apps_cmd_pipe
[1]);
1253 lttng_poll_clean(&events
);
1255 rcu_thread_offline();
1256 rcu_unregister_thread();
1261 * Dispatch request from the registration threads to the application
1262 * communication thread.
1264 static void *thread_dispatch_ust_registration(void *data
)
1267 struct cds_wfq_node
*node
;
1268 struct ust_command
*ust_cmd
= NULL
;
1270 tracepoint(sessiond_th_dispatch_start
);
1272 DBG("[thread] Dispatch UST command started");
1274 while (!dispatch_thread_exit
) {
1275 /* Atomically prepare the queue futex */
1276 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1279 tracepoint(sessiond_th_dispatch_block
);
1281 /* Dequeue command for registration */
1282 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1284 DBG("Woken up but nothing in the UST command queue");
1285 /* Continue thread execution */
1289 tracepoint(ust_dispatch_register_start
);
1291 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1293 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1294 " gid:%d sock:%d name:%s (version %d.%d)",
1295 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1296 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1297 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1298 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1300 * Inform apps thread of the new application registration. This
1301 * call is blocking so we can be assured that the data will be read
1302 * at some point in time or wait to the end of the world :)
1304 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1305 sizeof(struct ust_command
));
1307 perror("write apps cmd pipe");
1308 if (errno
== EBADF
) {
1310 * We can't inform the application thread to process
1311 * registration. We will exit or else application
1312 * registration will not occur and tracing will never
1319 } while (node
!= NULL
);
1321 tracepoint(ust_dispatch_register_stop
);
1323 /* Futex wait on queue. Blocking call on futex() */
1324 futex_nto1_wait(&ust_cmd_queue
.futex
);
1328 DBG("Dispatch thread dying");
1333 * This thread manage application registration.
1335 static void *thread_registration_apps(void *data
)
1337 int sock
= 0, i
, ret
, pollfd
;
1338 uint32_t revents
, nb_fd
;
1339 struct lttng_poll_event events
;
1341 * Get allocated in this thread, enqueued to a global queue, dequeued and
1342 * freed in the manage apps thread.
1344 struct ust_command
*ust_cmd
= NULL
;
1346 tracepoint(sessiond_th_reg_start
);
1348 DBG("[thread] Manage application registration started");
1350 ret
= lttcomm_listen_unix_sock(apps_sock
);
1356 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1357 * more will be added to this poll set.
1359 ret
= create_thread_poll_set(&events
, 2);
1364 /* Add the application registration socket */
1365 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1370 /* Notify all applications to register */
1371 ret
= notify_ust_apps(1);
1373 ERR("Failed to notify applications or create the wait shared memory.\n"
1374 "Execution continues but there might be problem for already\n"
1375 "running applications that wishes to register.");
1379 DBG("Accepting application registration");
1381 tracepoint(sessiond_th_reg_poll
);
1383 nb_fd
= LTTNG_POLL_GETNB(&events
);
1385 /* Inifinite blocking call, waiting for transmission */
1387 ret
= lttng_poll_wait(&events
, -1);
1390 * Restart interrupted system call.
1392 if (errno
== EINTR
) {
1398 for (i
= 0; i
< nb_fd
; i
++) {
1399 /* Fetch once the poll data */
1400 revents
= LTTNG_POLL_GETEV(&events
, i
);
1401 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1403 /* Thread quit pipe has been closed. Killing thread. */
1404 ret
= check_thread_quit_pipe(pollfd
, revents
);
1409 /* Event on the registration socket */
1410 if (pollfd
== apps_sock
) {
1411 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1412 ERR("Register apps socket poll error");
1414 } else if (revents
& LPOLLIN
) {
1415 /* Registration starts here. Recording cycles */
1416 tracepoint(ust_register_start
);
1418 sock
= lttcomm_accept_unix_sock(apps_sock
);
1423 /* Create UST registration command for enqueuing */
1424 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1425 if (ust_cmd
== NULL
) {
1426 perror("ust command zmalloc");
1431 * Using message-based transmissions to ensure we don't
1432 * have to deal with partially received messages.
1434 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1435 sizeof(struct ust_register_msg
));
1436 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1438 perror("lttcomm_recv_unix_sock register apps");
1440 ERR("Wrong size received on apps register");
1447 ust_cmd
->sock
= sock
;
1449 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1450 " gid:%d sock:%d name:%s (version %d.%d)",
1451 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1452 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1453 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1454 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1457 * Lock free enqueue the registration request. The red pill
1458 * has been taken! This apps will be part of the *system*.
1460 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1463 * Wake the registration queue futex. Implicit memory
1464 * barrier with the exchange in cds_wfq_enqueue.
1466 futex_nto1_wake(&ust_cmd_queue
.futex
);
1468 tracepoint(ust_register_stop
);
1475 DBG("UST Registration thread dying");
1477 /* Notify that the registration thread is gone */
1482 unlink(apps_unix_sock_path
);
1484 lttng_poll_clean(&events
);
1490 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1491 * exec or it will fails.
1493 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1496 struct timespec timeout
;
1498 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1499 timeout
.tv_nsec
= 0;
1501 /* Setup semaphore */
1502 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1504 PERROR("sem_init consumer semaphore");
1508 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1509 thread_manage_consumer
, consumer_data
);
1511 PERROR("pthread_create consumer");
1516 /* Get time for sem_timedwait absolute timeout */
1517 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1519 PERROR("clock_gettime spawn consumer");
1520 /* Infinite wait for the kconsumerd thread to be ready */
1521 ret
= sem_wait(&consumer_data
->sem
);
1523 /* Normal timeout if the gettime was successful */
1524 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1525 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1529 if (errno
== ETIMEDOUT
) {
1531 * Call has timed out so we kill the kconsumerd_thread and return
1534 ERR("The consumer thread was never ready. Killing it");
1535 ret
= pthread_cancel(consumer_data
->thread
);
1537 PERROR("pthread_cancel consumer thread");
1540 PERROR("semaphore wait failed consumer thread");
1545 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1546 if (consumer_data
->pid
== 0) {
1547 ERR("Kconsumerd did not start");
1548 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1551 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1560 * Join consumer thread
1562 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1567 if (consumer_data
->pid
!= 0) {
1568 ret
= kill(consumer_data
->pid
, SIGTERM
);
1570 ERR("Error killing consumer daemon");
1573 return pthread_join(consumer_data
->thread
, &status
);
1580 * Fork and exec a consumer daemon (consumerd).
1582 * Return pid if successful else -1.
1584 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1588 const char *consumer_to_use
;
1589 const char *verbosity
;
1592 DBG("Spawning consumerd");
1599 if (opt_verbose_consumer
) {
1600 verbosity
= "--verbose";
1602 verbosity
= "--quiet";
1604 switch (consumer_data
->type
) {
1605 case LTTNG_CONSUMER_KERNEL
:
1607 * Find out which consumerd to execute. We will first try the
1608 * 64-bit path, then the sessiond's installation directory, and
1609 * fallback on the 32-bit one,
1611 DBG3("Looking for a kernel consumer at these locations:");
1612 DBG3(" 1) %s", consumerd64_bin
);
1613 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1614 DBG3(" 3) %s", consumerd32_bin
);
1615 if (stat(consumerd64_bin
, &st
) == 0) {
1616 DBG3("Found location #1");
1617 consumer_to_use
= consumerd64_bin
;
1618 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1619 DBG3("Found location #2");
1620 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1621 } else if (stat(consumerd32_bin
, &st
) == 0) {
1622 DBG3("Found location #3");
1623 consumer_to_use
= consumerd32_bin
;
1625 DBG("Could not find any valid consumerd executable");
1628 DBG("Using kernel consumer at: %s", consumer_to_use
);
1629 execl(consumer_to_use
,
1630 "lttng-consumerd", verbosity
, "-k",
1631 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1632 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1635 case LTTNG_CONSUMER64_UST
:
1637 char *tmpnew
= NULL
;
1639 if (consumerd64_libdir
[0] != '\0') {
1643 tmp
= getenv("LD_LIBRARY_PATH");
1647 tmplen
= strlen("LD_LIBRARY_PATH=")
1648 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1649 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1654 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1655 strcat(tmpnew
, consumerd64_libdir
);
1656 if (tmp
[0] != '\0') {
1657 strcat(tmpnew
, ":");
1658 strcat(tmpnew
, tmp
);
1660 ret
= putenv(tmpnew
);
1666 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1667 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1668 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1669 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1671 if (consumerd64_libdir
[0] != '\0') {
1679 case LTTNG_CONSUMER32_UST
:
1681 char *tmpnew
= NULL
;
1683 if (consumerd32_libdir
[0] != '\0') {
1687 tmp
= getenv("LD_LIBRARY_PATH");
1691 tmplen
= strlen("LD_LIBRARY_PATH=")
1692 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1693 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1698 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1699 strcat(tmpnew
, consumerd32_libdir
);
1700 if (tmp
[0] != '\0') {
1701 strcat(tmpnew
, ":");
1702 strcat(tmpnew
, tmp
);
1704 ret
= putenv(tmpnew
);
1710 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1711 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1712 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1713 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1715 if (consumerd32_libdir
[0] != '\0') {
1724 perror("unknown consumer type");
1728 perror("kernel start consumer exec");
1731 } else if (pid
> 0) {
1734 perror("start consumer fork");
1742 * Spawn the consumerd daemon and session daemon thread.
1744 static int start_consumerd(struct consumer_data
*consumer_data
)
1748 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1749 if (consumer_data
->pid
!= 0) {
1750 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1754 ret
= spawn_consumerd(consumer_data
);
1756 ERR("Spawning consumerd failed");
1757 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1761 /* Setting up the consumer_data pid */
1762 consumer_data
->pid
= ret
;
1763 DBG2("Consumer pid %d", consumer_data
->pid
);
1764 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1766 DBG2("Spawning consumer control thread");
1767 ret
= spawn_consumer_thread(consumer_data
);
1769 ERR("Fatal error spawning consumer control thread");
1781 * Check version of the lttng-modules.
1783 static int validate_lttng_modules_version(void)
1785 return kernel_validate_version(kernel_tracer_fd
);
1789 * Setup necessary data for kernel tracer action.
1791 static int init_kernel_tracer(void)
1795 /* Modprobe lttng kernel modules */
1796 ret
= modprobe_lttng_control();
1801 /* Open debugfs lttng */
1802 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1803 if (kernel_tracer_fd
< 0) {
1804 DBG("Failed to open %s", module_proc_lttng
);
1809 /* Validate kernel version */
1810 ret
= validate_lttng_modules_version();
1815 ret
= modprobe_lttng_data();
1820 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1824 modprobe_remove_lttng_control();
1825 close(kernel_tracer_fd
);
1826 kernel_tracer_fd
= 0;
1827 return LTTCOMM_KERN_VERSION
;
1830 close(kernel_tracer_fd
);
1833 modprobe_remove_lttng_control();
1836 WARN("No kernel tracer available");
1837 kernel_tracer_fd
= 0;
1838 return LTTCOMM_KERN_NA
;
1842 * Init tracing by creating trace directory and sending fds kernel consumer.
1844 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1848 if (session
->consumer_fds_sent
== 0) {
1850 * Assign default kernel consumer socket if no consumer assigned to the
1851 * kernel session. At this point, it's NOT suppose to be 0 but this is
1852 * an extra security check.
1854 if (session
->consumer_fd
== 0) {
1855 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1858 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1860 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1864 session
->consumer_fds_sent
= 1;
1872 * Create an UST session and add it to the session ust list.
1874 static int create_ust_session(struct ltt_session
*session
,
1875 struct lttng_domain
*domain
)
1877 struct ltt_ust_session
*lus
= NULL
;
1880 switch (domain
->type
) {
1881 case LTTNG_DOMAIN_UST
:
1884 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1888 DBG("Creating UST session");
1890 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1892 ret
= LTTCOMM_UST_SESS_FAIL
;
1896 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1897 session
->uid
, session
->gid
);
1899 if (ret
!= -EEXIST
) {
1900 ERR("Trace directory creation error");
1901 ret
= LTTCOMM_UST_SESS_FAIL
;
1906 /* The domain type dictate different actions on session creation */
1907 switch (domain
->type
) {
1908 case LTTNG_DOMAIN_UST
:
1909 /* No ustctl for the global UST domain */
1912 ERR("Unknown UST domain on create session %d", domain
->type
);
1915 lus
->uid
= session
->uid
;
1916 lus
->gid
= session
->gid
;
1917 session
->ust_session
= lus
;
1927 * Create a kernel tracer session then create the default channel.
1929 static int create_kernel_session(struct ltt_session
*session
)
1933 DBG("Creating kernel session");
1935 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1937 ret
= LTTCOMM_KERN_SESS_FAIL
;
1941 /* Set kernel consumer socket fd */
1942 if (kconsumer_data
.cmd_sock
) {
1943 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1946 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1947 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1949 if (ret
!= -EEXIST
) {
1950 ERR("Trace directory creation error");
1954 session
->kernel_session
->uid
= session
->uid
;
1955 session
->kernel_session
->gid
= session
->gid
;
1962 * Check if the UID or GID match the session. Root user has access to all
1965 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1967 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1974 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1977 struct ltt_session
*session
;
1979 DBG("Counting number of available session for UID %d GID %d",
1981 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1983 * Only list the sessions the user can control.
1985 if (!session_access_ok(session
, uid
, gid
)) {
1994 * Using the session list, filled a lttng_session array to send back to the
1995 * client for session listing.
1997 * The session list lock MUST be acquired before calling this function. Use
1998 * session_lock_list() and session_unlock_list().
2000 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2004 struct ltt_session
*session
;
2006 DBG("Getting all available session for UID %d GID %d",
2009 * Iterate over session list and append data after the control struct in
2012 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2014 * Only list the sessions the user can control.
2016 if (!session_access_ok(session
, uid
, gid
)) {
2019 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2020 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2021 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2022 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2023 sessions
[i
].enabled
= session
->enabled
;
2029 * Fill lttng_channel array of all channels.
2031 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2032 struct lttng_channel
*channels
)
2035 struct ltt_kernel_channel
*kchan
;
2037 DBG("Listing channels for session %s", session
->name
);
2040 case LTTNG_DOMAIN_KERNEL
:
2041 /* Kernel channels */
2042 if (session
->kernel_session
!= NULL
) {
2043 cds_list_for_each_entry(kchan
,
2044 &session
->kernel_session
->channel_list
.head
, list
) {
2045 /* Copy lttng_channel struct to array */
2046 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2047 channels
[i
].enabled
= kchan
->enabled
;
2052 case LTTNG_DOMAIN_UST
:
2054 struct lttng_ht_iter iter
;
2055 struct ltt_ust_channel
*uchan
;
2057 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2058 &iter
.iter
, uchan
, node
.node
) {
2059 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2060 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2061 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2062 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2063 channels
[i
].attr
.switch_timer_interval
=
2064 uchan
->attr
.switch_timer_interval
;
2065 channels
[i
].attr
.read_timer_interval
=
2066 uchan
->attr
.read_timer_interval
;
2067 channels
[i
].enabled
= uchan
->enabled
;
2068 switch (uchan
->attr
.output
) {
2069 case LTTNG_UST_MMAP
:
2071 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2084 * Create a list of ust global domain events.
2086 static int list_lttng_ust_global_events(char *channel_name
,
2087 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2090 unsigned int nb_event
= 0;
2091 struct lttng_ht_iter iter
;
2092 struct lttng_ht_node_str
*node
;
2093 struct ltt_ust_channel
*uchan
;
2094 struct ltt_ust_event
*uevent
;
2095 struct lttng_event
*tmp
;
2097 DBG("Listing UST global events for channel %s", channel_name
);
2101 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2102 node
= lttng_ht_iter_get_node_str(&iter
);
2104 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2108 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2110 nb_event
+= lttng_ht_get_count(uchan
->events
);
2112 if (nb_event
== 0) {
2117 DBG3("Listing UST global %d events", nb_event
);
2119 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2121 ret
= -LTTCOMM_FATAL
;
2125 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2126 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2127 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2128 tmp
[i
].enabled
= uevent
->enabled
;
2129 switch (uevent
->attr
.instrumentation
) {
2130 case LTTNG_UST_TRACEPOINT
:
2131 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2133 case LTTNG_UST_PROBE
:
2134 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2136 case LTTNG_UST_FUNCTION
:
2137 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2140 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2141 switch (uevent
->attr
.loglevel_type
) {
2142 case LTTNG_UST_LOGLEVEL_ALL
:
2143 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2145 case LTTNG_UST_LOGLEVEL_RANGE
:
2146 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2148 case LTTNG_UST_LOGLEVEL_SINGLE
:
2149 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2164 * Fill lttng_event array of all kernel events in the channel.
2166 static int list_lttng_kernel_events(char *channel_name
,
2167 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2170 unsigned int nb_event
;
2171 struct ltt_kernel_event
*event
;
2172 struct ltt_kernel_channel
*kchan
;
2174 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2175 if (kchan
== NULL
) {
2176 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2180 nb_event
= kchan
->event_count
;
2182 DBG("Listing events for channel %s", kchan
->channel
->name
);
2184 if (nb_event
== 0) {
2189 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2190 if (*events
== NULL
) {
2191 ret
= LTTCOMM_FATAL
;
2195 /* Kernel channels */
2196 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2197 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2198 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2199 (*events
)[i
].enabled
= event
->enabled
;
2200 switch (event
->event
->instrumentation
) {
2201 case LTTNG_KERNEL_TRACEPOINT
:
2202 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2204 case LTTNG_KERNEL_KPROBE
:
2205 case LTTNG_KERNEL_KRETPROBE
:
2206 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2207 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2208 sizeof(struct lttng_kernel_kprobe
));
2210 case LTTNG_KERNEL_FUNCTION
:
2211 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2212 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2213 sizeof(struct lttng_kernel_function
));
2215 case LTTNG_KERNEL_NOOP
:
2216 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2218 case LTTNG_KERNEL_SYSCALL
:
2219 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2221 case LTTNG_KERNEL_ALL
:
2235 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2237 static int cmd_disable_channel(struct ltt_session
*session
,
2238 int domain
, char *channel_name
)
2241 struct ltt_ust_session
*usess
;
2243 usess
= session
->ust_session
;
2246 case LTTNG_DOMAIN_KERNEL
:
2248 ret
= channel_kernel_disable(session
->kernel_session
,
2250 if (ret
!= LTTCOMM_OK
) {
2254 kernel_wait_quiescent(kernel_tracer_fd
);
2257 case LTTNG_DOMAIN_UST
:
2259 struct ltt_ust_channel
*uchan
;
2260 struct lttng_ht
*chan_ht
;
2262 chan_ht
= usess
->domain_global
.channels
;
2264 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2265 if (uchan
== NULL
) {
2266 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2270 ret
= channel_ust_disable(usess
, domain
, uchan
);
2271 if (ret
!= LTTCOMM_OK
) {
2277 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2278 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2279 case LTTNG_DOMAIN_UST_PID
:
2282 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2293 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2295 static int cmd_enable_channel(struct ltt_session
*session
,
2296 int domain
, struct lttng_channel
*attr
)
2299 struct ltt_ust_session
*usess
= session
->ust_session
;
2300 struct lttng_ht
*chan_ht
;
2302 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2305 case LTTNG_DOMAIN_KERNEL
:
2307 struct ltt_kernel_channel
*kchan
;
2309 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2310 session
->kernel_session
);
2311 if (kchan
== NULL
) {
2312 ret
= channel_kernel_create(session
->kernel_session
,
2313 attr
, kernel_poll_pipe
[1]);
2315 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2318 if (ret
!= LTTCOMM_OK
) {
2322 kernel_wait_quiescent(kernel_tracer_fd
);
2325 case LTTNG_DOMAIN_UST
:
2327 struct ltt_ust_channel
*uchan
;
2329 chan_ht
= usess
->domain_global
.channels
;
2331 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2332 if (uchan
== NULL
) {
2333 ret
= channel_ust_create(usess
, domain
, attr
);
2335 ret
= channel_ust_enable(usess
, domain
, uchan
);
2340 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2341 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2342 case LTTNG_DOMAIN_UST_PID
:
2345 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2354 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2356 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2357 char *channel_name
, char *event_name
)
2362 case LTTNG_DOMAIN_KERNEL
:
2364 struct ltt_kernel_channel
*kchan
;
2365 struct ltt_kernel_session
*ksess
;
2367 ksess
= session
->kernel_session
;
2369 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2370 if (kchan
== NULL
) {
2371 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2375 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2376 if (ret
!= LTTCOMM_OK
) {
2380 kernel_wait_quiescent(kernel_tracer_fd
);
2383 case LTTNG_DOMAIN_UST
:
2385 struct ltt_ust_channel
*uchan
;
2386 struct ltt_ust_session
*usess
;
2388 usess
= session
->ust_session
;
2390 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2392 if (uchan
== NULL
) {
2393 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2397 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2398 if (ret
!= LTTCOMM_OK
) {
2402 DBG3("Disable UST event %s in channel %s completed", event_name
,
2407 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2408 case LTTNG_DOMAIN_UST_PID
:
2409 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2423 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2425 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2431 case LTTNG_DOMAIN_KERNEL
:
2433 struct ltt_kernel_session
*ksess
;
2434 struct ltt_kernel_channel
*kchan
;
2436 ksess
= session
->kernel_session
;
2438 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2439 if (kchan
== NULL
) {
2440 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2444 ret
= event_kernel_disable_all(ksess
, kchan
);
2445 if (ret
!= LTTCOMM_OK
) {
2449 kernel_wait_quiescent(kernel_tracer_fd
);
2452 case LTTNG_DOMAIN_UST
:
2454 struct ltt_ust_session
*usess
;
2455 struct ltt_ust_channel
*uchan
;
2457 usess
= session
->ust_session
;
2459 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2461 if (uchan
== NULL
) {
2462 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2466 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2471 DBG3("Disable all UST events in channel %s completed", channel_name
);
2476 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2477 case LTTNG_DOMAIN_UST_PID
:
2478 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2492 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2494 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2495 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2500 case LTTNG_DOMAIN_KERNEL
:
2501 /* Add kernel context to kernel tracer */
2502 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2503 event_name
, channel_name
);
2504 if (ret
!= LTTCOMM_OK
) {
2508 case LTTNG_DOMAIN_UST
:
2510 struct ltt_ust_session
*usess
= session
->ust_session
;
2512 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2513 if (ret
!= LTTCOMM_OK
) {
2519 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2520 case LTTNG_DOMAIN_UST_PID
:
2521 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2535 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2537 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2538 char *channel_name
, struct lttng_event
*event
)
2541 struct lttng_channel
*attr
;
2542 struct ltt_ust_session
*usess
= session
->ust_session
;
2545 case LTTNG_DOMAIN_KERNEL
:
2547 struct ltt_kernel_channel
*kchan
;
2549 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2550 session
->kernel_session
);
2551 if (kchan
== NULL
) {
2552 attr
= channel_new_default_attr(domain
);
2554 ret
= LTTCOMM_FATAL
;
2557 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2559 /* This call will notify the kernel thread */
2560 ret
= channel_kernel_create(session
->kernel_session
,
2561 attr
, kernel_poll_pipe
[1]);
2562 if (ret
!= LTTCOMM_OK
) {
2569 /* Get the newly created kernel channel pointer */
2570 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2571 session
->kernel_session
);
2572 if (kchan
== NULL
) {
2573 /* This sould not happen... */
2574 ret
= LTTCOMM_FATAL
;
2578 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2580 if (ret
!= LTTCOMM_OK
) {
2584 kernel_wait_quiescent(kernel_tracer_fd
);
2587 case LTTNG_DOMAIN_UST
:
2589 struct lttng_channel
*attr
;
2590 struct ltt_ust_channel
*uchan
;
2592 /* Get channel from global UST domain */
2593 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2595 if (uchan
== NULL
) {
2596 /* Create default channel */
2597 attr
= channel_new_default_attr(domain
);
2599 ret
= LTTCOMM_FATAL
;
2602 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2603 attr
->name
[NAME_MAX
- 1] = '\0';
2605 ret
= channel_ust_create(usess
, domain
, attr
);
2606 if (ret
!= LTTCOMM_OK
) {
2612 /* Get the newly created channel reference back */
2613 uchan
= trace_ust_find_channel_by_name(
2614 usess
->domain_global
.channels
, channel_name
);
2615 if (uchan
== NULL
) {
2616 /* Something is really wrong */
2617 ret
= LTTCOMM_FATAL
;
2622 /* At this point, the session and channel exist on the tracer */
2623 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2624 if (ret
!= LTTCOMM_OK
) {
2630 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2631 case LTTNG_DOMAIN_UST_PID
:
2632 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2646 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2648 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2649 char *channel_name
, int event_type
)
2652 struct ltt_kernel_channel
*kchan
;
2655 case LTTNG_DOMAIN_KERNEL
:
2656 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2657 session
->kernel_session
);
2658 if (kchan
== NULL
) {
2659 /* This call will notify the kernel thread */
2660 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2661 kernel_poll_pipe
[1]);
2662 if (ret
!= LTTCOMM_OK
) {
2666 /* Get the newly created kernel channel pointer */
2667 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2668 session
->kernel_session
);
2669 if (kchan
== NULL
) {
2670 /* This sould not happen... */
2671 ret
= LTTCOMM_FATAL
;
2677 switch (event_type
) {
2678 case LTTNG_EVENT_SYSCALL
:
2679 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2680 kchan
, kernel_tracer_fd
);
2682 case LTTNG_EVENT_TRACEPOINT
:
2684 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2685 * events already registered to the channel.
2687 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2688 kchan
, kernel_tracer_fd
);
2690 case LTTNG_EVENT_ALL
:
2691 /* Enable syscalls and tracepoints */
2692 ret
= event_kernel_enable_all(session
->kernel_session
,
2693 kchan
, kernel_tracer_fd
);
2696 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2700 /* Manage return value */
2701 if (ret
!= LTTCOMM_OK
) {
2705 kernel_wait_quiescent(kernel_tracer_fd
);
2707 case LTTNG_DOMAIN_UST
:
2709 struct lttng_channel
*attr
;
2710 struct ltt_ust_channel
*uchan
;
2711 struct ltt_ust_session
*usess
= session
->ust_session
;
2713 /* Get channel from global UST domain */
2714 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2716 if (uchan
== NULL
) {
2717 /* Create default channel */
2718 attr
= channel_new_default_attr(domain
);
2720 ret
= LTTCOMM_FATAL
;
2723 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2724 attr
->name
[NAME_MAX
- 1] = '\0';
2726 /* Use the internal command enable channel */
2727 ret
= channel_ust_create(usess
, domain
, attr
);
2728 if (ret
!= LTTCOMM_OK
) {
2734 /* Get the newly created channel reference back */
2735 uchan
= trace_ust_find_channel_by_name(
2736 usess
->domain_global
.channels
, channel_name
);
2737 if (uchan
== NULL
) {
2738 /* Something is really wrong */
2739 ret
= LTTCOMM_FATAL
;
2744 /* At this point, the session and channel exist on the tracer */
2746 switch (event_type
) {
2747 case LTTNG_EVENT_ALL
:
2748 case LTTNG_EVENT_TRACEPOINT
:
2749 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2750 if (ret
!= LTTCOMM_OK
) {
2755 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2759 /* Manage return value */
2760 if (ret
!= LTTCOMM_OK
) {
2767 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2768 case LTTNG_DOMAIN_UST_PID
:
2769 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2783 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2785 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2788 ssize_t nb_events
= 0;
2791 case LTTNG_DOMAIN_KERNEL
:
2792 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2793 if (nb_events
< 0) {
2794 ret
= LTTCOMM_KERN_LIST_FAIL
;
2798 case LTTNG_DOMAIN_UST
:
2799 nb_events
= ust_app_list_events(events
);
2800 if (nb_events
< 0) {
2801 ret
= LTTCOMM_UST_LIST_FAIL
;
2813 /* Return negative value to differentiate return code */
2818 * Command LTTNG_START_TRACE processed by the client thread.
2820 static int cmd_start_trace(struct ltt_session
*session
)
2823 struct ltt_kernel_session
*ksession
;
2824 struct ltt_ust_session
*usess
;
2827 ksession
= session
->kernel_session
;
2828 usess
= session
->ust_session
;
2830 if (session
->enabled
) {
2831 ret
= LTTCOMM_UST_START_FAIL
;
2835 session
->enabled
= 1;
2837 /* Kernel tracing */
2838 if (ksession
!= NULL
) {
2839 struct ltt_kernel_channel
*kchan
;
2841 /* Open kernel metadata */
2842 if (ksession
->metadata
== NULL
) {
2843 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2845 ret
= LTTCOMM_KERN_META_FAIL
;
2850 /* Open kernel metadata stream */
2851 if (ksession
->metadata_stream_fd
== 0) {
2852 ret
= kernel_open_metadata_stream(ksession
);
2854 ERR("Kernel create metadata stream failed");
2855 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2860 /* For each channel */
2861 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2862 if (kchan
->stream_count
== 0) {
2863 ret
= kernel_open_channel_stream(kchan
);
2865 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2868 /* Update the stream global counter */
2869 ksession
->stream_count_global
+= ret
;
2873 /* Setup kernel consumer socket and send fds to it */
2874 ret
= init_kernel_tracing(ksession
);
2876 ret
= LTTCOMM_KERN_START_FAIL
;
2880 /* This start the kernel tracing */
2881 ret
= kernel_start_session(ksession
);
2883 ret
= LTTCOMM_KERN_START_FAIL
;
2887 /* Quiescent wait after starting trace */
2888 kernel_wait_quiescent(kernel_tracer_fd
);
2891 /* Flag session that trace should start automatically */
2893 usess
->start_trace
= 1;
2895 ret
= ust_app_start_trace_all(usess
);
2897 ret
= LTTCOMM_UST_START_FAIL
;
2909 * Command LTTNG_STOP_TRACE processed by the client thread.
2911 static int cmd_stop_trace(struct ltt_session
*session
)
2914 struct ltt_kernel_channel
*kchan
;
2915 struct ltt_kernel_session
*ksession
;
2916 struct ltt_ust_session
*usess
;
2919 ksession
= session
->kernel_session
;
2920 usess
= session
->ust_session
;
2922 if (!session
->enabled
) {
2923 ret
= LTTCOMM_UST_STOP_FAIL
;
2927 session
->enabled
= 0;
2930 if (ksession
!= NULL
) {
2931 DBG("Stop kernel tracing");
2933 /* Flush all buffers before stopping */
2934 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2936 ERR("Kernel metadata flush failed");
2939 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2940 ret
= kernel_flush_buffer(kchan
);
2942 ERR("Kernel flush buffer error");
2946 ret
= kernel_stop_session(ksession
);
2948 ret
= LTTCOMM_KERN_STOP_FAIL
;
2952 kernel_wait_quiescent(kernel_tracer_fd
);
2956 usess
->start_trace
= 0;
2958 ret
= ust_app_stop_trace_all(usess
);
2960 ret
= LTTCOMM_UST_STOP_FAIL
;
2972 * Command LTTNG_CREATE_SESSION processed by the client thread.
2974 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2978 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2979 if (ret
!= LTTCOMM_OK
) {
2990 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2992 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2996 /* Clean kernel session teardown */
2997 teardown_kernel_session(session
);
2998 /* UST session teardown */
2999 teardown_ust_session(session
);
3002 * Must notify the kernel thread here to update it's poll setin order
3003 * to remove the channel(s)' fd just destroyed.
3005 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3007 perror("write kernel poll pipe");
3010 ret
= session_destroy(session
);
3016 * Command LTTNG_CALIBRATE processed by the client thread.
3018 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3023 case LTTNG_DOMAIN_KERNEL
:
3025 struct lttng_kernel_calibrate kcalibrate
;
3027 kcalibrate
.type
= calibrate
->type
;
3028 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3030 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3035 case LTTNG_DOMAIN_UST
:
3037 struct lttng_ust_calibrate ucalibrate
;
3039 ucalibrate
.type
= calibrate
->type
;
3040 ret
= ust_app_calibrate_glb(&ucalibrate
);
3042 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3059 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3061 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3067 case LTTNG_DOMAIN_KERNEL
:
3068 /* Can't register a consumer if there is already one */
3069 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3070 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3074 sock
= lttcomm_connect_unix_sock(sock_path
);
3076 ret
= LTTCOMM_CONNECT_FAIL
;
3080 session
->kernel_session
->consumer_fd
= sock
;
3083 /* TODO: Userspace tracing */
3095 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3097 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3098 struct lttng_domain
**domains
)
3103 if (session
->kernel_session
!= NULL
) {
3104 DBG3("Listing domains found kernel domain");
3108 if (session
->ust_session
!= NULL
) {
3109 DBG3("Listing domains found UST global domain");
3113 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3114 if (*domains
== NULL
) {
3115 ret
= -LTTCOMM_FATAL
;
3119 if (session
->kernel_session
!= NULL
) {
3120 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3124 if (session
->ust_session
!= NULL
) {
3125 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3136 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3138 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3139 struct lttng_channel
**channels
)
3142 ssize_t nb_chan
= 0;
3145 case LTTNG_DOMAIN_KERNEL
:
3146 if (session
->kernel_session
!= NULL
) {
3147 nb_chan
= session
->kernel_session
->channel_count
;
3149 DBG3("Number of kernel channels %zd", nb_chan
);
3151 case LTTNG_DOMAIN_UST
:
3152 if (session
->ust_session
!= NULL
) {
3153 nb_chan
= lttng_ht_get_count(
3154 session
->ust_session
->domain_global
.channels
);
3156 DBG3("Number of UST global channels %zd", nb_chan
);
3165 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3166 if (*channels
== NULL
) {
3167 ret
= -LTTCOMM_FATAL
;
3171 list_lttng_channels(domain
, session
, *channels
);
3183 * Command LTTNG_LIST_EVENTS processed by the client thread.
3185 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3186 char *channel_name
, struct lttng_event
**events
)
3189 ssize_t nb_event
= 0;
3192 case LTTNG_DOMAIN_KERNEL
:
3193 if (session
->kernel_session
!= NULL
) {
3194 nb_event
= list_lttng_kernel_events(channel_name
,
3195 session
->kernel_session
, events
);
3198 case LTTNG_DOMAIN_UST
:
3200 if (session
->ust_session
!= NULL
) {
3201 nb_event
= list_lttng_ust_global_events(channel_name
,
3202 &session
->ust_session
->domain_global
, events
);
3218 * Process the command requested by the lttng client within the command
3219 * context structure. This function make sure that the return structure (llm)
3220 * is set and ready for transmission before returning.
3222 * Return any error encountered or 0 for success.
3224 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3226 int ret
= LTTCOMM_OK
;
3227 int need_tracing_session
= 1;
3230 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3232 switch (cmd_ctx
->lsm
->cmd_type
) {
3233 case LTTNG_CREATE_SESSION
:
3234 case LTTNG_DESTROY_SESSION
:
3235 case LTTNG_LIST_SESSIONS
:
3236 case LTTNG_LIST_DOMAINS
:
3237 case LTTNG_START_TRACE
:
3238 case LTTNG_STOP_TRACE
:
3245 if (opt_no_kernel
&& need_domain
3246 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3247 ret
= LTTCOMM_KERN_NA
;
3252 * Check for command that don't needs to allocate a returned payload. We do
3253 * this here so we don't have to make the call for no payload at each
3256 switch(cmd_ctx
->lsm
->cmd_type
) {
3257 case LTTNG_LIST_SESSIONS
:
3258 case LTTNG_LIST_TRACEPOINTS
:
3259 case LTTNG_LIST_DOMAINS
:
3260 case LTTNG_LIST_CHANNELS
:
3261 case LTTNG_LIST_EVENTS
:
3264 /* Setup lttng message with no payload */
3265 ret
= setup_lttng_msg(cmd_ctx
, 0);
3267 /* This label does not try to unlock the session */
3268 goto init_setup_error
;
3272 /* Commands that DO NOT need a session. */
3273 switch (cmd_ctx
->lsm
->cmd_type
) {
3274 case LTTNG_CREATE_SESSION
:
3275 case LTTNG_CALIBRATE
:
3276 case LTTNG_LIST_SESSIONS
:
3277 case LTTNG_LIST_TRACEPOINTS
:
3278 need_tracing_session
= 0;
3281 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3282 session_lock_list();
3283 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3284 session_unlock_list();
3285 if (cmd_ctx
->session
== NULL
) {
3286 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3287 ret
= LTTCOMM_SESS_NOT_FOUND
;
3289 /* If no session name specified */
3290 ret
= LTTCOMM_SELECT_SESS
;
3294 /* Acquire lock for the session */
3295 session_lock(cmd_ctx
->session
);
3304 * Check domain type for specific "pre-action".
3306 switch (cmd_ctx
->lsm
->domain
.type
) {
3307 case LTTNG_DOMAIN_KERNEL
:
3309 ret
= LTTCOMM_KERN_NA
;
3313 /* Kernel tracer check */
3314 if (kernel_tracer_fd
== 0) {
3315 /* Basically, load kernel tracer modules */
3316 ret
= init_kernel_tracer();
3322 /* Need a session for kernel command */
3323 if (need_tracing_session
) {
3324 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3325 ret
= create_kernel_session(cmd_ctx
->session
);
3327 ret
= LTTCOMM_KERN_SESS_FAIL
;
3332 /* Start the kernel consumer daemon */
3333 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3334 if (kconsumer_data
.pid
== 0 &&
3335 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3336 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3337 ret
= start_consumerd(&kconsumer_data
);
3339 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3343 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3347 case LTTNG_DOMAIN_UST
:
3349 if (need_tracing_session
) {
3350 if (cmd_ctx
->session
->ust_session
== NULL
) {
3351 ret
= create_ust_session(cmd_ctx
->session
,
3352 &cmd_ctx
->lsm
->domain
);
3353 if (ret
!= LTTCOMM_OK
) {
3357 /* Start the UST consumer daemons */
3359 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3360 if (consumerd64_bin
[0] != '\0' &&
3361 ustconsumer64_data
.pid
== 0 &&
3362 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3363 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3364 ret
= start_consumerd(&ustconsumer64_data
);
3366 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3367 ust_consumerd64_fd
= -EINVAL
;
3371 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3373 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3376 if (consumerd32_bin
[0] != '\0' &&
3377 ustconsumer32_data
.pid
== 0 &&
3378 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3379 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3380 ret
= start_consumerd(&ustconsumer32_data
);
3382 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3383 ust_consumerd32_fd
= -EINVAL
;
3386 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3388 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3399 * Check that the UID or GID match that of the tracing session.
3400 * The root user can interact with all sessions.
3402 if (need_tracing_session
) {
3403 if (!session_access_ok(cmd_ctx
->session
,
3404 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3405 ret
= LTTCOMM_EPERM
;
3410 /* Process by command type */
3411 switch (cmd_ctx
->lsm
->cmd_type
) {
3412 case LTTNG_ADD_CONTEXT
:
3414 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3415 cmd_ctx
->lsm
->u
.context
.channel_name
,
3416 cmd_ctx
->lsm
->u
.context
.event_name
,
3417 &cmd_ctx
->lsm
->u
.context
.ctx
);
3420 case LTTNG_DISABLE_CHANNEL
:
3422 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3423 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3426 case LTTNG_DISABLE_EVENT
:
3428 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3429 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3430 cmd_ctx
->lsm
->u
.disable
.name
);
3433 case LTTNG_DISABLE_ALL_EVENT
:
3435 DBG("Disabling all events");
3437 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3438 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3441 case LTTNG_ENABLE_CHANNEL
:
3443 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3444 &cmd_ctx
->lsm
->u
.channel
.chan
);
3447 case LTTNG_ENABLE_EVENT
:
3449 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3450 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3451 &cmd_ctx
->lsm
->u
.enable
.event
);
3454 case LTTNG_ENABLE_ALL_EVENT
:
3456 DBG("Enabling all events");
3458 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3459 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3460 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3463 case LTTNG_LIST_TRACEPOINTS
:
3465 struct lttng_event
*events
;
3468 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3469 if (nb_events
< 0) {
3475 * Setup lttng message with payload size set to the event list size in
3476 * bytes and then copy list into the llm payload.
3478 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3484 /* Copy event list into message payload */
3485 memcpy(cmd_ctx
->llm
->payload
, events
,
3486 sizeof(struct lttng_event
) * nb_events
);
3493 case LTTNG_START_TRACE
:
3495 ret
= cmd_start_trace(cmd_ctx
->session
);
3498 case LTTNG_STOP_TRACE
:
3500 ret
= cmd_stop_trace(cmd_ctx
->session
);
3503 case LTTNG_CREATE_SESSION
:
3505 tracepoint(create_session_start
);
3506 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3507 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3508 tracepoint(create_session_end
);
3511 case LTTNG_DESTROY_SESSION
:
3513 tracepoint(destroy_session_start
);
3514 ret
= cmd_destroy_session(cmd_ctx
->session
,
3515 cmd_ctx
->lsm
->session
.name
);
3516 tracepoint(destroy_session_end
);
3519 case LTTNG_LIST_DOMAINS
:
3522 struct lttng_domain
*domains
;
3524 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3530 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3535 /* Copy event list into message payload */
3536 memcpy(cmd_ctx
->llm
->payload
, domains
,
3537 nb_dom
* sizeof(struct lttng_domain
));
3544 case LTTNG_LIST_CHANNELS
:
3547 struct lttng_channel
*channels
;
3549 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3550 cmd_ctx
->session
, &channels
);
3556 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3561 /* Copy event list into message payload */
3562 memcpy(cmd_ctx
->llm
->payload
, channels
,
3563 nb_chan
* sizeof(struct lttng_channel
));
3570 case LTTNG_LIST_EVENTS
:
3573 struct lttng_event
*events
= NULL
;
3575 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3576 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3582 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3587 /* Copy event list into message payload */
3588 memcpy(cmd_ctx
->llm
->payload
, events
,
3589 nb_event
* sizeof(struct lttng_event
));
3596 case LTTNG_LIST_SESSIONS
:
3598 unsigned int nr_sessions
;
3600 session_lock_list();
3601 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3603 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3605 session_unlock_list();
3609 /* Filled the session array */
3610 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3611 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3613 session_unlock_list();
3618 case LTTNG_CALIBRATE
:
3620 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3621 &cmd_ctx
->lsm
->u
.calibrate
);
3624 case LTTNG_REGISTER_CONSUMER
:
3626 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3627 cmd_ctx
->lsm
->u
.reg
.path
);
3636 if (cmd_ctx
->llm
== NULL
) {
3637 DBG("Missing llm structure. Allocating one.");
3638 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3642 /* Set return code */
3643 cmd_ctx
->llm
->ret_code
= ret
;
3645 if (cmd_ctx
->session
) {
3646 session_unlock(cmd_ctx
->session
);
3653 * This thread manage all clients request using the unix client socket for
3656 static void *thread_manage_clients(void *data
)
3658 int sock
= 0, ret
, i
, pollfd
;
3659 uint32_t revents
, nb_fd
;
3660 struct command_ctx
*cmd_ctx
= NULL
;
3661 struct lttng_poll_event events
;
3663 tracepoint(sessiond_th_cli_start
);
3665 DBG("[thread] Manage client started");
3667 rcu_register_thread();
3669 ret
= lttcomm_listen_unix_sock(client_sock
);
3675 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3676 * more will be added to this poll set.
3678 ret
= create_thread_poll_set(&events
, 2);
3683 /* Add the application registration socket */
3684 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3690 * Notify parent pid that we are ready to accept command for client side.
3692 if (opt_sig_parent
) {
3693 kill(ppid
, SIGUSR1
);
3697 DBG("Accepting client command ...");
3699 tracepoint(sessiond_th_cli_poll
);
3701 nb_fd
= LTTNG_POLL_GETNB(&events
);
3703 /* Inifinite blocking call, waiting for transmission */
3705 ret
= lttng_poll_wait(&events
, -1);
3708 * Restart interrupted system call.
3710 if (errno
== EINTR
) {
3716 for (i
= 0; i
< nb_fd
; i
++) {
3717 /* Fetch once the poll data */
3718 revents
= LTTNG_POLL_GETEV(&events
, i
);
3719 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3721 /* Thread quit pipe has been closed. Killing thread. */
3722 ret
= check_thread_quit_pipe(pollfd
, revents
);
3727 /* Event on the registration socket */
3728 if (pollfd
== client_sock
) {
3729 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3730 ERR("Client socket poll error");
3736 DBG("Wait for client response");
3738 sock
= lttcomm_accept_unix_sock(client_sock
);
3743 /* Set socket option for credentials retrieval */
3744 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3749 /* Allocate context command to process the client request */
3750 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3751 if (cmd_ctx
== NULL
) {
3752 perror("zmalloc cmd_ctx");
3756 /* Allocate data buffer for reception */
3757 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3758 if (cmd_ctx
->lsm
== NULL
) {
3759 perror("zmalloc cmd_ctx->lsm");
3763 cmd_ctx
->llm
= NULL
;
3764 cmd_ctx
->session
= NULL
;
3767 * Data is received from the lttng client. The struct
3768 * lttcomm_session_msg (lsm) contains the command and data request of
3771 DBG("Receiving data from client ...");
3772 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3773 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3775 DBG("Nothing recv() from client... continuing");
3781 // TODO: Validate cmd_ctx including sanity check for
3782 // security purpose.
3784 rcu_thread_online();
3786 * This function dispatch the work to the kernel or userspace tracer
3787 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3788 * informations for the client. The command context struct contains
3789 * everything this function may needs.
3791 ret
= process_client_msg(cmd_ctx
);
3792 rcu_thread_offline();
3795 * TODO: Inform client somehow of the fatal error. At
3796 * this point, ret < 0 means that a zmalloc failed
3797 * (ENOMEM). Error detected but still accept command.
3799 clean_command_ctx(&cmd_ctx
);
3803 DBG("Sending response (size: %d, retcode: %s)",
3804 cmd_ctx
->lttng_msg_size
,
3805 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3806 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3808 ERR("Failed to send data back to client");
3811 /* End of transmission */
3814 clean_command_ctx(&cmd_ctx
);
3818 DBG("Client thread dying");
3819 unlink(client_unix_sock_path
);
3823 lttng_poll_clean(&events
);
3824 clean_command_ctx(&cmd_ctx
);
3826 rcu_unregister_thread();
3832 * usage function on stderr
3834 static void usage(void)
3836 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3837 fprintf(stderr
, " -h, --help Display this usage.\n");
3838 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3839 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3840 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3841 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3842 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3843 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3844 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3845 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3846 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3847 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3848 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3849 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3850 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3851 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3852 fprintf(stderr
, " -V, --version Show version number.\n");
3853 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3854 fprintf(stderr
, " -q, --quiet No output at all.\n");
3855 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3856 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3857 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3861 * daemon argument parsing
3863 static int parse_args(int argc
, char **argv
)
3867 static struct option long_options
[] = {
3868 { "client-sock", 1, 0, 'c' },
3869 { "apps-sock", 1, 0, 'a' },
3870 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3871 { "kconsumerd-err-sock", 1, 0, 'E' },
3872 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3873 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3874 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3875 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3876 { "consumerd32-path", 1, 0, 'u' },
3877 { "consumerd32-libdir", 1, 0, 'U' },
3878 { "consumerd64-path", 1, 0, 't' },
3879 { "consumerd64-libdir", 1, 0, 'T' },
3880 { "daemonize", 0, 0, 'd' },
3881 { "sig-parent", 0, 0, 'S' },
3882 { "help", 0, 0, 'h' },
3883 { "group", 1, 0, 'g' },
3884 { "version", 0, 0, 'V' },
3885 { "quiet", 0, 0, 'q' },
3886 { "verbose", 0, 0, 'v' },
3887 { "verbose-consumer", 0, 0, 'Z' },
3888 { "no-kernel", 0, 0, 'N' },
3893 int option_index
= 0;
3894 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3895 long_options
, &option_index
);
3902 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3904 fprintf(stderr
, " with arg %s\n", optarg
);
3908 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3911 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3917 opt_tracing_group
= optarg
;
3923 fprintf(stdout
, "%s\n", VERSION
);
3929 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3932 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3935 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3938 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3941 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3944 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3953 /* Verbose level can increase using multiple -v */
3957 opt_verbose_consumer
+= 1;
3960 consumerd32_bin
= optarg
;
3963 consumerd32_libdir
= optarg
;
3966 consumerd64_bin
= optarg
;
3969 consumerd64_libdir
= optarg
;
3972 /* Unknown option or other error.
3973 * Error is printed by getopt, just return */
3982 * Creates the two needed socket by the daemon.
3983 * apps_sock - The communication socket for all UST apps.
3984 * client_sock - The communication of the cli tool (lttng).
3986 static int init_daemon_socket(void)
3991 old_umask
= umask(0);
3993 /* Create client tool unix socket */
3994 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3995 if (client_sock
< 0) {
3996 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4001 /* File permission MUST be 660 */
4002 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4004 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4009 /* Create the application unix socket */
4010 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4011 if (apps_sock
< 0) {
4012 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4017 /* File permission MUST be 666 */
4018 ret
= chmod(apps_unix_sock_path
,
4019 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4021 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4032 * Check if the global socket is available, and if a daemon is answering at the
4033 * other side. If yes, error is returned.
4035 static int check_existing_daemon(void)
4037 /* Is there anybody out there ? */
4038 if (lttng_session_daemon_alive()) {
4046 * Set the tracing group gid onto the client socket.
4048 * Race window between mkdir and chown is OK because we are going from more
4049 * permissive (root.root) to less permissive (root.tracing).
4051 static int set_permissions(char *rundir
)
4056 gid
= allowed_group();
4058 WARN("No tracing group detected");
4063 /* Set lttng run dir */
4064 ret
= chown(rundir
, 0, gid
);
4066 ERR("Unable to set group on %s", rundir
);
4070 /* Ensure tracing group can search the run dir */
4071 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
);
4073 ERR("Unable to set permissions on %s", rundir
);
4077 /* lttng client socket path */
4078 ret
= chown(client_unix_sock_path
, 0, gid
);
4080 ERR("Unable to set group on %s", client_unix_sock_path
);
4084 /* kconsumer error socket path */
4085 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4087 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4091 /* 64-bit ustconsumer error socket path */
4092 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4094 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4098 /* 32-bit ustconsumer compat32 error socket path */
4099 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4101 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4105 DBG("All permissions are set");
4112 * Create the pipe used to wake up the kernel thread.
4114 static int create_kernel_poll_pipe(void)
4116 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4120 * Create the application command pipe to wake thread_manage_apps.
4122 static int create_apps_cmd_pipe(void)
4124 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4128 * Create the lttng run directory needed for all global sockets and pipe.
4130 static int create_lttng_rundir(const char *rundir
)
4134 DBG3("Creating LTTng run directory: %s", rundir
);
4136 ret
= mkdir(rundir
, S_IRWXU
);
4138 if (errno
!= EEXIST
) {
4139 ERR("Unable to create %s", rundir
);
4151 * Setup sockets and directory needed by the kconsumerd communication with the
4154 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4158 char path
[PATH_MAX
];
4160 switch (consumer_data
->type
) {
4161 case LTTNG_CONSUMER_KERNEL
:
4162 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4164 case LTTNG_CONSUMER64_UST
:
4165 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4167 case LTTNG_CONSUMER32_UST
:
4168 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4171 ERR("Consumer type unknown");
4176 DBG2("Creating consumer directory: %s", path
);
4178 ret
= mkdir(path
, S_IRWXU
);
4180 if (errno
!= EEXIST
) {
4181 ERR("Failed to create %s", path
);
4187 /* Create the kconsumerd error unix socket */
4188 consumer_data
->err_sock
=
4189 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4190 if (consumer_data
->err_sock
< 0) {
4191 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4196 /* File permission MUST be 660 */
4197 ret
= chmod(consumer_data
->err_unix_sock_path
,
4198 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4200 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4210 * Signal handler for the daemon
4212 * Simply stop all worker threads, leaving main() return gracefully after
4213 * joining all threads and calling cleanup().
4215 static void sighandler(int sig
)
4219 DBG("SIGPIPE caught");
4222 DBG("SIGINT caught");
4226 DBG("SIGTERM caught");
4235 * Setup signal handler for :
4236 * SIGINT, SIGTERM, SIGPIPE
4238 static int set_signal_handler(void)
4241 struct sigaction sa
;
4244 if ((ret
= sigemptyset(&sigset
)) < 0) {
4245 perror("sigemptyset");
4249 sa
.sa_handler
= sighandler
;
4250 sa
.sa_mask
= sigset
;
4252 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4253 perror("sigaction");
4257 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4258 perror("sigaction");
4262 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4263 perror("sigaction");
4267 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4273 * Set open files limit to unlimited. This daemon can open a large number of
4274 * file descriptors in order to consumer multiple kernel traces.
4276 static void set_ulimit(void)
4281 /* The kernel does not allowed an infinite limit for open files */
4282 lim
.rlim_cur
= 65535;
4283 lim
.rlim_max
= 65535;
4285 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4287 perror("failed to set open files limit");
4294 int main(int argc
, char **argv
)
4298 const char *home_path
;
4300 tracepoint(sessiond_boot_start
);
4302 init_kernel_workarounds();
4304 rcu_register_thread();
4306 /* Create thread quit pipe */
4307 if ((ret
= init_thread_quit_pipe()) < 0) {
4311 setup_consumerd_path();
4313 /* Parse arguments */
4315 if ((ret
= parse_args(argc
, argv
) < 0)) {
4328 /* Check if daemon is UID = 0 */
4329 is_root
= !getuid();
4332 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4334 /* Create global run dir with root access */
4335 ret
= create_lttng_rundir(rundir
);
4340 if (strlen(apps_unix_sock_path
) == 0) {
4341 snprintf(apps_unix_sock_path
, PATH_MAX
,
4342 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4345 if (strlen(client_unix_sock_path
) == 0) {
4346 snprintf(client_unix_sock_path
, PATH_MAX
,
4347 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4350 /* Set global SHM for ust */
4351 if (strlen(wait_shm_path
) == 0) {
4352 snprintf(wait_shm_path
, PATH_MAX
,
4353 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4356 /* Setup kernel consumerd path */
4357 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4358 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4359 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4360 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4362 DBG2("Kernel consumer err path: %s",
4363 kconsumer_data
.err_unix_sock_path
);
4364 DBG2("Kernel consumer cmd path: %s",
4365 kconsumer_data
.cmd_unix_sock_path
);
4367 home_path
= get_home_dir();
4368 if (home_path
== NULL
) {
4369 /* TODO: Add --socket PATH option */
4370 ERR("Can't get HOME directory for sockets creation.");
4376 * Create rundir from home path. This will create something like
4379 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4385 ret
= create_lttng_rundir(rundir
);
4390 if (strlen(apps_unix_sock_path
) == 0) {
4391 snprintf(apps_unix_sock_path
, PATH_MAX
,
4392 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4395 /* Set the cli tool unix socket path */
4396 if (strlen(client_unix_sock_path
) == 0) {
4397 snprintf(client_unix_sock_path
, PATH_MAX
,
4398 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4401 /* Set global SHM for ust */
4402 if (strlen(wait_shm_path
) == 0) {
4403 snprintf(wait_shm_path
, PATH_MAX
,
4404 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4408 DBG("Client socket path %s", client_unix_sock_path
);
4409 DBG("Application socket path %s", apps_unix_sock_path
);
4410 DBG("LTTng run directory path: %s", rundir
);
4412 /* 32 bits consumerd path setup */
4413 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4414 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4415 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4416 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4418 DBG2("UST consumer 32 bits err path: %s",
4419 ustconsumer32_data
.err_unix_sock_path
);
4420 DBG2("UST consumer 32 bits cmd path: %s",
4421 ustconsumer32_data
.cmd_unix_sock_path
);
4423 /* 64 bits consumerd path setup */
4424 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4425 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4426 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4427 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4429 DBG2("UST consumer 64 bits err path: %s",
4430 ustconsumer64_data
.err_unix_sock_path
);
4431 DBG2("UST consumer 64 bits cmd path: %s",
4432 ustconsumer64_data
.cmd_unix_sock_path
);
4435 * See if daemon already exist.
4437 if ((ret
= check_existing_daemon()) < 0) {
4438 ERR("Already running daemon.\n");
4440 * We do not goto exit because we must not cleanup()
4441 * because a daemon is already running.
4446 /* After this point, we can safely call cleanup() with "goto exit" */
4449 * These actions must be executed as root. We do that *after* setting up
4450 * the sockets path because we MUST make the check for another daemon using
4451 * those paths *before* trying to set the kernel consumer sockets and init
4455 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4460 /* Setup kernel tracer */
4461 if (!opt_no_kernel
) {
4462 init_kernel_tracer();
4465 /* Set ulimit for open files */
4469 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4474 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4479 if ((ret
= set_signal_handler()) < 0) {
4483 /* Setup the needed unix socket */
4484 if ((ret
= init_daemon_socket()) < 0) {
4488 /* Set credentials to socket */
4489 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4493 /* Get parent pid if -S, --sig-parent is specified. */
4494 if (opt_sig_parent
) {
4498 /* Setup the kernel pipe for waking up the kernel thread */
4499 if ((ret
= create_kernel_poll_pipe()) < 0) {
4503 /* Setup the thread apps communication pipe. */
4504 if ((ret
= create_apps_cmd_pipe()) < 0) {
4508 /* Init UST command queue. */
4509 cds_wfq_init(&ust_cmd_queue
.queue
);
4511 /* Init UST app hash table */
4515 * Get session list pointer. This pointer MUST NOT be free(). This list is
4516 * statically declared in session.c
4518 session_list_ptr
= session_get_list();
4520 /* Set up max poll set size */
4521 lttng_poll_set_max_size();
4523 /* Create thread to manage the client socket */
4524 ret
= pthread_create(&client_thread
, NULL
,
4525 thread_manage_clients
, (void *) NULL
);
4527 perror("pthread_create clients");
4531 /* Create thread to dispatch registration */
4532 ret
= pthread_create(&dispatch_thread
, NULL
,
4533 thread_dispatch_ust_registration
, (void *) NULL
);
4535 perror("pthread_create dispatch");
4539 /* Create thread to manage application registration. */
4540 ret
= pthread_create(®_apps_thread
, NULL
,
4541 thread_registration_apps
, (void *) NULL
);
4543 perror("pthread_create registration");
4547 /* Create thread to manage application socket */
4548 ret
= pthread_create(&apps_thread
, NULL
,
4549 thread_manage_apps
, (void *) NULL
);
4551 perror("pthread_create apps");
4555 /* Create kernel thread to manage kernel event */
4556 ret
= pthread_create(&kernel_thread
, NULL
,
4557 thread_manage_kernel
, (void *) NULL
);
4559 perror("pthread_create kernel");
4563 tracepoint(sessiond_boot_end
);
4565 ret
= pthread_join(kernel_thread
, &status
);
4567 perror("pthread_join");
4568 goto error
; /* join error, exit without cleanup */
4572 ret
= pthread_join(apps_thread
, &status
);
4574 perror("pthread_join");
4575 goto error
; /* join error, exit without cleanup */
4579 ret
= pthread_join(reg_apps_thread
, &status
);
4581 perror("pthread_join");
4582 goto error
; /* join error, exit without cleanup */
4586 ret
= pthread_join(dispatch_thread
, &status
);
4588 perror("pthread_join");
4589 goto error
; /* join error, exit without cleanup */
4593 ret
= pthread_join(client_thread
, &status
);
4595 perror("pthread_join");
4596 goto error
; /* join error, exit without cleanup */
4599 ret
= join_consumer_thread(&kconsumer_data
);
4601 perror("join_consumer");
4602 goto error
; /* join error, exit without cleanup */
4608 * cleanup() is called when no other thread is running.
4610 rcu_thread_online();
4612 rcu_thread_offline();
4613 rcu_unregister_thread();