2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <common/common.h>
42 #include <common/compat/poll.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
58 #define CONSUMERD_FILE "lttng-consumerd"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
78 #include "benchmark.h"
81 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
82 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
83 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
84 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
87 int opt_verbose
; /* Not static for lttngerr.h */
88 int opt_verbose_consumer
; /* Not static for lttngerr.h */
89 int opt_quiet
; /* Not static for lttngerr.h */
92 const char *opt_tracing_group
;
93 static int opt_sig_parent
;
94 static int opt_daemon
;
95 static int opt_no_kernel
;
96 static int is_root
; /* Set to 1 if the daemon is running as root */
97 static pid_t ppid
; /* Parent PID for --sig-parent option */
100 /* Consumer daemon specific control data */
101 static struct consumer_data kconsumer_data
= {
102 .type
= LTTNG_CONSUMER_KERNEL
,
103 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
104 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
106 static struct consumer_data ustconsumer64_data
= {
107 .type
= LTTNG_CONSUMER64_UST
,
108 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
109 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
111 static struct consumer_data ustconsumer32_data
= {
112 .type
= LTTNG_CONSUMER32_UST
,
113 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
114 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
117 static int dispatch_thread_exit
;
119 /* Global application Unix socket path */
120 static char apps_unix_sock_path
[PATH_MAX
];
121 /* Global client Unix socket path */
122 static char client_unix_sock_path
[PATH_MAX
];
123 /* global wait shm path for UST */
124 static char wait_shm_path
[PATH_MAX
];
126 /* Sockets and FDs */
127 static int client_sock
;
128 static int apps_sock
;
129 static int kernel_tracer_fd
;
130 static int kernel_poll_pipe
[2];
133 * Quit pipe for all threads. This permits a single cancellation point
134 * for all threads when receiving an event on the pipe.
136 static int thread_quit_pipe
[2];
139 * This pipe is used to inform the thread managing application communication
140 * that a command is queued and ready to be processed.
142 static int apps_cmd_pipe
[2];
144 /* Pthread, Mutexes and Semaphores */
145 static pthread_t apps_thread
;
146 static pthread_t reg_apps_thread
;
147 static pthread_t client_thread
;
148 static pthread_t kernel_thread
;
149 static pthread_t dispatch_thread
;
153 * UST registration command queue. This queue is tied with a futex and uses a N
154 * wakers / 1 waiter implemented and detailed in futex.c/.h
156 * The thread_manage_apps and thread_dispatch_ust_registration interact with
157 * this queue and the wait/wake scheme.
159 static struct ust_cmd_queue ust_cmd_queue
;
162 * Pointer initialized before thread creation.
164 * This points to the tracing session list containing the session count and a
165 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
166 * MUST NOT be taken if you call a public function in session.c.
168 * The lock is nested inside the structure: session_list_ptr->lock. Please use
169 * session_lock_list and session_unlock_list for lock acquisition.
171 static struct ltt_session_list
*session_list_ptr
;
173 int ust_consumerd64_fd
= -1;
174 int ust_consumerd32_fd
= -1;
176 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
177 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
178 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
179 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
182 void setup_consumerd_path(void)
184 const char *bin
, *libdir
;
187 * Allow INSTALL_BIN_PATH to be used as a target path for the
188 * native architecture size consumer if CONFIG_CONSUMER*_PATH
189 * has not been defined.
191 #if (CAA_BITS_PER_LONG == 32)
192 if (!consumerd32_bin
[0]) {
193 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
195 if (!consumerd32_libdir
[0]) {
196 consumerd32_libdir
= INSTALL_LIB_PATH
;
198 #elif (CAA_BITS_PER_LONG == 64)
199 if (!consumerd64_bin
[0]) {
200 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
202 if (!consumerd64_libdir
[0]) {
203 consumerd64_libdir
= INSTALL_LIB_PATH
;
206 #error "Unknown bitness"
210 * runtime env. var. overrides the build default.
212 bin
= getenv("LTTNG_CONSUMERD32_BIN");
214 consumerd32_bin
= bin
;
216 bin
= getenv("LTTNG_CONSUMERD64_BIN");
218 consumerd64_bin
= bin
;
220 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
222 consumerd32_libdir
= libdir
;
224 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
226 consumerd64_libdir
= libdir
;
231 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
233 static int create_thread_poll_set(struct lttng_poll_event
*events
,
238 if (events
== NULL
|| size
== 0) {
243 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
249 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
261 * Check if the thread quit pipe was triggered.
263 * Return 1 if it was triggered else 0;
265 static int check_thread_quit_pipe(int fd
, uint32_t events
)
267 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
275 * Return group ID of the tracing group or -1 if not found.
277 static gid_t
allowed_group(void)
281 if (opt_tracing_group
) {
282 grp
= getgrnam(opt_tracing_group
);
284 grp
= getgrnam(default_tracing_group
);
294 * Init thread quit pipe.
296 * Return -1 on error or 0 if all pipes are created.
298 static int init_thread_quit_pipe(void)
302 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
304 perror("thread quit pipe");
313 * Complete teardown of a kernel session. This free all data structure related
314 * to a kernel session and update counter.
316 static void teardown_kernel_session(struct ltt_session
*session
)
318 if (!session
->kernel_session
) {
319 DBG3("No kernel session when tearing down session");
323 DBG("Tearing down kernel session");
326 * If a custom kernel consumer was registered, close the socket before
327 * tearing down the complete kernel session structure
329 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
330 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
333 trace_kernel_destroy_session(session
->kernel_session
);
337 * Complete teardown of all UST sessions. This will free everything on his path
338 * and destroy the core essence of all ust sessions :)
340 static void teardown_ust_session(struct ltt_session
*session
)
344 if (!session
->ust_session
) {
345 DBG3("No UST session when tearing down session");
349 DBG("Tearing down UST session(s)");
351 ret
= ust_app_destroy_trace_all(session
->ust_session
);
353 ERR("Error in ust_app_destroy_trace_all");
356 trace_ust_destroy_session(session
->ust_session
);
360 * Stop all threads by closing the thread quit pipe.
362 static void stop_threads(void)
366 /* Stopping all threads */
367 DBG("Terminating all threads");
368 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
370 ERR("write error on thread quit pipe");
373 /* Dispatch thread */
374 dispatch_thread_exit
= 1;
375 futex_nto1_wake(&ust_cmd_queue
.futex
);
381 static void cleanup(void)
385 struct ltt_session
*sess
, *stmp
;
389 DBG("Removing %s directory", rundir
);
390 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
392 ERR("asprintf failed. Something is really wrong!");
395 /* Remove lttng run directory */
398 ERR("Unable to clean %s", rundir
);
402 DBG("Cleaning up all sessions");
404 /* Destroy session list mutex */
405 if (session_list_ptr
!= NULL
) {
406 pthread_mutex_destroy(&session_list_ptr
->lock
);
408 /* Cleanup ALL session */
409 cds_list_for_each_entry_safe(sess
, stmp
,
410 &session_list_ptr
->head
, list
) {
411 teardown_kernel_session(sess
);
412 teardown_ust_session(sess
);
417 DBG("Closing all UST sockets");
418 ust_app_clean_list();
420 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
422 if (is_root
&& !opt_no_kernel
) {
423 DBG2("Closing kernel fd");
424 close(kernel_tracer_fd
);
425 DBG("Unloading kernel modules");
426 modprobe_remove_lttng_all();
429 close(thread_quit_pipe
[0]);
430 close(thread_quit_pipe
[1]);
432 /* OUTPUT BENCHMARK RESULTS */
435 if (getenv("BENCH_UST_NOTIFY")) {
436 bench_print_ust_notification();
439 if (getenv("BENCH_UST_REGISTER")) {
440 bench_print_ust_register();
441 bench_print_ust_unregister();
444 if (getenv("BENCH_BOOT_PROCESS")) {
445 bench_print_boot_process();
452 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
453 "Matthew, BEET driven development works!%c[%dm",
454 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
459 * Send data on a unix socket using the liblttsessiondcomm API.
461 * Return lttcomm error code.
463 static int send_unix_sock(int sock
, void *buf
, size_t len
)
465 /* Check valid length */
470 return lttcomm_send_unix_sock(sock
, buf
, len
);
474 * Free memory of a command context structure.
476 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
478 DBG("Clean command context structure");
480 if ((*cmd_ctx
)->llm
) {
481 free((*cmd_ctx
)->llm
);
483 if ((*cmd_ctx
)->lsm
) {
484 free((*cmd_ctx
)->lsm
);
492 * Send all stream fds of kernel channel to the consumer.
494 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
495 int sock
, struct ltt_kernel_channel
*channel
,
496 uid_t uid
, gid_t gid
)
499 struct ltt_kernel_stream
*stream
;
500 struct lttcomm_consumer_msg lkm
;
502 DBG("Sending streams of channel %s to kernel consumer",
503 channel
->channel
->name
);
506 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
507 lkm
.u
.channel
.channel_key
= channel
->fd
;
508 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
509 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
510 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
511 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
513 perror("send consumer channel");
518 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
522 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
523 lkm
.u
.stream
.channel_key
= channel
->fd
;
524 lkm
.u
.stream
.stream_key
= stream
->fd
;
525 lkm
.u
.stream
.state
= stream
->state
;
526 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
527 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
528 lkm
.u
.stream
.uid
= uid
;
529 lkm
.u
.stream
.gid
= gid
;
530 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
531 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
532 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
533 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
535 perror("send consumer stream");
538 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
540 perror("send consumer stream ancillary data");
545 DBG("consumer channel streams sent");
554 * Send all stream fds of the kernel session to the consumer.
556 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
557 struct ltt_kernel_session
*session
)
560 struct ltt_kernel_channel
*chan
;
561 struct lttcomm_consumer_msg lkm
;
562 int sock
= session
->consumer_fd
;
564 DBG("Sending metadata stream fd");
566 /* Extra protection. It's NOT supposed to be set to 0 at this point */
567 if (session
->consumer_fd
== 0) {
568 session
->consumer_fd
= consumer_data
->cmd_sock
;
571 if (session
->metadata_stream_fd
!= 0) {
572 /* Send metadata channel fd */
573 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
574 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
575 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
576 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
577 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
578 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
580 perror("send consumer channel");
584 /* Send metadata stream fd */
585 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
586 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
587 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
588 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
589 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
590 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
591 lkm
.u
.stream
.uid
= session
->uid
;
592 lkm
.u
.stream
.gid
= session
->gid
;
593 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
594 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
595 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
596 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
598 perror("send consumer stream");
601 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
603 perror("send consumer stream");
608 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
609 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
610 session
->uid
, session
->gid
);
616 DBG("consumer fds (metadata and channel streams) sent");
625 * Notify UST applications using the shm mmap futex.
627 static int notify_ust_apps(int active
)
631 DBG("Notifying applications of session daemon state: %d", active
);
633 tracepoint(ust_notify_apps_start
);
635 /* See shm.c for this call implying mmap, shm and futex calls */
636 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
637 if (wait_shm_mmap
== NULL
) {
641 /* Wake waiting process */
642 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
644 tracepoint(ust_notify_apps_stop
);
646 /* Apps notified successfully */
654 * Setup the outgoing data buffer for the response (llm) by allocating the
655 * right amount of memory and copying the original information from the lsm
658 * Return total size of the buffer pointed by buf.
660 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
666 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
667 if (cmd_ctx
->llm
== NULL
) {
673 /* Copy common data */
674 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
675 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
677 cmd_ctx
->llm
->data_size
= size
;
678 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
687 * Update the kernel poll set of all channel fd available over all tracing
688 * session. Add the wakeup pipe at the end of the set.
690 static int update_kernel_poll(struct lttng_poll_event
*events
)
693 struct ltt_session
*session
;
694 struct ltt_kernel_channel
*channel
;
696 DBG("Updating kernel poll set");
699 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
700 session_lock(session
);
701 if (session
->kernel_session
== NULL
) {
702 session_unlock(session
);
706 cds_list_for_each_entry(channel
,
707 &session
->kernel_session
->channel_list
.head
, list
) {
708 /* Add channel fd to the kernel poll set */
709 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
711 session_unlock(session
);
714 DBG("Channel fd %d added to kernel set", channel
->fd
);
716 session_unlock(session
);
718 session_unlock_list();
723 session_unlock_list();
728 * Find the channel fd from 'fd' over all tracing session. When found, check
729 * for new channel stream and send those stream fds to the kernel consumer.
731 * Useful for CPU hotplug feature.
733 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
736 struct ltt_session
*session
;
737 struct ltt_kernel_channel
*channel
;
739 DBG("Updating kernel streams for channel fd %d", fd
);
742 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
743 session_lock(session
);
744 if (session
->kernel_session
== NULL
) {
745 session_unlock(session
);
749 /* This is not suppose to be 0 but this is an extra security check */
750 if (session
->kernel_session
->consumer_fd
== 0) {
751 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
754 cds_list_for_each_entry(channel
,
755 &session
->kernel_session
->channel_list
.head
, list
) {
756 if (channel
->fd
== fd
) {
757 DBG("Channel found, updating kernel streams");
758 ret
= kernel_open_channel_stream(channel
);
764 * Have we already sent fds to the consumer? If yes, it means
765 * that tracing is started so it is safe to send our updated
768 if (session
->kernel_session
->consumer_fds_sent
== 1) {
769 ret
= send_kconsumer_channel_streams(consumer_data
,
770 session
->kernel_session
->consumer_fd
, channel
,
771 session
->uid
, session
->gid
);
779 session_unlock(session
);
781 session_unlock_list();
785 session_unlock(session
);
786 session_unlock_list();
791 * For each tracing session, update newly registered apps.
793 static void update_ust_app(int app_sock
)
795 struct ltt_session
*sess
, *stmp
;
797 /* For all tracing session(s) */
798 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
799 if (sess
->ust_session
) {
800 ust_app_global_update(sess
->ust_session
, app_sock
);
806 * This thread manage event coming from the kernel.
808 * Features supported in this thread:
811 static void *thread_manage_kernel(void *data
)
813 int ret
, i
, pollfd
, update_poll_flag
= 1;
814 uint32_t revents
, nb_fd
;
816 struct lttng_poll_event events
;
818 tracepoint(sessiond_th_kern_start
);
820 DBG("Thread manage kernel started");
822 ret
= create_thread_poll_set(&events
, 2);
827 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
833 if (update_poll_flag
== 1) {
835 * Reset number of fd in the poll set. Always 2 since there is the thread
836 * quit pipe and the kernel pipe.
840 ret
= update_kernel_poll(&events
);
844 update_poll_flag
= 0;
847 nb_fd
= LTTNG_POLL_GETNB(&events
);
849 DBG("Thread kernel polling on %d fds", nb_fd
);
851 /* Zeroed the poll events */
852 lttng_poll_reset(&events
);
854 tracepoint(sessiond_th_kern_poll
);
856 /* Poll infinite value of time */
857 ret
= lttng_poll_wait(&events
, -1);
860 } else if (ret
== 0) {
861 /* Should not happen since timeout is infinite */
862 ERR("Return value of poll is 0 with an infinite timeout.\n"
863 "This should not have happened! Continuing...");
867 for (i
= 0; i
< nb_fd
; i
++) {
868 /* Fetch once the poll data */
869 revents
= LTTNG_POLL_GETEV(&events
, i
);
870 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
872 /* Thread quit pipe has been closed. Killing thread. */
873 ret
= check_thread_quit_pipe(pollfd
, revents
);
878 /* Check for data on kernel pipe */
879 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
880 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
881 update_poll_flag
= 1;
885 * New CPU detected by the kernel. Adding kernel stream to
886 * kernel session and updating the kernel consumer
888 if (revents
& LPOLLIN
) {
889 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
895 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
896 * and unregister kernel stream at this point.
904 DBG("Kernel thread dying");
905 close(kernel_poll_pipe
[0]);
906 close(kernel_poll_pipe
[1]);
908 lttng_poll_clean(&events
);
914 * This thread manage the consumer error sent back to the session daemon.
916 static void *thread_manage_consumer(void *data
)
918 int sock
= 0, i
, ret
, pollfd
;
919 uint32_t revents
, nb_fd
;
920 enum lttcomm_return_code code
;
921 struct lttng_poll_event events
;
922 struct consumer_data
*consumer_data
= data
;
924 tracepoint(sessiond_th_kcon_start
);
926 DBG("[thread] Manage consumer started");
928 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
934 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
935 * Nothing more will be added to this poll set.
937 ret
= create_thread_poll_set(&events
, 2);
942 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
947 nb_fd
= LTTNG_POLL_GETNB(&events
);
949 tracepoint(sessiond_th_kcon_poll
);
951 /* Inifinite blocking call, waiting for transmission */
952 ret
= lttng_poll_wait(&events
, -1);
957 for (i
= 0; i
< nb_fd
; i
++) {
958 /* Fetch once the poll data */
959 revents
= LTTNG_POLL_GETEV(&events
, i
);
960 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
962 /* Thread quit pipe has been closed. Killing thread. */
963 ret
= check_thread_quit_pipe(pollfd
, revents
);
968 /* Event on the registration socket */
969 if (pollfd
== consumer_data
->err_sock
) {
970 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
971 ERR("consumer err socket poll error");
977 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
982 DBG2("Receiving code from consumer err_sock");
984 /* Getting status code from kconsumerd */
985 ret
= lttcomm_recv_unix_sock(sock
, &code
,
986 sizeof(enum lttcomm_return_code
));
991 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
992 consumer_data
->cmd_sock
=
993 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
994 if (consumer_data
->cmd_sock
< 0) {
995 sem_post(&consumer_data
->sem
);
996 PERROR("consumer connect");
999 /* Signal condition to tell that the kconsumerd is ready */
1000 sem_post(&consumer_data
->sem
);
1001 DBG("consumer command socket ready");
1003 ERR("consumer error when waiting for SOCK_READY : %s",
1004 lttcomm_get_readable_code(-code
));
1008 /* Remove the kconsumerd error sock since we've established a connexion */
1009 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1014 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1019 /* Update number of fd */
1020 nb_fd
= LTTNG_POLL_GETNB(&events
);
1022 /* Inifinite blocking call, waiting for transmission */
1023 ret
= lttng_poll_wait(&events
, -1);
1028 for (i
= 0; i
< nb_fd
; i
++) {
1029 /* Fetch once the poll data */
1030 revents
= LTTNG_POLL_GETEV(&events
, i
);
1031 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1033 /* Thread quit pipe has been closed. Killing thread. */
1034 ret
= check_thread_quit_pipe(pollfd
, revents
);
1039 /* Event on the kconsumerd socket */
1040 if (pollfd
== sock
) {
1041 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1042 ERR("consumer err socket second poll error");
1048 /* Wait for any kconsumerd error */
1049 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1050 sizeof(enum lttcomm_return_code
));
1052 ERR("consumer closed the command socket");
1056 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1059 DBG("consumer thread dying");
1060 close(consumer_data
->err_sock
);
1061 close(consumer_data
->cmd_sock
);
1064 unlink(consumer_data
->err_unix_sock_path
);
1065 unlink(consumer_data
->cmd_unix_sock_path
);
1066 consumer_data
->pid
= 0;
1068 lttng_poll_clean(&events
);
1074 * This thread manage application communication.
1076 static void *thread_manage_apps(void *data
)
1079 uint32_t revents
, nb_fd
;
1080 struct ust_command ust_cmd
;
1081 struct lttng_poll_event events
;
1083 tracepoint(sessiond_th_apps_start
);
1085 DBG("[thread] Manage application started");
1087 rcu_register_thread();
1088 rcu_thread_online();
1090 ret
= create_thread_poll_set(&events
, 2);
1095 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1101 /* Zeroed the events structure */
1102 lttng_poll_reset(&events
);
1104 nb_fd
= LTTNG_POLL_GETNB(&events
);
1106 DBG("Apps thread polling on %d fds", nb_fd
);
1108 tracepoint(sessiond_th_apps_poll
);
1110 /* Inifinite blocking call, waiting for transmission */
1111 ret
= lttng_poll_wait(&events
, -1);
1116 for (i
= 0; i
< nb_fd
; i
++) {
1117 /* Fetch once the poll data */
1118 revents
= LTTNG_POLL_GETEV(&events
, i
);
1119 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1121 /* Thread quit pipe has been closed. Killing thread. */
1122 ret
= check_thread_quit_pipe(pollfd
, revents
);
1127 /* Inspect the apps cmd pipe */
1128 if (pollfd
== apps_cmd_pipe
[0]) {
1129 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1130 ERR("Apps command pipe error");
1132 } else if (revents
& LPOLLIN
) {
1133 tracepoint(ust_register_read_start
);
1135 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1136 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1137 perror("read apps cmd pipe");
1140 tracepoint(ust_register_read_stop
);
1142 tracepoint(ust_register_add_start
);
1143 /* Register applicaton to the session daemon */
1144 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1146 if (ret
== -ENOMEM
) {
1148 } else if (ret
< 0) {
1151 tracepoint(ust_register_add_stop
);
1153 tracepoint(ust_register_done_start
);
1155 * Validate UST version compatibility.
1157 ret
= ust_app_validate_version(ust_cmd
.sock
);
1160 * Add channel(s) and event(s) to newly registered apps
1161 * from lttng global UST domain.
1163 update_ust_app(ust_cmd
.sock
);
1166 ret
= ust_app_register_done(ust_cmd
.sock
);
1169 * If the registration is not possible, we simply
1170 * unregister the apps and continue
1172 ust_app_unregister(ust_cmd
.sock
);
1175 * We just need here to monitor the close of the UST
1176 * socket and poll set monitor those by default.
1178 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1183 DBG("Apps with sock %d added to poll set",
1186 tracepoint(ust_register_done_stop
);
1191 * At this point, we know that a registered application made
1192 * the event at poll_wait.
1194 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1195 tracepoint(ust_unregister_start
);
1197 /* Removing from the poll set */
1198 ret
= lttng_poll_del(&events
, pollfd
);
1203 /* Socket closed on remote end. */
1204 ust_app_unregister(pollfd
);
1206 tracepoint(ust_unregister_stop
);
1214 DBG("Application communication apps dying");
1215 close(apps_cmd_pipe
[0]);
1216 close(apps_cmd_pipe
[1]);
1218 lttng_poll_clean(&events
);
1220 rcu_thread_offline();
1221 rcu_unregister_thread();
1226 * Dispatch request from the registration threads to the application
1227 * communication thread.
1229 static void *thread_dispatch_ust_registration(void *data
)
1232 struct cds_wfq_node
*node
;
1233 struct ust_command
*ust_cmd
= NULL
;
1235 tracepoint(sessiond_th_dispatch_start
);
1237 DBG("[thread] Dispatch UST command started");
1239 while (!dispatch_thread_exit
) {
1240 /* Atomically prepare the queue futex */
1241 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1244 tracepoint(sessiond_th_dispatch_block
);
1246 /* Dequeue command for registration */
1247 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1249 DBG("Woken up but nothing in the UST command queue");
1250 /* Continue thread execution */
1254 tracepoint(ust_dispatch_register_start
);
1256 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1258 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1259 " gid:%d sock:%d name:%s (version %d.%d)",
1260 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1261 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1262 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1263 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1265 * Inform apps thread of the new application registration. This
1266 * call is blocking so we can be assured that the data will be read
1267 * at some point in time or wait to the end of the world :)
1269 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1270 sizeof(struct ust_command
));
1272 perror("write apps cmd pipe");
1273 if (errno
== EBADF
) {
1275 * We can't inform the application thread to process
1276 * registration. We will exit or else application
1277 * registration will not occur and tracing will never
1284 } while (node
!= NULL
);
1286 tracepoint(ust_dispatch_register_stop
);
1288 /* Futex wait on queue. Blocking call on futex() */
1289 futex_nto1_wait(&ust_cmd_queue
.futex
);
1293 DBG("Dispatch thread dying");
1298 * This thread manage application registration.
1300 static void *thread_registration_apps(void *data
)
1302 int sock
= 0, i
, ret
, pollfd
;
1303 uint32_t revents
, nb_fd
;
1304 struct lttng_poll_event events
;
1306 * Get allocated in this thread, enqueued to a global queue, dequeued and
1307 * freed in the manage apps thread.
1309 struct ust_command
*ust_cmd
= NULL
;
1311 tracepoint(sessiond_th_reg_start
);
1313 DBG("[thread] Manage application registration started");
1315 ret
= lttcomm_listen_unix_sock(apps_sock
);
1321 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1322 * more will be added to this poll set.
1324 ret
= create_thread_poll_set(&events
, 2);
1329 /* Add the application registration socket */
1330 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1335 /* Notify all applications to register */
1336 ret
= notify_ust_apps(1);
1338 ERR("Failed to notify applications or create the wait shared memory.\n"
1339 "Execution continues but there might be problem for already\n"
1340 "running applications that wishes to register.");
1344 DBG("Accepting application registration");
1346 tracepoint(sessiond_th_reg_poll
);
1348 nb_fd
= LTTNG_POLL_GETNB(&events
);
1350 /* Inifinite blocking call, waiting for transmission */
1351 ret
= lttng_poll_wait(&events
, -1);
1356 for (i
= 0; i
< nb_fd
; i
++) {
1357 /* Fetch once the poll data */
1358 revents
= LTTNG_POLL_GETEV(&events
, i
);
1359 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1361 /* Thread quit pipe has been closed. Killing thread. */
1362 ret
= check_thread_quit_pipe(pollfd
, revents
);
1367 /* Event on the registration socket */
1368 if (pollfd
== apps_sock
) {
1369 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1370 ERR("Register apps socket poll error");
1372 } else if (revents
& LPOLLIN
) {
1373 /* Registration starts here. Recording cycles */
1374 tracepoint(ust_register_start
);
1376 sock
= lttcomm_accept_unix_sock(apps_sock
);
1381 /* Create UST registration command for enqueuing */
1382 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1383 if (ust_cmd
== NULL
) {
1384 perror("ust command zmalloc");
1389 * Using message-based transmissions to ensure we don't
1390 * have to deal with partially received messages.
1392 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1393 sizeof(struct ust_register_msg
));
1394 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1396 perror("lttcomm_recv_unix_sock register apps");
1398 ERR("Wrong size received on apps register");
1405 ust_cmd
->sock
= sock
;
1407 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1408 " gid:%d sock:%d name:%s (version %d.%d)",
1409 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1410 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1411 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1412 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1415 * Lock free enqueue the registration request. The red pill
1416 * has been taken! This apps will be part of the *system*.
1418 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1421 * Wake the registration queue futex. Implicit memory
1422 * barrier with the exchange in cds_wfq_enqueue.
1424 futex_nto1_wake(&ust_cmd_queue
.futex
);
1426 tracepoint(ust_register_stop
);
1433 DBG("UST Registration thread dying");
1435 /* Notify that the registration thread is gone */
1440 unlink(apps_unix_sock_path
);
1442 lttng_poll_clean(&events
);
1448 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1449 * exec or it will fails.
1451 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1454 struct timespec timeout
;
1456 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1457 timeout
.tv_nsec
= 0;
1459 /* Setup semaphore */
1460 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1462 PERROR("sem_init consumer semaphore");
1466 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1467 thread_manage_consumer
, consumer_data
);
1469 PERROR("pthread_create consumer");
1474 /* Get time for sem_timedwait absolute timeout */
1475 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1477 PERROR("clock_gettime spawn consumer");
1478 /* Infinite wait for the kconsumerd thread to be ready */
1479 ret
= sem_wait(&consumer_data
->sem
);
1481 /* Normal timeout if the gettime was successful */
1482 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1483 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1487 if (errno
== ETIMEDOUT
) {
1489 * Call has timed out so we kill the kconsumerd_thread and return
1492 ERR("The consumer thread was never ready. Killing it");
1493 ret
= pthread_cancel(consumer_data
->thread
);
1495 PERROR("pthread_cancel consumer thread");
1498 PERROR("semaphore wait failed consumer thread");
1503 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1504 if (consumer_data
->pid
== 0) {
1505 ERR("Kconsumerd did not start");
1506 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1509 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1518 * Join consumer thread
1520 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1525 if (consumer_data
->pid
!= 0) {
1526 ret
= kill(consumer_data
->pid
, SIGTERM
);
1528 ERR("Error killing consumer daemon");
1531 return pthread_join(consumer_data
->thread
, &status
);
1538 * Fork and exec a consumer daemon (consumerd).
1540 * Return pid if successful else -1.
1542 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1546 const char *consumer_to_use
;
1547 const char *verbosity
;
1550 DBG("Spawning consumerd");
1557 if (opt_verbose_consumer
) {
1558 verbosity
= "--verbose";
1560 verbosity
= "--quiet";
1562 switch (consumer_data
->type
) {
1563 case LTTNG_CONSUMER_KERNEL
:
1565 * Find out which consumerd to execute. We will first try the
1566 * 64-bit path, then the sessiond's installation directory, and
1567 * fallback on the 32-bit one,
1569 DBG3("Looking for a kernel consumer at these locations:");
1570 DBG3(" 1) %s", consumerd64_bin
);
1571 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1572 DBG3(" 3) %s", consumerd32_bin
);
1573 if (stat(consumerd64_bin
, &st
) == 0) {
1574 DBG3("Found location #1");
1575 consumer_to_use
= consumerd64_bin
;
1576 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1577 DBG3("Found location #2");
1578 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1579 } else if (stat(consumerd32_bin
, &st
) == 0) {
1580 DBG3("Found location #3");
1581 consumer_to_use
= consumerd32_bin
;
1583 DBG("Could not find any valid consumerd executable");
1586 DBG("Using kernel consumer at: %s", consumer_to_use
);
1587 execl(consumer_to_use
,
1588 "lttng-consumerd", verbosity
, "-k",
1589 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1590 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1593 case LTTNG_CONSUMER64_UST
:
1595 char *tmpnew
= NULL
;
1597 if (consumerd64_libdir
[0] != '\0') {
1601 tmp
= getenv("LD_LIBRARY_PATH");
1605 tmplen
= strlen("LD_LIBRARY_PATH=")
1606 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1607 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1612 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1613 strcat(tmpnew
, consumerd64_libdir
);
1614 if (tmp
[0] != '\0') {
1615 strcat(tmpnew
, ":");
1616 strcat(tmpnew
, tmp
);
1618 ret
= putenv(tmpnew
);
1624 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1625 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1626 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1627 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1629 if (consumerd64_libdir
[0] != '\0') {
1637 case LTTNG_CONSUMER32_UST
:
1639 char *tmpnew
= NULL
;
1641 if (consumerd32_libdir
[0] != '\0') {
1645 tmp
= getenv("LD_LIBRARY_PATH");
1649 tmplen
= strlen("LD_LIBRARY_PATH=")
1650 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1651 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1656 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1657 strcat(tmpnew
, consumerd32_libdir
);
1658 if (tmp
[0] != '\0') {
1659 strcat(tmpnew
, ":");
1660 strcat(tmpnew
, tmp
);
1662 ret
= putenv(tmpnew
);
1668 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1669 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1670 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1671 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1673 if (consumerd32_libdir
[0] != '\0') {
1682 perror("unknown consumer type");
1686 perror("kernel start consumer exec");
1689 } else if (pid
> 0) {
1692 perror("start consumer fork");
1700 * Spawn the consumerd daemon and session daemon thread.
1702 static int start_consumerd(struct consumer_data
*consumer_data
)
1706 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1707 if (consumer_data
->pid
!= 0) {
1708 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1712 ret
= spawn_consumerd(consumer_data
);
1714 ERR("Spawning consumerd failed");
1715 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1719 /* Setting up the consumer_data pid */
1720 consumer_data
->pid
= ret
;
1721 DBG2("Consumer pid %d", consumer_data
->pid
);
1722 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1724 DBG2("Spawning consumer control thread");
1725 ret
= spawn_consumer_thread(consumer_data
);
1727 ERR("Fatal error spawning consumer control thread");
1739 * Check version of the lttng-modules.
1741 static int validate_lttng_modules_version(void)
1743 return kernel_validate_version(kernel_tracer_fd
);
1747 * Setup necessary data for kernel tracer action.
1749 static int init_kernel_tracer(void)
1753 /* Modprobe lttng kernel modules */
1754 ret
= modprobe_lttng_control();
1759 /* Open debugfs lttng */
1760 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1761 if (kernel_tracer_fd
< 0) {
1762 DBG("Failed to open %s", module_proc_lttng
);
1767 /* Validate kernel version */
1768 ret
= validate_lttng_modules_version();
1773 ret
= modprobe_lttng_data();
1778 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1782 modprobe_remove_lttng_control();
1783 close(kernel_tracer_fd
);
1784 kernel_tracer_fd
= 0;
1785 return LTTCOMM_KERN_VERSION
;
1788 close(kernel_tracer_fd
);
1791 modprobe_remove_lttng_control();
1794 WARN("No kernel tracer available");
1795 kernel_tracer_fd
= 0;
1796 return LTTCOMM_KERN_NA
;
1800 * Init tracing by creating trace directory and sending fds kernel consumer.
1802 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1806 if (session
->consumer_fds_sent
== 0) {
1808 * Assign default kernel consumer socket if no consumer assigned to the
1809 * kernel session. At this point, it's NOT suppose to be 0 but this is
1810 * an extra security check.
1812 if (session
->consumer_fd
== 0) {
1813 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1816 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1818 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1822 session
->consumer_fds_sent
= 1;
1830 * Create an UST session and add it to the session ust list.
1832 static int create_ust_session(struct ltt_session
*session
,
1833 struct lttng_domain
*domain
)
1835 struct ltt_ust_session
*lus
= NULL
;
1838 switch (domain
->type
) {
1839 case LTTNG_DOMAIN_UST
:
1842 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1846 DBG("Creating UST session");
1848 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1850 ret
= LTTCOMM_UST_SESS_FAIL
;
1854 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1855 session
->uid
, session
->gid
);
1857 if (ret
!= -EEXIST
) {
1858 ERR("Trace directory creation error");
1859 ret
= LTTCOMM_UST_SESS_FAIL
;
1864 /* The domain type dictate different actions on session creation */
1865 switch (domain
->type
) {
1866 case LTTNG_DOMAIN_UST
:
1867 /* No ustctl for the global UST domain */
1870 ERR("Unknown UST domain on create session %d", domain
->type
);
1873 lus
->uid
= session
->uid
;
1874 lus
->gid
= session
->gid
;
1875 session
->ust_session
= lus
;
1885 * Create a kernel tracer session then create the default channel.
1887 static int create_kernel_session(struct ltt_session
*session
)
1891 DBG("Creating kernel session");
1893 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1895 ret
= LTTCOMM_KERN_SESS_FAIL
;
1899 /* Set kernel consumer socket fd */
1900 if (kconsumer_data
.cmd_sock
) {
1901 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1904 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1905 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1907 if (ret
!= -EEXIST
) {
1908 ERR("Trace directory creation error");
1912 session
->kernel_session
->uid
= session
->uid
;
1913 session
->kernel_session
->gid
= session
->gid
;
1920 * Check if the UID or GID match the session. Root user has access to all
1923 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1925 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1932 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1935 struct ltt_session
*session
;
1937 DBG("Counting number of available session for UID %d GID %d",
1939 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1941 * Only list the sessions the user can control.
1943 if (!session_access_ok(session
, uid
, gid
)) {
1952 * Using the session list, filled a lttng_session array to send back to the
1953 * client for session listing.
1955 * The session list lock MUST be acquired before calling this function. Use
1956 * session_lock_list() and session_unlock_list().
1958 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1962 struct ltt_session
*session
;
1964 DBG("Getting all available session for UID %d GID %d",
1967 * Iterate over session list and append data after the control struct in
1970 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1972 * Only list the sessions the user can control.
1974 if (!session_access_ok(session
, uid
, gid
)) {
1977 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1978 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1979 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1980 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1981 sessions
[i
].enabled
= session
->enabled
;
1987 * Fill lttng_channel array of all channels.
1989 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1990 struct lttng_channel
*channels
)
1993 struct ltt_kernel_channel
*kchan
;
1995 DBG("Listing channels for session %s", session
->name
);
1998 case LTTNG_DOMAIN_KERNEL
:
1999 /* Kernel channels */
2000 if (session
->kernel_session
!= NULL
) {
2001 cds_list_for_each_entry(kchan
,
2002 &session
->kernel_session
->channel_list
.head
, list
) {
2003 /* Copy lttng_channel struct to array */
2004 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2005 channels
[i
].enabled
= kchan
->enabled
;
2010 case LTTNG_DOMAIN_UST
:
2012 struct lttng_ht_iter iter
;
2013 struct ltt_ust_channel
*uchan
;
2015 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2016 &iter
.iter
, uchan
, node
.node
) {
2017 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2018 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2019 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2020 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2021 channels
[i
].attr
.switch_timer_interval
=
2022 uchan
->attr
.switch_timer_interval
;
2023 channels
[i
].attr
.read_timer_interval
=
2024 uchan
->attr
.read_timer_interval
;
2025 channels
[i
].enabled
= uchan
->enabled
;
2026 switch (uchan
->attr
.output
) {
2027 case LTTNG_UST_MMAP
:
2029 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2042 * Create a list of ust global domain events.
2044 static int list_lttng_ust_global_events(char *channel_name
,
2045 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2048 unsigned int nb_event
= 0;
2049 struct lttng_ht_iter iter
;
2050 struct lttng_ht_node_str
*node
;
2051 struct ltt_ust_channel
*uchan
;
2052 struct ltt_ust_event
*uevent
;
2053 struct lttng_event
*tmp
;
2055 DBG("Listing UST global events for channel %s", channel_name
);
2059 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2060 node
= lttng_ht_iter_get_node_str(&iter
);
2062 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2066 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2068 nb_event
+= lttng_ht_get_count(uchan
->events
);
2070 if (nb_event
== 0) {
2075 DBG3("Listing UST global %d events", nb_event
);
2077 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2079 ret
= -LTTCOMM_FATAL
;
2083 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2084 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2085 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2086 tmp
[i
].enabled
= uevent
->enabled
;
2087 switch (uevent
->attr
.instrumentation
) {
2088 case LTTNG_UST_TRACEPOINT
:
2089 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2091 case LTTNG_UST_PROBE
:
2092 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2094 case LTTNG_UST_FUNCTION
:
2095 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2098 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2099 switch (uevent
->attr
.loglevel_type
) {
2100 case LTTNG_UST_LOGLEVEL_ALL
:
2101 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2103 case LTTNG_UST_LOGLEVEL_RANGE
:
2104 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2106 case LTTNG_UST_LOGLEVEL_SINGLE
:
2107 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2122 * Fill lttng_event array of all kernel events in the channel.
2124 static int list_lttng_kernel_events(char *channel_name
,
2125 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2128 unsigned int nb_event
;
2129 struct ltt_kernel_event
*event
;
2130 struct ltt_kernel_channel
*kchan
;
2132 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2133 if (kchan
== NULL
) {
2134 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2138 nb_event
= kchan
->event_count
;
2140 DBG("Listing events for channel %s", kchan
->channel
->name
);
2142 if (nb_event
== 0) {
2147 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2148 if (*events
== NULL
) {
2149 ret
= LTTCOMM_FATAL
;
2153 /* Kernel channels */
2154 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2155 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2156 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2157 (*events
)[i
].enabled
= event
->enabled
;
2158 switch (event
->event
->instrumentation
) {
2159 case LTTNG_KERNEL_TRACEPOINT
:
2160 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2162 case LTTNG_KERNEL_KPROBE
:
2163 case LTTNG_KERNEL_KRETPROBE
:
2164 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2165 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2166 sizeof(struct lttng_kernel_kprobe
));
2168 case LTTNG_KERNEL_FUNCTION
:
2169 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2170 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2171 sizeof(struct lttng_kernel_function
));
2173 case LTTNG_KERNEL_NOOP
:
2174 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2176 case LTTNG_KERNEL_SYSCALL
:
2177 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2179 case LTTNG_KERNEL_ALL
:
2193 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2195 static int cmd_disable_channel(struct ltt_session
*session
,
2196 int domain
, char *channel_name
)
2199 struct ltt_ust_session
*usess
;
2201 usess
= session
->ust_session
;
2204 case LTTNG_DOMAIN_KERNEL
:
2206 ret
= channel_kernel_disable(session
->kernel_session
,
2208 if (ret
!= LTTCOMM_OK
) {
2212 kernel_wait_quiescent(kernel_tracer_fd
);
2215 case LTTNG_DOMAIN_UST
:
2217 struct ltt_ust_channel
*uchan
;
2218 struct lttng_ht
*chan_ht
;
2220 chan_ht
= usess
->domain_global
.channels
;
2222 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2223 if (uchan
== NULL
) {
2224 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2228 ret
= channel_ust_disable(usess
, domain
, uchan
);
2229 if (ret
!= LTTCOMM_OK
) {
2235 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2236 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2237 case LTTNG_DOMAIN_UST_PID
:
2240 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2251 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2253 static int cmd_enable_channel(struct ltt_session
*session
,
2254 int domain
, struct lttng_channel
*attr
)
2257 struct ltt_ust_session
*usess
= session
->ust_session
;
2258 struct lttng_ht
*chan_ht
;
2260 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2263 case LTTNG_DOMAIN_KERNEL
:
2265 struct ltt_kernel_channel
*kchan
;
2267 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2268 session
->kernel_session
);
2269 if (kchan
== NULL
) {
2270 ret
= channel_kernel_create(session
->kernel_session
,
2271 attr
, kernel_poll_pipe
[1]);
2273 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2276 if (ret
!= LTTCOMM_OK
) {
2280 kernel_wait_quiescent(kernel_tracer_fd
);
2283 case LTTNG_DOMAIN_UST
:
2285 struct ltt_ust_channel
*uchan
;
2287 chan_ht
= usess
->domain_global
.channels
;
2289 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2290 if (uchan
== NULL
) {
2291 ret
= channel_ust_create(usess
, domain
, attr
);
2293 ret
= channel_ust_enable(usess
, domain
, uchan
);
2298 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2299 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2300 case LTTNG_DOMAIN_UST_PID
:
2303 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2312 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2314 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2315 char *channel_name
, char *event_name
)
2320 case LTTNG_DOMAIN_KERNEL
:
2322 struct ltt_kernel_channel
*kchan
;
2323 struct ltt_kernel_session
*ksess
;
2325 ksess
= session
->kernel_session
;
2327 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2328 if (kchan
== NULL
) {
2329 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2333 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2334 if (ret
!= LTTCOMM_OK
) {
2338 kernel_wait_quiescent(kernel_tracer_fd
);
2341 case LTTNG_DOMAIN_UST
:
2343 struct ltt_ust_channel
*uchan
;
2344 struct ltt_ust_session
*usess
;
2346 usess
= session
->ust_session
;
2348 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2350 if (uchan
== NULL
) {
2351 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2355 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2356 if (ret
!= LTTCOMM_OK
) {
2360 DBG3("Disable UST event %s in channel %s completed", event_name
,
2365 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2366 case LTTNG_DOMAIN_UST_PID
:
2367 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2381 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2383 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2389 case LTTNG_DOMAIN_KERNEL
:
2391 struct ltt_kernel_session
*ksess
;
2392 struct ltt_kernel_channel
*kchan
;
2394 ksess
= session
->kernel_session
;
2396 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2397 if (kchan
== NULL
) {
2398 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2402 ret
= event_kernel_disable_all(ksess
, kchan
);
2403 if (ret
!= LTTCOMM_OK
) {
2407 kernel_wait_quiescent(kernel_tracer_fd
);
2410 case LTTNG_DOMAIN_UST
:
2412 struct ltt_ust_session
*usess
;
2413 struct ltt_ust_channel
*uchan
;
2415 usess
= session
->ust_session
;
2417 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2419 if (uchan
== NULL
) {
2420 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2424 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2429 DBG3("Disable all UST events in channel %s completed", channel_name
);
2434 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2435 case LTTNG_DOMAIN_UST_PID
:
2436 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2450 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2452 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2453 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2458 case LTTNG_DOMAIN_KERNEL
:
2459 /* Add kernel context to kernel tracer */
2460 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2461 event_name
, channel_name
);
2462 if (ret
!= LTTCOMM_OK
) {
2466 case LTTNG_DOMAIN_UST
:
2468 struct ltt_ust_session
*usess
= session
->ust_session
;
2470 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2471 if (ret
!= LTTCOMM_OK
) {
2477 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2478 case LTTNG_DOMAIN_UST_PID
:
2479 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2493 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2495 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2496 char *channel_name
, struct lttng_event
*event
)
2499 struct lttng_channel
*attr
;
2500 struct ltt_ust_session
*usess
= session
->ust_session
;
2503 case LTTNG_DOMAIN_KERNEL
:
2505 struct ltt_kernel_channel
*kchan
;
2507 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2508 session
->kernel_session
);
2509 if (kchan
== NULL
) {
2510 attr
= channel_new_default_attr(domain
);
2512 ret
= LTTCOMM_FATAL
;
2515 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2517 /* This call will notify the kernel thread */
2518 ret
= channel_kernel_create(session
->kernel_session
,
2519 attr
, kernel_poll_pipe
[1]);
2520 if (ret
!= LTTCOMM_OK
) {
2527 /* Get the newly created kernel channel pointer */
2528 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2529 session
->kernel_session
);
2530 if (kchan
== NULL
) {
2531 /* This sould not happen... */
2532 ret
= LTTCOMM_FATAL
;
2536 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2538 if (ret
!= LTTCOMM_OK
) {
2542 kernel_wait_quiescent(kernel_tracer_fd
);
2545 case LTTNG_DOMAIN_UST
:
2547 struct lttng_channel
*attr
;
2548 struct ltt_ust_channel
*uchan
;
2550 /* Get channel from global UST domain */
2551 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2553 if (uchan
== NULL
) {
2554 /* Create default channel */
2555 attr
= channel_new_default_attr(domain
);
2557 ret
= LTTCOMM_FATAL
;
2560 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2561 attr
->name
[NAME_MAX
- 1] = '\0';
2563 ret
= channel_ust_create(usess
, domain
, attr
);
2564 if (ret
!= LTTCOMM_OK
) {
2570 /* Get the newly created channel reference back */
2571 uchan
= trace_ust_find_channel_by_name(
2572 usess
->domain_global
.channels
, channel_name
);
2573 if (uchan
== NULL
) {
2574 /* Something is really wrong */
2575 ret
= LTTCOMM_FATAL
;
2580 /* At this point, the session and channel exist on the tracer */
2581 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2582 if (ret
!= LTTCOMM_OK
) {
2588 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2589 case LTTNG_DOMAIN_UST_PID
:
2590 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2604 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2606 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2607 char *channel_name
, int event_type
)
2610 struct ltt_kernel_channel
*kchan
;
2613 case LTTNG_DOMAIN_KERNEL
:
2614 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2615 session
->kernel_session
);
2616 if (kchan
== NULL
) {
2617 /* This call will notify the kernel thread */
2618 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2619 kernel_poll_pipe
[1]);
2620 if (ret
!= LTTCOMM_OK
) {
2624 /* Get the newly created kernel channel pointer */
2625 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2626 session
->kernel_session
);
2627 if (kchan
== NULL
) {
2628 /* This sould not happen... */
2629 ret
= LTTCOMM_FATAL
;
2635 switch (event_type
) {
2636 case LTTNG_EVENT_SYSCALL
:
2637 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2638 kchan
, kernel_tracer_fd
);
2640 case LTTNG_EVENT_TRACEPOINT
:
2642 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2643 * events already registered to the channel.
2645 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2646 kchan
, kernel_tracer_fd
);
2648 case LTTNG_EVENT_ALL
:
2649 /* Enable syscalls and tracepoints */
2650 ret
= event_kernel_enable_all(session
->kernel_session
,
2651 kchan
, kernel_tracer_fd
);
2654 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2658 /* Manage return value */
2659 if (ret
!= LTTCOMM_OK
) {
2663 kernel_wait_quiescent(kernel_tracer_fd
);
2665 case LTTNG_DOMAIN_UST
:
2667 struct lttng_channel
*attr
;
2668 struct ltt_ust_channel
*uchan
;
2669 struct ltt_ust_session
*usess
= session
->ust_session
;
2671 /* Get channel from global UST domain */
2672 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2674 if (uchan
== NULL
) {
2675 /* Create default channel */
2676 attr
= channel_new_default_attr(domain
);
2678 ret
= LTTCOMM_FATAL
;
2681 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2682 attr
->name
[NAME_MAX
- 1] = '\0';
2684 /* Use the internal command enable channel */
2685 ret
= channel_ust_create(usess
, domain
, attr
);
2686 if (ret
!= LTTCOMM_OK
) {
2692 /* Get the newly created channel reference back */
2693 uchan
= trace_ust_find_channel_by_name(
2694 usess
->domain_global
.channels
, channel_name
);
2695 if (uchan
== NULL
) {
2696 /* Something is really wrong */
2697 ret
= LTTCOMM_FATAL
;
2702 /* At this point, the session and channel exist on the tracer */
2704 switch (event_type
) {
2705 case LTTNG_EVENT_ALL
:
2706 case LTTNG_EVENT_TRACEPOINT
:
2707 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2708 if (ret
!= LTTCOMM_OK
) {
2713 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2717 /* Manage return value */
2718 if (ret
!= LTTCOMM_OK
) {
2725 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2726 case LTTNG_DOMAIN_UST_PID
:
2727 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2741 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2743 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2746 ssize_t nb_events
= 0;
2749 case LTTNG_DOMAIN_KERNEL
:
2750 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2751 if (nb_events
< 0) {
2752 ret
= LTTCOMM_KERN_LIST_FAIL
;
2756 case LTTNG_DOMAIN_UST
:
2757 nb_events
= ust_app_list_events(events
);
2758 if (nb_events
< 0) {
2759 ret
= LTTCOMM_UST_LIST_FAIL
;
2771 /* Return negative value to differentiate return code */
2776 * Command LTTNG_START_TRACE processed by the client thread.
2778 static int cmd_start_trace(struct ltt_session
*session
)
2781 struct ltt_kernel_session
*ksession
;
2782 struct ltt_ust_session
*usess
;
2785 ksession
= session
->kernel_session
;
2786 usess
= session
->ust_session
;
2788 if (session
->enabled
) {
2789 ret
= LTTCOMM_UST_START_FAIL
;
2793 session
->enabled
= 1;
2795 /* Kernel tracing */
2796 if (ksession
!= NULL
) {
2797 struct ltt_kernel_channel
*kchan
;
2799 /* Open kernel metadata */
2800 if (ksession
->metadata
== NULL
) {
2801 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2803 ret
= LTTCOMM_KERN_META_FAIL
;
2808 /* Open kernel metadata stream */
2809 if (ksession
->metadata_stream_fd
== 0) {
2810 ret
= kernel_open_metadata_stream(ksession
);
2812 ERR("Kernel create metadata stream failed");
2813 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2818 /* For each channel */
2819 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2820 if (kchan
->stream_count
== 0) {
2821 ret
= kernel_open_channel_stream(kchan
);
2823 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2826 /* Update the stream global counter */
2827 ksession
->stream_count_global
+= ret
;
2831 /* Setup kernel consumer socket and send fds to it */
2832 ret
= init_kernel_tracing(ksession
);
2834 ret
= LTTCOMM_KERN_START_FAIL
;
2838 /* This start the kernel tracing */
2839 ret
= kernel_start_session(ksession
);
2841 ret
= LTTCOMM_KERN_START_FAIL
;
2845 /* Quiescent wait after starting trace */
2846 kernel_wait_quiescent(kernel_tracer_fd
);
2849 /* Flag session that trace should start automatically */
2851 usess
->start_trace
= 1;
2853 ret
= ust_app_start_trace_all(usess
);
2855 ret
= LTTCOMM_UST_START_FAIL
;
2867 * Command LTTNG_STOP_TRACE processed by the client thread.
2869 static int cmd_stop_trace(struct ltt_session
*session
)
2872 struct ltt_kernel_channel
*kchan
;
2873 struct ltt_kernel_session
*ksession
;
2874 struct ltt_ust_session
*usess
;
2877 ksession
= session
->kernel_session
;
2878 usess
= session
->ust_session
;
2880 if (!session
->enabled
) {
2881 ret
= LTTCOMM_UST_STOP_FAIL
;
2885 session
->enabled
= 0;
2888 if (ksession
!= NULL
) {
2889 DBG("Stop kernel tracing");
2891 /* Flush all buffers before stopping */
2892 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2894 ERR("Kernel metadata flush failed");
2897 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2898 ret
= kernel_flush_buffer(kchan
);
2900 ERR("Kernel flush buffer error");
2904 ret
= kernel_stop_session(ksession
);
2906 ret
= LTTCOMM_KERN_STOP_FAIL
;
2910 kernel_wait_quiescent(kernel_tracer_fd
);
2914 usess
->start_trace
= 0;
2916 ret
= ust_app_stop_trace_all(usess
);
2918 ret
= LTTCOMM_UST_STOP_FAIL
;
2930 * Command LTTNG_CREATE_SESSION processed by the client thread.
2932 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2936 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2937 if (ret
!= LTTCOMM_OK
) {
2948 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2950 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2954 /* Clean kernel session teardown */
2955 teardown_kernel_session(session
);
2956 /* UST session teardown */
2957 teardown_ust_session(session
);
2960 * Must notify the kernel thread here to update it's poll setin order
2961 * to remove the channel(s)' fd just destroyed.
2963 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2965 perror("write kernel poll pipe");
2968 ret
= session_destroy(session
);
2974 * Command LTTNG_CALIBRATE processed by the client thread.
2976 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2981 case LTTNG_DOMAIN_KERNEL
:
2983 struct lttng_kernel_calibrate kcalibrate
;
2985 kcalibrate
.type
= calibrate
->type
;
2986 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2988 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2993 case LTTNG_DOMAIN_UST
:
2995 struct lttng_ust_calibrate ucalibrate
;
2997 ucalibrate
.type
= calibrate
->type
;
2998 ret
= ust_app_calibrate_glb(&ucalibrate
);
3000 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3017 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3019 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3025 case LTTNG_DOMAIN_KERNEL
:
3026 /* Can't register a consumer if there is already one */
3027 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3028 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3032 sock
= lttcomm_connect_unix_sock(sock_path
);
3034 ret
= LTTCOMM_CONNECT_FAIL
;
3038 session
->kernel_session
->consumer_fd
= sock
;
3041 /* TODO: Userspace tracing */
3053 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3055 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3056 struct lttng_domain
**domains
)
3061 if (session
->kernel_session
!= NULL
) {
3062 DBG3("Listing domains found kernel domain");
3066 if (session
->ust_session
!= NULL
) {
3067 DBG3("Listing domains found UST global domain");
3071 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3072 if (*domains
== NULL
) {
3073 ret
= -LTTCOMM_FATAL
;
3077 if (session
->kernel_session
!= NULL
) {
3078 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3082 if (session
->ust_session
!= NULL
) {
3083 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3094 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3096 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3097 struct lttng_channel
**channels
)
3100 ssize_t nb_chan
= 0;
3103 case LTTNG_DOMAIN_KERNEL
:
3104 if (session
->kernel_session
!= NULL
) {
3105 nb_chan
= session
->kernel_session
->channel_count
;
3107 DBG3("Number of kernel channels %zd", nb_chan
);
3109 case LTTNG_DOMAIN_UST
:
3110 if (session
->ust_session
!= NULL
) {
3111 nb_chan
= lttng_ht_get_count(
3112 session
->ust_session
->domain_global
.channels
);
3114 DBG3("Number of UST global channels %zd", nb_chan
);
3123 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3124 if (*channels
== NULL
) {
3125 ret
= -LTTCOMM_FATAL
;
3129 list_lttng_channels(domain
, session
, *channels
);
3141 * Command LTTNG_LIST_EVENTS processed by the client thread.
3143 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3144 char *channel_name
, struct lttng_event
**events
)
3147 ssize_t nb_event
= 0;
3150 case LTTNG_DOMAIN_KERNEL
:
3151 if (session
->kernel_session
!= NULL
) {
3152 nb_event
= list_lttng_kernel_events(channel_name
,
3153 session
->kernel_session
, events
);
3156 case LTTNG_DOMAIN_UST
:
3158 if (session
->ust_session
!= NULL
) {
3159 nb_event
= list_lttng_ust_global_events(channel_name
,
3160 &session
->ust_session
->domain_global
, events
);
3176 * Process the command requested by the lttng client within the command
3177 * context structure. This function make sure that the return structure (llm)
3178 * is set and ready for transmission before returning.
3180 * Return any error encountered or 0 for success.
3182 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3184 int ret
= LTTCOMM_OK
;
3185 int need_tracing_session
= 1;
3187 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3189 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3190 ret
= LTTCOMM_KERN_NA
;
3195 * Check for command that don't needs to allocate a returned payload. We do
3196 * this here so we don't have to make the call for no payload at each
3199 switch(cmd_ctx
->lsm
->cmd_type
) {
3200 case LTTNG_LIST_SESSIONS
:
3201 case LTTNG_LIST_TRACEPOINTS
:
3202 case LTTNG_LIST_DOMAINS
:
3203 case LTTNG_LIST_CHANNELS
:
3204 case LTTNG_LIST_EVENTS
:
3207 /* Setup lttng message with no payload */
3208 ret
= setup_lttng_msg(cmd_ctx
, 0);
3210 /* This label does not try to unlock the session */
3211 goto init_setup_error
;
3215 /* Commands that DO NOT need a session. */
3216 switch (cmd_ctx
->lsm
->cmd_type
) {
3217 case LTTNG_CALIBRATE
:
3218 case LTTNG_CREATE_SESSION
:
3219 case LTTNG_LIST_SESSIONS
:
3220 case LTTNG_LIST_TRACEPOINTS
:
3221 need_tracing_session
= 0;
3224 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3225 session_lock_list();
3226 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3227 session_unlock_list();
3228 if (cmd_ctx
->session
== NULL
) {
3229 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3230 ret
= LTTCOMM_SESS_NOT_FOUND
;
3232 /* If no session name specified */
3233 ret
= LTTCOMM_SELECT_SESS
;
3237 /* Acquire lock for the session */
3238 session_lock(cmd_ctx
->session
);
3244 * Check domain type for specific "pre-action".
3246 switch (cmd_ctx
->lsm
->domain
.type
) {
3247 case LTTNG_DOMAIN_KERNEL
:
3249 ret
= LTTCOMM_KERN_NA
;
3253 /* Kernel tracer check */
3254 if (kernel_tracer_fd
== 0) {
3255 /* Basically, load kernel tracer modules */
3256 ret
= init_kernel_tracer();
3262 /* Need a session for kernel command */
3263 if (need_tracing_session
) {
3264 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3265 ret
= create_kernel_session(cmd_ctx
->session
);
3267 ret
= LTTCOMM_KERN_SESS_FAIL
;
3272 /* Start the kernel consumer daemon */
3273 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3274 if (kconsumer_data
.pid
== 0 &&
3275 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3276 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3277 ret
= start_consumerd(&kconsumer_data
);
3279 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3283 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3287 case LTTNG_DOMAIN_UST
:
3289 if (need_tracing_session
) {
3290 if (cmd_ctx
->session
->ust_session
== NULL
) {
3291 ret
= create_ust_session(cmd_ctx
->session
,
3292 &cmd_ctx
->lsm
->domain
);
3293 if (ret
!= LTTCOMM_OK
) {
3297 /* Start the UST consumer daemons */
3299 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3300 if (consumerd64_bin
[0] != '\0' &&
3301 ustconsumer64_data
.pid
== 0 &&
3302 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3303 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3304 ret
= start_consumerd(&ustconsumer64_data
);
3306 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3307 ust_consumerd64_fd
= -EINVAL
;
3311 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3313 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3316 if (consumerd32_bin
[0] != '\0' &&
3317 ustconsumer32_data
.pid
== 0 &&
3318 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3319 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3320 ret
= start_consumerd(&ustconsumer32_data
);
3322 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3323 ust_consumerd32_fd
= -EINVAL
;
3326 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3328 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3338 * Check that the UID or GID match that of the tracing session.
3339 * The root user can interact with all sessions.
3341 if (need_tracing_session
) {
3342 if (!session_access_ok(cmd_ctx
->session
,
3343 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3344 ret
= LTTCOMM_EPERM
;
3349 /* Process by command type */
3350 switch (cmd_ctx
->lsm
->cmd_type
) {
3351 case LTTNG_ADD_CONTEXT
:
3353 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3354 cmd_ctx
->lsm
->u
.context
.channel_name
,
3355 cmd_ctx
->lsm
->u
.context
.event_name
,
3356 &cmd_ctx
->lsm
->u
.context
.ctx
);
3359 case LTTNG_DISABLE_CHANNEL
:
3361 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3362 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3365 case LTTNG_DISABLE_EVENT
:
3367 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3368 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3369 cmd_ctx
->lsm
->u
.disable
.name
);
3372 case LTTNG_DISABLE_ALL_EVENT
:
3374 DBG("Disabling all events");
3376 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3377 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3380 case LTTNG_ENABLE_CHANNEL
:
3382 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3383 &cmd_ctx
->lsm
->u
.channel
.chan
);
3386 case LTTNG_ENABLE_EVENT
:
3388 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3389 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3390 &cmd_ctx
->lsm
->u
.enable
.event
);
3393 case LTTNG_ENABLE_ALL_EVENT
:
3395 DBG("Enabling all events");
3397 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3398 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3399 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3402 case LTTNG_LIST_TRACEPOINTS
:
3404 struct lttng_event
*events
;
3407 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3408 if (nb_events
< 0) {
3414 * Setup lttng message with payload size set to the event list size in
3415 * bytes and then copy list into the llm payload.
3417 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3423 /* Copy event list into message payload */
3424 memcpy(cmd_ctx
->llm
->payload
, events
,
3425 sizeof(struct lttng_event
) * nb_events
);
3432 case LTTNG_START_TRACE
:
3434 ret
= cmd_start_trace(cmd_ctx
->session
);
3437 case LTTNG_STOP_TRACE
:
3439 ret
= cmd_stop_trace(cmd_ctx
->session
);
3442 case LTTNG_CREATE_SESSION
:
3444 tracepoint(create_session_start
);
3445 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3446 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3447 tracepoint(create_session_end
);
3450 case LTTNG_DESTROY_SESSION
:
3452 tracepoint(destroy_session_start
);
3453 ret
= cmd_destroy_session(cmd_ctx
->session
,
3454 cmd_ctx
->lsm
->session
.name
);
3455 tracepoint(destroy_session_end
);
3458 case LTTNG_LIST_DOMAINS
:
3461 struct lttng_domain
*domains
;
3463 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3469 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3474 /* Copy event list into message payload */
3475 memcpy(cmd_ctx
->llm
->payload
, domains
,
3476 nb_dom
* sizeof(struct lttng_domain
));
3483 case LTTNG_LIST_CHANNELS
:
3486 struct lttng_channel
*channels
;
3488 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3489 cmd_ctx
->session
, &channels
);
3495 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3500 /* Copy event list into message payload */
3501 memcpy(cmd_ctx
->llm
->payload
, channels
,
3502 nb_chan
* sizeof(struct lttng_channel
));
3509 case LTTNG_LIST_EVENTS
:
3512 struct lttng_event
*events
= NULL
;
3514 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3515 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3521 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3526 /* Copy event list into message payload */
3527 memcpy(cmd_ctx
->llm
->payload
, events
,
3528 nb_event
* sizeof(struct lttng_event
));
3535 case LTTNG_LIST_SESSIONS
:
3537 unsigned int nr_sessions
;
3539 session_lock_list();
3540 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3541 if (nr_sessions
== 0) {
3542 ret
= LTTCOMM_NO_SESSION
;
3543 session_unlock_list();
3546 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3548 session_unlock_list();
3552 /* Filled the session array */
3553 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3554 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3556 session_unlock_list();
3561 case LTTNG_CALIBRATE
:
3563 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3564 &cmd_ctx
->lsm
->u
.calibrate
);
3567 case LTTNG_REGISTER_CONSUMER
:
3569 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3570 cmd_ctx
->lsm
->u
.reg
.path
);
3579 if (cmd_ctx
->llm
== NULL
) {
3580 DBG("Missing llm structure. Allocating one.");
3581 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3585 /* Set return code */
3586 cmd_ctx
->llm
->ret_code
= ret
;
3588 if (cmd_ctx
->session
) {
3589 session_unlock(cmd_ctx
->session
);
3596 * This thread manage all clients request using the unix client socket for
3599 static void *thread_manage_clients(void *data
)
3601 int sock
= 0, ret
, i
, pollfd
;
3602 uint32_t revents
, nb_fd
;
3603 struct command_ctx
*cmd_ctx
= NULL
;
3604 struct lttng_poll_event events
;
3606 tracepoint(sessiond_th_cli_start
);
3608 DBG("[thread] Manage client started");
3610 rcu_register_thread();
3612 ret
= lttcomm_listen_unix_sock(client_sock
);
3618 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3619 * more will be added to this poll set.
3621 ret
= create_thread_poll_set(&events
, 2);
3626 /* Add the application registration socket */
3627 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3633 * Notify parent pid that we are ready to accept command for client side.
3635 if (opt_sig_parent
) {
3636 kill(ppid
, SIGUSR1
);
3640 DBG("Accepting client command ...");
3642 tracepoint(sessiond_th_cli_poll
);
3644 nb_fd
= LTTNG_POLL_GETNB(&events
);
3646 /* Inifinite blocking call, waiting for transmission */
3647 ret
= lttng_poll_wait(&events
, -1);
3652 for (i
= 0; i
< nb_fd
; i
++) {
3653 /* Fetch once the poll data */
3654 revents
= LTTNG_POLL_GETEV(&events
, i
);
3655 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3657 /* Thread quit pipe has been closed. Killing thread. */
3658 ret
= check_thread_quit_pipe(pollfd
, revents
);
3663 /* Event on the registration socket */
3664 if (pollfd
== client_sock
) {
3665 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3666 ERR("Client socket poll error");
3672 DBG("Wait for client response");
3674 sock
= lttcomm_accept_unix_sock(client_sock
);
3679 /* Set socket option for credentials retrieval */
3680 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3685 /* Allocate context command to process the client request */
3686 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3687 if (cmd_ctx
== NULL
) {
3688 perror("zmalloc cmd_ctx");
3692 /* Allocate data buffer for reception */
3693 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3694 if (cmd_ctx
->lsm
== NULL
) {
3695 perror("zmalloc cmd_ctx->lsm");
3699 cmd_ctx
->llm
= NULL
;
3700 cmd_ctx
->session
= NULL
;
3703 * Data is received from the lttng client. The struct
3704 * lttcomm_session_msg (lsm) contains the command and data request of
3707 DBG("Receiving data from client ...");
3708 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3709 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3711 DBG("Nothing recv() from client... continuing");
3717 // TODO: Validate cmd_ctx including sanity check for
3718 // security purpose.
3720 rcu_thread_online();
3722 * This function dispatch the work to the kernel or userspace tracer
3723 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3724 * informations for the client. The command context struct contains
3725 * everything this function may needs.
3727 ret
= process_client_msg(cmd_ctx
);
3728 rcu_thread_offline();
3731 * TODO: Inform client somehow of the fatal error. At
3732 * this point, ret < 0 means that a zmalloc failed
3733 * (ENOMEM). Error detected but still accept command.
3735 clean_command_ctx(&cmd_ctx
);
3739 DBG("Sending response (size: %d, retcode: %s)",
3740 cmd_ctx
->lttng_msg_size
,
3741 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3742 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3744 ERR("Failed to send data back to client");
3747 /* End of transmission */
3750 clean_command_ctx(&cmd_ctx
);
3754 DBG("Client thread dying");
3755 unlink(client_unix_sock_path
);
3759 lttng_poll_clean(&events
);
3760 clean_command_ctx(&cmd_ctx
);
3762 rcu_unregister_thread();
3768 * usage function on stderr
3770 static void usage(void)
3772 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3773 fprintf(stderr
, " -h, --help Display this usage.\n");
3774 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3775 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3776 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3777 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3778 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3779 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3780 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3781 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3782 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3783 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3784 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3785 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3786 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3787 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3788 fprintf(stderr
, " -V, --version Show version number.\n");
3789 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3790 fprintf(stderr
, " -q, --quiet No output at all.\n");
3791 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3792 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3793 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3797 * daemon argument parsing
3799 static int parse_args(int argc
, char **argv
)
3803 static struct option long_options
[] = {
3804 { "client-sock", 1, 0, 'c' },
3805 { "apps-sock", 1, 0, 'a' },
3806 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3807 { "kconsumerd-err-sock", 1, 0, 'E' },
3808 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3809 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3810 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3811 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3812 { "consumerd32-path", 1, 0, 'u' },
3813 { "consumerd32-libdir", 1, 0, 'U' },
3814 { "consumerd64-path", 1, 0, 't' },
3815 { "consumerd64-libdir", 1, 0, 'T' },
3816 { "daemonize", 0, 0, 'd' },
3817 { "sig-parent", 0, 0, 'S' },
3818 { "help", 0, 0, 'h' },
3819 { "group", 1, 0, 'g' },
3820 { "version", 0, 0, 'V' },
3821 { "quiet", 0, 0, 'q' },
3822 { "verbose", 0, 0, 'v' },
3823 { "verbose-consumer", 0, 0, 'Z' },
3824 { "no-kernel", 0, 0, 'N' },
3829 int option_index
= 0;
3830 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3831 long_options
, &option_index
);
3838 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3840 fprintf(stderr
, " with arg %s\n", optarg
);
3844 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3847 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3853 opt_tracing_group
= optarg
;
3859 fprintf(stdout
, "%s\n", VERSION
);
3865 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3868 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3871 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3874 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3877 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3880 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3889 /* Verbose level can increase using multiple -v */
3893 opt_verbose_consumer
+= 1;
3896 consumerd32_bin
= optarg
;
3899 consumerd32_libdir
= optarg
;
3902 consumerd64_bin
= optarg
;
3905 consumerd64_libdir
= optarg
;
3908 /* Unknown option or other error.
3909 * Error is printed by getopt, just return */
3918 * Creates the two needed socket by the daemon.
3919 * apps_sock - The communication socket for all UST apps.
3920 * client_sock - The communication of the cli tool (lttng).
3922 static int init_daemon_socket(void)
3927 old_umask
= umask(0);
3929 /* Create client tool unix socket */
3930 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3931 if (client_sock
< 0) {
3932 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3937 /* File permission MUST be 660 */
3938 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3940 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3945 /* Create the application unix socket */
3946 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3947 if (apps_sock
< 0) {
3948 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3953 /* File permission MUST be 666 */
3954 ret
= chmod(apps_unix_sock_path
,
3955 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3957 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3968 * Check if the global socket is available, and if a daemon is answering at the
3969 * other side. If yes, error is returned.
3971 static int check_existing_daemon(void)
3973 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3974 access(apps_unix_sock_path
, F_OK
) < 0) {
3978 /* Is there anybody out there ? */
3979 if (lttng_session_daemon_alive()) {
3987 * Set the tracing group gid onto the client socket.
3989 * Race window between mkdir and chown is OK because we are going from more
3990 * permissive (root.root) to les permissive (root.tracing).
3992 static int set_permissions(char *rundir
)
3997 gid
= allowed_group();
3999 WARN("No tracing group detected");
4004 /* Set lttng run dir */
4005 ret
= chown(rundir
, 0, gid
);
4007 ERR("Unable to set group on %s", rundir
);
4011 /* lttng client socket path */
4012 ret
= chown(client_unix_sock_path
, 0, gid
);
4014 ERR("Unable to set group on %s", client_unix_sock_path
);
4018 /* kconsumer error socket path */
4019 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4021 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4025 /* 64-bit ustconsumer error socket path */
4026 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4028 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4032 /* 32-bit ustconsumer compat32 error socket path */
4033 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4035 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4039 DBG("All permissions are set");
4046 * Create the pipe used to wake up the kernel thread.
4048 static int create_kernel_poll_pipe(void)
4050 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4054 * Create the application command pipe to wake thread_manage_apps.
4056 static int create_apps_cmd_pipe(void)
4058 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4062 * Create the lttng run directory needed for all global sockets and pipe.
4064 static int create_lttng_rundir(const char *rundir
)
4068 DBG3("Creating LTTng run directory: %s", rundir
);
4070 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4072 if (errno
!= EEXIST
) {
4073 ERR("Unable to create %s", rundir
);
4085 * Setup sockets and directory needed by the kconsumerd communication with the
4088 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4092 char path
[PATH_MAX
];
4094 switch (consumer_data
->type
) {
4095 case LTTNG_CONSUMER_KERNEL
:
4096 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4098 case LTTNG_CONSUMER64_UST
:
4099 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4101 case LTTNG_CONSUMER32_UST
:
4102 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4105 ERR("Consumer type unknown");
4110 DBG2("Creating consumer directory: %s", path
);
4112 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4114 if (errno
!= EEXIST
) {
4115 ERR("Failed to create %s", path
);
4121 /* Create the kconsumerd error unix socket */
4122 consumer_data
->err_sock
=
4123 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4124 if (consumer_data
->err_sock
< 0) {
4125 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4130 /* File permission MUST be 660 */
4131 ret
= chmod(consumer_data
->err_unix_sock_path
,
4132 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4134 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4144 * Signal handler for the daemon
4146 * Simply stop all worker threads, leaving main() return gracefully after
4147 * joining all threads and calling cleanup().
4149 static void sighandler(int sig
)
4153 DBG("SIGPIPE caught");
4156 DBG("SIGINT caught");
4160 DBG("SIGTERM caught");
4169 * Setup signal handler for :
4170 * SIGINT, SIGTERM, SIGPIPE
4172 static int set_signal_handler(void)
4175 struct sigaction sa
;
4178 if ((ret
= sigemptyset(&sigset
)) < 0) {
4179 perror("sigemptyset");
4183 sa
.sa_handler
= sighandler
;
4184 sa
.sa_mask
= sigset
;
4186 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4187 perror("sigaction");
4191 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4192 perror("sigaction");
4196 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4197 perror("sigaction");
4201 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4207 * Set open files limit to unlimited. This daemon can open a large number of
4208 * file descriptors in order to consumer multiple kernel traces.
4210 static void set_ulimit(void)
4215 /* The kernel does not allowed an infinite limit for open files */
4216 lim
.rlim_cur
= 65535;
4217 lim
.rlim_max
= 65535;
4219 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4221 perror("failed to set open files limit");
4228 int main(int argc
, char **argv
)
4232 const char *home_path
;
4234 tracepoint(sessiond_boot_start
);
4236 init_kernel_workarounds();
4238 rcu_register_thread();
4240 /* Create thread quit pipe */
4241 if ((ret
= init_thread_quit_pipe()) < 0) {
4245 setup_consumerd_path();
4247 /* Parse arguments */
4249 if ((ret
= parse_args(argc
, argv
) < 0)) {
4262 /* Check if daemon is UID = 0 */
4263 is_root
= !getuid();
4266 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4268 /* Create global run dir with root access */
4269 ret
= create_lttng_rundir(rundir
);
4274 if (strlen(apps_unix_sock_path
) == 0) {
4275 snprintf(apps_unix_sock_path
, PATH_MAX
,
4276 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4279 if (strlen(client_unix_sock_path
) == 0) {
4280 snprintf(client_unix_sock_path
, PATH_MAX
,
4281 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4284 /* Set global SHM for ust */
4285 if (strlen(wait_shm_path
) == 0) {
4286 snprintf(wait_shm_path
, PATH_MAX
,
4287 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4290 /* Setup kernel consumerd path */
4291 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4292 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4293 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4294 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4296 DBG2("Kernel consumer err path: %s",
4297 kconsumer_data
.err_unix_sock_path
);
4298 DBG2("Kernel consumer cmd path: %s",
4299 kconsumer_data
.cmd_unix_sock_path
);
4301 home_path
= get_home_dir();
4302 if (home_path
== NULL
) {
4303 /* TODO: Add --socket PATH option */
4304 ERR("Can't get HOME directory for sockets creation.");
4310 * Create rundir from home path. This will create something like
4313 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4319 ret
= create_lttng_rundir(rundir
);
4324 if (strlen(apps_unix_sock_path
) == 0) {
4325 snprintf(apps_unix_sock_path
, PATH_MAX
,
4326 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4329 /* Set the cli tool unix socket path */
4330 if (strlen(client_unix_sock_path
) == 0) {
4331 snprintf(client_unix_sock_path
, PATH_MAX
,
4332 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4335 /* Set global SHM for ust */
4336 if (strlen(wait_shm_path
) == 0) {
4337 snprintf(wait_shm_path
, PATH_MAX
,
4338 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4342 DBG("Client socket path %s", client_unix_sock_path
);
4343 DBG("Application socket path %s", apps_unix_sock_path
);
4344 DBG("LTTng run directory path: %s", rundir
);
4346 /* 32 bits consumerd path setup */
4347 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4348 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4349 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4350 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4352 DBG2("UST consumer 32 bits err path: %s",
4353 ustconsumer32_data
.err_unix_sock_path
);
4354 DBG2("UST consumer 32 bits cmd path: %s",
4355 ustconsumer32_data
.cmd_unix_sock_path
);
4357 /* 64 bits consumerd path setup */
4358 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4359 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4360 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4361 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4363 DBG2("UST consumer 64 bits err path: %s",
4364 ustconsumer64_data
.err_unix_sock_path
);
4365 DBG2("UST consumer 64 bits cmd path: %s",
4366 ustconsumer64_data
.cmd_unix_sock_path
);
4369 * See if daemon already exist.
4371 if ((ret
= check_existing_daemon()) < 0) {
4372 ERR("Already running daemon.\n");
4374 * We do not goto exit because we must not cleanup()
4375 * because a daemon is already running.
4380 /* After this point, we can safely call cleanup() with "goto exit" */
4383 * These actions must be executed as root. We do that *after* setting up
4384 * the sockets path because we MUST make the check for another daemon using
4385 * those paths *before* trying to set the kernel consumer sockets and init
4389 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4394 /* Setup kernel tracer */
4395 if (!opt_no_kernel
) {
4396 init_kernel_tracer();
4399 /* Set ulimit for open files */
4403 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4408 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4413 if ((ret
= set_signal_handler()) < 0) {
4417 /* Setup the needed unix socket */
4418 if ((ret
= init_daemon_socket()) < 0) {
4422 /* Set credentials to socket */
4423 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4427 /* Get parent pid if -S, --sig-parent is specified. */
4428 if (opt_sig_parent
) {
4432 /* Setup the kernel pipe for waking up the kernel thread */
4433 if ((ret
= create_kernel_poll_pipe()) < 0) {
4437 /* Setup the thread apps communication pipe. */
4438 if ((ret
= create_apps_cmd_pipe()) < 0) {
4442 /* Init UST command queue. */
4443 cds_wfq_init(&ust_cmd_queue
.queue
);
4445 /* Init UST app hash table */
4449 * Get session list pointer. This pointer MUST NOT be free(). This list is
4450 * statically declared in session.c
4452 session_list_ptr
= session_get_list();
4454 /* Set up max poll set size */
4455 lttng_poll_set_max_size();
4457 /* Create thread to manage the client socket */
4458 ret
= pthread_create(&client_thread
, NULL
,
4459 thread_manage_clients
, (void *) NULL
);
4461 perror("pthread_create clients");
4465 /* Create thread to dispatch registration */
4466 ret
= pthread_create(&dispatch_thread
, NULL
,
4467 thread_dispatch_ust_registration
, (void *) NULL
);
4469 perror("pthread_create dispatch");
4473 /* Create thread to manage application registration. */
4474 ret
= pthread_create(®_apps_thread
, NULL
,
4475 thread_registration_apps
, (void *) NULL
);
4477 perror("pthread_create registration");
4481 /* Create thread to manage application socket */
4482 ret
= pthread_create(&apps_thread
, NULL
,
4483 thread_manage_apps
, (void *) NULL
);
4485 perror("pthread_create apps");
4489 /* Create kernel thread to manage kernel event */
4490 ret
= pthread_create(&kernel_thread
, NULL
,
4491 thread_manage_kernel
, (void *) NULL
);
4493 perror("pthread_create kernel");
4497 tracepoint(sessiond_boot_end
);
4499 ret
= pthread_join(kernel_thread
, &status
);
4501 perror("pthread_join");
4502 goto error
; /* join error, exit without cleanup */
4506 ret
= pthread_join(apps_thread
, &status
);
4508 perror("pthread_join");
4509 goto error
; /* join error, exit without cleanup */
4513 ret
= pthread_join(reg_apps_thread
, &status
);
4515 perror("pthread_join");
4516 goto error
; /* join error, exit without cleanup */
4520 ret
= pthread_join(dispatch_thread
, &status
);
4522 perror("pthread_join");
4523 goto error
; /* join error, exit without cleanup */
4527 ret
= pthread_join(client_thread
, &status
);
4529 perror("pthread_join");
4530 goto error
; /* join error, exit without cleanup */
4533 ret
= join_consumer_thread(&kconsumer_data
);
4535 perror("join_consumer");
4536 goto error
; /* join error, exit without cleanup */
4542 * cleanup() is called when no other thread is running.
4544 rcu_thread_online();
4546 rcu_thread_offline();
4547 rcu_unregister_thread();