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 */
842 ret
= lttng_poll_wait(&events
, -1);
845 } else if (ret
== 0) {
846 /* Should not happen since timeout is infinite */
847 ERR("Return value of poll is 0 with an infinite timeout.\n"
848 "This should not have happened! Continuing...");
852 for (i
= 0; i
< nb_fd
; i
++) {
853 /* Fetch once the poll data */
854 revents
= LTTNG_POLL_GETEV(&events
, i
);
855 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
857 /* Thread quit pipe has been closed. Killing thread. */
858 ret
= check_thread_quit_pipe(pollfd
, revents
);
863 /* Check for data on kernel pipe */
864 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
865 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
866 update_poll_flag
= 1;
870 * New CPU detected by the kernel. Adding kernel stream to
871 * kernel session and updating the kernel consumer
873 if (revents
& LPOLLIN
) {
874 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
880 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
881 * and unregister kernel stream at this point.
889 DBG("Kernel thread dying");
890 close(kernel_poll_pipe
[0]);
891 close(kernel_poll_pipe
[1]);
893 lttng_poll_clean(&events
);
899 * This thread manage the consumer error sent back to the session daemon.
901 static void *thread_manage_consumer(void *data
)
903 int sock
= 0, i
, ret
, pollfd
;
904 uint32_t revents
, nb_fd
;
905 enum lttcomm_return_code code
;
906 struct lttng_poll_event events
;
907 struct consumer_data
*consumer_data
= data
;
909 DBG("[thread] Manage consumer started");
911 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
917 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
918 * Nothing more will be added to this poll set.
920 ret
= create_thread_poll_set(&events
, 2);
925 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
930 nb_fd
= LTTNG_POLL_GETNB(&events
);
932 /* Inifinite blocking call, waiting for transmission */
933 ret
= lttng_poll_wait(&events
, -1);
938 for (i
= 0; i
< nb_fd
; i
++) {
939 /* Fetch once the poll data */
940 revents
= LTTNG_POLL_GETEV(&events
, i
);
941 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
943 /* Thread quit pipe has been closed. Killing thread. */
944 ret
= check_thread_quit_pipe(pollfd
, revents
);
949 /* Event on the registration socket */
950 if (pollfd
== consumer_data
->err_sock
) {
951 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
952 ERR("consumer err socket poll error");
958 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
963 DBG2("Receiving code from consumer err_sock");
965 /* Getting status code from kconsumerd */
966 ret
= lttcomm_recv_unix_sock(sock
, &code
,
967 sizeof(enum lttcomm_return_code
));
972 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
973 consumer_data
->cmd_sock
=
974 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
975 if (consumer_data
->cmd_sock
< 0) {
976 sem_post(&consumer_data
->sem
);
977 PERROR("consumer connect");
980 /* Signal condition to tell that the kconsumerd is ready */
981 sem_post(&consumer_data
->sem
);
982 DBG("consumer command socket ready");
984 ERR("consumer error when waiting for SOCK_READY : %s",
985 lttcomm_get_readable_code(-code
));
989 /* Remove the kconsumerd error sock since we've established a connexion */
990 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
995 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1000 /* Update number of fd */
1001 nb_fd
= LTTNG_POLL_GETNB(&events
);
1003 /* Inifinite blocking call, waiting for transmission */
1004 ret
= lttng_poll_wait(&events
, -1);
1009 for (i
= 0; i
< nb_fd
; i
++) {
1010 /* Fetch once the poll data */
1011 revents
= LTTNG_POLL_GETEV(&events
, i
);
1012 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1014 /* Thread quit pipe has been closed. Killing thread. */
1015 ret
= check_thread_quit_pipe(pollfd
, revents
);
1020 /* Event on the kconsumerd socket */
1021 if (pollfd
== sock
) {
1022 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1023 ERR("consumer err socket second poll error");
1029 /* Wait for any kconsumerd error */
1030 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1031 sizeof(enum lttcomm_return_code
));
1033 ERR("consumer closed the command socket");
1037 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1040 DBG("consumer thread dying");
1041 close(consumer_data
->err_sock
);
1042 close(consumer_data
->cmd_sock
);
1045 unlink(consumer_data
->err_unix_sock_path
);
1046 unlink(consumer_data
->cmd_unix_sock_path
);
1047 consumer_data
->pid
= 0;
1049 lttng_poll_clean(&events
);
1055 * This thread manage application communication.
1057 static void *thread_manage_apps(void *data
)
1060 uint32_t revents
, nb_fd
;
1061 struct ust_command ust_cmd
;
1062 struct lttng_poll_event events
;
1064 DBG("[thread] Manage application started");
1066 rcu_register_thread();
1067 rcu_thread_online();
1069 ret
= create_thread_poll_set(&events
, 2);
1074 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1080 /* Zeroed the events structure */
1081 lttng_poll_reset(&events
);
1083 nb_fd
= LTTNG_POLL_GETNB(&events
);
1085 DBG("Apps thread polling on %d fds", nb_fd
);
1087 /* Inifinite blocking call, waiting for transmission */
1088 ret
= lttng_poll_wait(&events
, -1);
1093 for (i
= 0; i
< nb_fd
; i
++) {
1094 /* Fetch once the poll data */
1095 revents
= LTTNG_POLL_GETEV(&events
, i
);
1096 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1098 /* Thread quit pipe has been closed. Killing thread. */
1099 ret
= check_thread_quit_pipe(pollfd
, revents
);
1104 /* Inspect the apps cmd pipe */
1105 if (pollfd
== apps_cmd_pipe
[0]) {
1106 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1107 ERR("Apps command pipe error");
1109 } else if (revents
& LPOLLIN
) {
1111 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1112 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1113 perror("read apps cmd pipe");
1117 /* Register applicaton to the session daemon */
1118 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1120 if (ret
== -ENOMEM
) {
1122 } else if (ret
< 0) {
1127 * Validate UST version compatibility.
1129 ret
= ust_app_validate_version(ust_cmd
.sock
);
1132 * Add channel(s) and event(s) to newly registered apps
1133 * from lttng global UST domain.
1135 update_ust_app(ust_cmd
.sock
);
1138 ret
= ust_app_register_done(ust_cmd
.sock
);
1141 * If the registration is not possible, we simply
1142 * unregister the apps and continue
1144 ust_app_unregister(ust_cmd
.sock
);
1147 * We just need here to monitor the close of the UST
1148 * socket and poll set monitor those by default.
1150 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1155 DBG("Apps with sock %d added to poll set",
1163 * At this point, we know that a registered application made
1164 * the event at poll_wait.
1166 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1167 /* Removing from the poll set */
1168 ret
= lttng_poll_del(&events
, pollfd
);
1173 /* Socket closed on remote end. */
1174 ust_app_unregister(pollfd
);
1182 DBG("Application communication apps dying");
1183 close(apps_cmd_pipe
[0]);
1184 close(apps_cmd_pipe
[1]);
1186 lttng_poll_clean(&events
);
1188 rcu_thread_offline();
1189 rcu_unregister_thread();
1194 * Dispatch request from the registration threads to the application
1195 * communication thread.
1197 static void *thread_dispatch_ust_registration(void *data
)
1200 struct cds_wfq_node
*node
;
1201 struct ust_command
*ust_cmd
= NULL
;
1203 DBG("[thread] Dispatch UST command started");
1205 while (!dispatch_thread_exit
) {
1206 /* Atomically prepare the queue futex */
1207 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1210 /* Dequeue command for registration */
1211 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1213 DBG("Woken up but nothing in the UST command queue");
1214 /* Continue thread execution */
1218 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1220 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1221 " gid:%d sock:%d name:%s (version %d.%d)",
1222 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1223 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1224 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1225 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1227 * Inform apps thread of the new application registration. This
1228 * call is blocking so we can be assured that the data will be read
1229 * at some point in time or wait to the end of the world :)
1231 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1232 sizeof(struct ust_command
));
1234 perror("write apps cmd pipe");
1235 if (errno
== EBADF
) {
1237 * We can't inform the application thread to process
1238 * registration. We will exit or else application
1239 * registration will not occur and tracing will never
1246 } while (node
!= NULL
);
1248 /* Futex wait on queue. Blocking call on futex() */
1249 futex_nto1_wait(&ust_cmd_queue
.futex
);
1253 DBG("Dispatch thread dying");
1258 * This thread manage application registration.
1260 static void *thread_registration_apps(void *data
)
1262 int sock
= 0, i
, ret
, pollfd
;
1263 uint32_t revents
, nb_fd
;
1264 struct lttng_poll_event events
;
1266 * Get allocated in this thread, enqueued to a global queue, dequeued and
1267 * freed in the manage apps thread.
1269 struct ust_command
*ust_cmd
= NULL
;
1271 DBG("[thread] Manage application registration started");
1273 ret
= lttcomm_listen_unix_sock(apps_sock
);
1279 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1280 * more will be added to this poll set.
1282 ret
= create_thread_poll_set(&events
, 2);
1287 /* Add the application registration socket */
1288 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1293 /* Notify all applications to register */
1294 ret
= notify_ust_apps(1);
1296 ERR("Failed to notify applications or create the wait shared memory.\n"
1297 "Execution continues but there might be problem for already\n"
1298 "running applications that wishes to register.");
1302 DBG("Accepting application registration");
1304 nb_fd
= LTTNG_POLL_GETNB(&events
);
1306 /* Inifinite blocking call, waiting for transmission */
1307 ret
= lttng_poll_wait(&events
, -1);
1312 for (i
= 0; i
< nb_fd
; i
++) {
1313 /* Fetch once the poll data */
1314 revents
= LTTNG_POLL_GETEV(&events
, i
);
1315 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1317 /* Thread quit pipe has been closed. Killing thread. */
1318 ret
= check_thread_quit_pipe(pollfd
, revents
);
1323 /* Event on the registration socket */
1324 if (pollfd
== apps_sock
) {
1325 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1326 ERR("Register apps socket poll error");
1328 } else if (revents
& LPOLLIN
) {
1329 sock
= lttcomm_accept_unix_sock(apps_sock
);
1334 /* Create UST registration command for enqueuing */
1335 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1336 if (ust_cmd
== NULL
) {
1337 perror("ust command zmalloc");
1342 * Using message-based transmissions to ensure we don't
1343 * have to deal with partially received messages.
1345 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1346 sizeof(struct ust_register_msg
));
1347 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1349 perror("lttcomm_recv_unix_sock register apps");
1351 ERR("Wrong size received on apps register");
1358 ust_cmd
->sock
= sock
;
1360 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1361 " gid:%d sock:%d name:%s (version %d.%d)",
1362 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1363 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1364 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1365 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1368 * Lock free enqueue the registration request. The red pill
1369 * has been taken! This apps will be part of the *system*.
1371 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1374 * Wake the registration queue futex. Implicit memory
1375 * barrier with the exchange in cds_wfq_enqueue.
1377 futex_nto1_wake(&ust_cmd_queue
.futex
);
1384 DBG("UST Registration thread dying");
1386 /* Notify that the registration thread is gone */
1391 unlink(apps_unix_sock_path
);
1393 lttng_poll_clean(&events
);
1399 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1400 * exec or it will fails.
1402 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1405 struct timespec timeout
;
1407 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1408 timeout
.tv_nsec
= 0;
1410 /* Setup semaphore */
1411 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1413 PERROR("sem_init consumer semaphore");
1417 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1418 thread_manage_consumer
, consumer_data
);
1420 PERROR("pthread_create consumer");
1425 /* Get time for sem_timedwait absolute timeout */
1426 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1428 PERROR("clock_gettime spawn consumer");
1429 /* Infinite wait for the kconsumerd thread to be ready */
1430 ret
= sem_wait(&consumer_data
->sem
);
1432 /* Normal timeout if the gettime was successful */
1433 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1434 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1438 if (errno
== ETIMEDOUT
) {
1440 * Call has timed out so we kill the kconsumerd_thread and return
1443 ERR("The consumer thread was never ready. Killing it");
1444 ret
= pthread_cancel(consumer_data
->thread
);
1446 PERROR("pthread_cancel consumer thread");
1449 PERROR("semaphore wait failed consumer thread");
1454 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1455 if (consumer_data
->pid
== 0) {
1456 ERR("Kconsumerd did not start");
1457 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1460 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1469 * Join consumer thread
1471 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1476 if (consumer_data
->pid
!= 0) {
1477 ret
= kill(consumer_data
->pid
, SIGTERM
);
1479 ERR("Error killing consumer daemon");
1482 return pthread_join(consumer_data
->thread
, &status
);
1489 * Fork and exec a consumer daemon (consumerd).
1491 * Return pid if successful else -1.
1493 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1497 const char *consumer_to_use
;
1498 const char *verbosity
;
1501 DBG("Spawning consumerd");
1508 if (opt_verbose_consumer
) {
1509 verbosity
= "--verbose";
1511 verbosity
= "--quiet";
1513 switch (consumer_data
->type
) {
1514 case LTTNG_CONSUMER_KERNEL
:
1516 * Find out which consumerd to execute. We will first try the
1517 * 64-bit path, then the sessiond's installation directory, and
1518 * fallback on the 32-bit one,
1520 DBG3("Looking for a kernel consumer at these locations:");
1521 DBG3(" 1) %s", consumerd64_bin
);
1522 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1523 DBG3(" 3) %s", consumerd32_bin
);
1524 if (stat(consumerd64_bin
, &st
) == 0) {
1525 DBG3("Found location #1");
1526 consumer_to_use
= consumerd64_bin
;
1527 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1528 DBG3("Found location #2");
1529 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1530 } else if (stat(consumerd32_bin
, &st
) == 0) {
1531 DBG3("Found location #3");
1532 consumer_to_use
= consumerd32_bin
;
1534 DBG("Could not find any valid consumerd executable");
1537 DBG("Using kernel consumer at: %s", consumer_to_use
);
1538 execl(consumer_to_use
,
1539 "lttng-consumerd", verbosity
, "-k",
1540 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1541 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1544 case LTTNG_CONSUMER64_UST
:
1546 char *tmpnew
= NULL
;
1548 if (consumerd64_libdir
[0] != '\0') {
1552 tmp
= getenv("LD_LIBRARY_PATH");
1556 tmplen
= strlen("LD_LIBRARY_PATH=")
1557 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1558 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1563 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1564 strcat(tmpnew
, consumerd64_libdir
);
1565 if (tmp
[0] != '\0') {
1566 strcat(tmpnew
, ":");
1567 strcat(tmpnew
, tmp
);
1569 ret
= putenv(tmpnew
);
1575 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1576 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1577 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1578 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1580 if (consumerd64_libdir
[0] != '\0') {
1588 case LTTNG_CONSUMER32_UST
:
1590 char *tmpnew
= NULL
;
1592 if (consumerd32_libdir
[0] != '\0') {
1596 tmp
= getenv("LD_LIBRARY_PATH");
1600 tmplen
= strlen("LD_LIBRARY_PATH=")
1601 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1602 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1607 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1608 strcat(tmpnew
, consumerd32_libdir
);
1609 if (tmp
[0] != '\0') {
1610 strcat(tmpnew
, ":");
1611 strcat(tmpnew
, tmp
);
1613 ret
= putenv(tmpnew
);
1619 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1620 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1621 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1622 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1624 if (consumerd32_libdir
[0] != '\0') {
1633 perror("unknown consumer type");
1637 perror("kernel start consumer exec");
1640 } else if (pid
> 0) {
1643 perror("start consumer fork");
1651 * Spawn the consumerd daemon and session daemon thread.
1653 static int start_consumerd(struct consumer_data
*consumer_data
)
1657 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1658 if (consumer_data
->pid
!= 0) {
1659 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1663 ret
= spawn_consumerd(consumer_data
);
1665 ERR("Spawning consumerd failed");
1666 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1670 /* Setting up the consumer_data pid */
1671 consumer_data
->pid
= ret
;
1672 DBG2("Consumer pid %d", consumer_data
->pid
);
1673 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1675 DBG2("Spawning consumer control thread");
1676 ret
= spawn_consumer_thread(consumer_data
);
1678 ERR("Fatal error spawning consumer control thread");
1690 * Check version of the lttng-modules.
1692 static int validate_lttng_modules_version(void)
1694 return kernel_validate_version(kernel_tracer_fd
);
1698 * Setup necessary data for kernel tracer action.
1700 static int init_kernel_tracer(void)
1704 /* Modprobe lttng kernel modules */
1705 ret
= modprobe_lttng_control();
1710 /* Open debugfs lttng */
1711 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1712 if (kernel_tracer_fd
< 0) {
1713 DBG("Failed to open %s", module_proc_lttng
);
1718 /* Validate kernel version */
1719 ret
= validate_lttng_modules_version();
1724 ret
= modprobe_lttng_data();
1729 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1733 modprobe_remove_lttng_control();
1734 close(kernel_tracer_fd
);
1735 kernel_tracer_fd
= 0;
1736 return LTTCOMM_KERN_VERSION
;
1739 close(kernel_tracer_fd
);
1742 modprobe_remove_lttng_control();
1745 WARN("No kernel tracer available");
1746 kernel_tracer_fd
= 0;
1747 return LTTCOMM_KERN_NA
;
1751 * Init tracing by creating trace directory and sending fds kernel consumer.
1753 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1757 if (session
->consumer_fds_sent
== 0) {
1759 * Assign default kernel consumer socket if no consumer assigned to the
1760 * kernel session. At this point, it's NOT suppose to be 0 but this is
1761 * an extra security check.
1763 if (session
->consumer_fd
== 0) {
1764 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1767 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1769 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1773 session
->consumer_fds_sent
= 1;
1781 * Create an UST session and add it to the session ust list.
1783 static int create_ust_session(struct ltt_session
*session
,
1784 struct lttng_domain
*domain
)
1786 struct ltt_ust_session
*lus
= NULL
;
1789 switch (domain
->type
) {
1790 case LTTNG_DOMAIN_UST
:
1793 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1797 DBG("Creating UST session");
1799 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1801 ret
= LTTCOMM_UST_SESS_FAIL
;
1805 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1806 session
->uid
, session
->gid
);
1808 if (ret
!= -EEXIST
) {
1809 ERR("Trace directory creation error");
1810 ret
= LTTCOMM_UST_SESS_FAIL
;
1815 /* The domain type dictate different actions on session creation */
1816 switch (domain
->type
) {
1817 case LTTNG_DOMAIN_UST
:
1818 /* No ustctl for the global UST domain */
1821 ERR("Unknown UST domain on create session %d", domain
->type
);
1824 lus
->uid
= session
->uid
;
1825 lus
->gid
= session
->gid
;
1826 session
->ust_session
= lus
;
1836 * Create a kernel tracer session then create the default channel.
1838 static int create_kernel_session(struct ltt_session
*session
)
1842 DBG("Creating kernel session");
1844 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1846 ret
= LTTCOMM_KERN_SESS_FAIL
;
1850 /* Set kernel consumer socket fd */
1851 if (kconsumer_data
.cmd_sock
) {
1852 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1855 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1856 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1858 if (ret
!= -EEXIST
) {
1859 ERR("Trace directory creation error");
1863 session
->kernel_session
->uid
= session
->uid
;
1864 session
->kernel_session
->gid
= session
->gid
;
1871 * Check if the UID or GID match the session. Root user has access to all
1874 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1876 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1883 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1886 struct ltt_session
*session
;
1888 DBG("Counting number of available session for UID %d GID %d",
1890 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1892 * Only list the sessions the user can control.
1894 if (!session_access_ok(session
, uid
, gid
)) {
1903 * Using the session list, filled a lttng_session array to send back to the
1904 * client for session listing.
1906 * The session list lock MUST be acquired before calling this function. Use
1907 * session_lock_list() and session_unlock_list().
1909 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1913 struct ltt_session
*session
;
1915 DBG("Getting all available session for UID %d GID %d",
1918 * Iterate over session list and append data after the control struct in
1921 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1923 * Only list the sessions the user can control.
1925 if (!session_access_ok(session
, uid
, gid
)) {
1928 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1929 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1930 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1931 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1932 sessions
[i
].enabled
= session
->enabled
;
1938 * Fill lttng_channel array of all channels.
1940 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1941 struct lttng_channel
*channels
)
1944 struct ltt_kernel_channel
*kchan
;
1946 DBG("Listing channels for session %s", session
->name
);
1949 case LTTNG_DOMAIN_KERNEL
:
1950 /* Kernel channels */
1951 if (session
->kernel_session
!= NULL
) {
1952 cds_list_for_each_entry(kchan
,
1953 &session
->kernel_session
->channel_list
.head
, list
) {
1954 /* Copy lttng_channel struct to array */
1955 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1956 channels
[i
].enabled
= kchan
->enabled
;
1961 case LTTNG_DOMAIN_UST
:
1963 struct lttng_ht_iter iter
;
1964 struct ltt_ust_channel
*uchan
;
1966 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1967 &iter
.iter
, uchan
, node
.node
) {
1968 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1969 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1970 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1971 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1972 channels
[i
].attr
.switch_timer_interval
=
1973 uchan
->attr
.switch_timer_interval
;
1974 channels
[i
].attr
.read_timer_interval
=
1975 uchan
->attr
.read_timer_interval
;
1976 channels
[i
].enabled
= uchan
->enabled
;
1977 switch (uchan
->attr
.output
) {
1978 case LTTNG_UST_MMAP
:
1980 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
1993 * Create a list of ust global domain events.
1995 static int list_lttng_ust_global_events(char *channel_name
,
1996 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
1999 unsigned int nb_event
= 0;
2000 struct lttng_ht_iter iter
;
2001 struct lttng_ht_node_str
*node
;
2002 struct ltt_ust_channel
*uchan
;
2003 struct ltt_ust_event
*uevent
;
2004 struct lttng_event
*tmp
;
2006 DBG("Listing UST global events for channel %s", channel_name
);
2010 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2011 node
= lttng_ht_iter_get_node_str(&iter
);
2013 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2017 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2019 nb_event
+= lttng_ht_get_count(uchan
->events
);
2021 if (nb_event
== 0) {
2026 DBG3("Listing UST global %d events", nb_event
);
2028 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2030 ret
= -LTTCOMM_FATAL
;
2034 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2035 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2036 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2037 tmp
[i
].enabled
= uevent
->enabled
;
2038 switch (uevent
->attr
.instrumentation
) {
2039 case LTTNG_UST_TRACEPOINT
:
2040 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2042 case LTTNG_UST_PROBE
:
2043 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2045 case LTTNG_UST_FUNCTION
:
2046 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2049 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2050 switch (uevent
->attr
.loglevel_type
) {
2051 case LTTNG_UST_LOGLEVEL_ALL
:
2052 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2054 case LTTNG_UST_LOGLEVEL_RANGE
:
2055 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2057 case LTTNG_UST_LOGLEVEL_SINGLE
:
2058 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2073 * Fill lttng_event array of all kernel events in the channel.
2075 static int list_lttng_kernel_events(char *channel_name
,
2076 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2079 unsigned int nb_event
;
2080 struct ltt_kernel_event
*event
;
2081 struct ltt_kernel_channel
*kchan
;
2083 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2084 if (kchan
== NULL
) {
2085 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2089 nb_event
= kchan
->event_count
;
2091 DBG("Listing events for channel %s", kchan
->channel
->name
);
2093 if (nb_event
== 0) {
2098 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2099 if (*events
== NULL
) {
2100 ret
= LTTCOMM_FATAL
;
2104 /* Kernel channels */
2105 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2106 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2107 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2108 (*events
)[i
].enabled
= event
->enabled
;
2109 switch (event
->event
->instrumentation
) {
2110 case LTTNG_KERNEL_TRACEPOINT
:
2111 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2113 case LTTNG_KERNEL_KPROBE
:
2114 case LTTNG_KERNEL_KRETPROBE
:
2115 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2116 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2117 sizeof(struct lttng_kernel_kprobe
));
2119 case LTTNG_KERNEL_FUNCTION
:
2120 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2121 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2122 sizeof(struct lttng_kernel_function
));
2124 case LTTNG_KERNEL_NOOP
:
2125 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2127 case LTTNG_KERNEL_SYSCALL
:
2128 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2130 case LTTNG_KERNEL_ALL
:
2144 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2146 static int cmd_disable_channel(struct ltt_session
*session
,
2147 int domain
, char *channel_name
)
2150 struct ltt_ust_session
*usess
;
2152 usess
= session
->ust_session
;
2155 case LTTNG_DOMAIN_KERNEL
:
2157 ret
= channel_kernel_disable(session
->kernel_session
,
2159 if (ret
!= LTTCOMM_OK
) {
2163 kernel_wait_quiescent(kernel_tracer_fd
);
2166 case LTTNG_DOMAIN_UST
:
2168 struct ltt_ust_channel
*uchan
;
2169 struct lttng_ht
*chan_ht
;
2171 chan_ht
= usess
->domain_global
.channels
;
2173 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2174 if (uchan
== NULL
) {
2175 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2179 ret
= channel_ust_disable(usess
, domain
, uchan
);
2180 if (ret
!= LTTCOMM_OK
) {
2186 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2187 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2188 case LTTNG_DOMAIN_UST_PID
:
2191 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2202 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2204 static int cmd_enable_channel(struct ltt_session
*session
,
2205 int domain
, struct lttng_channel
*attr
)
2208 struct ltt_ust_session
*usess
= session
->ust_session
;
2209 struct lttng_ht
*chan_ht
;
2211 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2214 case LTTNG_DOMAIN_KERNEL
:
2216 struct ltt_kernel_channel
*kchan
;
2218 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2219 session
->kernel_session
);
2220 if (kchan
== NULL
) {
2221 ret
= channel_kernel_create(session
->kernel_session
,
2222 attr
, kernel_poll_pipe
[1]);
2224 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2227 if (ret
!= LTTCOMM_OK
) {
2231 kernel_wait_quiescent(kernel_tracer_fd
);
2234 case LTTNG_DOMAIN_UST
:
2236 struct ltt_ust_channel
*uchan
;
2238 chan_ht
= usess
->domain_global
.channels
;
2240 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2241 if (uchan
== NULL
) {
2242 ret
= channel_ust_create(usess
, domain
, attr
);
2244 ret
= channel_ust_enable(usess
, domain
, uchan
);
2249 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2250 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2251 case LTTNG_DOMAIN_UST_PID
:
2254 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2263 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2265 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2266 char *channel_name
, char *event_name
)
2271 case LTTNG_DOMAIN_KERNEL
:
2273 struct ltt_kernel_channel
*kchan
;
2274 struct ltt_kernel_session
*ksess
;
2276 ksess
= session
->kernel_session
;
2278 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2279 if (kchan
== NULL
) {
2280 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2284 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2285 if (ret
!= LTTCOMM_OK
) {
2289 kernel_wait_quiescent(kernel_tracer_fd
);
2292 case LTTNG_DOMAIN_UST
:
2294 struct ltt_ust_channel
*uchan
;
2295 struct ltt_ust_session
*usess
;
2297 usess
= session
->ust_session
;
2299 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2301 if (uchan
== NULL
) {
2302 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2306 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2307 if (ret
!= LTTCOMM_OK
) {
2311 DBG3("Disable UST event %s in channel %s completed", event_name
,
2316 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2317 case LTTNG_DOMAIN_UST_PID
:
2318 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2332 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2334 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2340 case LTTNG_DOMAIN_KERNEL
:
2342 struct ltt_kernel_session
*ksess
;
2343 struct ltt_kernel_channel
*kchan
;
2345 ksess
= session
->kernel_session
;
2347 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2348 if (kchan
== NULL
) {
2349 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2353 ret
= event_kernel_disable_all(ksess
, kchan
);
2354 if (ret
!= LTTCOMM_OK
) {
2358 kernel_wait_quiescent(kernel_tracer_fd
);
2361 case LTTNG_DOMAIN_UST
:
2363 struct ltt_ust_session
*usess
;
2364 struct ltt_ust_channel
*uchan
;
2366 usess
= session
->ust_session
;
2368 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2370 if (uchan
== NULL
) {
2371 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2375 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2380 DBG3("Disable all UST events in channel %s completed", channel_name
);
2385 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2386 case LTTNG_DOMAIN_UST_PID
:
2387 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2401 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2403 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2404 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2409 case LTTNG_DOMAIN_KERNEL
:
2410 /* Add kernel context to kernel tracer */
2411 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2412 event_name
, channel_name
);
2413 if (ret
!= LTTCOMM_OK
) {
2417 case LTTNG_DOMAIN_UST
:
2419 struct ltt_ust_session
*usess
= session
->ust_session
;
2421 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2422 if (ret
!= LTTCOMM_OK
) {
2428 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2429 case LTTNG_DOMAIN_UST_PID
:
2430 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2444 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2446 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2447 char *channel_name
, struct lttng_event
*event
)
2450 struct lttng_channel
*attr
;
2451 struct ltt_ust_session
*usess
= session
->ust_session
;
2454 case LTTNG_DOMAIN_KERNEL
:
2456 struct ltt_kernel_channel
*kchan
;
2458 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2459 session
->kernel_session
);
2460 if (kchan
== NULL
) {
2461 attr
= channel_new_default_attr(domain
);
2463 ret
= LTTCOMM_FATAL
;
2466 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2468 /* This call will notify the kernel thread */
2469 ret
= channel_kernel_create(session
->kernel_session
,
2470 attr
, kernel_poll_pipe
[1]);
2471 if (ret
!= LTTCOMM_OK
) {
2478 /* Get the newly created kernel channel pointer */
2479 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2480 session
->kernel_session
);
2481 if (kchan
== NULL
) {
2482 /* This sould not happen... */
2483 ret
= LTTCOMM_FATAL
;
2487 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2489 if (ret
!= LTTCOMM_OK
) {
2493 kernel_wait_quiescent(kernel_tracer_fd
);
2496 case LTTNG_DOMAIN_UST
:
2498 struct lttng_channel
*attr
;
2499 struct ltt_ust_channel
*uchan
;
2501 /* Get channel from global UST domain */
2502 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2504 if (uchan
== NULL
) {
2505 /* Create default channel */
2506 attr
= channel_new_default_attr(domain
);
2508 ret
= LTTCOMM_FATAL
;
2511 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2512 attr
->name
[NAME_MAX
- 1] = '\0';
2514 ret
= channel_ust_create(usess
, domain
, attr
);
2515 if (ret
!= LTTCOMM_OK
) {
2521 /* Get the newly created channel reference back */
2522 uchan
= trace_ust_find_channel_by_name(
2523 usess
->domain_global
.channels
, channel_name
);
2524 if (uchan
== NULL
) {
2525 /* Something is really wrong */
2526 ret
= LTTCOMM_FATAL
;
2531 /* At this point, the session and channel exist on the tracer */
2532 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2533 if (ret
!= LTTCOMM_OK
) {
2539 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2540 case LTTNG_DOMAIN_UST_PID
:
2541 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2555 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2557 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2558 char *channel_name
, int event_type
)
2561 struct ltt_kernel_channel
*kchan
;
2564 case LTTNG_DOMAIN_KERNEL
:
2565 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2566 session
->kernel_session
);
2567 if (kchan
== NULL
) {
2568 /* This call will notify the kernel thread */
2569 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2570 kernel_poll_pipe
[1]);
2571 if (ret
!= LTTCOMM_OK
) {
2575 /* Get the newly created kernel channel pointer */
2576 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2577 session
->kernel_session
);
2578 if (kchan
== NULL
) {
2579 /* This sould not happen... */
2580 ret
= LTTCOMM_FATAL
;
2586 switch (event_type
) {
2587 case LTTNG_EVENT_SYSCALL
:
2588 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2589 kchan
, kernel_tracer_fd
);
2591 case LTTNG_EVENT_TRACEPOINT
:
2593 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2594 * events already registered to the channel.
2596 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2597 kchan
, kernel_tracer_fd
);
2599 case LTTNG_EVENT_ALL
:
2600 /* Enable syscalls and tracepoints */
2601 ret
= event_kernel_enable_all(session
->kernel_session
,
2602 kchan
, kernel_tracer_fd
);
2605 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2609 /* Manage return value */
2610 if (ret
!= LTTCOMM_OK
) {
2614 kernel_wait_quiescent(kernel_tracer_fd
);
2616 case LTTNG_DOMAIN_UST
:
2618 struct lttng_channel
*attr
;
2619 struct ltt_ust_channel
*uchan
;
2620 struct ltt_ust_session
*usess
= session
->ust_session
;
2622 /* Get channel from global UST domain */
2623 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2625 if (uchan
== NULL
) {
2626 /* Create default channel */
2627 attr
= channel_new_default_attr(domain
);
2629 ret
= LTTCOMM_FATAL
;
2632 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2633 attr
->name
[NAME_MAX
- 1] = '\0';
2635 /* Use the internal command enable channel */
2636 ret
= channel_ust_create(usess
, domain
, attr
);
2637 if (ret
!= LTTCOMM_OK
) {
2643 /* Get the newly created channel reference back */
2644 uchan
= trace_ust_find_channel_by_name(
2645 usess
->domain_global
.channels
, channel_name
);
2646 if (uchan
== NULL
) {
2647 /* Something is really wrong */
2648 ret
= LTTCOMM_FATAL
;
2653 /* At this point, the session and channel exist on the tracer */
2655 switch (event_type
) {
2656 case LTTNG_EVENT_ALL
:
2657 case LTTNG_EVENT_TRACEPOINT
:
2658 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2659 if (ret
!= LTTCOMM_OK
) {
2664 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2668 /* Manage return value */
2669 if (ret
!= LTTCOMM_OK
) {
2676 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2677 case LTTNG_DOMAIN_UST_PID
:
2678 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2692 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2694 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2697 ssize_t nb_events
= 0;
2700 case LTTNG_DOMAIN_KERNEL
:
2701 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2702 if (nb_events
< 0) {
2703 ret
= LTTCOMM_KERN_LIST_FAIL
;
2707 case LTTNG_DOMAIN_UST
:
2708 nb_events
= ust_app_list_events(events
);
2709 if (nb_events
< 0) {
2710 ret
= LTTCOMM_UST_LIST_FAIL
;
2722 /* Return negative value to differentiate return code */
2727 * Command LTTNG_START_TRACE processed by the client thread.
2729 static int cmd_start_trace(struct ltt_session
*session
)
2732 struct ltt_kernel_session
*ksession
;
2733 struct ltt_ust_session
*usess
;
2736 ksession
= session
->kernel_session
;
2737 usess
= session
->ust_session
;
2739 if (session
->enabled
) {
2740 ret
= LTTCOMM_UST_START_FAIL
;
2744 session
->enabled
= 1;
2746 /* Kernel tracing */
2747 if (ksession
!= NULL
) {
2748 struct ltt_kernel_channel
*kchan
;
2750 /* Open kernel metadata */
2751 if (ksession
->metadata
== NULL
) {
2752 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2754 ret
= LTTCOMM_KERN_META_FAIL
;
2759 /* Open kernel metadata stream */
2760 if (ksession
->metadata_stream_fd
== 0) {
2761 ret
= kernel_open_metadata_stream(ksession
);
2763 ERR("Kernel create metadata stream failed");
2764 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2769 /* For each channel */
2770 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2771 if (kchan
->stream_count
== 0) {
2772 ret
= kernel_open_channel_stream(kchan
);
2774 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2777 /* Update the stream global counter */
2778 ksession
->stream_count_global
+= ret
;
2782 /* Setup kernel consumer socket and send fds to it */
2783 ret
= init_kernel_tracing(ksession
);
2785 ret
= LTTCOMM_KERN_START_FAIL
;
2789 /* This start the kernel tracing */
2790 ret
= kernel_start_session(ksession
);
2792 ret
= LTTCOMM_KERN_START_FAIL
;
2796 /* Quiescent wait after starting trace */
2797 kernel_wait_quiescent(kernel_tracer_fd
);
2800 /* Flag session that trace should start automatically */
2802 usess
->start_trace
= 1;
2804 ret
= ust_app_start_trace_all(usess
);
2806 ret
= LTTCOMM_UST_START_FAIL
;
2818 * Command LTTNG_STOP_TRACE processed by the client thread.
2820 static int cmd_stop_trace(struct ltt_session
*session
)
2823 struct ltt_kernel_channel
*kchan
;
2824 struct ltt_kernel_session
*ksession
;
2825 struct ltt_ust_session
*usess
;
2828 ksession
= session
->kernel_session
;
2829 usess
= session
->ust_session
;
2831 if (!session
->enabled
) {
2832 ret
= LTTCOMM_UST_STOP_FAIL
;
2836 session
->enabled
= 0;
2839 if (ksession
!= NULL
) {
2840 DBG("Stop kernel tracing");
2842 /* Flush all buffers before stopping */
2843 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2845 ERR("Kernel metadata flush failed");
2848 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2849 ret
= kernel_flush_buffer(kchan
);
2851 ERR("Kernel flush buffer error");
2855 ret
= kernel_stop_session(ksession
);
2857 ret
= LTTCOMM_KERN_STOP_FAIL
;
2861 kernel_wait_quiescent(kernel_tracer_fd
);
2865 usess
->start_trace
= 0;
2867 ret
= ust_app_stop_trace_all(usess
);
2869 ret
= LTTCOMM_UST_STOP_FAIL
;
2881 * Command LTTNG_CREATE_SESSION processed by the client thread.
2883 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2887 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2888 LTTNG_SOCK_GET_GID_CRED(creds
));
2889 if (ret
!= LTTCOMM_OK
) {
2900 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2902 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2906 /* Clean kernel session teardown */
2907 teardown_kernel_session(session
);
2908 /* UST session teardown */
2909 teardown_ust_session(session
);
2912 * Must notify the kernel thread here to update it's poll setin order
2913 * to remove the channel(s)' fd just destroyed.
2915 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2917 perror("write kernel poll pipe");
2920 ret
= session_destroy(session
);
2926 * Command LTTNG_CALIBRATE processed by the client thread.
2928 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2933 case LTTNG_DOMAIN_KERNEL
:
2935 struct lttng_kernel_calibrate kcalibrate
;
2937 kcalibrate
.type
= calibrate
->type
;
2938 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2940 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2945 case LTTNG_DOMAIN_UST
:
2947 struct lttng_ust_calibrate ucalibrate
;
2949 ucalibrate
.type
= calibrate
->type
;
2950 ret
= ust_app_calibrate_glb(&ucalibrate
);
2952 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2969 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2971 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2977 case LTTNG_DOMAIN_KERNEL
:
2978 /* Can't register a consumer if there is already one */
2979 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
2980 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2984 sock
= lttcomm_connect_unix_sock(sock_path
);
2986 ret
= LTTCOMM_CONNECT_FAIL
;
2990 session
->kernel_session
->consumer_fd
= sock
;
2993 /* TODO: Userspace tracing */
3005 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3007 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3008 struct lttng_domain
**domains
)
3013 if (session
->kernel_session
!= NULL
) {
3014 DBG3("Listing domains found kernel domain");
3018 if (session
->ust_session
!= NULL
) {
3019 DBG3("Listing domains found UST global domain");
3023 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3024 if (*domains
== NULL
) {
3025 ret
= -LTTCOMM_FATAL
;
3029 if (session
->kernel_session
!= NULL
) {
3030 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3034 if (session
->ust_session
!= NULL
) {
3035 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3046 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3048 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3049 struct lttng_channel
**channels
)
3052 ssize_t nb_chan
= 0;
3055 case LTTNG_DOMAIN_KERNEL
:
3056 if (session
->kernel_session
!= NULL
) {
3057 nb_chan
= session
->kernel_session
->channel_count
;
3059 DBG3("Number of kernel channels %zd", nb_chan
);
3061 case LTTNG_DOMAIN_UST
:
3062 if (session
->ust_session
!= NULL
) {
3063 nb_chan
= lttng_ht_get_count(
3064 session
->ust_session
->domain_global
.channels
);
3066 DBG3("Number of UST global channels %zd", nb_chan
);
3075 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3076 if (*channels
== NULL
) {
3077 ret
= -LTTCOMM_FATAL
;
3081 list_lttng_channels(domain
, session
, *channels
);
3093 * Command LTTNG_LIST_EVENTS processed by the client thread.
3095 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3096 char *channel_name
, struct lttng_event
**events
)
3099 ssize_t nb_event
= 0;
3102 case LTTNG_DOMAIN_KERNEL
:
3103 if (session
->kernel_session
!= NULL
) {
3104 nb_event
= list_lttng_kernel_events(channel_name
,
3105 session
->kernel_session
, events
);
3108 case LTTNG_DOMAIN_UST
:
3110 if (session
->ust_session
!= NULL
) {
3111 nb_event
= list_lttng_ust_global_events(channel_name
,
3112 &session
->ust_session
->domain_global
, events
);
3128 * Process the command requested by the lttng client within the command
3129 * context structure. This function make sure that the return structure (llm)
3130 * is set and ready for transmission before returning.
3132 * Return any error encountered or 0 for success.
3134 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3136 int ret
= LTTCOMM_OK
;
3137 int need_tracing_session
= 1;
3140 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3142 switch (cmd_ctx
->lsm
->cmd_type
) {
3143 case LTTNG_CREATE_SESSION
:
3144 case LTTNG_DESTROY_SESSION
:
3145 case LTTNG_LIST_SESSIONS
:
3146 case LTTNG_LIST_DOMAINS
:
3147 case LTTNG_START_TRACE
:
3148 case LTTNG_STOP_TRACE
:
3155 if (opt_no_kernel
&& need_domain
3156 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3157 ret
= LTTCOMM_KERN_NA
;
3162 * Check for command that don't needs to allocate a returned payload. We do
3163 * this here so we don't have to make the call for no payload at each
3166 switch(cmd_ctx
->lsm
->cmd_type
) {
3167 case LTTNG_LIST_SESSIONS
:
3168 case LTTNG_LIST_TRACEPOINTS
:
3169 case LTTNG_LIST_DOMAINS
:
3170 case LTTNG_LIST_CHANNELS
:
3171 case LTTNG_LIST_EVENTS
:
3174 /* Setup lttng message with no payload */
3175 ret
= setup_lttng_msg(cmd_ctx
, 0);
3177 /* This label does not try to unlock the session */
3178 goto init_setup_error
;
3182 /* Commands that DO NOT need a session. */
3183 switch (cmd_ctx
->lsm
->cmd_type
) {
3184 case LTTNG_CREATE_SESSION
:
3185 case LTTNG_CALIBRATE
:
3186 case LTTNG_LIST_SESSIONS
:
3187 case LTTNG_LIST_TRACEPOINTS
:
3188 need_tracing_session
= 0;
3191 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3192 session_lock_list();
3193 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3194 session_unlock_list();
3195 if (cmd_ctx
->session
== NULL
) {
3196 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3197 ret
= LTTCOMM_SESS_NOT_FOUND
;
3199 /* If no session name specified */
3200 ret
= LTTCOMM_SELECT_SESS
;
3204 /* Acquire lock for the session */
3205 session_lock(cmd_ctx
->session
);
3214 * Check domain type for specific "pre-action".
3216 switch (cmd_ctx
->lsm
->domain
.type
) {
3217 case LTTNG_DOMAIN_KERNEL
:
3219 ret
= LTTCOMM_KERN_NA
;
3223 /* Kernel tracer check */
3224 if (kernel_tracer_fd
== 0) {
3225 /* Basically, load kernel tracer modules */
3226 ret
= init_kernel_tracer();
3232 /* Need a session for kernel command */
3233 if (need_tracing_session
) {
3234 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3235 ret
= create_kernel_session(cmd_ctx
->session
);
3237 ret
= LTTCOMM_KERN_SESS_FAIL
;
3242 /* Start the kernel consumer daemon */
3243 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3244 if (kconsumer_data
.pid
== 0 &&
3245 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3246 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3247 ret
= start_consumerd(&kconsumer_data
);
3249 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3253 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3257 case LTTNG_DOMAIN_UST
:
3259 if (need_tracing_session
) {
3260 if (cmd_ctx
->session
->ust_session
== NULL
) {
3261 ret
= create_ust_session(cmd_ctx
->session
,
3262 &cmd_ctx
->lsm
->domain
);
3263 if (ret
!= LTTCOMM_OK
) {
3267 /* Start the UST consumer daemons */
3269 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3270 if (consumerd64_bin
[0] != '\0' &&
3271 ustconsumer64_data
.pid
== 0 &&
3272 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3273 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3274 ret
= start_consumerd(&ustconsumer64_data
);
3276 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3277 ust_consumerd64_fd
= -EINVAL
;
3281 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3283 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3286 if (consumerd32_bin
[0] != '\0' &&
3287 ustconsumer32_data
.pid
== 0 &&
3288 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3289 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3290 ret
= start_consumerd(&ustconsumer32_data
);
3292 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3293 ust_consumerd32_fd
= -EINVAL
;
3296 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3298 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3309 * Check that the UID or GID match that of the tracing session.
3310 * The root user can interact with all sessions.
3312 if (need_tracing_session
) {
3313 if (!session_access_ok(cmd_ctx
->session
,
3314 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3315 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3316 ret
= LTTCOMM_EPERM
;
3321 /* Process by command type */
3322 switch (cmd_ctx
->lsm
->cmd_type
) {
3323 case LTTNG_ADD_CONTEXT
:
3325 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3326 cmd_ctx
->lsm
->u
.context
.channel_name
,
3327 cmd_ctx
->lsm
->u
.context
.event_name
,
3328 &cmd_ctx
->lsm
->u
.context
.ctx
);
3331 case LTTNG_DISABLE_CHANNEL
:
3333 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3334 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3337 case LTTNG_DISABLE_EVENT
:
3339 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3340 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3341 cmd_ctx
->lsm
->u
.disable
.name
);
3344 case LTTNG_DISABLE_ALL_EVENT
:
3346 DBG("Disabling all events");
3348 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3349 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3352 case LTTNG_ENABLE_CHANNEL
:
3354 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3355 &cmd_ctx
->lsm
->u
.channel
.chan
);
3358 case LTTNG_ENABLE_EVENT
:
3360 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3361 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3362 &cmd_ctx
->lsm
->u
.enable
.event
);
3365 case LTTNG_ENABLE_ALL_EVENT
:
3367 DBG("Enabling all events");
3369 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3370 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3371 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3374 case LTTNG_LIST_TRACEPOINTS
:
3376 struct lttng_event
*events
;
3379 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3380 if (nb_events
< 0) {
3386 * Setup lttng message with payload size set to the event list size in
3387 * bytes and then copy list into the llm payload.
3389 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3395 /* Copy event list into message payload */
3396 memcpy(cmd_ctx
->llm
->payload
, events
,
3397 sizeof(struct lttng_event
) * nb_events
);
3404 case LTTNG_START_TRACE
:
3406 ret
= cmd_start_trace(cmd_ctx
->session
);
3409 case LTTNG_STOP_TRACE
:
3411 ret
= cmd_stop_trace(cmd_ctx
->session
);
3414 case LTTNG_CREATE_SESSION
:
3416 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3417 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3420 case LTTNG_DESTROY_SESSION
:
3422 ret
= cmd_destroy_session(cmd_ctx
->session
,
3423 cmd_ctx
->lsm
->session
.name
);
3426 case LTTNG_LIST_DOMAINS
:
3429 struct lttng_domain
*domains
;
3431 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3437 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3442 /* Copy event list into message payload */
3443 memcpy(cmd_ctx
->llm
->payload
, domains
,
3444 nb_dom
* sizeof(struct lttng_domain
));
3451 case LTTNG_LIST_CHANNELS
:
3454 struct lttng_channel
*channels
;
3456 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3457 cmd_ctx
->session
, &channels
);
3463 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3468 /* Copy event list into message payload */
3469 memcpy(cmd_ctx
->llm
->payload
, channels
,
3470 nb_chan
* sizeof(struct lttng_channel
));
3477 case LTTNG_LIST_EVENTS
:
3480 struct lttng_event
*events
= NULL
;
3482 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3483 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3489 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3494 /* Copy event list into message payload */
3495 memcpy(cmd_ctx
->llm
->payload
, events
,
3496 nb_event
* sizeof(struct lttng_event
));
3503 case LTTNG_LIST_SESSIONS
:
3505 unsigned int nr_sessions
;
3507 session_lock_list();
3508 nr_sessions
= lttng_sessions_count(
3509 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3510 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3512 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3514 session_unlock_list();
3518 /* Filled the session array */
3519 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3520 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3521 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3523 session_unlock_list();
3528 case LTTNG_CALIBRATE
:
3530 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3531 &cmd_ctx
->lsm
->u
.calibrate
);
3534 case LTTNG_REGISTER_CONSUMER
:
3536 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3537 cmd_ctx
->lsm
->u
.reg
.path
);
3546 if (cmd_ctx
->llm
== NULL
) {
3547 DBG("Missing llm structure. Allocating one.");
3548 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3552 /* Set return code */
3553 cmd_ctx
->llm
->ret_code
= ret
;
3555 if (cmd_ctx
->session
) {
3556 session_unlock(cmd_ctx
->session
);
3563 * This thread manage all clients request using the unix client socket for
3566 static void *thread_manage_clients(void *data
)
3568 int sock
= 0, ret
, i
, pollfd
;
3569 uint32_t revents
, nb_fd
;
3570 struct command_ctx
*cmd_ctx
= NULL
;
3571 struct lttng_poll_event events
;
3573 DBG("[thread] Manage client started");
3575 rcu_register_thread();
3577 ret
= lttcomm_listen_unix_sock(client_sock
);
3583 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3584 * more will be added to this poll set.
3586 ret
= create_thread_poll_set(&events
, 2);
3591 /* Add the application registration socket */
3592 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3598 * Notify parent pid that we are ready to accept command for client side.
3600 if (opt_sig_parent
) {
3601 kill(ppid
, SIGUSR1
);
3605 DBG("Accepting client command ...");
3607 nb_fd
= LTTNG_POLL_GETNB(&events
);
3609 /* Inifinite blocking call, waiting for transmission */
3610 ret
= lttng_poll_wait(&events
, -1);
3615 for (i
= 0; i
< nb_fd
; i
++) {
3616 /* Fetch once the poll data */
3617 revents
= LTTNG_POLL_GETEV(&events
, i
);
3618 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3620 /* Thread quit pipe has been closed. Killing thread. */
3621 ret
= check_thread_quit_pipe(pollfd
, revents
);
3626 /* Event on the registration socket */
3627 if (pollfd
== client_sock
) {
3628 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3629 ERR("Client socket poll error");
3635 DBG("Wait for client response");
3637 sock
= lttcomm_accept_unix_sock(client_sock
);
3642 /* Set socket option for credentials retrieval */
3643 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3648 /* Allocate context command to process the client request */
3649 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3650 if (cmd_ctx
== NULL
) {
3651 perror("zmalloc cmd_ctx");
3655 /* Allocate data buffer for reception */
3656 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3657 if (cmd_ctx
->lsm
== NULL
) {
3658 perror("zmalloc cmd_ctx->lsm");
3662 cmd_ctx
->llm
= NULL
;
3663 cmd_ctx
->session
= NULL
;
3666 * Data is received from the lttng client. The struct
3667 * lttcomm_session_msg (lsm) contains the command and data request of
3670 DBG("Receiving data from client ...");
3671 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3672 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3674 DBG("Nothing recv() from client... continuing");
3680 // TODO: Validate cmd_ctx including sanity check for
3681 // security purpose.
3683 rcu_thread_online();
3685 * This function dispatch the work to the kernel or userspace tracer
3686 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3687 * informations for the client. The command context struct contains
3688 * everything this function may needs.
3690 ret
= process_client_msg(cmd_ctx
);
3691 rcu_thread_offline();
3694 * TODO: Inform client somehow of the fatal error. At
3695 * this point, ret < 0 means that a zmalloc failed
3696 * (ENOMEM). Error detected but still accept command.
3698 clean_command_ctx(&cmd_ctx
);
3702 DBG("Sending response (size: %d, retcode: %s)",
3703 cmd_ctx
->lttng_msg_size
,
3704 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3705 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3707 ERR("Failed to send data back to client");
3710 /* End of transmission */
3713 clean_command_ctx(&cmd_ctx
);
3717 DBG("Client thread dying");
3718 unlink(client_unix_sock_path
);
3722 lttng_poll_clean(&events
);
3723 clean_command_ctx(&cmd_ctx
);
3725 rcu_unregister_thread();
3731 * usage function on stderr
3733 static void usage(void)
3735 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3736 fprintf(stderr
, " -h, --help Display this usage.\n");
3737 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3738 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3739 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3740 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3741 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3742 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3743 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3744 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3745 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3746 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3747 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3748 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3749 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3750 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3751 fprintf(stderr
, " -V, --version Show version number.\n");
3752 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3753 fprintf(stderr
, " -q, --quiet No output at all.\n");
3754 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3755 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3756 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3760 * daemon argument parsing
3762 static int parse_args(int argc
, char **argv
)
3766 static struct option long_options
[] = {
3767 { "client-sock", 1, 0, 'c' },
3768 { "apps-sock", 1, 0, 'a' },
3769 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3770 { "kconsumerd-err-sock", 1, 0, 'E' },
3771 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3772 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3773 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3774 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3775 { "consumerd32-path", 1, 0, 'u' },
3776 { "consumerd32-libdir", 1, 0, 'U' },
3777 { "consumerd64-path", 1, 0, 't' },
3778 { "consumerd64-libdir", 1, 0, 'T' },
3779 { "daemonize", 0, 0, 'd' },
3780 { "sig-parent", 0, 0, 'S' },
3781 { "help", 0, 0, 'h' },
3782 { "group", 1, 0, 'g' },
3783 { "version", 0, 0, 'V' },
3784 { "quiet", 0, 0, 'q' },
3785 { "verbose", 0, 0, 'v' },
3786 { "verbose-consumer", 0, 0, 'Z' },
3787 { "no-kernel", 0, 0, 'N' },
3792 int option_index
= 0;
3793 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3794 long_options
, &option_index
);
3801 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3803 fprintf(stderr
, " with arg %s\n", optarg
);
3807 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3810 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3816 opt_tracing_group
= optarg
;
3822 fprintf(stdout
, "%s\n", VERSION
);
3828 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3831 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3834 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3837 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3840 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3843 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3852 /* Verbose level can increase using multiple -v */
3856 opt_verbose_consumer
+= 1;
3859 consumerd32_bin
= optarg
;
3862 consumerd32_libdir
= optarg
;
3865 consumerd64_bin
= optarg
;
3868 consumerd64_libdir
= optarg
;
3871 /* Unknown option or other error.
3872 * Error is printed by getopt, just return */
3881 * Creates the two needed socket by the daemon.
3882 * apps_sock - The communication socket for all UST apps.
3883 * client_sock - The communication of the cli tool (lttng).
3885 static int init_daemon_socket(void)
3890 old_umask
= umask(0);
3892 /* Create client tool unix socket */
3893 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3894 if (client_sock
< 0) {
3895 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3900 /* File permission MUST be 660 */
3901 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3903 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3908 /* Create the application unix socket */
3909 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3910 if (apps_sock
< 0) {
3911 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3916 /* File permission MUST be 666 */
3917 ret
= chmod(apps_unix_sock_path
,
3918 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3920 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3931 * Check if the global socket is available, and if a daemon is answering at the
3932 * other side. If yes, error is returned.
3934 static int check_existing_daemon(void)
3936 /* Is there anybody out there ? */
3937 if (lttng_session_daemon_alive()) {
3945 * Set the tracing group gid onto the client socket.
3947 * Race window between mkdir and chown is OK because we are going from more
3948 * permissive (root.root) to less permissive (root.tracing).
3950 static int set_permissions(char *rundir
)
3955 gid
= allowed_group();
3957 WARN("No tracing group detected");
3962 /* Set lttng run dir */
3963 ret
= chown(rundir
, 0, gid
);
3965 ERR("Unable to set group on %s", rundir
);
3969 /* Ensure tracing group can search the run dir */
3970 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
);
3972 ERR("Unable to set permissions on %s", rundir
);
3976 /* lttng client socket path */
3977 ret
= chown(client_unix_sock_path
, 0, gid
);
3979 ERR("Unable to set group on %s", client_unix_sock_path
);
3983 /* kconsumer error socket path */
3984 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3986 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3990 /* 64-bit ustconsumer error socket path */
3991 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3993 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3997 /* 32-bit ustconsumer compat32 error socket path */
3998 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4000 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4004 DBG("All permissions are set");
4011 * Create the pipe used to wake up the kernel thread.
4013 static int create_kernel_poll_pipe(void)
4017 ret
= pipe(kernel_poll_pipe
);
4019 PERROR("kernel poll pipe");
4023 for (i
= 0; i
< 2; i
++) {
4024 ret
= fcntl(kernel_poll_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4026 PERROR("fcntl kernel_poll_pipe");
4036 * Create the application command pipe to wake thread_manage_apps.
4038 static int create_apps_cmd_pipe(void)
4042 ret
= pipe(apps_cmd_pipe
);
4044 PERROR("apps cmd pipe");
4048 for (i
= 0; i
< 2; i
++) {
4049 ret
= fcntl(apps_cmd_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4051 PERROR("fcntl apps_cmd_pipe");
4061 * Create the lttng run directory needed for all global sockets and pipe.
4063 static int create_lttng_rundir(const char *rundir
)
4067 DBG3("Creating LTTng run directory: %s", rundir
);
4069 ret
= mkdir(rundir
, S_IRWXU
);
4071 if (errno
!= EEXIST
) {
4072 ERR("Unable to create %s", rundir
);
4084 * Setup sockets and directory needed by the kconsumerd communication with the
4087 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4091 char path
[PATH_MAX
];
4093 switch (consumer_data
->type
) {
4094 case LTTNG_CONSUMER_KERNEL
:
4095 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4097 case LTTNG_CONSUMER64_UST
:
4098 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4100 case LTTNG_CONSUMER32_UST
:
4101 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4104 ERR("Consumer type unknown");
4109 DBG2("Creating consumer directory: %s", path
);
4111 ret
= mkdir(path
, S_IRWXU
);
4113 if (errno
!= EEXIST
) {
4114 ERR("Failed to create %s", path
);
4120 /* Create the kconsumerd error unix socket */
4121 consumer_data
->err_sock
=
4122 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4123 if (consumer_data
->err_sock
< 0) {
4124 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4129 /* File permission MUST be 660 */
4130 ret
= chmod(consumer_data
->err_unix_sock_path
,
4131 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4133 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4143 * Signal handler for the daemon
4145 * Simply stop all worker threads, leaving main() return gracefully after
4146 * joining all threads and calling cleanup().
4148 static void sighandler(int sig
)
4152 DBG("SIGPIPE caught");
4155 DBG("SIGINT caught");
4159 DBG("SIGTERM caught");
4168 * Setup signal handler for :
4169 * SIGINT, SIGTERM, SIGPIPE
4171 static int set_signal_handler(void)
4174 struct sigaction sa
;
4177 if ((ret
= sigemptyset(&sigset
)) < 0) {
4178 perror("sigemptyset");
4182 sa
.sa_handler
= sighandler
;
4183 sa
.sa_mask
= sigset
;
4185 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4186 perror("sigaction");
4190 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4191 perror("sigaction");
4195 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4196 perror("sigaction");
4200 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4206 * Set open files limit to unlimited. This daemon can open a large number of
4207 * file descriptors in order to consumer multiple kernel traces.
4209 static void set_ulimit(void)
4214 /* The kernel does not allowed an infinite limit for open files */
4215 lim
.rlim_cur
= 65535;
4216 lim
.rlim_max
= 65535;
4218 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4220 perror("failed to set open files limit");
4227 int main(int argc
, char **argv
)
4231 const char *home_path
;
4233 init_kernel_workarounds();
4235 rcu_register_thread();
4237 /* Create thread quit pipe */
4238 if ((ret
= init_thread_quit_pipe()) < 0) {
4242 setup_consumerd_path();
4244 /* Parse arguments */
4246 if ((ret
= parse_args(argc
, argv
) < 0)) {
4259 /* Check if daemon is UID = 0 */
4260 is_root
= !getuid();
4263 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4265 /* Create global run dir with root access */
4266 ret
= create_lttng_rundir(rundir
);
4271 if (strlen(apps_unix_sock_path
) == 0) {
4272 snprintf(apps_unix_sock_path
, PATH_MAX
,
4273 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4276 if (strlen(client_unix_sock_path
) == 0) {
4277 snprintf(client_unix_sock_path
, PATH_MAX
,
4278 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4281 /* Set global SHM for ust */
4282 if (strlen(wait_shm_path
) == 0) {
4283 snprintf(wait_shm_path
, PATH_MAX
,
4284 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4287 /* Setup kernel consumerd path */
4288 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4289 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4290 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4291 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4293 DBG2("Kernel consumer err path: %s",
4294 kconsumer_data
.err_unix_sock_path
);
4295 DBG2("Kernel consumer cmd path: %s",
4296 kconsumer_data
.cmd_unix_sock_path
);
4298 home_path
= get_home_dir();
4299 if (home_path
== NULL
) {
4300 /* TODO: Add --socket PATH option */
4301 ERR("Can't get HOME directory for sockets creation.");
4307 * Create rundir from home path. This will create something like
4310 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4316 ret
= create_lttng_rundir(rundir
);
4321 if (strlen(apps_unix_sock_path
) == 0) {
4322 snprintf(apps_unix_sock_path
, PATH_MAX
,
4323 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4326 /* Set the cli tool unix socket path */
4327 if (strlen(client_unix_sock_path
) == 0) {
4328 snprintf(client_unix_sock_path
, PATH_MAX
,
4329 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4332 /* Set global SHM for ust */
4333 if (strlen(wait_shm_path
) == 0) {
4334 snprintf(wait_shm_path
, PATH_MAX
,
4335 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4339 DBG("Client socket path %s", client_unix_sock_path
);
4340 DBG("Application socket path %s", apps_unix_sock_path
);
4341 DBG("LTTng run directory path: %s", rundir
);
4343 /* 32 bits consumerd path setup */
4344 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4345 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4346 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4347 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4349 DBG2("UST consumer 32 bits err path: %s",
4350 ustconsumer32_data
.err_unix_sock_path
);
4351 DBG2("UST consumer 32 bits cmd path: %s",
4352 ustconsumer32_data
.cmd_unix_sock_path
);
4354 /* 64 bits consumerd path setup */
4355 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4356 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4357 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4358 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4360 DBG2("UST consumer 64 bits err path: %s",
4361 ustconsumer64_data
.err_unix_sock_path
);
4362 DBG2("UST consumer 64 bits cmd path: %s",
4363 ustconsumer64_data
.cmd_unix_sock_path
);
4366 * See if daemon already exist.
4368 if ((ret
= check_existing_daemon()) < 0) {
4369 ERR("Already running daemon.\n");
4371 * We do not goto exit because we must not cleanup()
4372 * because a daemon is already running.
4377 /* After this point, we can safely call cleanup() with "goto exit" */
4380 * These actions must be executed as root. We do that *after* setting up
4381 * the sockets path because we MUST make the check for another daemon using
4382 * those paths *before* trying to set the kernel consumer sockets and init
4386 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4391 /* Setup kernel tracer */
4392 if (!opt_no_kernel
) {
4393 init_kernel_tracer();
4396 /* Set ulimit for open files */
4400 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4405 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4410 if ((ret
= set_signal_handler()) < 0) {
4414 /* Setup the needed unix socket */
4415 if ((ret
= init_daemon_socket()) < 0) {
4419 /* Set credentials to socket */
4420 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4424 /* Get parent pid if -S, --sig-parent is specified. */
4425 if (opt_sig_parent
) {
4429 /* Setup the kernel pipe for waking up the kernel thread */
4430 if ((ret
= create_kernel_poll_pipe()) < 0) {
4434 /* Setup the thread apps communication pipe. */
4435 if ((ret
= create_apps_cmd_pipe()) < 0) {
4439 /* Init UST command queue. */
4440 cds_wfq_init(&ust_cmd_queue
.queue
);
4442 /* Init UST app hash table */
4446 * Get session list pointer. This pointer MUST NOT be free(). This list is
4447 * statically declared in session.c
4449 session_list_ptr
= session_get_list();
4451 /* Set up max poll set size */
4452 lttng_poll_set_max_size();
4454 /* Create thread to manage the client socket */
4455 ret
= pthread_create(&client_thread
, NULL
,
4456 thread_manage_clients
, (void *) NULL
);
4458 perror("pthread_create clients");
4462 /* Create thread to dispatch registration */
4463 ret
= pthread_create(&dispatch_thread
, NULL
,
4464 thread_dispatch_ust_registration
, (void *) NULL
);
4466 perror("pthread_create dispatch");
4470 /* Create thread to manage application registration. */
4471 ret
= pthread_create(®_apps_thread
, NULL
,
4472 thread_registration_apps
, (void *) NULL
);
4474 perror("pthread_create registration");
4478 /* Create thread to manage application socket */
4479 ret
= pthread_create(&apps_thread
, NULL
,
4480 thread_manage_apps
, (void *) NULL
);
4482 perror("pthread_create apps");
4486 /* Create kernel thread to manage kernel event */
4487 ret
= pthread_create(&kernel_thread
, NULL
,
4488 thread_manage_kernel
, (void *) NULL
);
4490 perror("pthread_create kernel");
4494 ret
= pthread_join(kernel_thread
, &status
);
4496 perror("pthread_join");
4497 goto error
; /* join error, exit without cleanup */
4501 ret
= pthread_join(apps_thread
, &status
);
4503 perror("pthread_join");
4504 goto error
; /* join error, exit without cleanup */
4508 ret
= pthread_join(reg_apps_thread
, &status
);
4510 perror("pthread_join");
4511 goto error
; /* join error, exit without cleanup */
4515 ret
= pthread_join(dispatch_thread
, &status
);
4517 perror("pthread_join");
4518 goto error
; /* join error, exit without cleanup */
4522 ret
= pthread_join(client_thread
, &status
);
4524 perror("pthread_join");
4525 goto error
; /* join error, exit without cleanup */
4528 ret
= join_consumer_thread(&kconsumer_data
);
4530 perror("join_consumer");
4531 goto error
; /* join error, exit without cleanup */
4537 * cleanup() is called when no other thread is running.
4539 rcu_thread_online();
4541 rcu_thread_offline();
4542 rcu_unregister_thread();