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
,
104 static struct consumer_data ustconsumer64_data
= {
105 .type
= LTTNG_CONSUMER64_UST
,
106 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
107 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
109 static struct consumer_data ustconsumer32_data
= {
110 .type
= LTTNG_CONSUMER32_UST
,
111 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
112 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
115 static int dispatch_thread_exit
;
117 /* Global application Unix socket path */
118 static char apps_unix_sock_path
[PATH_MAX
];
119 /* Global client Unix socket path */
120 static char client_unix_sock_path
[PATH_MAX
];
121 /* global wait shm path for UST */
122 static char wait_shm_path
[PATH_MAX
];
124 /* Sockets and FDs */
125 static int client_sock
;
126 static int apps_sock
;
127 static int kernel_tracer_fd
;
128 static int kernel_poll_pipe
[2];
131 * Quit pipe for all threads. This permits a single cancellation point
132 * for all threads when receiving an event on the pipe.
134 static int thread_quit_pipe
[2];
137 * This pipe is used to inform the thread managing application communication
138 * that a command is queued and ready to be processed.
140 static int apps_cmd_pipe
[2];
142 /* Pthread, Mutexes and Semaphores */
143 static pthread_t apps_thread
;
144 static pthread_t reg_apps_thread
;
145 static pthread_t client_thread
;
146 static pthread_t kernel_thread
;
147 static pthread_t dispatch_thread
;
151 * UST registration command queue. This queue is tied with a futex and uses a N
152 * wakers / 1 waiter implemented and detailed in futex.c/.h
154 * The thread_manage_apps and thread_dispatch_ust_registration interact with
155 * this queue and the wait/wake scheme.
157 static struct ust_cmd_queue ust_cmd_queue
;
160 * Pointer initialized before thread creation.
162 * This points to the tracing session list containing the session count and a
163 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
164 * MUST NOT be taken if you call a public function in session.c.
166 * The lock is nested inside the structure: session_list_ptr->lock. Please use
167 * session_lock_list and session_unlock_list for lock acquisition.
169 static struct ltt_session_list
*session_list_ptr
;
171 int ust_consumerd64_fd
= -1;
172 int ust_consumerd32_fd
= -1;
174 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
175 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
176 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
177 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
180 void setup_consumerd_path(void)
182 const char *bin
, *libdir
;
185 * Allow INSTALL_BIN_PATH to be used as a target path for the
186 * native architecture size consumer if CONFIG_CONSUMER*_PATH
187 * has not been defined.
189 #if (CAA_BITS_PER_LONG == 32)
190 if (!consumerd32_bin
[0]) {
191 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
193 if (!consumerd32_libdir
[0]) {
194 consumerd32_libdir
= INSTALL_LIB_PATH
;
196 #elif (CAA_BITS_PER_LONG == 64)
197 if (!consumerd64_bin
[0]) {
198 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
200 if (!consumerd64_libdir
[0]) {
201 consumerd64_libdir
= INSTALL_LIB_PATH
;
204 #error "Unknown bitness"
208 * runtime env. var. overrides the build default.
210 bin
= getenv("LTTNG_CONSUMERD32_BIN");
212 consumerd32_bin
= bin
;
214 bin
= getenv("LTTNG_CONSUMERD64_BIN");
216 consumerd64_bin
= bin
;
218 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
220 consumerd32_libdir
= libdir
;
222 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
224 consumerd64_libdir
= libdir
;
229 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
231 static int create_thread_poll_set(struct lttng_poll_event
*events
,
236 if (events
== NULL
|| size
== 0) {
241 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
247 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
259 * Check if the thread quit pipe was triggered.
261 * Return 1 if it was triggered else 0;
263 static int check_thread_quit_pipe(int fd
, uint32_t events
)
265 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
273 * Return group ID of the tracing group or -1 if not found.
275 static gid_t
allowed_group(void)
279 if (opt_tracing_group
) {
280 grp
= getgrnam(opt_tracing_group
);
282 grp
= getgrnam(default_tracing_group
);
292 * Init thread quit pipe.
294 * Return -1 on error or 0 if all pipes are created.
296 static int init_thread_quit_pipe(void)
300 ret
= pipe(thread_quit_pipe
);
302 PERROR("thread quit pipe");
306 for (i
= 0; i
< 2; i
++) {
307 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
319 * Complete teardown of a kernel session. This free all data structure related
320 * to a kernel session and update counter.
322 static void teardown_kernel_session(struct ltt_session
*session
)
324 if (!session
->kernel_session
) {
325 DBG3("No kernel session when tearing down session");
329 DBG("Tearing down kernel session");
332 * If a custom kernel consumer was registered, close the socket before
333 * tearing down the complete kernel session structure
335 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
336 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
339 trace_kernel_destroy_session(session
->kernel_session
);
343 * Complete teardown of all UST sessions. This will free everything on his path
344 * and destroy the core essence of all ust sessions :)
346 static void teardown_ust_session(struct ltt_session
*session
)
350 if (!session
->ust_session
) {
351 DBG3("No UST session when tearing down session");
355 DBG("Tearing down UST session(s)");
357 ret
= ust_app_destroy_trace_all(session
->ust_session
);
359 ERR("Error in ust_app_destroy_trace_all");
362 trace_ust_destroy_session(session
->ust_session
);
366 * Stop all threads by closing the thread quit pipe.
368 static void stop_threads(void)
372 /* Stopping all threads */
373 DBG("Terminating all threads");
374 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
376 ERR("write error on thread quit pipe");
379 /* Dispatch thread */
380 dispatch_thread_exit
= 1;
381 futex_nto1_wake(&ust_cmd_queue
.futex
);
387 static void cleanup(void)
391 struct ltt_session
*sess
, *stmp
;
395 DBG("Removing %s directory", rundir
);
396 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
398 ERR("asprintf failed. Something is really wrong!");
401 /* Remove lttng run directory */
404 ERR("Unable to clean %s", rundir
);
408 DBG("Cleaning up all sessions");
410 /* Destroy session list mutex */
411 if (session_list_ptr
!= NULL
) {
412 pthread_mutex_destroy(&session_list_ptr
->lock
);
414 /* Cleanup ALL session */
415 cds_list_for_each_entry_safe(sess
, stmp
,
416 &session_list_ptr
->head
, list
) {
417 teardown_kernel_session(sess
);
418 teardown_ust_session(sess
);
423 DBG("Closing all UST sockets");
424 ust_app_clean_list();
426 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
428 if (is_root
&& !opt_no_kernel
) {
429 DBG2("Closing kernel fd");
430 close(kernel_tracer_fd
);
431 DBG("Unloading kernel modules");
432 modprobe_remove_lttng_all();
435 close(thread_quit_pipe
[0]);
436 close(thread_quit_pipe
[1]);
439 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
440 "Matthew, BEET driven development works!%c[%dm",
441 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
446 * Send data on a unix socket using the liblttsessiondcomm API.
448 * Return lttcomm error code.
450 static int send_unix_sock(int sock
, void *buf
, size_t len
)
452 /* Check valid length */
457 return lttcomm_send_unix_sock(sock
, buf
, len
);
461 * Free memory of a command context structure.
463 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
465 DBG("Clean command context structure");
467 if ((*cmd_ctx
)->llm
) {
468 free((*cmd_ctx
)->llm
);
470 if ((*cmd_ctx
)->lsm
) {
471 free((*cmd_ctx
)->lsm
);
479 * Send all stream fds of kernel channel to the consumer.
481 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
482 int sock
, struct ltt_kernel_channel
*channel
,
483 uid_t uid
, gid_t gid
)
486 struct ltt_kernel_stream
*stream
;
487 struct lttcomm_consumer_msg lkm
;
489 DBG("Sending streams of channel %s to kernel consumer",
490 channel
->channel
->name
);
493 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
494 lkm
.u
.channel
.channel_key
= channel
->fd
;
495 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
496 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
497 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
498 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
500 perror("send consumer channel");
505 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
509 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
510 lkm
.u
.stream
.channel_key
= channel
->fd
;
511 lkm
.u
.stream
.stream_key
= stream
->fd
;
512 lkm
.u
.stream
.state
= stream
->state
;
513 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
514 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
515 lkm
.u
.stream
.uid
= uid
;
516 lkm
.u
.stream
.gid
= gid
;
517 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
518 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
519 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
520 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
522 perror("send consumer stream");
525 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
527 perror("send consumer stream ancillary data");
532 DBG("consumer channel streams sent");
541 * Send all stream fds of the kernel session to the consumer.
543 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
544 struct ltt_kernel_session
*session
)
547 struct ltt_kernel_channel
*chan
;
548 struct lttcomm_consumer_msg lkm
;
549 int sock
= session
->consumer_fd
;
551 DBG("Sending metadata stream fd");
553 /* Extra protection. It's NOT supposed to be set to 0 at this point */
554 if (session
->consumer_fd
== 0) {
555 session
->consumer_fd
= consumer_data
->cmd_sock
;
558 if (session
->metadata_stream_fd
!= 0) {
559 /* Send metadata channel fd */
560 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
561 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
562 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
563 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
564 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
565 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
567 perror("send consumer channel");
571 /* Send metadata stream fd */
572 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
573 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
574 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
575 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
576 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
577 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
578 lkm
.u
.stream
.uid
= session
->uid
;
579 lkm
.u
.stream
.gid
= session
->gid
;
580 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
581 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
582 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
583 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
585 perror("send consumer stream");
588 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
590 perror("send consumer stream");
595 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
596 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
597 session
->uid
, session
->gid
);
603 DBG("consumer fds (metadata and channel streams) sent");
612 * Notify UST applications using the shm mmap futex.
614 static int notify_ust_apps(int active
)
618 DBG("Notifying applications of session daemon state: %d", active
);
620 /* See shm.c for this call implying mmap, shm and futex calls */
621 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
622 if (wait_shm_mmap
== NULL
) {
626 /* Wake waiting process */
627 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
629 /* Apps notified successfully */
637 * Setup the outgoing data buffer for the response (llm) by allocating the
638 * right amount of memory and copying the original information from the lsm
641 * Return total size of the buffer pointed by buf.
643 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
649 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
650 if (cmd_ctx
->llm
== NULL
) {
656 /* Copy common data */
657 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
658 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
660 cmd_ctx
->llm
->data_size
= size
;
661 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
670 * Update the kernel poll set of all channel fd available over all tracing
671 * session. Add the wakeup pipe at the end of the set.
673 static int update_kernel_poll(struct lttng_poll_event
*events
)
676 struct ltt_session
*session
;
677 struct ltt_kernel_channel
*channel
;
679 DBG("Updating kernel poll set");
682 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
683 session_lock(session
);
684 if (session
->kernel_session
== NULL
) {
685 session_unlock(session
);
689 cds_list_for_each_entry(channel
,
690 &session
->kernel_session
->channel_list
.head
, list
) {
691 /* Add channel fd to the kernel poll set */
692 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
694 session_unlock(session
);
697 DBG("Channel fd %d added to kernel set", channel
->fd
);
699 session_unlock(session
);
701 session_unlock_list();
706 session_unlock_list();
711 * Find the channel fd from 'fd' over all tracing session. When found, check
712 * for new channel stream and send those stream fds to the kernel consumer.
714 * Useful for CPU hotplug feature.
716 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
719 struct ltt_session
*session
;
720 struct ltt_kernel_channel
*channel
;
722 DBG("Updating kernel streams for channel fd %d", fd
);
725 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
726 session_lock(session
);
727 if (session
->kernel_session
== NULL
) {
728 session_unlock(session
);
732 /* This is not suppose to be 0 but this is an extra security check */
733 if (session
->kernel_session
->consumer_fd
== 0) {
734 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
737 cds_list_for_each_entry(channel
,
738 &session
->kernel_session
->channel_list
.head
, list
) {
739 if (channel
->fd
== fd
) {
740 DBG("Channel found, updating kernel streams");
741 ret
= kernel_open_channel_stream(channel
);
747 * Have we already sent fds to the consumer? If yes, it means
748 * that tracing is started so it is safe to send our updated
751 if (session
->kernel_session
->consumer_fds_sent
== 1) {
752 ret
= send_kconsumer_channel_streams(consumer_data
,
753 session
->kernel_session
->consumer_fd
, channel
,
754 session
->uid
, session
->gid
);
762 session_unlock(session
);
764 session_unlock_list();
768 session_unlock(session
);
769 session_unlock_list();
774 * For each tracing session, update newly registered apps.
776 static void update_ust_app(int app_sock
)
778 struct ltt_session
*sess
, *stmp
;
782 /* For all tracing session(s) */
783 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
785 if (sess
->ust_session
) {
786 ust_app_global_update(sess
->ust_session
, app_sock
);
788 session_unlock(sess
);
791 session_unlock_list();
795 * This thread manage event coming from the kernel.
797 * Features supported in this thread:
800 static void *thread_manage_kernel(void *data
)
802 int ret
, i
, pollfd
, update_poll_flag
= 1;
803 uint32_t revents
, nb_fd
;
805 struct lttng_poll_event events
;
807 DBG("Thread manage kernel started");
809 ret
= create_thread_poll_set(&events
, 2);
814 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
820 if (update_poll_flag
== 1) {
822 * Reset number of fd in the poll set. Always 2 since there is the thread
823 * quit pipe and the kernel pipe.
827 ret
= update_kernel_poll(&events
);
831 update_poll_flag
= 0;
834 nb_fd
= LTTNG_POLL_GETNB(&events
);
836 DBG("Thread kernel polling on %d fds", nb_fd
);
838 /* Zeroed the poll events */
839 lttng_poll_reset(&events
);
841 /* Poll infinite value of time */
843 ret
= lttng_poll_wait(&events
, -1);
846 * Restart interrupted system call.
848 if (errno
== EINTR
) {
852 } else if (ret
== 0) {
853 /* Should not happen since timeout is infinite */
854 ERR("Return value of poll is 0 with an infinite timeout.\n"
855 "This should not have happened! Continuing...");
859 for (i
= 0; i
< nb_fd
; i
++) {
860 /* Fetch once the poll data */
861 revents
= LTTNG_POLL_GETEV(&events
, i
);
862 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
864 /* Thread quit pipe has been closed. Killing thread. */
865 ret
= check_thread_quit_pipe(pollfd
, revents
);
870 /* Check for data on kernel pipe */
871 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
872 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
873 update_poll_flag
= 1;
877 * New CPU detected by the kernel. Adding kernel stream to
878 * kernel session and updating the kernel consumer
880 if (revents
& LPOLLIN
) {
881 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
887 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
888 * and unregister kernel stream at this point.
896 DBG("Kernel thread dying");
897 close(kernel_poll_pipe
[0]);
898 close(kernel_poll_pipe
[1]);
900 lttng_poll_clean(&events
);
906 * This thread manage the consumer error sent back to the session daemon.
908 static void *thread_manage_consumer(void *data
)
910 int sock
= 0, i
, ret
, pollfd
;
911 uint32_t revents
, nb_fd
;
912 enum lttcomm_return_code code
;
913 struct lttng_poll_event events
;
914 struct consumer_data
*consumer_data
= data
;
916 DBG("[thread] Manage consumer started");
918 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
924 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
925 * Nothing more will be added to this poll set.
927 ret
= create_thread_poll_set(&events
, 2);
932 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
937 nb_fd
= LTTNG_POLL_GETNB(&events
);
939 /* Inifinite blocking call, waiting for transmission */
941 ret
= lttng_poll_wait(&events
, -1);
944 * Restart interrupted system call.
946 if (errno
== EINTR
) {
952 for (i
= 0; i
< nb_fd
; i
++) {
953 /* Fetch once the poll data */
954 revents
= LTTNG_POLL_GETEV(&events
, i
);
955 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
957 /* Thread quit pipe has been closed. Killing thread. */
958 ret
= check_thread_quit_pipe(pollfd
, revents
);
963 /* Event on the registration socket */
964 if (pollfd
== consumer_data
->err_sock
) {
965 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
966 ERR("consumer err socket poll error");
972 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
977 DBG2("Receiving code from consumer err_sock");
979 /* Getting status code from kconsumerd */
980 ret
= lttcomm_recv_unix_sock(sock
, &code
,
981 sizeof(enum lttcomm_return_code
));
986 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
987 consumer_data
->cmd_sock
=
988 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
989 if (consumer_data
->cmd_sock
< 0) {
990 sem_post(&consumer_data
->sem
);
991 PERROR("consumer connect");
994 /* Signal condition to tell that the kconsumerd is ready */
995 sem_post(&consumer_data
->sem
);
996 DBG("consumer command socket ready");
998 ERR("consumer error when waiting for SOCK_READY : %s",
999 lttcomm_get_readable_code(-code
));
1003 /* Remove the kconsumerd error sock since we've established a connexion */
1004 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1009 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1014 /* Update number of fd */
1015 nb_fd
= LTTNG_POLL_GETNB(&events
);
1017 /* Inifinite blocking call, waiting for transmission */
1019 ret
= lttng_poll_wait(&events
, -1);
1022 * Restart interrupted system call.
1024 if (errno
== EINTR
) {
1030 for (i
= 0; i
< nb_fd
; i
++) {
1031 /* Fetch once the poll data */
1032 revents
= LTTNG_POLL_GETEV(&events
, i
);
1033 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1035 /* Thread quit pipe has been closed. Killing thread. */
1036 ret
= check_thread_quit_pipe(pollfd
, revents
);
1041 /* Event on the kconsumerd socket */
1042 if (pollfd
== sock
) {
1043 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1044 ERR("consumer err socket second poll error");
1050 /* Wait for any kconsumerd error */
1051 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1052 sizeof(enum lttcomm_return_code
));
1054 ERR("consumer closed the command socket");
1058 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1061 DBG("consumer thread dying");
1062 close(consumer_data
->err_sock
);
1063 close(consumer_data
->cmd_sock
);
1066 unlink(consumer_data
->err_unix_sock_path
);
1067 unlink(consumer_data
->cmd_unix_sock_path
);
1068 consumer_data
->pid
= 0;
1070 lttng_poll_clean(&events
);
1076 * This thread manage application communication.
1078 static void *thread_manage_apps(void *data
)
1081 uint32_t revents
, nb_fd
;
1082 struct ust_command ust_cmd
;
1083 struct lttng_poll_event events
;
1085 DBG("[thread] Manage application started");
1087 rcu_register_thread();
1088 rcu_thread_online();
1090 ret
= create_thread_poll_set(&events
, 2);
1095 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1101 /* Zeroed the events structure */
1102 lttng_poll_reset(&events
);
1104 nb_fd
= LTTNG_POLL_GETNB(&events
);
1106 DBG("Apps thread polling on %d fds", nb_fd
);
1108 /* Inifinite blocking call, waiting for transmission */
1110 ret
= lttng_poll_wait(&events
, -1);
1113 * Restart interrupted system call.
1115 if (errno
== EINTR
) {
1121 for (i
= 0; i
< nb_fd
; i
++) {
1122 /* Fetch once the poll data */
1123 revents
= LTTNG_POLL_GETEV(&events
, i
);
1124 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1126 /* Thread quit pipe has been closed. Killing thread. */
1127 ret
= check_thread_quit_pipe(pollfd
, revents
);
1132 /* Inspect the apps cmd pipe */
1133 if (pollfd
== apps_cmd_pipe
[0]) {
1134 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1135 ERR("Apps command pipe error");
1137 } else if (revents
& LPOLLIN
) {
1139 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1140 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1141 perror("read apps cmd pipe");
1145 /* Register applicaton to the session daemon */
1146 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1148 if (ret
== -ENOMEM
) {
1150 } else if (ret
< 0) {
1155 * Validate UST version compatibility.
1157 ret
= ust_app_validate_version(ust_cmd
.sock
);
1160 * Add channel(s) and event(s) to newly registered apps
1161 * from lttng global UST domain.
1163 update_ust_app(ust_cmd
.sock
);
1166 ret
= ust_app_register_done(ust_cmd
.sock
);
1169 * If the registration is not possible, we simply
1170 * unregister the apps and continue
1172 ust_app_unregister(ust_cmd
.sock
);
1175 * We just need here to monitor the close of the UST
1176 * socket and poll set monitor those by default.
1177 * Listen on POLLIN (even if we never expect any
1178 * data) to ensure that hangup wakes us.
1180 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1185 DBG("Apps with sock %d added to poll set",
1193 * At this point, we know that a registered application made
1194 * the event at poll_wait.
1196 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1197 /* Removing from the poll set */
1198 ret
= lttng_poll_del(&events
, pollfd
);
1203 /* Socket closed on remote end. */
1204 ust_app_unregister(pollfd
);
1212 DBG("Application communication apps dying");
1213 close(apps_cmd_pipe
[0]);
1214 close(apps_cmd_pipe
[1]);
1216 lttng_poll_clean(&events
);
1218 rcu_thread_offline();
1219 rcu_unregister_thread();
1224 * Dispatch request from the registration threads to the application
1225 * communication thread.
1227 static void *thread_dispatch_ust_registration(void *data
)
1230 struct cds_wfq_node
*node
;
1231 struct ust_command
*ust_cmd
= NULL
;
1233 DBG("[thread] Dispatch UST command started");
1235 while (!dispatch_thread_exit
) {
1236 /* Atomically prepare the queue futex */
1237 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1240 /* Dequeue command for registration */
1241 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1243 DBG("Woken up but nothing in the UST command queue");
1244 /* Continue thread execution */
1248 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1250 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1251 " gid:%d sock:%d name:%s (version %d.%d)",
1252 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1253 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1254 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1255 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1257 * Inform apps thread of the new application registration. This
1258 * call is blocking so we can be assured that the data will be read
1259 * at some point in time or wait to the end of the world :)
1261 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1262 sizeof(struct ust_command
));
1264 perror("write apps cmd pipe");
1265 if (errno
== EBADF
) {
1267 * We can't inform the application thread to process
1268 * registration. We will exit or else application
1269 * registration will not occur and tracing will never
1276 } while (node
!= NULL
);
1278 /* Futex wait on queue. Blocking call on futex() */
1279 futex_nto1_wait(&ust_cmd_queue
.futex
);
1283 DBG("Dispatch thread dying");
1288 * This thread manage application registration.
1290 static void *thread_registration_apps(void *data
)
1292 int sock
= 0, i
, ret
, pollfd
;
1293 uint32_t revents
, nb_fd
;
1294 struct lttng_poll_event events
;
1296 * Get allocated in this thread, enqueued to a global queue, dequeued and
1297 * freed in the manage apps thread.
1299 struct ust_command
*ust_cmd
= NULL
;
1301 DBG("[thread] Manage application registration started");
1303 ret
= lttcomm_listen_unix_sock(apps_sock
);
1309 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1310 * more will be added to this poll set.
1312 ret
= create_thread_poll_set(&events
, 2);
1317 /* Add the application registration socket */
1318 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1323 /* Notify all applications to register */
1324 ret
= notify_ust_apps(1);
1326 ERR("Failed to notify applications or create the wait shared memory.\n"
1327 "Execution continues but there might be problem for already\n"
1328 "running applications that wishes to register.");
1332 DBG("Accepting application registration");
1334 nb_fd
= LTTNG_POLL_GETNB(&events
);
1336 /* Inifinite blocking call, waiting for transmission */
1338 ret
= lttng_poll_wait(&events
, -1);
1341 * Restart interrupted system call.
1343 if (errno
== EINTR
) {
1349 for (i
= 0; i
< nb_fd
; i
++) {
1350 /* Fetch once the poll data */
1351 revents
= LTTNG_POLL_GETEV(&events
, i
);
1352 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1354 /* Thread quit pipe has been closed. Killing thread. */
1355 ret
= check_thread_quit_pipe(pollfd
, revents
);
1360 /* Event on the registration socket */
1361 if (pollfd
== apps_sock
) {
1362 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1363 ERR("Register apps socket poll error");
1365 } else if (revents
& LPOLLIN
) {
1366 sock
= lttcomm_accept_unix_sock(apps_sock
);
1371 /* Create UST registration command for enqueuing */
1372 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1373 if (ust_cmd
== NULL
) {
1374 perror("ust command zmalloc");
1379 * Using message-based transmissions to ensure we don't
1380 * have to deal with partially received messages.
1382 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1383 sizeof(struct ust_register_msg
));
1384 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1386 perror("lttcomm_recv_unix_sock register apps");
1388 ERR("Wrong size received on apps register");
1395 ust_cmd
->sock
= sock
;
1397 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1398 " gid:%d sock:%d name:%s (version %d.%d)",
1399 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1400 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1401 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1402 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1405 * Lock free enqueue the registration request. The red pill
1406 * has been taken! This apps will be part of the *system*.
1408 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1411 * Wake the registration queue futex. Implicit memory
1412 * barrier with the exchange in cds_wfq_enqueue.
1414 futex_nto1_wake(&ust_cmd_queue
.futex
);
1421 DBG("UST Registration thread dying");
1423 /* Notify that the registration thread is gone */
1428 unlink(apps_unix_sock_path
);
1430 lttng_poll_clean(&events
);
1436 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1437 * exec or it will fails.
1439 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1442 struct timespec timeout
;
1444 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1445 timeout
.tv_nsec
= 0;
1447 /* Setup semaphore */
1448 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1450 PERROR("sem_init consumer semaphore");
1454 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1455 thread_manage_consumer
, consumer_data
);
1457 PERROR("pthread_create consumer");
1462 /* Get time for sem_timedwait absolute timeout */
1463 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1465 PERROR("clock_gettime spawn consumer");
1466 /* Infinite wait for the kconsumerd thread to be ready */
1467 ret
= sem_wait(&consumer_data
->sem
);
1469 /* Normal timeout if the gettime was successful */
1470 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1471 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1475 if (errno
== ETIMEDOUT
) {
1477 * Call has timed out so we kill the kconsumerd_thread and return
1480 ERR("The consumer thread was never ready. Killing it");
1481 ret
= pthread_cancel(consumer_data
->thread
);
1483 PERROR("pthread_cancel consumer thread");
1486 PERROR("semaphore wait failed consumer thread");
1491 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1492 if (consumer_data
->pid
== 0) {
1493 ERR("Kconsumerd did not start");
1494 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1497 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1506 * Join consumer thread
1508 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1513 if (consumer_data
->pid
!= 0) {
1514 ret
= kill(consumer_data
->pid
, SIGTERM
);
1516 ERR("Error killing consumer daemon");
1519 return pthread_join(consumer_data
->thread
, &status
);
1526 * Fork and exec a consumer daemon (consumerd).
1528 * Return pid if successful else -1.
1530 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1534 const char *consumer_to_use
;
1535 const char *verbosity
;
1538 DBG("Spawning consumerd");
1545 if (opt_verbose_consumer
) {
1546 verbosity
= "--verbose";
1548 verbosity
= "--quiet";
1550 switch (consumer_data
->type
) {
1551 case LTTNG_CONSUMER_KERNEL
:
1553 * Find out which consumerd to execute. We will first try the
1554 * 64-bit path, then the sessiond's installation directory, and
1555 * fallback on the 32-bit one,
1557 DBG3("Looking for a kernel consumer at these locations:");
1558 DBG3(" 1) %s", consumerd64_bin
);
1559 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1560 DBG3(" 3) %s", consumerd32_bin
);
1561 if (stat(consumerd64_bin
, &st
) == 0) {
1562 DBG3("Found location #1");
1563 consumer_to_use
= consumerd64_bin
;
1564 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1565 DBG3("Found location #2");
1566 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1567 } else if (stat(consumerd32_bin
, &st
) == 0) {
1568 DBG3("Found location #3");
1569 consumer_to_use
= consumerd32_bin
;
1571 DBG("Could not find any valid consumerd executable");
1574 DBG("Using kernel consumer at: %s", consumer_to_use
);
1575 execl(consumer_to_use
,
1576 "lttng-consumerd", verbosity
, "-k",
1577 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1578 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1581 case LTTNG_CONSUMER64_UST
:
1583 char *tmpnew
= NULL
;
1585 if (consumerd64_libdir
[0] != '\0') {
1589 tmp
= getenv("LD_LIBRARY_PATH");
1593 tmplen
= strlen("LD_LIBRARY_PATH=")
1594 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1595 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1600 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1601 strcat(tmpnew
, consumerd64_libdir
);
1602 if (tmp
[0] != '\0') {
1603 strcat(tmpnew
, ":");
1604 strcat(tmpnew
, tmp
);
1606 ret
= putenv(tmpnew
);
1612 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1613 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1614 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1615 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1617 if (consumerd64_libdir
[0] != '\0') {
1625 case LTTNG_CONSUMER32_UST
:
1627 char *tmpnew
= NULL
;
1629 if (consumerd32_libdir
[0] != '\0') {
1633 tmp
= getenv("LD_LIBRARY_PATH");
1637 tmplen
= strlen("LD_LIBRARY_PATH=")
1638 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1639 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1644 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1645 strcat(tmpnew
, consumerd32_libdir
);
1646 if (tmp
[0] != '\0') {
1647 strcat(tmpnew
, ":");
1648 strcat(tmpnew
, tmp
);
1650 ret
= putenv(tmpnew
);
1656 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1657 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1658 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1659 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1661 if (consumerd32_libdir
[0] != '\0') {
1670 perror("unknown consumer type");
1674 perror("kernel start consumer exec");
1677 } else if (pid
> 0) {
1680 perror("start consumer fork");
1688 * Spawn the consumerd daemon and session daemon thread.
1690 static int start_consumerd(struct consumer_data
*consumer_data
)
1694 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1695 if (consumer_data
->pid
!= 0) {
1696 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1700 ret
= spawn_consumerd(consumer_data
);
1702 ERR("Spawning consumerd failed");
1703 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1707 /* Setting up the consumer_data pid */
1708 consumer_data
->pid
= ret
;
1709 DBG2("Consumer pid %d", consumer_data
->pid
);
1710 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1712 DBG2("Spawning consumer control thread");
1713 ret
= spawn_consumer_thread(consumer_data
);
1715 ERR("Fatal error spawning consumer control thread");
1727 * Check version of the lttng-modules.
1729 static int validate_lttng_modules_version(void)
1731 return kernel_validate_version(kernel_tracer_fd
);
1735 * Setup necessary data for kernel tracer action.
1737 static int init_kernel_tracer(void)
1741 /* Modprobe lttng kernel modules */
1742 ret
= modprobe_lttng_control();
1747 /* Open debugfs lttng */
1748 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1749 if (kernel_tracer_fd
< 0) {
1750 DBG("Failed to open %s", module_proc_lttng
);
1755 /* Validate kernel version */
1756 ret
= validate_lttng_modules_version();
1761 ret
= modprobe_lttng_data();
1766 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1770 modprobe_remove_lttng_control();
1771 close(kernel_tracer_fd
);
1772 kernel_tracer_fd
= 0;
1773 return LTTCOMM_KERN_VERSION
;
1776 close(kernel_tracer_fd
);
1779 modprobe_remove_lttng_control();
1782 WARN("No kernel tracer available");
1783 kernel_tracer_fd
= 0;
1784 return LTTCOMM_KERN_NA
;
1788 * Init tracing by creating trace directory and sending fds kernel consumer.
1790 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1794 if (session
->consumer_fds_sent
== 0) {
1796 * Assign default kernel consumer socket if no consumer assigned to the
1797 * kernel session. At this point, it's NOT suppose to be 0 but this is
1798 * an extra security check.
1800 if (session
->consumer_fd
== 0) {
1801 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1804 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1806 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1810 session
->consumer_fds_sent
= 1;
1818 * Create an UST session and add it to the session ust list.
1820 static int create_ust_session(struct ltt_session
*session
,
1821 struct lttng_domain
*domain
)
1823 struct ltt_ust_session
*lus
= NULL
;
1826 switch (domain
->type
) {
1827 case LTTNG_DOMAIN_UST
:
1830 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1834 DBG("Creating UST session");
1836 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1838 ret
= LTTCOMM_UST_SESS_FAIL
;
1842 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1843 session
->uid
, session
->gid
);
1845 if (ret
!= -EEXIST
) {
1846 ERR("Trace directory creation error");
1847 ret
= LTTCOMM_UST_SESS_FAIL
;
1852 /* The domain type dictate different actions on session creation */
1853 switch (domain
->type
) {
1854 case LTTNG_DOMAIN_UST
:
1855 /* No ustctl for the global UST domain */
1858 ERR("Unknown UST domain on create session %d", domain
->type
);
1861 lus
->uid
= session
->uid
;
1862 lus
->gid
= session
->gid
;
1863 session
->ust_session
= lus
;
1873 * Create a kernel tracer session then create the default channel.
1875 static int create_kernel_session(struct ltt_session
*session
)
1879 DBG("Creating kernel session");
1881 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1883 ret
= LTTCOMM_KERN_SESS_FAIL
;
1887 /* Set kernel consumer socket fd */
1888 if (kconsumer_data
.cmd_sock
) {
1889 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1892 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1893 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1895 if (ret
!= -EEXIST
) {
1896 ERR("Trace directory creation error");
1900 session
->kernel_session
->uid
= session
->uid
;
1901 session
->kernel_session
->gid
= session
->gid
;
1908 * Check if the UID or GID match the session. Root user has access to all
1911 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1913 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1920 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1923 struct ltt_session
*session
;
1925 DBG("Counting number of available session for UID %d GID %d",
1927 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1929 * Only list the sessions the user can control.
1931 if (!session_access_ok(session
, uid
, gid
)) {
1940 * Using the session list, filled a lttng_session array to send back to the
1941 * client for session listing.
1943 * The session list lock MUST be acquired before calling this function. Use
1944 * session_lock_list() and session_unlock_list().
1946 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1950 struct ltt_session
*session
;
1952 DBG("Getting all available session for UID %d GID %d",
1955 * Iterate over session list and append data after the control struct in
1958 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1960 * Only list the sessions the user can control.
1962 if (!session_access_ok(session
, uid
, gid
)) {
1965 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1966 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1967 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1968 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1969 sessions
[i
].enabled
= session
->enabled
;
1975 * Fill lttng_channel array of all channels.
1977 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1978 struct lttng_channel
*channels
)
1981 struct ltt_kernel_channel
*kchan
;
1983 DBG("Listing channels for session %s", session
->name
);
1986 case LTTNG_DOMAIN_KERNEL
:
1987 /* Kernel channels */
1988 if (session
->kernel_session
!= NULL
) {
1989 cds_list_for_each_entry(kchan
,
1990 &session
->kernel_session
->channel_list
.head
, list
) {
1991 /* Copy lttng_channel struct to array */
1992 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1993 channels
[i
].enabled
= kchan
->enabled
;
1998 case LTTNG_DOMAIN_UST
:
2000 struct lttng_ht_iter iter
;
2001 struct ltt_ust_channel
*uchan
;
2003 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2004 &iter
.iter
, uchan
, node
.node
) {
2005 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2006 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2007 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2008 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2009 channels
[i
].attr
.switch_timer_interval
=
2010 uchan
->attr
.switch_timer_interval
;
2011 channels
[i
].attr
.read_timer_interval
=
2012 uchan
->attr
.read_timer_interval
;
2013 channels
[i
].enabled
= uchan
->enabled
;
2014 switch (uchan
->attr
.output
) {
2015 case LTTNG_UST_MMAP
:
2017 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2030 * Create a list of ust global domain events.
2032 static int list_lttng_ust_global_events(char *channel_name
,
2033 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2036 unsigned int nb_event
= 0;
2037 struct lttng_ht_iter iter
;
2038 struct lttng_ht_node_str
*node
;
2039 struct ltt_ust_channel
*uchan
;
2040 struct ltt_ust_event
*uevent
;
2041 struct lttng_event
*tmp
;
2043 DBG("Listing UST global events for channel %s", channel_name
);
2047 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2048 node
= lttng_ht_iter_get_node_str(&iter
);
2050 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2054 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2056 nb_event
+= lttng_ht_get_count(uchan
->events
);
2058 if (nb_event
== 0) {
2063 DBG3("Listing UST global %d events", nb_event
);
2065 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2067 ret
= -LTTCOMM_FATAL
;
2071 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2072 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2073 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2074 tmp
[i
].enabled
= uevent
->enabled
;
2075 switch (uevent
->attr
.instrumentation
) {
2076 case LTTNG_UST_TRACEPOINT
:
2077 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2079 case LTTNG_UST_PROBE
:
2080 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2082 case LTTNG_UST_FUNCTION
:
2083 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2086 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2087 switch (uevent
->attr
.loglevel_type
) {
2088 case LTTNG_UST_LOGLEVEL_ALL
:
2089 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2091 case LTTNG_UST_LOGLEVEL_RANGE
:
2092 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2094 case LTTNG_UST_LOGLEVEL_SINGLE
:
2095 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2110 * Fill lttng_event array of all kernel events in the channel.
2112 static int list_lttng_kernel_events(char *channel_name
,
2113 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2116 unsigned int nb_event
;
2117 struct ltt_kernel_event
*event
;
2118 struct ltt_kernel_channel
*kchan
;
2120 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2121 if (kchan
== NULL
) {
2122 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2126 nb_event
= kchan
->event_count
;
2128 DBG("Listing events for channel %s", kchan
->channel
->name
);
2130 if (nb_event
== 0) {
2135 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2136 if (*events
== NULL
) {
2137 ret
= LTTCOMM_FATAL
;
2141 /* Kernel channels */
2142 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2143 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2144 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2145 (*events
)[i
].enabled
= event
->enabled
;
2146 switch (event
->event
->instrumentation
) {
2147 case LTTNG_KERNEL_TRACEPOINT
:
2148 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2150 case LTTNG_KERNEL_KPROBE
:
2151 case LTTNG_KERNEL_KRETPROBE
:
2152 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2153 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2154 sizeof(struct lttng_kernel_kprobe
));
2156 case LTTNG_KERNEL_FUNCTION
:
2157 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2158 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2159 sizeof(struct lttng_kernel_function
));
2161 case LTTNG_KERNEL_NOOP
:
2162 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2164 case LTTNG_KERNEL_SYSCALL
:
2165 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2167 case LTTNG_KERNEL_ALL
:
2181 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2183 static int cmd_disable_channel(struct ltt_session
*session
,
2184 int domain
, char *channel_name
)
2187 struct ltt_ust_session
*usess
;
2189 usess
= session
->ust_session
;
2192 case LTTNG_DOMAIN_KERNEL
:
2194 ret
= channel_kernel_disable(session
->kernel_session
,
2196 if (ret
!= LTTCOMM_OK
) {
2200 kernel_wait_quiescent(kernel_tracer_fd
);
2203 case LTTNG_DOMAIN_UST
:
2205 struct ltt_ust_channel
*uchan
;
2206 struct lttng_ht
*chan_ht
;
2208 chan_ht
= usess
->domain_global
.channels
;
2210 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2211 if (uchan
== NULL
) {
2212 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2216 ret
= channel_ust_disable(usess
, domain
, uchan
);
2217 if (ret
!= LTTCOMM_OK
) {
2223 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2224 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2225 case LTTNG_DOMAIN_UST_PID
:
2228 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2239 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2241 static int cmd_enable_channel(struct ltt_session
*session
,
2242 int domain
, struct lttng_channel
*attr
)
2245 struct ltt_ust_session
*usess
= session
->ust_session
;
2246 struct lttng_ht
*chan_ht
;
2248 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2251 case LTTNG_DOMAIN_KERNEL
:
2253 struct ltt_kernel_channel
*kchan
;
2255 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2256 session
->kernel_session
);
2257 if (kchan
== NULL
) {
2258 ret
= channel_kernel_create(session
->kernel_session
,
2259 attr
, kernel_poll_pipe
[1]);
2261 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2264 if (ret
!= LTTCOMM_OK
) {
2268 kernel_wait_quiescent(kernel_tracer_fd
);
2271 case LTTNG_DOMAIN_UST
:
2273 struct ltt_ust_channel
*uchan
;
2275 chan_ht
= usess
->domain_global
.channels
;
2277 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2278 if (uchan
== NULL
) {
2279 ret
= channel_ust_create(usess
, domain
, attr
);
2281 ret
= channel_ust_enable(usess
, domain
, uchan
);
2286 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2287 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2288 case LTTNG_DOMAIN_UST_PID
:
2291 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2300 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2302 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2303 char *channel_name
, char *event_name
)
2308 case LTTNG_DOMAIN_KERNEL
:
2310 struct ltt_kernel_channel
*kchan
;
2311 struct ltt_kernel_session
*ksess
;
2313 ksess
= session
->kernel_session
;
2315 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2316 if (kchan
== NULL
) {
2317 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2321 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2322 if (ret
!= LTTCOMM_OK
) {
2326 kernel_wait_quiescent(kernel_tracer_fd
);
2329 case LTTNG_DOMAIN_UST
:
2331 struct ltt_ust_channel
*uchan
;
2332 struct ltt_ust_session
*usess
;
2334 usess
= session
->ust_session
;
2336 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2338 if (uchan
== NULL
) {
2339 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2343 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2344 if (ret
!= LTTCOMM_OK
) {
2348 DBG3("Disable UST event %s in channel %s completed", event_name
,
2353 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2354 case LTTNG_DOMAIN_UST_PID
:
2355 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2369 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2371 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2377 case LTTNG_DOMAIN_KERNEL
:
2379 struct ltt_kernel_session
*ksess
;
2380 struct ltt_kernel_channel
*kchan
;
2382 ksess
= session
->kernel_session
;
2384 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2385 if (kchan
== NULL
) {
2386 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2390 ret
= event_kernel_disable_all(ksess
, kchan
);
2391 if (ret
!= LTTCOMM_OK
) {
2395 kernel_wait_quiescent(kernel_tracer_fd
);
2398 case LTTNG_DOMAIN_UST
:
2400 struct ltt_ust_session
*usess
;
2401 struct ltt_ust_channel
*uchan
;
2403 usess
= session
->ust_session
;
2405 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2407 if (uchan
== NULL
) {
2408 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2412 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2417 DBG3("Disable all UST events in channel %s completed", channel_name
);
2422 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2423 case LTTNG_DOMAIN_UST_PID
:
2424 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2438 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2440 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2441 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2446 case LTTNG_DOMAIN_KERNEL
:
2447 /* Add kernel context to kernel tracer */
2448 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2449 event_name
, channel_name
);
2450 if (ret
!= LTTCOMM_OK
) {
2454 case LTTNG_DOMAIN_UST
:
2456 struct ltt_ust_session
*usess
= session
->ust_session
;
2458 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2459 if (ret
!= LTTCOMM_OK
) {
2465 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2466 case LTTNG_DOMAIN_UST_PID
:
2467 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2481 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2483 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2484 char *channel_name
, struct lttng_event
*event
)
2487 struct lttng_channel
*attr
;
2488 struct ltt_ust_session
*usess
= session
->ust_session
;
2491 case LTTNG_DOMAIN_KERNEL
:
2493 struct ltt_kernel_channel
*kchan
;
2495 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2496 session
->kernel_session
);
2497 if (kchan
== NULL
) {
2498 attr
= channel_new_default_attr(domain
);
2500 ret
= LTTCOMM_FATAL
;
2503 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2505 /* This call will notify the kernel thread */
2506 ret
= channel_kernel_create(session
->kernel_session
,
2507 attr
, kernel_poll_pipe
[1]);
2508 if (ret
!= LTTCOMM_OK
) {
2515 /* Get the newly created kernel channel pointer */
2516 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2517 session
->kernel_session
);
2518 if (kchan
== NULL
) {
2519 /* This sould not happen... */
2520 ret
= LTTCOMM_FATAL
;
2524 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2526 if (ret
!= LTTCOMM_OK
) {
2530 kernel_wait_quiescent(kernel_tracer_fd
);
2533 case LTTNG_DOMAIN_UST
:
2535 struct lttng_channel
*attr
;
2536 struct ltt_ust_channel
*uchan
;
2538 /* Get channel from global UST domain */
2539 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2541 if (uchan
== NULL
) {
2542 /* Create default channel */
2543 attr
= channel_new_default_attr(domain
);
2545 ret
= LTTCOMM_FATAL
;
2548 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2549 attr
->name
[NAME_MAX
- 1] = '\0';
2551 ret
= channel_ust_create(usess
, domain
, attr
);
2552 if (ret
!= LTTCOMM_OK
) {
2558 /* Get the newly created channel reference back */
2559 uchan
= trace_ust_find_channel_by_name(
2560 usess
->domain_global
.channels
, channel_name
);
2561 if (uchan
== NULL
) {
2562 /* Something is really wrong */
2563 ret
= LTTCOMM_FATAL
;
2568 /* At this point, the session and channel exist on the tracer */
2569 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2570 if (ret
!= LTTCOMM_OK
) {
2576 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2577 case LTTNG_DOMAIN_UST_PID
:
2578 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2592 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2594 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2595 char *channel_name
, int event_type
)
2598 struct ltt_kernel_channel
*kchan
;
2601 case LTTNG_DOMAIN_KERNEL
:
2602 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2603 session
->kernel_session
);
2604 if (kchan
== NULL
) {
2605 /* This call will notify the kernel thread */
2606 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2607 kernel_poll_pipe
[1]);
2608 if (ret
!= LTTCOMM_OK
) {
2612 /* Get the newly created kernel channel pointer */
2613 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2614 session
->kernel_session
);
2615 if (kchan
== NULL
) {
2616 /* This sould not happen... */
2617 ret
= LTTCOMM_FATAL
;
2623 switch (event_type
) {
2624 case LTTNG_EVENT_SYSCALL
:
2625 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2626 kchan
, kernel_tracer_fd
);
2628 case LTTNG_EVENT_TRACEPOINT
:
2630 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2631 * events already registered to the channel.
2633 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2634 kchan
, kernel_tracer_fd
);
2636 case LTTNG_EVENT_ALL
:
2637 /* Enable syscalls and tracepoints */
2638 ret
= event_kernel_enable_all(session
->kernel_session
,
2639 kchan
, kernel_tracer_fd
);
2642 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2646 /* Manage return value */
2647 if (ret
!= LTTCOMM_OK
) {
2651 kernel_wait_quiescent(kernel_tracer_fd
);
2653 case LTTNG_DOMAIN_UST
:
2655 struct lttng_channel
*attr
;
2656 struct ltt_ust_channel
*uchan
;
2657 struct ltt_ust_session
*usess
= session
->ust_session
;
2659 /* Get channel from global UST domain */
2660 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2662 if (uchan
== NULL
) {
2663 /* Create default channel */
2664 attr
= channel_new_default_attr(domain
);
2666 ret
= LTTCOMM_FATAL
;
2669 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2670 attr
->name
[NAME_MAX
- 1] = '\0';
2672 /* Use the internal command enable channel */
2673 ret
= channel_ust_create(usess
, domain
, attr
);
2674 if (ret
!= LTTCOMM_OK
) {
2680 /* Get the newly created channel reference back */
2681 uchan
= trace_ust_find_channel_by_name(
2682 usess
->domain_global
.channels
, channel_name
);
2683 if (uchan
== NULL
) {
2684 /* Something is really wrong */
2685 ret
= LTTCOMM_FATAL
;
2690 /* At this point, the session and channel exist on the tracer */
2692 switch (event_type
) {
2693 case LTTNG_EVENT_ALL
:
2694 case LTTNG_EVENT_TRACEPOINT
:
2695 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2696 if (ret
!= LTTCOMM_OK
) {
2701 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2705 /* Manage return value */
2706 if (ret
!= LTTCOMM_OK
) {
2713 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2714 case LTTNG_DOMAIN_UST_PID
:
2715 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2729 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2731 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2734 ssize_t nb_events
= 0;
2737 case LTTNG_DOMAIN_KERNEL
:
2738 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2739 if (nb_events
< 0) {
2740 ret
= LTTCOMM_KERN_LIST_FAIL
;
2744 case LTTNG_DOMAIN_UST
:
2745 nb_events
= ust_app_list_events(events
);
2746 if (nb_events
< 0) {
2747 ret
= LTTCOMM_UST_LIST_FAIL
;
2759 /* Return negative value to differentiate return code */
2764 * Command LTTNG_START_TRACE processed by the client thread.
2766 static int cmd_start_trace(struct ltt_session
*session
)
2769 struct ltt_kernel_session
*ksession
;
2770 struct ltt_ust_session
*usess
;
2773 ksession
= session
->kernel_session
;
2774 usess
= session
->ust_session
;
2776 if (session
->enabled
) {
2777 ret
= LTTCOMM_UST_START_FAIL
;
2781 session
->enabled
= 1;
2783 /* Kernel tracing */
2784 if (ksession
!= NULL
) {
2785 struct ltt_kernel_channel
*kchan
;
2787 /* Open kernel metadata */
2788 if (ksession
->metadata
== NULL
) {
2789 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2791 ret
= LTTCOMM_KERN_META_FAIL
;
2796 /* Open kernel metadata stream */
2797 if (ksession
->metadata_stream_fd
== 0) {
2798 ret
= kernel_open_metadata_stream(ksession
);
2800 ERR("Kernel create metadata stream failed");
2801 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2806 /* For each channel */
2807 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2808 if (kchan
->stream_count
== 0) {
2809 ret
= kernel_open_channel_stream(kchan
);
2811 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2814 /* Update the stream global counter */
2815 ksession
->stream_count_global
+= ret
;
2819 /* Setup kernel consumer socket and send fds to it */
2820 ret
= init_kernel_tracing(ksession
);
2822 ret
= LTTCOMM_KERN_START_FAIL
;
2826 /* This start the kernel tracing */
2827 ret
= kernel_start_session(ksession
);
2829 ret
= LTTCOMM_KERN_START_FAIL
;
2833 /* Quiescent wait after starting trace */
2834 kernel_wait_quiescent(kernel_tracer_fd
);
2837 /* Flag session that trace should start automatically */
2839 usess
->start_trace
= 1;
2841 ret
= ust_app_start_trace_all(usess
);
2843 ret
= LTTCOMM_UST_START_FAIL
;
2855 * Command LTTNG_STOP_TRACE processed by the client thread.
2857 static int cmd_stop_trace(struct ltt_session
*session
)
2860 struct ltt_kernel_channel
*kchan
;
2861 struct ltt_kernel_session
*ksession
;
2862 struct ltt_ust_session
*usess
;
2865 ksession
= session
->kernel_session
;
2866 usess
= session
->ust_session
;
2868 if (!session
->enabled
) {
2869 ret
= LTTCOMM_UST_STOP_FAIL
;
2873 session
->enabled
= 0;
2876 if (ksession
!= NULL
) {
2877 DBG("Stop kernel tracing");
2879 /* Flush all buffers before stopping */
2880 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2882 ERR("Kernel metadata flush failed");
2885 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2886 ret
= kernel_flush_buffer(kchan
);
2888 ERR("Kernel flush buffer error");
2892 ret
= kernel_stop_session(ksession
);
2894 ret
= LTTCOMM_KERN_STOP_FAIL
;
2898 kernel_wait_quiescent(kernel_tracer_fd
);
2902 usess
->start_trace
= 0;
2904 ret
= ust_app_stop_trace_all(usess
);
2906 ret
= LTTCOMM_UST_STOP_FAIL
;
2918 * Command LTTNG_CREATE_SESSION processed by the client thread.
2920 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2924 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2925 LTTNG_SOCK_GET_GID_CRED(creds
));
2926 if (ret
!= LTTCOMM_OK
) {
2937 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2939 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2943 /* Clean kernel session teardown */
2944 teardown_kernel_session(session
);
2945 /* UST session teardown */
2946 teardown_ust_session(session
);
2949 * Must notify the kernel thread here to update it's poll setin order
2950 * to remove the channel(s)' fd just destroyed.
2952 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2954 perror("write kernel poll pipe");
2957 ret
= session_destroy(session
);
2963 * Command LTTNG_CALIBRATE processed by the client thread.
2965 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2970 case LTTNG_DOMAIN_KERNEL
:
2972 struct lttng_kernel_calibrate kcalibrate
;
2974 kcalibrate
.type
= calibrate
->type
;
2975 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2977 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2982 case LTTNG_DOMAIN_UST
:
2984 struct lttng_ust_calibrate ucalibrate
;
2986 ucalibrate
.type
= calibrate
->type
;
2987 ret
= ust_app_calibrate_glb(&ucalibrate
);
2989 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3006 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3008 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3014 case LTTNG_DOMAIN_KERNEL
:
3015 /* Can't register a consumer if there is already one */
3016 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3017 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3021 sock
= lttcomm_connect_unix_sock(sock_path
);
3023 ret
= LTTCOMM_CONNECT_FAIL
;
3027 session
->kernel_session
->consumer_fd
= sock
;
3030 /* TODO: Userspace tracing */
3042 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3044 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3045 struct lttng_domain
**domains
)
3050 if (session
->kernel_session
!= NULL
) {
3051 DBG3("Listing domains found kernel domain");
3055 if (session
->ust_session
!= NULL
) {
3056 DBG3("Listing domains found UST global domain");
3060 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3061 if (*domains
== NULL
) {
3062 ret
= -LTTCOMM_FATAL
;
3066 if (session
->kernel_session
!= NULL
) {
3067 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3071 if (session
->ust_session
!= NULL
) {
3072 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3083 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3085 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3086 struct lttng_channel
**channels
)
3089 ssize_t nb_chan
= 0;
3092 case LTTNG_DOMAIN_KERNEL
:
3093 if (session
->kernel_session
!= NULL
) {
3094 nb_chan
= session
->kernel_session
->channel_count
;
3096 DBG3("Number of kernel channels %zd", nb_chan
);
3098 case LTTNG_DOMAIN_UST
:
3099 if (session
->ust_session
!= NULL
) {
3100 nb_chan
= lttng_ht_get_count(
3101 session
->ust_session
->domain_global
.channels
);
3103 DBG3("Number of UST global channels %zd", nb_chan
);
3112 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3113 if (*channels
== NULL
) {
3114 ret
= -LTTCOMM_FATAL
;
3118 list_lttng_channels(domain
, session
, *channels
);
3130 * Command LTTNG_LIST_EVENTS processed by the client thread.
3132 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3133 char *channel_name
, struct lttng_event
**events
)
3136 ssize_t nb_event
= 0;
3139 case LTTNG_DOMAIN_KERNEL
:
3140 if (session
->kernel_session
!= NULL
) {
3141 nb_event
= list_lttng_kernel_events(channel_name
,
3142 session
->kernel_session
, events
);
3145 case LTTNG_DOMAIN_UST
:
3147 if (session
->ust_session
!= NULL
) {
3148 nb_event
= list_lttng_ust_global_events(channel_name
,
3149 &session
->ust_session
->domain_global
, events
);
3165 * Process the command requested by the lttng client within the command
3166 * context structure. This function make sure that the return structure (llm)
3167 * is set and ready for transmission before returning.
3169 * Return any error encountered or 0 for success.
3171 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3173 int ret
= LTTCOMM_OK
;
3174 int need_tracing_session
= 1;
3177 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3179 switch (cmd_ctx
->lsm
->cmd_type
) {
3180 case LTTNG_CREATE_SESSION
:
3181 case LTTNG_DESTROY_SESSION
:
3182 case LTTNG_LIST_SESSIONS
:
3183 case LTTNG_LIST_DOMAINS
:
3184 case LTTNG_START_TRACE
:
3185 case LTTNG_STOP_TRACE
:
3192 if (opt_no_kernel
&& need_domain
3193 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3194 ret
= LTTCOMM_KERN_NA
;
3199 * Check for command that don't needs to allocate a returned payload. We do
3200 * this here so we don't have to make the call for no payload at each
3203 switch(cmd_ctx
->lsm
->cmd_type
) {
3204 case LTTNG_LIST_SESSIONS
:
3205 case LTTNG_LIST_TRACEPOINTS
:
3206 case LTTNG_LIST_DOMAINS
:
3207 case LTTNG_LIST_CHANNELS
:
3208 case LTTNG_LIST_EVENTS
:
3211 /* Setup lttng message with no payload */
3212 ret
= setup_lttng_msg(cmd_ctx
, 0);
3214 /* This label does not try to unlock the session */
3215 goto init_setup_error
;
3219 /* Commands that DO NOT need a session. */
3220 switch (cmd_ctx
->lsm
->cmd_type
) {
3221 case LTTNG_CREATE_SESSION
:
3222 case LTTNG_CALIBRATE
:
3223 case LTTNG_LIST_SESSIONS
:
3224 case LTTNG_LIST_TRACEPOINTS
:
3225 need_tracing_session
= 0;
3228 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3229 session_lock_list();
3230 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3231 session_unlock_list();
3232 if (cmd_ctx
->session
== NULL
) {
3233 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3234 ret
= LTTCOMM_SESS_NOT_FOUND
;
3236 /* If no session name specified */
3237 ret
= LTTCOMM_SELECT_SESS
;
3241 /* Acquire lock for the session */
3242 session_lock(cmd_ctx
->session
);
3251 * Check domain type for specific "pre-action".
3253 switch (cmd_ctx
->lsm
->domain
.type
) {
3254 case LTTNG_DOMAIN_KERNEL
:
3256 ret
= LTTCOMM_KERN_NA
;
3260 /* Kernel tracer check */
3261 if (kernel_tracer_fd
== 0) {
3262 /* Basically, load kernel tracer modules */
3263 ret
= init_kernel_tracer();
3269 /* Need a session for kernel command */
3270 if (need_tracing_session
) {
3271 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3272 ret
= create_kernel_session(cmd_ctx
->session
);
3274 ret
= LTTCOMM_KERN_SESS_FAIL
;
3279 /* Start the kernel consumer daemon */
3280 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3281 if (kconsumer_data
.pid
== 0 &&
3282 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3283 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3284 ret
= start_consumerd(&kconsumer_data
);
3286 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3290 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3294 case LTTNG_DOMAIN_UST
:
3296 if (need_tracing_session
) {
3297 if (cmd_ctx
->session
->ust_session
== NULL
) {
3298 ret
= create_ust_session(cmd_ctx
->session
,
3299 &cmd_ctx
->lsm
->domain
);
3300 if (ret
!= LTTCOMM_OK
) {
3304 /* Start the UST consumer daemons */
3306 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3307 if (consumerd64_bin
[0] != '\0' &&
3308 ustconsumer64_data
.pid
== 0 &&
3309 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3310 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3311 ret
= start_consumerd(&ustconsumer64_data
);
3313 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3314 ust_consumerd64_fd
= -EINVAL
;
3318 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3320 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3323 if (consumerd32_bin
[0] != '\0' &&
3324 ustconsumer32_data
.pid
== 0 &&
3325 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3326 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3327 ret
= start_consumerd(&ustconsumer32_data
);
3329 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3330 ust_consumerd32_fd
= -EINVAL
;
3333 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3335 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3346 * Check that the UID or GID match that of the tracing session.
3347 * The root user can interact with all sessions.
3349 if (need_tracing_session
) {
3350 if (!session_access_ok(cmd_ctx
->session
,
3351 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3352 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3353 ret
= LTTCOMM_EPERM
;
3358 /* Process by command type */
3359 switch (cmd_ctx
->lsm
->cmd_type
) {
3360 case LTTNG_ADD_CONTEXT
:
3362 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3363 cmd_ctx
->lsm
->u
.context
.channel_name
,
3364 cmd_ctx
->lsm
->u
.context
.event_name
,
3365 &cmd_ctx
->lsm
->u
.context
.ctx
);
3368 case LTTNG_DISABLE_CHANNEL
:
3370 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3371 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3374 case LTTNG_DISABLE_EVENT
:
3376 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3377 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3378 cmd_ctx
->lsm
->u
.disable
.name
);
3381 case LTTNG_DISABLE_ALL_EVENT
:
3383 DBG("Disabling all events");
3385 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3386 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3389 case LTTNG_ENABLE_CHANNEL
:
3391 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3392 &cmd_ctx
->lsm
->u
.channel
.chan
);
3395 case LTTNG_ENABLE_EVENT
:
3397 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3398 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3399 &cmd_ctx
->lsm
->u
.enable
.event
);
3402 case LTTNG_ENABLE_ALL_EVENT
:
3404 DBG("Enabling all events");
3406 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3407 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3408 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3411 case LTTNG_LIST_TRACEPOINTS
:
3413 struct lttng_event
*events
;
3416 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3417 if (nb_events
< 0) {
3423 * Setup lttng message with payload size set to the event list size in
3424 * bytes and then copy list into the llm payload.
3426 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3432 /* Copy event list into message payload */
3433 memcpy(cmd_ctx
->llm
->payload
, events
,
3434 sizeof(struct lttng_event
) * nb_events
);
3441 case LTTNG_START_TRACE
:
3443 ret
= cmd_start_trace(cmd_ctx
->session
);
3446 case LTTNG_STOP_TRACE
:
3448 ret
= cmd_stop_trace(cmd_ctx
->session
);
3451 case LTTNG_CREATE_SESSION
:
3453 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3454 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3457 case LTTNG_DESTROY_SESSION
:
3459 ret
= cmd_destroy_session(cmd_ctx
->session
,
3460 cmd_ctx
->lsm
->session
.name
);
3463 case LTTNG_LIST_DOMAINS
:
3466 struct lttng_domain
*domains
;
3468 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3474 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3479 /* Copy event list into message payload */
3480 memcpy(cmd_ctx
->llm
->payload
, domains
,
3481 nb_dom
* sizeof(struct lttng_domain
));
3488 case LTTNG_LIST_CHANNELS
:
3491 struct lttng_channel
*channels
;
3493 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3494 cmd_ctx
->session
, &channels
);
3500 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3505 /* Copy event list into message payload */
3506 memcpy(cmd_ctx
->llm
->payload
, channels
,
3507 nb_chan
* sizeof(struct lttng_channel
));
3514 case LTTNG_LIST_EVENTS
:
3517 struct lttng_event
*events
= NULL
;
3519 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3520 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3526 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3531 /* Copy event list into message payload */
3532 memcpy(cmd_ctx
->llm
->payload
, events
,
3533 nb_event
* sizeof(struct lttng_event
));
3540 case LTTNG_LIST_SESSIONS
:
3542 unsigned int nr_sessions
;
3544 session_lock_list();
3545 nr_sessions
= lttng_sessions_count(
3546 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3547 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3549 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3551 session_unlock_list();
3555 /* Filled the session array */
3556 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3557 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3558 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3560 session_unlock_list();
3565 case LTTNG_CALIBRATE
:
3567 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3568 &cmd_ctx
->lsm
->u
.calibrate
);
3571 case LTTNG_REGISTER_CONSUMER
:
3573 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3574 cmd_ctx
->lsm
->u
.reg
.path
);
3583 if (cmd_ctx
->llm
== NULL
) {
3584 DBG("Missing llm structure. Allocating one.");
3585 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3589 /* Set return code */
3590 cmd_ctx
->llm
->ret_code
= ret
;
3592 if (cmd_ctx
->session
) {
3593 session_unlock(cmd_ctx
->session
);
3600 * This thread manage all clients request using the unix client socket for
3603 static void *thread_manage_clients(void *data
)
3605 int sock
= 0, ret
, i
, pollfd
;
3606 uint32_t revents
, nb_fd
;
3607 struct command_ctx
*cmd_ctx
= NULL
;
3608 struct lttng_poll_event events
;
3610 DBG("[thread] Manage client started");
3612 rcu_register_thread();
3614 ret
= lttcomm_listen_unix_sock(client_sock
);
3620 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3621 * more will be added to this poll set.
3623 ret
= create_thread_poll_set(&events
, 2);
3628 /* Add the application registration socket */
3629 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3635 * Notify parent pid that we are ready to accept command for client side.
3637 if (opt_sig_parent
) {
3638 kill(ppid
, SIGUSR1
);
3642 DBG("Accepting client command ...");
3644 nb_fd
= LTTNG_POLL_GETNB(&events
);
3646 /* Inifinite blocking call, waiting for transmission */
3648 ret
= lttng_poll_wait(&events
, -1);
3651 * Restart interrupted system call.
3653 if (errno
== EINTR
) {
3659 for (i
= 0; i
< nb_fd
; i
++) {
3660 /* Fetch once the poll data */
3661 revents
= LTTNG_POLL_GETEV(&events
, i
);
3662 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3664 /* Thread quit pipe has been closed. Killing thread. */
3665 ret
= check_thread_quit_pipe(pollfd
, revents
);
3670 /* Event on the registration socket */
3671 if (pollfd
== client_sock
) {
3672 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3673 ERR("Client socket poll error");
3679 DBG("Wait for client response");
3681 sock
= lttcomm_accept_unix_sock(client_sock
);
3686 /* Set socket option for credentials retrieval */
3687 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3692 /* Allocate context command to process the client request */
3693 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3694 if (cmd_ctx
== NULL
) {
3695 perror("zmalloc cmd_ctx");
3699 /* Allocate data buffer for reception */
3700 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3701 if (cmd_ctx
->lsm
== NULL
) {
3702 perror("zmalloc cmd_ctx->lsm");
3706 cmd_ctx
->llm
= NULL
;
3707 cmd_ctx
->session
= NULL
;
3710 * Data is received from the lttng client. The struct
3711 * lttcomm_session_msg (lsm) contains the command and data request of
3714 DBG("Receiving data from client ...");
3715 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3716 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3718 DBG("Nothing recv() from client... continuing");
3724 // TODO: Validate cmd_ctx including sanity check for
3725 // security purpose.
3727 rcu_thread_online();
3729 * This function dispatch the work to the kernel or userspace tracer
3730 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3731 * informations for the client. The command context struct contains
3732 * everything this function may needs.
3734 ret
= process_client_msg(cmd_ctx
);
3735 rcu_thread_offline();
3738 * TODO: Inform client somehow of the fatal error. At
3739 * this point, ret < 0 means that a zmalloc failed
3740 * (ENOMEM). Error detected but still accept command.
3742 clean_command_ctx(&cmd_ctx
);
3746 DBG("Sending response (size: %d, retcode: %s)",
3747 cmd_ctx
->lttng_msg_size
,
3748 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3749 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3751 ERR("Failed to send data back to client");
3754 /* End of transmission */
3757 clean_command_ctx(&cmd_ctx
);
3761 DBG("Client thread dying");
3762 unlink(client_unix_sock_path
);
3766 lttng_poll_clean(&events
);
3767 clean_command_ctx(&cmd_ctx
);
3769 rcu_unregister_thread();
3775 * usage function on stderr
3777 static void usage(void)
3779 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3780 fprintf(stderr
, " -h, --help Display this usage.\n");
3781 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3782 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3783 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3784 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3785 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3786 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3787 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3788 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3789 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3790 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3791 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3792 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3793 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3794 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3795 fprintf(stderr
, " -V, --version Show version number.\n");
3796 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3797 fprintf(stderr
, " -q, --quiet No output at all.\n");
3798 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3799 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3800 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3804 * daemon argument parsing
3806 static int parse_args(int argc
, char **argv
)
3810 static struct option long_options
[] = {
3811 { "client-sock", 1, 0, 'c' },
3812 { "apps-sock", 1, 0, 'a' },
3813 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3814 { "kconsumerd-err-sock", 1, 0, 'E' },
3815 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3816 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3817 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3818 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3819 { "consumerd32-path", 1, 0, 'u' },
3820 { "consumerd32-libdir", 1, 0, 'U' },
3821 { "consumerd64-path", 1, 0, 't' },
3822 { "consumerd64-libdir", 1, 0, 'T' },
3823 { "daemonize", 0, 0, 'd' },
3824 { "sig-parent", 0, 0, 'S' },
3825 { "help", 0, 0, 'h' },
3826 { "group", 1, 0, 'g' },
3827 { "version", 0, 0, 'V' },
3828 { "quiet", 0, 0, 'q' },
3829 { "verbose", 0, 0, 'v' },
3830 { "verbose-consumer", 0, 0, 'Z' },
3831 { "no-kernel", 0, 0, 'N' },
3836 int option_index
= 0;
3837 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3838 long_options
, &option_index
);
3845 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3847 fprintf(stderr
, " with arg %s\n", optarg
);
3851 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3854 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3860 opt_tracing_group
= optarg
;
3866 fprintf(stdout
, "%s\n", VERSION
);
3872 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3875 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3878 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3881 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3884 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3887 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3896 /* Verbose level can increase using multiple -v */
3900 opt_verbose_consumer
+= 1;
3903 consumerd32_bin
= optarg
;
3906 consumerd32_libdir
= optarg
;
3909 consumerd64_bin
= optarg
;
3912 consumerd64_libdir
= optarg
;
3915 /* Unknown option or other error.
3916 * Error is printed by getopt, just return */
3925 * Creates the two needed socket by the daemon.
3926 * apps_sock - The communication socket for all UST apps.
3927 * client_sock - The communication of the cli tool (lttng).
3929 static int init_daemon_socket(void)
3934 old_umask
= umask(0);
3936 /* Create client tool unix socket */
3937 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3938 if (client_sock
< 0) {
3939 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3944 /* File permission MUST be 660 */
3945 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3947 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3952 /* Create the application unix socket */
3953 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3954 if (apps_sock
< 0) {
3955 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3960 /* File permission MUST be 666 */
3961 ret
= chmod(apps_unix_sock_path
,
3962 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3964 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3975 * Check if the global socket is available, and if a daemon is answering at the
3976 * other side. If yes, error is returned.
3978 static int check_existing_daemon(void)
3980 /* Is there anybody out there ? */
3981 if (lttng_session_daemon_alive()) {
3989 * Set the tracing group gid onto the client socket.
3991 * Race window between mkdir and chown is OK because we are going from more
3992 * permissive (root.root) to less permissive (root.tracing).
3994 static int set_permissions(char *rundir
)
3999 gid
= allowed_group();
4001 WARN("No tracing group detected");
4006 /* Set lttng run dir */
4007 ret
= chown(rundir
, 0, gid
);
4009 ERR("Unable to set group on %s", rundir
);
4013 /* Ensure tracing group can search the run dir */
4014 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4016 ERR("Unable to set permissions on %s", rundir
);
4020 /* lttng client socket path */
4021 ret
= chown(client_unix_sock_path
, 0, gid
);
4023 ERR("Unable to set group on %s", client_unix_sock_path
);
4027 /* kconsumer error socket path */
4028 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4030 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4034 /* 64-bit ustconsumer error socket path */
4035 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4037 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4041 /* 32-bit ustconsumer compat32 error socket path */
4042 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4044 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4048 DBG("All permissions are set");
4055 * Create the pipe used to wake up the kernel thread.
4057 static int create_kernel_poll_pipe(void)
4061 ret
= pipe(kernel_poll_pipe
);
4063 PERROR("kernel poll pipe");
4067 for (i
= 0; i
< 2; i
++) {
4068 ret
= fcntl(kernel_poll_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4070 PERROR("fcntl kernel_poll_pipe");
4080 * Create the application command pipe to wake thread_manage_apps.
4082 static int create_apps_cmd_pipe(void)
4086 ret
= pipe(apps_cmd_pipe
);
4088 PERROR("apps cmd pipe");
4092 for (i
= 0; i
< 2; i
++) {
4093 ret
= fcntl(apps_cmd_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4095 PERROR("fcntl apps_cmd_pipe");
4105 * Create the lttng run directory needed for all global sockets and pipe.
4107 static int create_lttng_rundir(const char *rundir
)
4111 DBG3("Creating LTTng run directory: %s", rundir
);
4113 ret
= mkdir(rundir
, S_IRWXU
);
4115 if (errno
!= EEXIST
) {
4116 ERR("Unable to create %s", rundir
);
4128 * Setup sockets and directory needed by the kconsumerd communication with the
4131 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4135 char path
[PATH_MAX
];
4137 switch (consumer_data
->type
) {
4138 case LTTNG_CONSUMER_KERNEL
:
4139 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4141 case LTTNG_CONSUMER64_UST
:
4142 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4144 case LTTNG_CONSUMER32_UST
:
4145 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4148 ERR("Consumer type unknown");
4153 DBG2("Creating consumer directory: %s", path
);
4155 ret
= mkdir(path
, S_IRWXU
);
4157 if (errno
!= EEXIST
) {
4158 ERR("Failed to create %s", path
);
4164 /* Create the kconsumerd error unix socket */
4165 consumer_data
->err_sock
=
4166 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4167 if (consumer_data
->err_sock
< 0) {
4168 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4173 /* File permission MUST be 660 */
4174 ret
= chmod(consumer_data
->err_unix_sock_path
,
4175 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4177 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4187 * Signal handler for the daemon
4189 * Simply stop all worker threads, leaving main() return gracefully after
4190 * joining all threads and calling cleanup().
4192 static void sighandler(int sig
)
4196 DBG("SIGPIPE caught");
4199 DBG("SIGINT caught");
4203 DBG("SIGTERM caught");
4212 * Setup signal handler for :
4213 * SIGINT, SIGTERM, SIGPIPE
4215 static int set_signal_handler(void)
4218 struct sigaction sa
;
4221 if ((ret
= sigemptyset(&sigset
)) < 0) {
4222 perror("sigemptyset");
4226 sa
.sa_handler
= sighandler
;
4227 sa
.sa_mask
= sigset
;
4229 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4230 perror("sigaction");
4234 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4235 perror("sigaction");
4239 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4240 perror("sigaction");
4244 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4250 * Set open files limit to unlimited. This daemon can open a large number of
4251 * file descriptors in order to consumer multiple kernel traces.
4253 static void set_ulimit(void)
4258 /* The kernel does not allowed an infinite limit for open files */
4259 lim
.rlim_cur
= 65535;
4260 lim
.rlim_max
= 65535;
4262 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4264 perror("failed to set open files limit");
4271 int main(int argc
, char **argv
)
4275 const char *home_path
;
4277 init_kernel_workarounds();
4279 rcu_register_thread();
4281 /* Create thread quit pipe */
4282 if ((ret
= init_thread_quit_pipe()) < 0) {
4286 setup_consumerd_path();
4288 /* Parse arguments */
4290 if ((ret
= parse_args(argc
, argv
) < 0)) {
4303 /* Check if daemon is UID = 0 */
4304 is_root
= !getuid();
4307 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4309 /* Create global run dir with root access */
4310 ret
= create_lttng_rundir(rundir
);
4315 if (strlen(apps_unix_sock_path
) == 0) {
4316 snprintf(apps_unix_sock_path
, PATH_MAX
,
4317 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4320 if (strlen(client_unix_sock_path
) == 0) {
4321 snprintf(client_unix_sock_path
, PATH_MAX
,
4322 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4325 /* Set global SHM for ust */
4326 if (strlen(wait_shm_path
) == 0) {
4327 snprintf(wait_shm_path
, PATH_MAX
,
4328 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4331 /* Setup kernel consumerd path */
4332 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4333 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4334 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4335 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4337 DBG2("Kernel consumer err path: %s",
4338 kconsumer_data
.err_unix_sock_path
);
4339 DBG2("Kernel consumer cmd path: %s",
4340 kconsumer_data
.cmd_unix_sock_path
);
4342 home_path
= get_home_dir();
4343 if (home_path
== NULL
) {
4344 /* TODO: Add --socket PATH option */
4345 ERR("Can't get HOME directory for sockets creation.");
4351 * Create rundir from home path. This will create something like
4354 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4360 ret
= create_lttng_rundir(rundir
);
4365 if (strlen(apps_unix_sock_path
) == 0) {
4366 snprintf(apps_unix_sock_path
, PATH_MAX
,
4367 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4370 /* Set the cli tool unix socket path */
4371 if (strlen(client_unix_sock_path
) == 0) {
4372 snprintf(client_unix_sock_path
, PATH_MAX
,
4373 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4376 /* Set global SHM for ust */
4377 if (strlen(wait_shm_path
) == 0) {
4378 snprintf(wait_shm_path
, PATH_MAX
,
4379 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4383 DBG("Client socket path %s", client_unix_sock_path
);
4384 DBG("Application socket path %s", apps_unix_sock_path
);
4385 DBG("LTTng run directory path: %s", rundir
);
4387 /* 32 bits consumerd path setup */
4388 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4389 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4390 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4391 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4393 DBG2("UST consumer 32 bits err path: %s",
4394 ustconsumer32_data
.err_unix_sock_path
);
4395 DBG2("UST consumer 32 bits cmd path: %s",
4396 ustconsumer32_data
.cmd_unix_sock_path
);
4398 /* 64 bits consumerd path setup */
4399 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4400 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4401 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4402 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4404 DBG2("UST consumer 64 bits err path: %s",
4405 ustconsumer64_data
.err_unix_sock_path
);
4406 DBG2("UST consumer 64 bits cmd path: %s",
4407 ustconsumer64_data
.cmd_unix_sock_path
);
4410 * See if daemon already exist.
4412 if ((ret
= check_existing_daemon()) < 0) {
4413 ERR("Already running daemon.\n");
4415 * We do not goto exit because we must not cleanup()
4416 * because a daemon is already running.
4421 /* After this point, we can safely call cleanup() with "goto exit" */
4424 * These actions must be executed as root. We do that *after* setting up
4425 * the sockets path because we MUST make the check for another daemon using
4426 * those paths *before* trying to set the kernel consumer sockets and init
4430 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4435 /* Setup kernel tracer */
4436 if (!opt_no_kernel
) {
4437 init_kernel_tracer();
4440 /* Set ulimit for open files */
4444 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4449 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4454 if ((ret
= set_signal_handler()) < 0) {
4458 /* Setup the needed unix socket */
4459 if ((ret
= init_daemon_socket()) < 0) {
4463 /* Set credentials to socket */
4464 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4468 /* Get parent pid if -S, --sig-parent is specified. */
4469 if (opt_sig_parent
) {
4473 /* Setup the kernel pipe for waking up the kernel thread */
4474 if ((ret
= create_kernel_poll_pipe()) < 0) {
4478 /* Setup the thread apps communication pipe. */
4479 if ((ret
= create_apps_cmd_pipe()) < 0) {
4483 /* Init UST command queue. */
4484 cds_wfq_init(&ust_cmd_queue
.queue
);
4486 /* Init UST app hash table */
4490 * Get session list pointer. This pointer MUST NOT be free(). This list is
4491 * statically declared in session.c
4493 session_list_ptr
= session_get_list();
4495 /* Set up max poll set size */
4496 lttng_poll_set_max_size();
4498 /* Create thread to manage the client socket */
4499 ret
= pthread_create(&client_thread
, NULL
,
4500 thread_manage_clients
, (void *) NULL
);
4502 perror("pthread_create clients");
4506 /* Create thread to dispatch registration */
4507 ret
= pthread_create(&dispatch_thread
, NULL
,
4508 thread_dispatch_ust_registration
, (void *) NULL
);
4510 perror("pthread_create dispatch");
4514 /* Create thread to manage application registration. */
4515 ret
= pthread_create(®_apps_thread
, NULL
,
4516 thread_registration_apps
, (void *) NULL
);
4518 perror("pthread_create registration");
4522 /* Create thread to manage application socket */
4523 ret
= pthread_create(&apps_thread
, NULL
,
4524 thread_manage_apps
, (void *) NULL
);
4526 perror("pthread_create apps");
4530 /* Create kernel thread to manage kernel event */
4531 ret
= pthread_create(&kernel_thread
, NULL
,
4532 thread_manage_kernel
, (void *) NULL
);
4534 perror("pthread_create kernel");
4538 ret
= pthread_join(kernel_thread
, &status
);
4540 perror("pthread_join");
4541 goto error
; /* join error, exit without cleanup */
4545 ret
= pthread_join(apps_thread
, &status
);
4547 perror("pthread_join");
4548 goto error
; /* join error, exit without cleanup */
4552 ret
= pthread_join(reg_apps_thread
, &status
);
4554 perror("pthread_join");
4555 goto error
; /* join error, exit without cleanup */
4559 ret
= pthread_join(dispatch_thread
, &status
);
4561 perror("pthread_join");
4562 goto error
; /* join error, exit without cleanup */
4566 ret
= pthread_join(client_thread
, &status
);
4568 perror("pthread_join");
4569 goto error
; /* join error, exit without cleanup */
4572 ret
= join_consumer_thread(&kconsumer_data
);
4574 perror("join_consumer");
4575 goto error
; /* join error, exit without cleanup */
4581 * cleanup() is called when no other thread is running.
4583 rcu_thread_online();
4585 rcu_thread_offline();
4586 rcu_unregister_thread();