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.
24 #include <semaphore.h>
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
36 #include <urcu/futex.h>
40 #include <common/common.h>
41 #include <common/compat/poll.h>
42 #include <common/compat/socket.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
58 #define CONSUMERD_FILE "lttng-consumerd"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
79 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
80 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
81 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
82 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
85 int opt_verbose
; /* Not static for lttngerr.h */
86 int opt_verbose_consumer
; /* Not static for lttngerr.h */
87 int opt_quiet
; /* Not static for lttngerr.h */
90 const char *opt_tracing_group
;
91 static int opt_sig_parent
;
92 static int opt_daemon
;
93 static int opt_no_kernel
;
94 static int is_root
; /* Set to 1 if the daemon is running as root */
95 static pid_t ppid
; /* Parent PID for --sig-parent option */
98 /* Consumer daemon specific control data */
99 static struct consumer_data kconsumer_data
= {
100 .type
= LTTNG_CONSUMER_KERNEL
,
101 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
102 .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
,
113 static struct consumer_data ustconsumer32_data
= {
114 .type
= LTTNG_CONSUMER32_UST
,
115 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
116 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
121 static int dispatch_thread_exit
;
123 /* Global application Unix socket path */
124 static char apps_unix_sock_path
[PATH_MAX
];
125 /* Global client Unix socket path */
126 static char client_unix_sock_path
[PATH_MAX
];
127 /* global wait shm path for UST */
128 static char wait_shm_path
[PATH_MAX
];
130 /* Sockets and FDs */
131 static int client_sock
= -1;
132 static int apps_sock
= -1;
133 static int kernel_tracer_fd
= -1;
134 static int kernel_poll_pipe
[2] = { -1, -1 };
137 * Quit pipe for all threads. This permits a single cancellation point
138 * for all threads when receiving an event on the pipe.
140 static int thread_quit_pipe
[2] = { -1, -1 };
143 * This pipe is used to inform the thread managing application communication
144 * that a command is queued and ready to be processed.
146 static int apps_cmd_pipe
[2] = { -1, -1 };
148 /* Pthread, Mutexes and Semaphores */
149 static pthread_t apps_thread
;
150 static pthread_t reg_apps_thread
;
151 static pthread_t client_thread
;
152 static pthread_t kernel_thread
;
153 static pthread_t dispatch_thread
;
157 * UST registration command queue. This queue is tied with a futex and uses a N
158 * wakers / 1 waiter implemented and detailed in futex.c/.h
160 * The thread_manage_apps and thread_dispatch_ust_registration interact with
161 * this queue and the wait/wake scheme.
163 static struct ust_cmd_queue ust_cmd_queue
;
166 * Pointer initialized before thread creation.
168 * This points to the tracing session list containing the session count and a
169 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
170 * MUST NOT be taken if you call a public function in session.c.
172 * The lock is nested inside the structure: session_list_ptr->lock. Please use
173 * session_lock_list and session_unlock_list for lock acquisition.
175 static struct ltt_session_list
*session_list_ptr
;
177 int ust_consumerd64_fd
= -1;
178 int ust_consumerd32_fd
= -1;
180 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
181 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
182 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
183 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
186 void setup_consumerd_path(void)
188 const char *bin
, *libdir
;
191 * Allow INSTALL_BIN_PATH to be used as a target path for the
192 * native architecture size consumer if CONFIG_CONSUMER*_PATH
193 * has not been defined.
195 #if (CAA_BITS_PER_LONG == 32)
196 if (!consumerd32_bin
[0]) {
197 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
199 if (!consumerd32_libdir
[0]) {
200 consumerd32_libdir
= INSTALL_LIB_PATH
;
202 #elif (CAA_BITS_PER_LONG == 64)
203 if (!consumerd64_bin
[0]) {
204 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
206 if (!consumerd64_libdir
[0]) {
207 consumerd64_libdir
= INSTALL_LIB_PATH
;
210 #error "Unknown bitness"
214 * runtime env. var. overrides the build default.
216 bin
= getenv("LTTNG_CONSUMERD32_BIN");
218 consumerd32_bin
= bin
;
220 bin
= getenv("LTTNG_CONSUMERD64_BIN");
222 consumerd64_bin
= bin
;
224 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
226 consumerd32_libdir
= libdir
;
228 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
230 consumerd64_libdir
= libdir
;
235 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
237 static int create_thread_poll_set(struct lttng_poll_event
*events
,
242 if (events
== NULL
|| size
== 0) {
247 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
253 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
265 * Check if the thread quit pipe was triggered.
267 * Return 1 if it was triggered else 0;
269 static int check_thread_quit_pipe(int fd
, uint32_t events
)
271 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
279 * Return group ID of the tracing group or -1 if not found.
281 static gid_t
allowed_group(void)
285 if (opt_tracing_group
) {
286 grp
= getgrnam(opt_tracing_group
);
288 grp
= getgrnam(default_tracing_group
);
298 * Init thread quit pipe.
300 * Return -1 on error or 0 if all pipes are created.
302 static int init_thread_quit_pipe(void)
306 ret
= pipe(thread_quit_pipe
);
308 PERROR("thread quit pipe");
312 for (i
= 0; i
< 2; i
++) {
313 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
325 * Complete teardown of a kernel session. This free all data structure related
326 * to a kernel session and update counter.
328 static void teardown_kernel_session(struct ltt_session
*session
)
330 if (!session
->kernel_session
) {
331 DBG3("No kernel session when tearing down session");
335 DBG("Tearing down kernel session");
338 * If a custom kernel consumer was registered, close the socket before
339 * tearing down the complete kernel session structure
341 if (kconsumer_data
.cmd_sock
>= 0 &&
342 session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
343 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
346 trace_kernel_destroy_session(session
->kernel_session
);
350 * Complete teardown of all UST sessions. This will free everything on his path
351 * and destroy the core essence of all ust sessions :)
353 static void teardown_ust_session(struct ltt_session
*session
)
357 if (!session
->ust_session
) {
358 DBG3("No UST session when tearing down session");
362 DBG("Tearing down UST session(s)");
364 ret
= ust_app_destroy_trace_all(session
->ust_session
);
366 ERR("Error in ust_app_destroy_trace_all");
369 trace_ust_destroy_session(session
->ust_session
);
373 * Stop all threads by closing the thread quit pipe.
375 static void stop_threads(void)
379 /* Stopping all threads */
380 DBG("Terminating all threads");
381 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
383 ERR("write error on thread quit pipe");
386 /* Dispatch thread */
387 dispatch_thread_exit
= 1;
388 futex_nto1_wake(&ust_cmd_queue
.futex
);
394 static void cleanup(void)
398 struct ltt_session
*sess
, *stmp
;
402 DBG("Removing %s directory", rundir
);
403 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
405 ERR("asprintf failed. Something is really wrong!");
408 /* Remove lttng run directory */
411 ERR("Unable to clean %s", rundir
);
415 DBG("Cleaning up all sessions");
417 /* Destroy session list mutex */
418 if (session_list_ptr
!= NULL
) {
419 pthread_mutex_destroy(&session_list_ptr
->lock
);
421 /* Cleanup ALL session */
422 cds_list_for_each_entry_safe(sess
, stmp
,
423 &session_list_ptr
->head
, list
) {
424 teardown_kernel_session(sess
);
425 teardown_ust_session(sess
);
430 DBG("Closing all UST sockets");
431 ust_app_clean_list();
433 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
435 if (is_root
&& !opt_no_kernel
) {
436 DBG2("Closing kernel fd");
437 if (kernel_tracer_fd
>= 0) {
438 ret
= close(kernel_tracer_fd
);
443 DBG("Unloading kernel modules");
444 modprobe_remove_lttng_all();
448 * Closing all pipes used for communication between threads.
450 for (i
= 0; i
< 2; i
++) {
451 if (kernel_poll_pipe
[i
] >= 0) {
452 ret
= close(kernel_poll_pipe
[i
]);
459 for (i
= 0; i
< 2; i
++) {
460 if (thread_quit_pipe
[i
] >= 0) {
461 ret
= close(thread_quit_pipe
[i
]);
467 for (i
= 0; i
< 2; i
++) {
468 if (apps_cmd_pipe
[i
] >= 0) {
469 ret
= close(apps_cmd_pipe
[i
]);
477 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
478 "Matthew, BEET driven development works!%c[%dm",
479 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
484 * Send data on a unix socket using the liblttsessiondcomm API.
486 * Return lttcomm error code.
488 static int send_unix_sock(int sock
, void *buf
, size_t len
)
490 /* Check valid length */
495 return lttcomm_send_unix_sock(sock
, buf
, len
);
499 * Free memory of a command context structure.
501 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
503 DBG("Clean command context structure");
505 if ((*cmd_ctx
)->llm
) {
506 free((*cmd_ctx
)->llm
);
508 if ((*cmd_ctx
)->lsm
) {
509 free((*cmd_ctx
)->lsm
);
517 * Send all stream fds of kernel channel to the consumer.
519 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
520 int sock
, struct ltt_kernel_channel
*channel
,
521 uid_t uid
, gid_t gid
)
524 struct ltt_kernel_stream
*stream
;
525 struct lttcomm_consumer_msg lkm
;
527 DBG("Sending streams of channel %s to kernel consumer",
528 channel
->channel
->name
);
531 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
532 lkm
.u
.channel
.channel_key
= channel
->fd
;
533 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
534 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
535 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
536 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
538 PERROR("send consumer channel");
543 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
547 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
548 lkm
.u
.stream
.channel_key
= channel
->fd
;
549 lkm
.u
.stream
.stream_key
= stream
->fd
;
550 lkm
.u
.stream
.state
= stream
->state
;
551 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
552 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
553 lkm
.u
.stream
.uid
= uid
;
554 lkm
.u
.stream
.gid
= gid
;
555 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
556 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
557 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
558 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
560 PERROR("send consumer stream");
563 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
565 PERROR("send consumer stream ancillary data");
570 DBG("consumer channel streams sent");
579 * Send all stream fds of the kernel session to the consumer.
581 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
582 struct ltt_kernel_session
*session
)
585 struct ltt_kernel_channel
*chan
;
586 struct lttcomm_consumer_msg lkm
;
587 int sock
= session
->consumer_fd
;
589 DBG("Sending metadata stream fd");
591 /* Extra protection. It's NOT supposed to be set to -1 at this point */
592 if (session
->consumer_fd
< 0) {
593 session
->consumer_fd
= consumer_data
->cmd_sock
;
596 if (session
->metadata_stream_fd
>= 0) {
597 /* Send metadata channel fd */
598 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
599 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
600 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
601 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
602 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
603 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
605 PERROR("send consumer channel");
609 /* Send metadata stream fd */
610 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
611 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
612 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
613 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
614 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
615 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
616 lkm
.u
.stream
.uid
= session
->uid
;
617 lkm
.u
.stream
.gid
= session
->gid
;
618 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
619 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
620 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
621 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
623 PERROR("send consumer stream");
626 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
628 PERROR("send consumer stream");
633 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
634 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
635 session
->uid
, session
->gid
);
641 DBG("consumer fds (metadata and channel streams) sent");
650 * Notify UST applications using the shm mmap futex.
652 static int notify_ust_apps(int active
)
656 DBG("Notifying applications of session daemon state: %d", active
);
658 /* See shm.c for this call implying mmap, shm and futex calls */
659 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
660 if (wait_shm_mmap
== NULL
) {
664 /* Wake waiting process */
665 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
667 /* Apps notified successfully */
675 * Setup the outgoing data buffer for the response (llm) by allocating the
676 * right amount of memory and copying the original information from the lsm
679 * Return total size of the buffer pointed by buf.
681 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
687 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
688 if (cmd_ctx
->llm
== NULL
) {
694 /* Copy common data */
695 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
696 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
698 cmd_ctx
->llm
->data_size
= size
;
699 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
708 * Update the kernel poll set of all channel fd available over all tracing
709 * session. Add the wakeup pipe at the end of the set.
711 static int update_kernel_poll(struct lttng_poll_event
*events
)
714 struct ltt_session
*session
;
715 struct ltt_kernel_channel
*channel
;
717 DBG("Updating kernel poll set");
720 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
721 session_lock(session
);
722 if (session
->kernel_session
== NULL
) {
723 session_unlock(session
);
727 cds_list_for_each_entry(channel
,
728 &session
->kernel_session
->channel_list
.head
, list
) {
729 /* Add channel fd to the kernel poll set */
730 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
732 session_unlock(session
);
735 DBG("Channel fd %d added to kernel set", channel
->fd
);
737 session_unlock(session
);
739 session_unlock_list();
744 session_unlock_list();
749 * Find the channel fd from 'fd' over all tracing session. When found, check
750 * for new channel stream and send those stream fds to the kernel consumer.
752 * Useful for CPU hotplug feature.
754 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
757 struct ltt_session
*session
;
758 struct ltt_kernel_channel
*channel
;
760 DBG("Updating kernel streams for channel fd %d", fd
);
763 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
764 session_lock(session
);
765 if (session
->kernel_session
== NULL
) {
766 session_unlock(session
);
770 /* This is not suppose to be -1 but this is an extra security check */
771 if (session
->kernel_session
->consumer_fd
< 0) {
772 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
775 cds_list_for_each_entry(channel
,
776 &session
->kernel_session
->channel_list
.head
, list
) {
777 if (channel
->fd
== fd
) {
778 DBG("Channel found, updating kernel streams");
779 ret
= kernel_open_channel_stream(channel
);
785 * Have we already sent fds to the consumer? If yes, it means
786 * that tracing is started so it is safe to send our updated
789 if (session
->kernel_session
->consumer_fds_sent
== 1) {
790 ret
= send_kconsumer_channel_streams(consumer_data
,
791 session
->kernel_session
->consumer_fd
, channel
,
792 session
->uid
, session
->gid
);
800 session_unlock(session
);
802 session_unlock_list();
806 session_unlock(session
);
807 session_unlock_list();
812 * For each tracing session, update newly registered apps.
814 static void update_ust_app(int app_sock
)
816 struct ltt_session
*sess
, *stmp
;
820 /* For all tracing session(s) */
821 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
823 if (sess
->ust_session
) {
824 ust_app_global_update(sess
->ust_session
, app_sock
);
826 session_unlock(sess
);
829 session_unlock_list();
833 * This thread manage event coming from the kernel.
835 * Features supported in this thread:
838 static void *thread_manage_kernel(void *data
)
840 int ret
, i
, pollfd
, update_poll_flag
= 1;
841 uint32_t revents
, nb_fd
;
843 struct lttng_poll_event events
;
845 DBG("Thread manage kernel started");
847 ret
= create_thread_poll_set(&events
, 2);
849 goto error_poll_create
;
852 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
858 if (update_poll_flag
== 1) {
860 * Reset number of fd in the poll set. Always 2 since there is the thread
861 * quit pipe and the kernel pipe.
865 ret
= update_kernel_poll(&events
);
869 update_poll_flag
= 0;
872 nb_fd
= LTTNG_POLL_GETNB(&events
);
874 DBG("Thread kernel polling on %d fds", nb_fd
);
876 /* Zeroed the poll events */
877 lttng_poll_reset(&events
);
879 /* Poll infinite value of time */
881 ret
= lttng_poll_wait(&events
, -1);
884 * Restart interrupted system call.
886 if (errno
== EINTR
) {
890 } else if (ret
== 0) {
891 /* Should not happen since timeout is infinite */
892 ERR("Return value of poll is 0 with an infinite timeout.\n"
893 "This should not have happened! Continuing...");
897 for (i
= 0; i
< nb_fd
; i
++) {
898 /* Fetch once the poll data */
899 revents
= LTTNG_POLL_GETEV(&events
, i
);
900 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
902 /* Thread quit pipe has been closed. Killing thread. */
903 ret
= check_thread_quit_pipe(pollfd
, revents
);
908 /* Check for data on kernel pipe */
909 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
910 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
911 update_poll_flag
= 1;
915 * New CPU detected by the kernel. Adding kernel stream to
916 * kernel session and updating the kernel consumer
918 if (revents
& LPOLLIN
) {
919 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
925 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
926 * and unregister kernel stream at this point.
934 lttng_poll_clean(&events
);
936 DBG("Kernel thread dying");
941 * This thread manage the consumer error sent back to the session daemon.
943 static void *thread_manage_consumer(void *data
)
945 int sock
= -1, i
, ret
, pollfd
;
946 uint32_t revents
, nb_fd
;
947 enum lttcomm_return_code code
;
948 struct lttng_poll_event events
;
949 struct consumer_data
*consumer_data
= data
;
951 DBG("[thread] Manage consumer started");
953 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
959 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
960 * Nothing more will be added to this poll set.
962 ret
= create_thread_poll_set(&events
, 2);
967 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
972 nb_fd
= LTTNG_POLL_GETNB(&events
);
974 /* Inifinite blocking call, waiting for transmission */
976 ret
= lttng_poll_wait(&events
, -1);
979 * Restart interrupted system call.
981 if (errno
== EINTR
) {
987 for (i
= 0; i
< nb_fd
; i
++) {
988 /* Fetch once the poll data */
989 revents
= LTTNG_POLL_GETEV(&events
, i
);
990 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
992 /* Thread quit pipe has been closed. Killing thread. */
993 ret
= check_thread_quit_pipe(pollfd
, revents
);
998 /* Event on the registration socket */
999 if (pollfd
== consumer_data
->err_sock
) {
1000 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1001 ERR("consumer err socket poll error");
1007 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1012 DBG2("Receiving code from consumer err_sock");
1014 /* Getting status code from kconsumerd */
1015 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1016 sizeof(enum lttcomm_return_code
));
1021 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1022 consumer_data
->cmd_sock
=
1023 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1024 if (consumer_data
->cmd_sock
< 0) {
1025 sem_post(&consumer_data
->sem
);
1026 PERROR("consumer connect");
1029 /* Signal condition to tell that the kconsumerd is ready */
1030 sem_post(&consumer_data
->sem
);
1031 DBG("consumer command socket ready");
1033 ERR("consumer error when waiting for SOCK_READY : %s",
1034 lttcomm_get_readable_code(-code
));
1038 /* Remove the kconsumerd error sock since we've established a connexion */
1039 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1044 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1049 /* Update number of fd */
1050 nb_fd
= LTTNG_POLL_GETNB(&events
);
1052 /* Inifinite blocking call, waiting for transmission */
1054 ret
= lttng_poll_wait(&events
, -1);
1057 * Restart interrupted system call.
1059 if (errno
== EINTR
) {
1065 for (i
= 0; i
< nb_fd
; i
++) {
1066 /* Fetch once the poll data */
1067 revents
= LTTNG_POLL_GETEV(&events
, i
);
1068 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1070 /* Thread quit pipe has been closed. Killing thread. */
1071 ret
= check_thread_quit_pipe(pollfd
, revents
);
1076 /* Event on the kconsumerd socket */
1077 if (pollfd
== sock
) {
1078 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1079 ERR("consumer err socket second poll error");
1085 /* Wait for any kconsumerd error */
1086 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1087 sizeof(enum lttcomm_return_code
));
1089 ERR("consumer closed the command socket");
1093 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1096 if (consumer_data
->err_sock
>= 0) {
1097 ret
= close(consumer_data
->err_sock
);
1102 if (consumer_data
->cmd_sock
>= 0) {
1103 ret
= close(consumer_data
->cmd_sock
);
1115 unlink(consumer_data
->err_unix_sock_path
);
1116 unlink(consumer_data
->cmd_unix_sock_path
);
1117 consumer_data
->pid
= 0;
1119 lttng_poll_clean(&events
);
1122 DBG("consumer thread cleanup completed");
1128 * This thread manage application communication.
1130 static void *thread_manage_apps(void *data
)
1133 uint32_t revents
, nb_fd
;
1134 struct ust_command ust_cmd
;
1135 struct lttng_poll_event events
;
1137 DBG("[thread] Manage application started");
1139 rcu_register_thread();
1140 rcu_thread_online();
1142 ret
= create_thread_poll_set(&events
, 2);
1144 goto error_poll_create
;
1147 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1153 /* Zeroed the events structure */
1154 lttng_poll_reset(&events
);
1156 nb_fd
= LTTNG_POLL_GETNB(&events
);
1158 DBG("Apps thread polling on %d fds", nb_fd
);
1160 /* Inifinite blocking call, waiting for transmission */
1162 ret
= lttng_poll_wait(&events
, -1);
1165 * Restart interrupted system call.
1167 if (errno
== EINTR
) {
1173 for (i
= 0; i
< nb_fd
; i
++) {
1174 /* Fetch once the poll data */
1175 revents
= LTTNG_POLL_GETEV(&events
, i
);
1176 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1178 /* Thread quit pipe has been closed. Killing thread. */
1179 ret
= check_thread_quit_pipe(pollfd
, revents
);
1184 /* Inspect the apps cmd pipe */
1185 if (pollfd
== apps_cmd_pipe
[0]) {
1186 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1187 ERR("Apps command pipe error");
1189 } else if (revents
& LPOLLIN
) {
1191 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1192 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1193 PERROR("read apps cmd pipe");
1197 /* Register applicaton to the session daemon */
1198 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1200 if (ret
== -ENOMEM
) {
1202 } else if (ret
< 0) {
1207 * Validate UST version compatibility.
1209 ret
= ust_app_validate_version(ust_cmd
.sock
);
1212 * Add channel(s) and event(s) to newly registered apps
1213 * from lttng global UST domain.
1215 update_ust_app(ust_cmd
.sock
);
1218 ret
= ust_app_register_done(ust_cmd
.sock
);
1221 * If the registration is not possible, we simply
1222 * unregister the apps and continue
1224 ust_app_unregister(ust_cmd
.sock
);
1227 * We just need here to monitor the close of the UST
1228 * socket and poll set monitor those by default.
1229 * Listen on POLLIN (even if we never expect any
1230 * data) to ensure that hangup wakes us.
1232 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1237 DBG("Apps with sock %d added to poll set",
1245 * At this point, we know that a registered application made
1246 * the event at poll_wait.
1248 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1249 /* Removing from the poll set */
1250 ret
= lttng_poll_del(&events
, pollfd
);
1255 /* Socket closed on remote end. */
1256 ust_app_unregister(pollfd
);
1264 lttng_poll_clean(&events
);
1266 DBG("Application communication apps thread cleanup complete");
1267 rcu_thread_offline();
1268 rcu_unregister_thread();
1273 * Dispatch request from the registration threads to the application
1274 * communication thread.
1276 static void *thread_dispatch_ust_registration(void *data
)
1279 struct cds_wfq_node
*node
;
1280 struct ust_command
*ust_cmd
= NULL
;
1282 DBG("[thread] Dispatch UST command started");
1284 while (!dispatch_thread_exit
) {
1285 /* Atomically prepare the queue futex */
1286 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1289 /* Dequeue command for registration */
1290 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1292 DBG("Woken up but nothing in the UST command queue");
1293 /* Continue thread execution */
1297 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1299 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1300 " gid:%d sock:%d name:%s (version %d.%d)",
1301 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1302 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1303 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1304 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1306 * Inform apps thread of the new application registration. This
1307 * call is blocking so we can be assured that the data will be read
1308 * at some point in time or wait to the end of the world :)
1310 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1311 sizeof(struct ust_command
));
1313 PERROR("write apps cmd pipe");
1314 if (errno
== EBADF
) {
1316 * We can't inform the application thread to process
1317 * registration. We will exit or else application
1318 * registration will not occur and tracing will never
1325 } while (node
!= NULL
);
1327 /* Futex wait on queue. Blocking call on futex() */
1328 futex_nto1_wait(&ust_cmd_queue
.futex
);
1332 DBG("Dispatch thread dying");
1337 * This thread manage application registration.
1339 static void *thread_registration_apps(void *data
)
1341 int sock
= -1, i
, ret
, pollfd
;
1342 uint32_t revents
, nb_fd
;
1343 struct lttng_poll_event events
;
1345 * Get allocated in this thread, enqueued to a global queue, dequeued and
1346 * freed in the manage apps thread.
1348 struct ust_command
*ust_cmd
= NULL
;
1350 DBG("[thread] Manage application registration started");
1352 ret
= lttcomm_listen_unix_sock(apps_sock
);
1358 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1359 * more will be added to this poll set.
1361 ret
= create_thread_poll_set(&events
, 2);
1363 goto error_create_poll
;
1366 /* Add the application registration socket */
1367 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1369 goto error_poll_add
;
1372 /* Notify all applications to register */
1373 ret
= notify_ust_apps(1);
1375 ERR("Failed to notify applications or create the wait shared memory.\n"
1376 "Execution continues but there might be problem for already\n"
1377 "running applications that wishes to register.");
1381 DBG("Accepting application registration");
1383 nb_fd
= LTTNG_POLL_GETNB(&events
);
1385 /* Inifinite blocking call, waiting for transmission */
1387 ret
= lttng_poll_wait(&events
, -1);
1390 * Restart interrupted system call.
1392 if (errno
== EINTR
) {
1398 for (i
= 0; i
< nb_fd
; i
++) {
1399 /* Fetch once the poll data */
1400 revents
= LTTNG_POLL_GETEV(&events
, i
);
1401 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1403 /* Thread quit pipe has been closed. Killing thread. */
1404 ret
= check_thread_quit_pipe(pollfd
, revents
);
1409 /* Event on the registration socket */
1410 if (pollfd
== apps_sock
) {
1411 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1412 ERR("Register apps socket poll error");
1414 } else if (revents
& LPOLLIN
) {
1415 sock
= lttcomm_accept_unix_sock(apps_sock
);
1420 /* Create UST registration command for enqueuing */
1421 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1422 if (ust_cmd
== NULL
) {
1423 PERROR("ust command zmalloc");
1428 * Using message-based transmissions to ensure we don't
1429 * have to deal with partially received messages.
1431 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1432 sizeof(struct ust_register_msg
));
1433 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1435 PERROR("lttcomm_recv_unix_sock register apps");
1437 ERR("Wrong size received on apps register");
1448 ust_cmd
->sock
= sock
;
1451 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1452 " gid:%d sock:%d name:%s (version %d.%d)",
1453 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1454 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1455 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1456 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1459 * Lock free enqueue the registration request. The red pill
1460 * has been taken! This apps will be part of the *system*.
1462 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1465 * Wake the registration queue futex. Implicit memory
1466 * barrier with the exchange in cds_wfq_enqueue.
1468 futex_nto1_wake(&ust_cmd_queue
.futex
);
1475 /* Notify that the registration thread is gone */
1478 if (apps_sock
>= 0) {
1479 ret
= close(apps_sock
);
1490 unlink(apps_unix_sock_path
);
1493 lttng_poll_clean(&events
);
1496 DBG("UST Registration thread cleanup complete");
1502 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1503 * exec or it will fails.
1505 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1508 struct timespec timeout
;
1510 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1511 timeout
.tv_nsec
= 0;
1513 /* Setup semaphore */
1514 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1516 PERROR("sem_init consumer semaphore");
1520 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1521 thread_manage_consumer
, consumer_data
);
1523 PERROR("pthread_create consumer");
1528 /* Get time for sem_timedwait absolute timeout */
1529 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1531 PERROR("clock_gettime spawn consumer");
1532 /* Infinite wait for the kconsumerd thread to be ready */
1533 ret
= sem_wait(&consumer_data
->sem
);
1535 /* Normal timeout if the gettime was successful */
1536 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1537 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1541 if (errno
== ETIMEDOUT
) {
1543 * Call has timed out so we kill the kconsumerd_thread and return
1546 ERR("The consumer thread was never ready. Killing it");
1547 ret
= pthread_cancel(consumer_data
->thread
);
1549 PERROR("pthread_cancel consumer thread");
1552 PERROR("semaphore wait failed consumer thread");
1557 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1558 if (consumer_data
->pid
== 0) {
1559 ERR("Kconsumerd did not start");
1560 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1563 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1572 * Join consumer thread
1574 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1579 if (consumer_data
->pid
!= 0) {
1580 ret
= kill(consumer_data
->pid
, SIGTERM
);
1582 ERR("Error killing consumer daemon");
1585 return pthread_join(consumer_data
->thread
, &status
);
1592 * Fork and exec a consumer daemon (consumerd).
1594 * Return pid if successful else -1.
1596 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1600 const char *consumer_to_use
;
1601 const char *verbosity
;
1604 DBG("Spawning consumerd");
1611 if (opt_verbose_consumer
) {
1612 verbosity
= "--verbose";
1614 verbosity
= "--quiet";
1616 switch (consumer_data
->type
) {
1617 case LTTNG_CONSUMER_KERNEL
:
1619 * Find out which consumerd to execute. We will first try the
1620 * 64-bit path, then the sessiond's installation directory, and
1621 * fallback on the 32-bit one,
1623 DBG3("Looking for a kernel consumer at these locations:");
1624 DBG3(" 1) %s", consumerd64_bin
);
1625 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1626 DBG3(" 3) %s", consumerd32_bin
);
1627 if (stat(consumerd64_bin
, &st
) == 0) {
1628 DBG3("Found location #1");
1629 consumer_to_use
= consumerd64_bin
;
1630 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1631 DBG3("Found location #2");
1632 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1633 } else if (stat(consumerd32_bin
, &st
) == 0) {
1634 DBG3("Found location #3");
1635 consumer_to_use
= consumerd32_bin
;
1637 DBG("Could not find any valid consumerd executable");
1640 DBG("Using kernel consumer at: %s", consumer_to_use
);
1641 execl(consumer_to_use
,
1642 "lttng-consumerd", verbosity
, "-k",
1643 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1644 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1647 case LTTNG_CONSUMER64_UST
:
1649 char *tmpnew
= NULL
;
1651 if (consumerd64_libdir
[0] != '\0') {
1655 tmp
= getenv("LD_LIBRARY_PATH");
1659 tmplen
= strlen("LD_LIBRARY_PATH=")
1660 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1661 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1666 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1667 strcat(tmpnew
, consumerd64_libdir
);
1668 if (tmp
[0] != '\0') {
1669 strcat(tmpnew
, ":");
1670 strcat(tmpnew
, tmp
);
1672 ret
= putenv(tmpnew
);
1678 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1679 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1680 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1681 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1683 if (consumerd64_libdir
[0] != '\0') {
1691 case LTTNG_CONSUMER32_UST
:
1693 char *tmpnew
= NULL
;
1695 if (consumerd32_libdir
[0] != '\0') {
1699 tmp
= getenv("LD_LIBRARY_PATH");
1703 tmplen
= strlen("LD_LIBRARY_PATH=")
1704 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1705 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1710 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1711 strcat(tmpnew
, consumerd32_libdir
);
1712 if (tmp
[0] != '\0') {
1713 strcat(tmpnew
, ":");
1714 strcat(tmpnew
, tmp
);
1716 ret
= putenv(tmpnew
);
1722 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1723 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1724 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1725 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1727 if (consumerd32_libdir
[0] != '\0') {
1736 PERROR("unknown consumer type");
1740 PERROR("kernel start consumer exec");
1743 } else if (pid
> 0) {
1746 PERROR("start consumer fork");
1754 * Spawn the consumerd daemon and session daemon thread.
1756 static int start_consumerd(struct consumer_data
*consumer_data
)
1760 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1761 if (consumer_data
->pid
!= 0) {
1762 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1766 ret
= spawn_consumerd(consumer_data
);
1768 ERR("Spawning consumerd failed");
1769 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1773 /* Setting up the consumer_data pid */
1774 consumer_data
->pid
= ret
;
1775 DBG2("Consumer pid %d", consumer_data
->pid
);
1776 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1778 DBG2("Spawning consumer control thread");
1779 ret
= spawn_consumer_thread(consumer_data
);
1781 ERR("Fatal error spawning consumer control thread");
1793 * Check version of the lttng-modules.
1795 static int validate_lttng_modules_version(void)
1797 return kernel_validate_version(kernel_tracer_fd
);
1801 * Setup necessary data for kernel tracer action.
1803 static int init_kernel_tracer(void)
1807 /* Modprobe lttng kernel modules */
1808 ret
= modprobe_lttng_control();
1813 /* Open debugfs lttng */
1814 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1815 if (kernel_tracer_fd
< 0) {
1816 DBG("Failed to open %s", module_proc_lttng
);
1821 /* Validate kernel version */
1822 ret
= validate_lttng_modules_version();
1827 ret
= modprobe_lttng_data();
1832 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1836 modprobe_remove_lttng_control();
1837 ret
= close(kernel_tracer_fd
);
1841 kernel_tracer_fd
= -1;
1842 return LTTCOMM_KERN_VERSION
;
1845 ret
= close(kernel_tracer_fd
);
1851 modprobe_remove_lttng_control();
1854 WARN("No kernel tracer available");
1855 kernel_tracer_fd
= -1;
1857 return LTTCOMM_NEED_ROOT_SESSIOND
;
1859 return LTTCOMM_KERN_NA
;
1864 * Init tracing by creating trace directory and sending fds kernel consumer.
1866 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1870 if (session
->consumer_fds_sent
== 0) {
1872 * Assign default kernel consumer socket if no consumer assigned to the
1873 * kernel session. At this point, it's NOT supposed to be -1 but this is
1874 * an extra security check.
1876 if (session
->consumer_fd
< 0) {
1877 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1880 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1882 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1886 session
->consumer_fds_sent
= 1;
1894 * Create an UST session and add it to the session ust list.
1896 static int create_ust_session(struct ltt_session
*session
,
1897 struct lttng_domain
*domain
)
1899 struct ltt_ust_session
*lus
= NULL
;
1902 switch (domain
->type
) {
1903 case LTTNG_DOMAIN_UST
:
1906 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1910 DBG("Creating UST session");
1912 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1914 ret
= LTTCOMM_UST_SESS_FAIL
;
1918 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1919 session
->uid
, session
->gid
);
1921 if (ret
!= -EEXIST
) {
1922 ERR("Trace directory creation error");
1923 ret
= LTTCOMM_UST_SESS_FAIL
;
1928 /* The domain type dictate different actions on session creation */
1929 switch (domain
->type
) {
1930 case LTTNG_DOMAIN_UST
:
1931 /* No ustctl for the global UST domain */
1934 ERR("Unknown UST domain on create session %d", domain
->type
);
1937 lus
->uid
= session
->uid
;
1938 lus
->gid
= session
->gid
;
1939 session
->ust_session
= lus
;
1949 * Create a kernel tracer session then create the default channel.
1951 static int create_kernel_session(struct ltt_session
*session
)
1955 DBG("Creating kernel session");
1957 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1959 ret
= LTTCOMM_KERN_SESS_FAIL
;
1963 /* Set kernel consumer socket fd */
1964 if (kconsumer_data
.cmd_sock
>= 0) {
1965 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1968 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1969 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1971 if (ret
!= -EEXIST
) {
1972 ERR("Trace directory creation error");
1976 session
->kernel_session
->uid
= session
->uid
;
1977 session
->kernel_session
->gid
= session
->gid
;
1984 * Check if the UID or GID match the session. Root user has access to all
1987 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1989 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1996 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1999 struct ltt_session
*session
;
2001 DBG("Counting number of available session for UID %d GID %d",
2003 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2005 * Only list the sessions the user can control.
2007 if (!session_access_ok(session
, uid
, gid
)) {
2016 * Using the session list, filled a lttng_session array to send back to the
2017 * client for session listing.
2019 * The session list lock MUST be acquired before calling this function. Use
2020 * session_lock_list() and session_unlock_list().
2022 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2026 struct ltt_session
*session
;
2028 DBG("Getting all available session for UID %d GID %d",
2031 * Iterate over session list and append data after the control struct in
2034 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2036 * Only list the sessions the user can control.
2038 if (!session_access_ok(session
, uid
, gid
)) {
2041 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2042 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2043 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2044 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2045 sessions
[i
].enabled
= session
->enabled
;
2051 * Fill lttng_channel array of all channels.
2053 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2054 struct lttng_channel
*channels
)
2057 struct ltt_kernel_channel
*kchan
;
2059 DBG("Listing channels for session %s", session
->name
);
2062 case LTTNG_DOMAIN_KERNEL
:
2063 /* Kernel channels */
2064 if (session
->kernel_session
!= NULL
) {
2065 cds_list_for_each_entry(kchan
,
2066 &session
->kernel_session
->channel_list
.head
, list
) {
2067 /* Copy lttng_channel struct to array */
2068 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2069 channels
[i
].enabled
= kchan
->enabled
;
2074 case LTTNG_DOMAIN_UST
:
2076 struct lttng_ht_iter iter
;
2077 struct ltt_ust_channel
*uchan
;
2079 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2080 &iter
.iter
, uchan
, node
.node
) {
2081 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2082 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2083 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2084 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2085 channels
[i
].attr
.switch_timer_interval
=
2086 uchan
->attr
.switch_timer_interval
;
2087 channels
[i
].attr
.read_timer_interval
=
2088 uchan
->attr
.read_timer_interval
;
2089 channels
[i
].enabled
= uchan
->enabled
;
2090 switch (uchan
->attr
.output
) {
2091 case LTTNG_UST_MMAP
:
2093 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2106 * Create a list of ust global domain events.
2108 static int list_lttng_ust_global_events(char *channel_name
,
2109 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2112 unsigned int nb_event
= 0;
2113 struct lttng_ht_iter iter
;
2114 struct lttng_ht_node_str
*node
;
2115 struct ltt_ust_channel
*uchan
;
2116 struct ltt_ust_event
*uevent
;
2117 struct lttng_event
*tmp
;
2119 DBG("Listing UST global events for channel %s", channel_name
);
2123 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2124 node
= lttng_ht_iter_get_node_str(&iter
);
2126 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2130 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2132 nb_event
+= lttng_ht_get_count(uchan
->events
);
2134 if (nb_event
== 0) {
2139 DBG3("Listing UST global %d events", nb_event
);
2141 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2143 ret
= -LTTCOMM_FATAL
;
2147 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2148 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2149 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2150 tmp
[i
].enabled
= uevent
->enabled
;
2151 switch (uevent
->attr
.instrumentation
) {
2152 case LTTNG_UST_TRACEPOINT
:
2153 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2155 case LTTNG_UST_PROBE
:
2156 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2158 case LTTNG_UST_FUNCTION
:
2159 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2162 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2163 switch (uevent
->attr
.loglevel_type
) {
2164 case LTTNG_UST_LOGLEVEL_ALL
:
2165 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2167 case LTTNG_UST_LOGLEVEL_RANGE
:
2168 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2170 case LTTNG_UST_LOGLEVEL_SINGLE
:
2171 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2186 * Fill lttng_event array of all kernel events in the channel.
2188 static int list_lttng_kernel_events(char *channel_name
,
2189 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2192 unsigned int nb_event
;
2193 struct ltt_kernel_event
*event
;
2194 struct ltt_kernel_channel
*kchan
;
2196 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2197 if (kchan
== NULL
) {
2198 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2202 nb_event
= kchan
->event_count
;
2204 DBG("Listing events for channel %s", kchan
->channel
->name
);
2206 if (nb_event
== 0) {
2211 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2212 if (*events
== NULL
) {
2213 ret
= LTTCOMM_FATAL
;
2217 /* Kernel channels */
2218 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2219 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2220 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2221 (*events
)[i
].enabled
= event
->enabled
;
2222 switch (event
->event
->instrumentation
) {
2223 case LTTNG_KERNEL_TRACEPOINT
:
2224 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2226 case LTTNG_KERNEL_KPROBE
:
2227 case LTTNG_KERNEL_KRETPROBE
:
2228 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2229 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2230 sizeof(struct lttng_kernel_kprobe
));
2232 case LTTNG_KERNEL_FUNCTION
:
2233 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2234 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2235 sizeof(struct lttng_kernel_function
));
2237 case LTTNG_KERNEL_NOOP
:
2238 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2240 case LTTNG_KERNEL_SYSCALL
:
2241 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2243 case LTTNG_KERNEL_ALL
:
2257 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2259 static int cmd_disable_channel(struct ltt_session
*session
,
2260 int domain
, char *channel_name
)
2263 struct ltt_ust_session
*usess
;
2265 usess
= session
->ust_session
;
2268 case LTTNG_DOMAIN_KERNEL
:
2270 ret
= channel_kernel_disable(session
->kernel_session
,
2272 if (ret
!= LTTCOMM_OK
) {
2276 kernel_wait_quiescent(kernel_tracer_fd
);
2279 case LTTNG_DOMAIN_UST
:
2281 struct ltt_ust_channel
*uchan
;
2282 struct lttng_ht
*chan_ht
;
2284 chan_ht
= usess
->domain_global
.channels
;
2286 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2287 if (uchan
== NULL
) {
2288 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2292 ret
= channel_ust_disable(usess
, domain
, uchan
);
2293 if (ret
!= LTTCOMM_OK
) {
2299 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2300 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2301 case LTTNG_DOMAIN_UST_PID
:
2304 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2315 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2317 static int cmd_enable_channel(struct ltt_session
*session
,
2318 int domain
, struct lttng_channel
*attr
)
2321 struct ltt_ust_session
*usess
= session
->ust_session
;
2322 struct lttng_ht
*chan_ht
;
2324 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2327 case LTTNG_DOMAIN_KERNEL
:
2329 struct ltt_kernel_channel
*kchan
;
2331 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2332 session
->kernel_session
);
2333 if (kchan
== NULL
) {
2334 ret
= channel_kernel_create(session
->kernel_session
,
2335 attr
, kernel_poll_pipe
[1]);
2337 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2340 if (ret
!= LTTCOMM_OK
) {
2344 kernel_wait_quiescent(kernel_tracer_fd
);
2347 case LTTNG_DOMAIN_UST
:
2349 struct ltt_ust_channel
*uchan
;
2351 chan_ht
= usess
->domain_global
.channels
;
2353 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2354 if (uchan
== NULL
) {
2355 ret
= channel_ust_create(usess
, domain
, attr
);
2357 ret
= channel_ust_enable(usess
, domain
, uchan
);
2362 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2363 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2364 case LTTNG_DOMAIN_UST_PID
:
2367 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2376 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2378 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2379 char *channel_name
, char *event_name
)
2384 case LTTNG_DOMAIN_KERNEL
:
2386 struct ltt_kernel_channel
*kchan
;
2387 struct ltt_kernel_session
*ksess
;
2389 ksess
= session
->kernel_session
;
2391 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2392 if (kchan
== NULL
) {
2393 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2397 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2398 if (ret
!= LTTCOMM_OK
) {
2402 kernel_wait_quiescent(kernel_tracer_fd
);
2405 case LTTNG_DOMAIN_UST
:
2407 struct ltt_ust_channel
*uchan
;
2408 struct ltt_ust_session
*usess
;
2410 usess
= session
->ust_session
;
2412 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2414 if (uchan
== NULL
) {
2415 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2419 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2420 if (ret
!= LTTCOMM_OK
) {
2424 DBG3("Disable UST event %s in channel %s completed", event_name
,
2429 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2430 case LTTNG_DOMAIN_UST_PID
:
2431 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2445 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2447 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2453 case LTTNG_DOMAIN_KERNEL
:
2455 struct ltt_kernel_session
*ksess
;
2456 struct ltt_kernel_channel
*kchan
;
2458 ksess
= session
->kernel_session
;
2460 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2461 if (kchan
== NULL
) {
2462 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2466 ret
= event_kernel_disable_all(ksess
, kchan
);
2467 if (ret
!= LTTCOMM_OK
) {
2471 kernel_wait_quiescent(kernel_tracer_fd
);
2474 case LTTNG_DOMAIN_UST
:
2476 struct ltt_ust_session
*usess
;
2477 struct ltt_ust_channel
*uchan
;
2479 usess
= session
->ust_session
;
2481 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2483 if (uchan
== NULL
) {
2484 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2488 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2493 DBG3("Disable all UST events in channel %s completed", channel_name
);
2498 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2499 case LTTNG_DOMAIN_UST_PID
:
2500 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2514 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2516 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2517 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2522 case LTTNG_DOMAIN_KERNEL
:
2523 /* Add kernel context to kernel tracer */
2524 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2525 event_name
, channel_name
);
2526 if (ret
!= LTTCOMM_OK
) {
2530 case LTTNG_DOMAIN_UST
:
2532 struct ltt_ust_session
*usess
= session
->ust_session
;
2534 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2535 if (ret
!= LTTCOMM_OK
) {
2541 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2542 case LTTNG_DOMAIN_UST_PID
:
2543 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2557 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2559 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2560 char *channel_name
, struct lttng_event
*event
)
2563 struct lttng_channel
*attr
;
2564 struct ltt_ust_session
*usess
= session
->ust_session
;
2567 case LTTNG_DOMAIN_KERNEL
:
2569 struct ltt_kernel_channel
*kchan
;
2571 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2572 session
->kernel_session
);
2573 if (kchan
== NULL
) {
2574 attr
= channel_new_default_attr(domain
);
2576 ret
= LTTCOMM_FATAL
;
2579 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2581 /* This call will notify the kernel thread */
2582 ret
= channel_kernel_create(session
->kernel_session
,
2583 attr
, kernel_poll_pipe
[1]);
2584 if (ret
!= LTTCOMM_OK
) {
2591 /* Get the newly created kernel channel pointer */
2592 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2593 session
->kernel_session
);
2594 if (kchan
== NULL
) {
2595 /* This sould not happen... */
2596 ret
= LTTCOMM_FATAL
;
2600 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2602 if (ret
!= LTTCOMM_OK
) {
2606 kernel_wait_quiescent(kernel_tracer_fd
);
2609 case LTTNG_DOMAIN_UST
:
2611 struct lttng_channel
*attr
;
2612 struct ltt_ust_channel
*uchan
;
2614 /* Get channel from global UST domain */
2615 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2617 if (uchan
== NULL
) {
2618 /* Create default channel */
2619 attr
= channel_new_default_attr(domain
);
2621 ret
= LTTCOMM_FATAL
;
2624 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2625 attr
->name
[NAME_MAX
- 1] = '\0';
2627 ret
= channel_ust_create(usess
, domain
, attr
);
2628 if (ret
!= LTTCOMM_OK
) {
2634 /* Get the newly created channel reference back */
2635 uchan
= trace_ust_find_channel_by_name(
2636 usess
->domain_global
.channels
, channel_name
);
2637 if (uchan
== NULL
) {
2638 /* Something is really wrong */
2639 ret
= LTTCOMM_FATAL
;
2644 /* At this point, the session and channel exist on the tracer */
2645 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2646 if (ret
!= LTTCOMM_OK
) {
2652 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2653 case LTTNG_DOMAIN_UST_PID
:
2654 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2668 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2670 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2671 char *channel_name
, int event_type
)
2674 struct ltt_kernel_channel
*kchan
;
2677 case LTTNG_DOMAIN_KERNEL
:
2678 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2679 session
->kernel_session
);
2680 if (kchan
== NULL
) {
2681 /* This call will notify the kernel thread */
2682 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2683 kernel_poll_pipe
[1]);
2684 if (ret
!= LTTCOMM_OK
) {
2688 /* Get the newly created kernel channel pointer */
2689 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2690 session
->kernel_session
);
2691 if (kchan
== NULL
) {
2692 /* This sould not happen... */
2693 ret
= LTTCOMM_FATAL
;
2699 switch (event_type
) {
2700 case LTTNG_EVENT_SYSCALL
:
2701 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2702 kchan
, kernel_tracer_fd
);
2704 case LTTNG_EVENT_TRACEPOINT
:
2706 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2707 * events already registered to the channel.
2709 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2710 kchan
, kernel_tracer_fd
);
2712 case LTTNG_EVENT_ALL
:
2713 /* Enable syscalls and tracepoints */
2714 ret
= event_kernel_enable_all(session
->kernel_session
,
2715 kchan
, kernel_tracer_fd
);
2718 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2722 /* Manage return value */
2723 if (ret
!= LTTCOMM_OK
) {
2727 kernel_wait_quiescent(kernel_tracer_fd
);
2729 case LTTNG_DOMAIN_UST
:
2731 struct lttng_channel
*attr
;
2732 struct ltt_ust_channel
*uchan
;
2733 struct ltt_ust_session
*usess
= session
->ust_session
;
2735 /* Get channel from global UST domain */
2736 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2738 if (uchan
== NULL
) {
2739 /* Create default channel */
2740 attr
= channel_new_default_attr(domain
);
2742 ret
= LTTCOMM_FATAL
;
2745 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2746 attr
->name
[NAME_MAX
- 1] = '\0';
2748 /* Use the internal command enable channel */
2749 ret
= channel_ust_create(usess
, domain
, attr
);
2750 if (ret
!= LTTCOMM_OK
) {
2756 /* Get the newly created channel reference back */
2757 uchan
= trace_ust_find_channel_by_name(
2758 usess
->domain_global
.channels
, channel_name
);
2759 if (uchan
== NULL
) {
2760 /* Something is really wrong */
2761 ret
= LTTCOMM_FATAL
;
2766 /* At this point, the session and channel exist on the tracer */
2768 switch (event_type
) {
2769 case LTTNG_EVENT_ALL
:
2770 case LTTNG_EVENT_TRACEPOINT
:
2771 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2772 if (ret
!= LTTCOMM_OK
) {
2777 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2781 /* Manage return value */
2782 if (ret
!= LTTCOMM_OK
) {
2789 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2790 case LTTNG_DOMAIN_UST_PID
:
2791 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2805 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2807 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2810 ssize_t nb_events
= 0;
2813 case LTTNG_DOMAIN_KERNEL
:
2814 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2815 if (nb_events
< 0) {
2816 ret
= LTTCOMM_KERN_LIST_FAIL
;
2820 case LTTNG_DOMAIN_UST
:
2821 nb_events
= ust_app_list_events(events
);
2822 if (nb_events
< 0) {
2823 ret
= LTTCOMM_UST_LIST_FAIL
;
2835 /* Return negative value to differentiate return code */
2840 * Command LTTNG_START_TRACE processed by the client thread.
2842 static int cmd_start_trace(struct ltt_session
*session
)
2845 struct ltt_kernel_session
*ksession
;
2846 struct ltt_ust_session
*usess
;
2849 ksession
= session
->kernel_session
;
2850 usess
= session
->ust_session
;
2852 if (session
->enabled
) {
2853 ret
= LTTCOMM_UST_START_FAIL
;
2857 session
->enabled
= 1;
2859 /* Kernel tracing */
2860 if (ksession
!= NULL
) {
2861 struct ltt_kernel_channel
*kchan
;
2863 /* Open kernel metadata */
2864 if (ksession
->metadata
== NULL
) {
2865 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2867 ret
= LTTCOMM_KERN_META_FAIL
;
2872 /* Open kernel metadata stream */
2873 if (ksession
->metadata_stream_fd
< 0) {
2874 ret
= kernel_open_metadata_stream(ksession
);
2876 ERR("Kernel create metadata stream failed");
2877 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2882 /* For each channel */
2883 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2884 if (kchan
->stream_count
== 0) {
2885 ret
= kernel_open_channel_stream(kchan
);
2887 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2890 /* Update the stream global counter */
2891 ksession
->stream_count_global
+= ret
;
2895 /* Setup kernel consumer socket and send fds to it */
2896 ret
= init_kernel_tracing(ksession
);
2898 ret
= LTTCOMM_KERN_START_FAIL
;
2902 /* This start the kernel tracing */
2903 ret
= kernel_start_session(ksession
);
2905 ret
= LTTCOMM_KERN_START_FAIL
;
2909 /* Quiescent wait after starting trace */
2910 kernel_wait_quiescent(kernel_tracer_fd
);
2913 /* Flag session that trace should start automatically */
2915 usess
->start_trace
= 1;
2917 ret
= ust_app_start_trace_all(usess
);
2919 ret
= LTTCOMM_UST_START_FAIL
;
2931 * Command LTTNG_STOP_TRACE processed by the client thread.
2933 static int cmd_stop_trace(struct ltt_session
*session
)
2936 struct ltt_kernel_channel
*kchan
;
2937 struct ltt_kernel_session
*ksession
;
2938 struct ltt_ust_session
*usess
;
2941 ksession
= session
->kernel_session
;
2942 usess
= session
->ust_session
;
2944 if (!session
->enabled
) {
2945 ret
= LTTCOMM_UST_STOP_FAIL
;
2949 session
->enabled
= 0;
2952 if (ksession
!= NULL
) {
2953 DBG("Stop kernel tracing");
2955 /* Flush all buffers before stopping */
2956 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2958 ERR("Kernel metadata flush failed");
2961 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2962 ret
= kernel_flush_buffer(kchan
);
2964 ERR("Kernel flush buffer error");
2968 ret
= kernel_stop_session(ksession
);
2970 ret
= LTTCOMM_KERN_STOP_FAIL
;
2974 kernel_wait_quiescent(kernel_tracer_fd
);
2978 usess
->start_trace
= 0;
2980 ret
= ust_app_stop_trace_all(usess
);
2982 ret
= LTTCOMM_UST_STOP_FAIL
;
2994 * Command LTTNG_CREATE_SESSION processed by the client thread.
2996 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
3000 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
3001 LTTNG_SOCK_GET_GID_CRED(creds
));
3002 if (ret
!= LTTCOMM_OK
) {
3013 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3015 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3019 /* Clean kernel session teardown */
3020 teardown_kernel_session(session
);
3021 /* UST session teardown */
3022 teardown_ust_session(session
);
3025 * Must notify the kernel thread here to update it's poll setin order
3026 * to remove the channel(s)' fd just destroyed.
3028 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3030 PERROR("write kernel poll pipe");
3033 ret
= session_destroy(session
);
3039 * Command LTTNG_CALIBRATE processed by the client thread.
3041 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3046 case LTTNG_DOMAIN_KERNEL
:
3048 struct lttng_kernel_calibrate kcalibrate
;
3050 kcalibrate
.type
= calibrate
->type
;
3051 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3053 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3058 case LTTNG_DOMAIN_UST
:
3060 struct lttng_ust_calibrate ucalibrate
;
3062 ucalibrate
.type
= calibrate
->type
;
3063 ret
= ust_app_calibrate_glb(&ucalibrate
);
3065 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3082 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3084 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3090 case LTTNG_DOMAIN_KERNEL
:
3091 /* Can't register a consumer if there is already one */
3092 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3093 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3097 sock
= lttcomm_connect_unix_sock(sock_path
);
3099 ret
= LTTCOMM_CONNECT_FAIL
;
3103 session
->kernel_session
->consumer_fd
= sock
;
3106 /* TODO: Userspace tracing */
3118 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3120 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3121 struct lttng_domain
**domains
)
3126 if (session
->kernel_session
!= NULL
) {
3127 DBG3("Listing domains found kernel domain");
3131 if (session
->ust_session
!= NULL
) {
3132 DBG3("Listing domains found UST global domain");
3136 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3137 if (*domains
== NULL
) {
3138 ret
= -LTTCOMM_FATAL
;
3142 if (session
->kernel_session
!= NULL
) {
3143 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3147 if (session
->ust_session
!= NULL
) {
3148 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3159 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3161 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3162 struct lttng_channel
**channels
)
3165 ssize_t nb_chan
= 0;
3168 case LTTNG_DOMAIN_KERNEL
:
3169 if (session
->kernel_session
!= NULL
) {
3170 nb_chan
= session
->kernel_session
->channel_count
;
3172 DBG3("Number of kernel channels %zd", nb_chan
);
3174 case LTTNG_DOMAIN_UST
:
3175 if (session
->ust_session
!= NULL
) {
3176 nb_chan
= lttng_ht_get_count(
3177 session
->ust_session
->domain_global
.channels
);
3179 DBG3("Number of UST global channels %zd", nb_chan
);
3188 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3189 if (*channels
== NULL
) {
3190 ret
= -LTTCOMM_FATAL
;
3194 list_lttng_channels(domain
, session
, *channels
);
3206 * Command LTTNG_LIST_EVENTS processed by the client thread.
3208 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3209 char *channel_name
, struct lttng_event
**events
)
3212 ssize_t nb_event
= 0;
3215 case LTTNG_DOMAIN_KERNEL
:
3216 if (session
->kernel_session
!= NULL
) {
3217 nb_event
= list_lttng_kernel_events(channel_name
,
3218 session
->kernel_session
, events
);
3221 case LTTNG_DOMAIN_UST
:
3223 if (session
->ust_session
!= NULL
) {
3224 nb_event
= list_lttng_ust_global_events(channel_name
,
3225 &session
->ust_session
->domain_global
, events
);
3241 * Process the command requested by the lttng client within the command
3242 * context structure. This function make sure that the return structure (llm)
3243 * is set and ready for transmission before returning.
3245 * Return any error encountered or 0 for success.
3247 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3249 int ret
= LTTCOMM_OK
;
3250 int need_tracing_session
= 1;
3253 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3255 switch (cmd_ctx
->lsm
->cmd_type
) {
3256 case LTTNG_CREATE_SESSION
:
3257 case LTTNG_DESTROY_SESSION
:
3258 case LTTNG_LIST_SESSIONS
:
3259 case LTTNG_LIST_DOMAINS
:
3260 case LTTNG_START_TRACE
:
3261 case LTTNG_STOP_TRACE
:
3268 if (opt_no_kernel
&& need_domain
3269 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3271 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3273 ret
= LTTCOMM_KERN_NA
;
3279 * Check for command that don't needs to allocate a returned payload. We do
3280 * this here so we don't have to make the call for no payload at each
3283 switch(cmd_ctx
->lsm
->cmd_type
) {
3284 case LTTNG_LIST_SESSIONS
:
3285 case LTTNG_LIST_TRACEPOINTS
:
3286 case LTTNG_LIST_DOMAINS
:
3287 case LTTNG_LIST_CHANNELS
:
3288 case LTTNG_LIST_EVENTS
:
3291 /* Setup lttng message with no payload */
3292 ret
= setup_lttng_msg(cmd_ctx
, 0);
3294 /* This label does not try to unlock the session */
3295 goto init_setup_error
;
3299 /* Commands that DO NOT need a session. */
3300 switch (cmd_ctx
->lsm
->cmd_type
) {
3301 case LTTNG_CREATE_SESSION
:
3302 case LTTNG_CALIBRATE
:
3303 case LTTNG_LIST_SESSIONS
:
3304 case LTTNG_LIST_TRACEPOINTS
:
3305 need_tracing_session
= 0;
3308 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3309 session_lock_list();
3310 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3311 session_unlock_list();
3312 if (cmd_ctx
->session
== NULL
) {
3313 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3314 ret
= LTTCOMM_SESS_NOT_FOUND
;
3316 /* If no session name specified */
3317 ret
= LTTCOMM_SELECT_SESS
;
3321 /* Acquire lock for the session */
3322 session_lock(cmd_ctx
->session
);
3331 * Check domain type for specific "pre-action".
3333 switch (cmd_ctx
->lsm
->domain
.type
) {
3334 case LTTNG_DOMAIN_KERNEL
:
3336 ret
= LTTCOMM_NEED_ROOT_SESSIOND
;
3340 /* Kernel tracer check */
3341 if (kernel_tracer_fd
== -1) {
3342 /* Basically, load kernel tracer modules */
3343 ret
= init_kernel_tracer();
3349 /* Need a session for kernel command */
3350 if (need_tracing_session
) {
3351 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3352 ret
= create_kernel_session(cmd_ctx
->session
);
3354 ret
= LTTCOMM_KERN_SESS_FAIL
;
3359 /* Start the kernel consumer daemon */
3360 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3361 if (kconsumer_data
.pid
== 0 &&
3362 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3363 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3364 ret
= start_consumerd(&kconsumer_data
);
3366 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3370 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3374 case LTTNG_DOMAIN_UST
:
3376 if (need_tracing_session
) {
3377 if (cmd_ctx
->session
->ust_session
== NULL
) {
3378 ret
= create_ust_session(cmd_ctx
->session
,
3379 &cmd_ctx
->lsm
->domain
);
3380 if (ret
!= LTTCOMM_OK
) {
3384 /* Start the UST consumer daemons */
3386 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3387 if (consumerd64_bin
[0] != '\0' &&
3388 ustconsumer64_data
.pid
== 0 &&
3389 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3390 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3391 ret
= start_consumerd(&ustconsumer64_data
);
3393 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3394 ust_consumerd64_fd
= -EINVAL
;
3398 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3400 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3403 if (consumerd32_bin
[0] != '\0' &&
3404 ustconsumer32_data
.pid
== 0 &&
3405 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3406 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3407 ret
= start_consumerd(&ustconsumer32_data
);
3409 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3410 ust_consumerd32_fd
= -EINVAL
;
3413 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3415 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3426 * Check that the UID or GID match that of the tracing session.
3427 * The root user can interact with all sessions.
3429 if (need_tracing_session
) {
3430 if (!session_access_ok(cmd_ctx
->session
,
3431 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3432 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3433 ret
= LTTCOMM_EPERM
;
3438 /* Process by command type */
3439 switch (cmd_ctx
->lsm
->cmd_type
) {
3440 case LTTNG_ADD_CONTEXT
:
3442 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3443 cmd_ctx
->lsm
->u
.context
.channel_name
,
3444 cmd_ctx
->lsm
->u
.context
.event_name
,
3445 &cmd_ctx
->lsm
->u
.context
.ctx
);
3448 case LTTNG_DISABLE_CHANNEL
:
3450 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3451 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3454 case LTTNG_DISABLE_EVENT
:
3456 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3457 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3458 cmd_ctx
->lsm
->u
.disable
.name
);
3461 case LTTNG_DISABLE_ALL_EVENT
:
3463 DBG("Disabling all events");
3465 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3466 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3469 case LTTNG_ENABLE_CHANNEL
:
3471 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3472 &cmd_ctx
->lsm
->u
.channel
.chan
);
3475 case LTTNG_ENABLE_EVENT
:
3477 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3478 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3479 &cmd_ctx
->lsm
->u
.enable
.event
);
3482 case LTTNG_ENABLE_ALL_EVENT
:
3484 DBG("Enabling all events");
3486 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3487 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3488 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3491 case LTTNG_LIST_TRACEPOINTS
:
3493 struct lttng_event
*events
;
3496 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3497 if (nb_events
< 0) {
3503 * Setup lttng message with payload size set to the event list size in
3504 * bytes and then copy list into the llm payload.
3506 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3512 /* Copy event list into message payload */
3513 memcpy(cmd_ctx
->llm
->payload
, events
,
3514 sizeof(struct lttng_event
) * nb_events
);
3521 case LTTNG_START_TRACE
:
3523 ret
= cmd_start_trace(cmd_ctx
->session
);
3526 case LTTNG_STOP_TRACE
:
3528 ret
= cmd_stop_trace(cmd_ctx
->session
);
3531 case LTTNG_CREATE_SESSION
:
3533 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3534 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3537 case LTTNG_DESTROY_SESSION
:
3539 ret
= cmd_destroy_session(cmd_ctx
->session
,
3540 cmd_ctx
->lsm
->session
.name
);
3543 case LTTNG_LIST_DOMAINS
:
3546 struct lttng_domain
*domains
;
3548 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3554 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3559 /* Copy event list into message payload */
3560 memcpy(cmd_ctx
->llm
->payload
, domains
,
3561 nb_dom
* sizeof(struct lttng_domain
));
3568 case LTTNG_LIST_CHANNELS
:
3571 struct lttng_channel
*channels
;
3573 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3574 cmd_ctx
->session
, &channels
);
3580 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3585 /* Copy event list into message payload */
3586 memcpy(cmd_ctx
->llm
->payload
, channels
,
3587 nb_chan
* sizeof(struct lttng_channel
));
3594 case LTTNG_LIST_EVENTS
:
3597 struct lttng_event
*events
= NULL
;
3599 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3600 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3606 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3611 /* Copy event list into message payload */
3612 memcpy(cmd_ctx
->llm
->payload
, events
,
3613 nb_event
* sizeof(struct lttng_event
));
3620 case LTTNG_LIST_SESSIONS
:
3622 unsigned int nr_sessions
;
3624 session_lock_list();
3625 nr_sessions
= lttng_sessions_count(
3626 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3627 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3629 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3631 session_unlock_list();
3635 /* Filled the session array */
3636 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3637 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3638 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3640 session_unlock_list();
3645 case LTTNG_CALIBRATE
:
3647 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3648 &cmd_ctx
->lsm
->u
.calibrate
);
3651 case LTTNG_REGISTER_CONSUMER
:
3653 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3654 cmd_ctx
->lsm
->u
.reg
.path
);
3663 if (cmd_ctx
->llm
== NULL
) {
3664 DBG("Missing llm structure. Allocating one.");
3665 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3669 /* Set return code */
3670 cmd_ctx
->llm
->ret_code
= ret
;
3672 if (cmd_ctx
->session
) {
3673 session_unlock(cmd_ctx
->session
);
3680 * This thread manage all clients request using the unix client socket for
3683 static void *thread_manage_clients(void *data
)
3685 int sock
= -1, ret
, i
, pollfd
;
3686 uint32_t revents
, nb_fd
;
3687 struct command_ctx
*cmd_ctx
= NULL
;
3688 struct lttng_poll_event events
;
3690 DBG("[thread] Manage client started");
3692 rcu_register_thread();
3694 ret
= lttcomm_listen_unix_sock(client_sock
);
3700 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3701 * more will be added to this poll set.
3703 ret
= create_thread_poll_set(&events
, 2);
3708 /* Add the application registration socket */
3709 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3715 * Notify parent pid that we are ready to accept command for client side.
3717 if (opt_sig_parent
) {
3718 kill(ppid
, SIGUSR1
);
3722 DBG("Accepting client command ...");
3724 nb_fd
= LTTNG_POLL_GETNB(&events
);
3726 /* Inifinite blocking call, waiting for transmission */
3728 ret
= lttng_poll_wait(&events
, -1);
3731 * Restart interrupted system call.
3733 if (errno
== EINTR
) {
3739 for (i
= 0; i
< nb_fd
; i
++) {
3740 /* Fetch once the poll data */
3741 revents
= LTTNG_POLL_GETEV(&events
, i
);
3742 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3744 /* Thread quit pipe has been closed. Killing thread. */
3745 ret
= check_thread_quit_pipe(pollfd
, revents
);
3750 /* Event on the registration socket */
3751 if (pollfd
== client_sock
) {
3752 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3753 ERR("Client socket poll error");
3759 DBG("Wait for client response");
3761 sock
= lttcomm_accept_unix_sock(client_sock
);
3766 /* Set socket option for credentials retrieval */
3767 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3772 /* Allocate context command to process the client request */
3773 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3774 if (cmd_ctx
== NULL
) {
3775 PERROR("zmalloc cmd_ctx");
3779 /* Allocate data buffer for reception */
3780 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3781 if (cmd_ctx
->lsm
== NULL
) {
3782 PERROR("zmalloc cmd_ctx->lsm");
3786 cmd_ctx
->llm
= NULL
;
3787 cmd_ctx
->session
= NULL
;
3790 * Data is received from the lttng client. The struct
3791 * lttcomm_session_msg (lsm) contains the command and data request of
3794 DBG("Receiving data from client ...");
3795 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3796 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3798 DBG("Nothing recv() from client... continuing");
3808 // TODO: Validate cmd_ctx including sanity check for
3809 // security purpose.
3811 rcu_thread_online();
3813 * This function dispatch the work to the kernel or userspace tracer
3814 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3815 * informations for the client. The command context struct contains
3816 * everything this function may needs.
3818 ret
= process_client_msg(cmd_ctx
);
3819 rcu_thread_offline();
3822 * TODO: Inform client somehow of the fatal error. At
3823 * this point, ret < 0 means that a zmalloc failed
3824 * (ENOMEM). Error detected but still accept command.
3826 clean_command_ctx(&cmd_ctx
);
3830 DBG("Sending response (size: %d, retcode: %s)",
3831 cmd_ctx
->lttng_msg_size
,
3832 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3833 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3835 ERR("Failed to send data back to client");
3838 /* End of transmission */
3845 clean_command_ctx(&cmd_ctx
);
3849 DBG("Client thread dying");
3850 unlink(client_unix_sock_path
);
3851 if (client_sock
>= 0) {
3852 ret
= close(client_sock
);
3864 lttng_poll_clean(&events
);
3865 clean_command_ctx(&cmd_ctx
);
3867 rcu_unregister_thread();
3873 * usage function on stderr
3875 static void usage(void)
3877 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3878 fprintf(stderr
, " -h, --help Display this usage.\n");
3879 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3880 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3881 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3882 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3883 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3884 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3885 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3886 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3887 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3888 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3889 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3890 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3891 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3892 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3893 fprintf(stderr
, " -V, --version Show version number.\n");
3894 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3895 fprintf(stderr
, " -q, --quiet No output at all.\n");
3896 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3897 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3898 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3902 * daemon argument parsing
3904 static int parse_args(int argc
, char **argv
)
3908 static struct option long_options
[] = {
3909 { "client-sock", 1, 0, 'c' },
3910 { "apps-sock", 1, 0, 'a' },
3911 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3912 { "kconsumerd-err-sock", 1, 0, 'E' },
3913 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3914 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3915 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3916 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3917 { "consumerd32-path", 1, 0, 'u' },
3918 { "consumerd32-libdir", 1, 0, 'U' },
3919 { "consumerd64-path", 1, 0, 't' },
3920 { "consumerd64-libdir", 1, 0, 'T' },
3921 { "daemonize", 0, 0, 'd' },
3922 { "sig-parent", 0, 0, 'S' },
3923 { "help", 0, 0, 'h' },
3924 { "group", 1, 0, 'g' },
3925 { "version", 0, 0, 'V' },
3926 { "quiet", 0, 0, 'q' },
3927 { "verbose", 0, 0, 'v' },
3928 { "verbose-consumer", 0, 0, 'Z' },
3929 { "no-kernel", 0, 0, 'N' },
3934 int option_index
= 0;
3935 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3936 long_options
, &option_index
);
3943 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3945 fprintf(stderr
, " with arg %s\n", optarg
);
3949 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3952 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3958 opt_tracing_group
= optarg
;
3964 fprintf(stdout
, "%s\n", VERSION
);
3970 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3973 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3976 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3979 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3982 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3985 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3994 /* Verbose level can increase using multiple -v */
3998 opt_verbose_consumer
+= 1;
4001 consumerd32_bin
= optarg
;
4004 consumerd32_libdir
= optarg
;
4007 consumerd64_bin
= optarg
;
4010 consumerd64_libdir
= optarg
;
4013 /* Unknown option or other error.
4014 * Error is printed by getopt, just return */
4023 * Creates the two needed socket by the daemon.
4024 * apps_sock - The communication socket for all UST apps.
4025 * client_sock - The communication of the cli tool (lttng).
4027 static int init_daemon_socket(void)
4032 old_umask
= umask(0);
4034 /* Create client tool unix socket */
4035 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4036 if (client_sock
< 0) {
4037 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4042 /* File permission MUST be 660 */
4043 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4045 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4050 /* Create the application unix socket */
4051 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4052 if (apps_sock
< 0) {
4053 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4058 /* File permission MUST be 666 */
4059 ret
= chmod(apps_unix_sock_path
,
4060 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4062 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4073 * Check if the global socket is available, and if a daemon is answering at the
4074 * other side. If yes, error is returned.
4076 static int check_existing_daemon(void)
4078 /* Is there anybody out there ? */
4079 if (lttng_session_daemon_alive()) {
4087 * Set the tracing group gid onto the client socket.
4089 * Race window between mkdir and chown is OK because we are going from more
4090 * permissive (root.root) to less permissive (root.tracing).
4092 static int set_permissions(char *rundir
)
4097 gid
= allowed_group();
4099 WARN("No tracing group detected");
4104 /* Set lttng run dir */
4105 ret
= chown(rundir
, 0, gid
);
4107 ERR("Unable to set group on %s", rundir
);
4111 /* Ensure tracing group can search the run dir */
4112 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4114 ERR("Unable to set permissions on %s", rundir
);
4118 /* lttng client socket path */
4119 ret
= chown(client_unix_sock_path
, 0, gid
);
4121 ERR("Unable to set group on %s", client_unix_sock_path
);
4125 /* kconsumer error socket path */
4126 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4128 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4132 /* 64-bit ustconsumer error socket path */
4133 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4135 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4139 /* 32-bit ustconsumer compat32 error socket path */
4140 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4142 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4146 DBG("All permissions are set");
4153 * Create the pipe used to wake up the kernel thread.
4154 * Closed in cleanup().
4156 static int create_kernel_poll_pipe(void)
4160 ret
= pipe(kernel_poll_pipe
);
4162 PERROR("kernel poll pipe");
4166 for (i
= 0; i
< 2; i
++) {
4167 ret
= fcntl(kernel_poll_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4169 PERROR("fcntl kernel_poll_pipe");
4179 * Create the application command pipe to wake thread_manage_apps.
4180 * Closed in cleanup().
4182 static int create_apps_cmd_pipe(void)
4186 ret
= pipe(apps_cmd_pipe
);
4188 PERROR("apps cmd pipe");
4192 for (i
= 0; i
< 2; i
++) {
4193 ret
= fcntl(apps_cmd_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4195 PERROR("fcntl apps_cmd_pipe");
4205 * Create the lttng run directory needed for all global sockets and pipe.
4207 static int create_lttng_rundir(const char *rundir
)
4211 DBG3("Creating LTTng run directory: %s", rundir
);
4213 ret
= mkdir(rundir
, S_IRWXU
);
4215 if (errno
!= EEXIST
) {
4216 ERR("Unable to create %s", rundir
);
4228 * Setup sockets and directory needed by the kconsumerd communication with the
4231 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4235 char path
[PATH_MAX
];
4237 switch (consumer_data
->type
) {
4238 case LTTNG_CONSUMER_KERNEL
:
4239 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4241 case LTTNG_CONSUMER64_UST
:
4242 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4244 case LTTNG_CONSUMER32_UST
:
4245 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4248 ERR("Consumer type unknown");
4253 DBG2("Creating consumer directory: %s", path
);
4255 ret
= mkdir(path
, S_IRWXU
);
4257 if (errno
!= EEXIST
) {
4258 ERR("Failed to create %s", path
);
4264 /* Create the kconsumerd error unix socket */
4265 consumer_data
->err_sock
=
4266 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4267 if (consumer_data
->err_sock
< 0) {
4268 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4273 /* File permission MUST be 660 */
4274 ret
= chmod(consumer_data
->err_unix_sock_path
,
4275 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4277 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4287 * Signal handler for the daemon
4289 * Simply stop all worker threads, leaving main() return gracefully after
4290 * joining all threads and calling cleanup().
4292 static void sighandler(int sig
)
4296 DBG("SIGPIPE caught");
4299 DBG("SIGINT caught");
4303 DBG("SIGTERM caught");
4312 * Setup signal handler for :
4313 * SIGINT, SIGTERM, SIGPIPE
4315 static int set_signal_handler(void)
4318 struct sigaction sa
;
4321 if ((ret
= sigemptyset(&sigset
)) < 0) {
4322 PERROR("sigemptyset");
4326 sa
.sa_handler
= sighandler
;
4327 sa
.sa_mask
= sigset
;
4329 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4330 PERROR("sigaction");
4334 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4335 PERROR("sigaction");
4339 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4340 PERROR("sigaction");
4344 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4350 * Set open files limit to unlimited. This daemon can open a large number of
4351 * file descriptors in order to consumer multiple kernel traces.
4353 static void set_ulimit(void)
4358 /* The kernel does not allowed an infinite limit for open files */
4359 lim
.rlim_cur
= 65535;
4360 lim
.rlim_max
= 65535;
4362 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4364 PERROR("failed to set open files limit");
4371 int main(int argc
, char **argv
)
4375 const char *home_path
;
4377 init_kernel_workarounds();
4379 rcu_register_thread();
4381 /* Create thread quit pipe */
4382 if ((ret
= init_thread_quit_pipe()) < 0) {
4386 setup_consumerd_path();
4388 /* Parse arguments */
4390 if ((ret
= parse_args(argc
, argv
) < 0)) {
4403 /* Check if daemon is UID = 0 */
4404 is_root
= !getuid();
4407 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4409 /* Create global run dir with root access */
4410 ret
= create_lttng_rundir(rundir
);
4415 if (strlen(apps_unix_sock_path
) == 0) {
4416 snprintf(apps_unix_sock_path
, PATH_MAX
,
4417 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4420 if (strlen(client_unix_sock_path
) == 0) {
4421 snprintf(client_unix_sock_path
, PATH_MAX
,
4422 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4425 /* Set global SHM for ust */
4426 if (strlen(wait_shm_path
) == 0) {
4427 snprintf(wait_shm_path
, PATH_MAX
,
4428 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4431 /* Setup kernel consumerd path */
4432 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4433 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4434 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4435 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4437 DBG2("Kernel consumer err path: %s",
4438 kconsumer_data
.err_unix_sock_path
);
4439 DBG2("Kernel consumer cmd path: %s",
4440 kconsumer_data
.cmd_unix_sock_path
);
4442 home_path
= get_home_dir();
4443 if (home_path
== NULL
) {
4444 /* TODO: Add --socket PATH option */
4445 ERR("Can't get HOME directory for sockets creation.");
4451 * Create rundir from home path. This will create something like
4454 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4460 ret
= create_lttng_rundir(rundir
);
4465 if (strlen(apps_unix_sock_path
) == 0) {
4466 snprintf(apps_unix_sock_path
, PATH_MAX
,
4467 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4470 /* Set the cli tool unix socket path */
4471 if (strlen(client_unix_sock_path
) == 0) {
4472 snprintf(client_unix_sock_path
, PATH_MAX
,
4473 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4476 /* Set global SHM for ust */
4477 if (strlen(wait_shm_path
) == 0) {
4478 snprintf(wait_shm_path
, PATH_MAX
,
4479 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4483 DBG("Client socket path %s", client_unix_sock_path
);
4484 DBG("Application socket path %s", apps_unix_sock_path
);
4485 DBG("LTTng run directory path: %s", rundir
);
4487 /* 32 bits consumerd path setup */
4488 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4489 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4490 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4491 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4493 DBG2("UST consumer 32 bits err path: %s",
4494 ustconsumer32_data
.err_unix_sock_path
);
4495 DBG2("UST consumer 32 bits cmd path: %s",
4496 ustconsumer32_data
.cmd_unix_sock_path
);
4498 /* 64 bits consumerd path setup */
4499 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4500 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4501 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4502 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4504 DBG2("UST consumer 64 bits err path: %s",
4505 ustconsumer64_data
.err_unix_sock_path
);
4506 DBG2("UST consumer 64 bits cmd path: %s",
4507 ustconsumer64_data
.cmd_unix_sock_path
);
4510 * See if daemon already exist.
4512 if ((ret
= check_existing_daemon()) < 0) {
4513 ERR("Already running daemon.\n");
4515 * We do not goto exit because we must not cleanup()
4516 * because a daemon is already running.
4521 /* After this point, we can safely call cleanup() with "goto exit" */
4524 * These actions must be executed as root. We do that *after* setting up
4525 * the sockets path because we MUST make the check for another daemon using
4526 * those paths *before* trying to set the kernel consumer sockets and init
4530 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4535 /* Setup kernel tracer */
4536 if (!opt_no_kernel
) {
4537 init_kernel_tracer();
4540 /* Set ulimit for open files */
4544 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4549 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4554 if ((ret
= set_signal_handler()) < 0) {
4558 /* Setup the needed unix socket */
4559 if ((ret
= init_daemon_socket()) < 0) {
4563 /* Set credentials to socket */
4564 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4568 /* Get parent pid if -S, --sig-parent is specified. */
4569 if (opt_sig_parent
) {
4573 /* Setup the kernel pipe for waking up the kernel thread */
4574 if ((ret
= create_kernel_poll_pipe()) < 0) {
4578 /* Setup the thread apps communication pipe. */
4579 if ((ret
= create_apps_cmd_pipe()) < 0) {
4583 /* Init UST command queue. */
4584 cds_wfq_init(&ust_cmd_queue
.queue
);
4586 /* Init UST app hash table */
4590 * Get session list pointer. This pointer MUST NOT be free(). This list is
4591 * statically declared in session.c
4593 session_list_ptr
= session_get_list();
4595 /* Set up max poll set size */
4596 lttng_poll_set_max_size();
4598 /* Create thread to manage the client socket */
4599 ret
= pthread_create(&client_thread
, NULL
,
4600 thread_manage_clients
, (void *) NULL
);
4602 PERROR("pthread_create clients");
4606 /* Create thread to dispatch registration */
4607 ret
= pthread_create(&dispatch_thread
, NULL
,
4608 thread_dispatch_ust_registration
, (void *) NULL
);
4610 PERROR("pthread_create dispatch");
4614 /* Create thread to manage application registration. */
4615 ret
= pthread_create(®_apps_thread
, NULL
,
4616 thread_registration_apps
, (void *) NULL
);
4618 PERROR("pthread_create registration");
4622 /* Create thread to manage application socket */
4623 ret
= pthread_create(&apps_thread
, NULL
,
4624 thread_manage_apps
, (void *) NULL
);
4626 PERROR("pthread_create apps");
4630 /* Create kernel thread to manage kernel event */
4631 ret
= pthread_create(&kernel_thread
, NULL
,
4632 thread_manage_kernel
, (void *) NULL
);
4634 PERROR("pthread_create kernel");
4638 ret
= pthread_join(kernel_thread
, &status
);
4640 PERROR("pthread_join");
4641 goto error
; /* join error, exit without cleanup */
4645 ret
= pthread_join(apps_thread
, &status
);
4647 PERROR("pthread_join");
4648 goto error
; /* join error, exit without cleanup */
4652 ret
= pthread_join(reg_apps_thread
, &status
);
4654 PERROR("pthread_join");
4655 goto error
; /* join error, exit without cleanup */
4659 ret
= pthread_join(dispatch_thread
, &status
);
4661 PERROR("pthread_join");
4662 goto error
; /* join error, exit without cleanup */
4666 ret
= pthread_join(client_thread
, &status
);
4668 PERROR("pthread_join");
4669 goto error
; /* join error, exit without cleanup */
4672 ret
= join_consumer_thread(&kconsumer_data
);
4674 PERROR("join_consumer");
4675 goto error
; /* join error, exit without cleanup */
4681 * cleanup() is called when no other thread is running.
4683 rcu_thread_online();
4685 rcu_thread_offline();
4686 rcu_unregister_thread();