2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <common/common.h>
42 #include <common/compat/poll.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
58 #define CONSUMERD_FILE "lttng-consumerd"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
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
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
302 perror("thread quit pipe");
311 * Complete teardown of a kernel session. This free all data structure related
312 * to a kernel session and update counter.
314 static void teardown_kernel_session(struct ltt_session
*session
)
316 if (!session
->kernel_session
) {
317 DBG3("No kernel session when tearing down session");
321 DBG("Tearing down kernel session");
324 * If a custom kernel consumer was registered, close the socket before
325 * tearing down the complete kernel session structure
327 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
328 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
331 trace_kernel_destroy_session(session
->kernel_session
);
335 * Complete teardown of all UST sessions. This will free everything on his path
336 * and destroy the core essence of all ust sessions :)
338 static void teardown_ust_session(struct ltt_session
*session
)
342 if (!session
->ust_session
) {
343 DBG3("No UST session when tearing down session");
347 DBG("Tearing down UST session(s)");
349 ret
= ust_app_destroy_trace_all(session
->ust_session
);
351 ERR("Error in ust_app_destroy_trace_all");
354 trace_ust_destroy_session(session
->ust_session
);
358 * Stop all threads by closing the thread quit pipe.
360 static void stop_threads(void)
364 /* Stopping all threads */
365 DBG("Terminating all threads");
366 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
368 ERR("write error on thread quit pipe");
371 /* Dispatch thread */
372 dispatch_thread_exit
= 1;
373 futex_nto1_wake(&ust_cmd_queue
.futex
);
379 static void cleanup(void)
383 struct ltt_session
*sess
, *stmp
;
387 DBG("Removing %s directory", rundir
);
388 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
390 ERR("asprintf failed. Something is really wrong!");
393 /* Remove lttng run directory */
396 ERR("Unable to clean %s", rundir
);
400 DBG("Cleaning up all sessions");
402 /* Destroy session list mutex */
403 if (session_list_ptr
!= NULL
) {
404 pthread_mutex_destroy(&session_list_ptr
->lock
);
406 /* Cleanup ALL session */
407 cds_list_for_each_entry_safe(sess
, stmp
,
408 &session_list_ptr
->head
, list
) {
409 teardown_kernel_session(sess
);
410 teardown_ust_session(sess
);
415 DBG("Closing all UST sockets");
416 ust_app_clean_list();
418 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
420 if (is_root
&& !opt_no_kernel
) {
421 DBG2("Closing kernel fd");
422 close(kernel_tracer_fd
);
423 DBG("Unloading kernel modules");
424 modprobe_remove_lttng_all();
427 close(thread_quit_pipe
[0]);
428 close(thread_quit_pipe
[1]);
431 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
432 "Matthew, BEET driven development works!%c[%dm",
433 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
438 * Send data on a unix socket using the liblttsessiondcomm API.
440 * Return lttcomm error code.
442 static int send_unix_sock(int sock
, void *buf
, size_t len
)
444 /* Check valid length */
449 return lttcomm_send_unix_sock(sock
, buf
, len
);
453 * Free memory of a command context structure.
455 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
457 DBG("Clean command context structure");
459 if ((*cmd_ctx
)->llm
) {
460 free((*cmd_ctx
)->llm
);
462 if ((*cmd_ctx
)->lsm
) {
463 free((*cmd_ctx
)->lsm
);
471 * Send all stream fds of kernel channel to the consumer.
473 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
474 int sock
, struct ltt_kernel_channel
*channel
,
475 uid_t uid
, gid_t gid
)
478 struct ltt_kernel_stream
*stream
;
479 struct lttcomm_consumer_msg lkm
;
481 DBG("Sending streams of channel %s to kernel consumer",
482 channel
->channel
->name
);
485 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
486 lkm
.u
.channel
.channel_key
= channel
->fd
;
487 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
488 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
489 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
490 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
492 perror("send consumer channel");
497 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
501 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
502 lkm
.u
.stream
.channel_key
= channel
->fd
;
503 lkm
.u
.stream
.stream_key
= stream
->fd
;
504 lkm
.u
.stream
.state
= stream
->state
;
505 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
506 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
507 lkm
.u
.stream
.uid
= uid
;
508 lkm
.u
.stream
.gid
= gid
;
509 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
510 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
511 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
512 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
514 perror("send consumer stream");
517 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
519 perror("send consumer stream ancillary data");
524 DBG("consumer channel streams sent");
533 * Send all stream fds of the kernel session to the consumer.
535 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
536 struct ltt_kernel_session
*session
)
539 struct ltt_kernel_channel
*chan
;
540 struct lttcomm_consumer_msg lkm
;
541 int sock
= session
->consumer_fd
;
543 DBG("Sending metadata stream fd");
545 /* Extra protection. It's NOT supposed to be set to 0 at this point */
546 if (session
->consumer_fd
== 0) {
547 session
->consumer_fd
= consumer_data
->cmd_sock
;
550 if (session
->metadata_stream_fd
!= 0) {
551 /* Send metadata channel fd */
552 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
553 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
554 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
555 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
556 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
557 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
559 perror("send consumer channel");
563 /* Send metadata stream fd */
564 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
565 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
566 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
567 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
568 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
569 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
570 lkm
.u
.stream
.uid
= session
->uid
;
571 lkm
.u
.stream
.gid
= session
->gid
;
572 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
573 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
574 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
575 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
577 perror("send consumer stream");
580 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
582 perror("send consumer stream");
587 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
588 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
589 session
->uid
, session
->gid
);
595 DBG("consumer fds (metadata and channel streams) sent");
604 * Notify UST applications using the shm mmap futex.
606 static int notify_ust_apps(int active
)
610 DBG("Notifying applications of session daemon state: %d", active
);
612 /* See shm.c for this call implying mmap, shm and futex calls */
613 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
614 if (wait_shm_mmap
== NULL
) {
618 /* Wake waiting process */
619 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
621 /* Apps notified successfully */
629 * Setup the outgoing data buffer for the response (llm) by allocating the
630 * right amount of memory and copying the original information from the lsm
633 * Return total size of the buffer pointed by buf.
635 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
641 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
642 if (cmd_ctx
->llm
== NULL
) {
648 /* Copy common data */
649 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
650 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
652 cmd_ctx
->llm
->data_size
= size
;
653 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
662 * Update the kernel poll set of all channel fd available over all tracing
663 * session. Add the wakeup pipe at the end of the set.
665 static int update_kernel_poll(struct lttng_poll_event
*events
)
668 struct ltt_session
*session
;
669 struct ltt_kernel_channel
*channel
;
671 DBG("Updating kernel poll set");
674 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
675 session_lock(session
);
676 if (session
->kernel_session
== NULL
) {
677 session_unlock(session
);
681 cds_list_for_each_entry(channel
,
682 &session
->kernel_session
->channel_list
.head
, list
) {
683 /* Add channel fd to the kernel poll set */
684 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
686 session_unlock(session
);
689 DBG("Channel fd %d added to kernel set", channel
->fd
);
691 session_unlock(session
);
693 session_unlock_list();
698 session_unlock_list();
703 * Find the channel fd from 'fd' over all tracing session. When found, check
704 * for new channel stream and send those stream fds to the kernel consumer.
706 * Useful for CPU hotplug feature.
708 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
711 struct ltt_session
*session
;
712 struct ltt_kernel_channel
*channel
;
714 DBG("Updating kernel streams for channel fd %d", fd
);
717 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
718 session_lock(session
);
719 if (session
->kernel_session
== NULL
) {
720 session_unlock(session
);
724 /* This is not suppose to be 0 but this is an extra security check */
725 if (session
->kernel_session
->consumer_fd
== 0) {
726 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
729 cds_list_for_each_entry(channel
,
730 &session
->kernel_session
->channel_list
.head
, list
) {
731 if (channel
->fd
== fd
) {
732 DBG("Channel found, updating kernel streams");
733 ret
= kernel_open_channel_stream(channel
);
739 * Have we already sent fds to the consumer? If yes, it means
740 * that tracing is started so it is safe to send our updated
743 if (session
->kernel_session
->consumer_fds_sent
== 1) {
744 ret
= send_kconsumer_channel_streams(consumer_data
,
745 session
->kernel_session
->consumer_fd
, channel
,
746 session
->uid
, session
->gid
);
754 session_unlock(session
);
756 session_unlock_list();
760 session_unlock(session
);
761 session_unlock_list();
766 * For each tracing session, update newly registered apps.
768 static void update_ust_app(int app_sock
)
770 struct ltt_session
*sess
, *stmp
;
774 /* For all tracing session(s) */
775 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
777 if (sess
->ust_session
) {
778 ust_app_global_update(sess
->ust_session
, app_sock
);
780 session_unlock(sess
);
783 session_unlock_list();
787 * This thread manage event coming from the kernel.
789 * Features supported in this thread:
792 static void *thread_manage_kernel(void *data
)
794 int ret
, i
, pollfd
, update_poll_flag
= 1;
795 uint32_t revents
, nb_fd
;
797 struct lttng_poll_event events
;
799 DBG("Thread manage kernel started");
801 ret
= create_thread_poll_set(&events
, 2);
806 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
812 if (update_poll_flag
== 1) {
814 * Reset number of fd in the poll set. Always 2 since there is the thread
815 * quit pipe and the kernel pipe.
819 ret
= update_kernel_poll(&events
);
823 update_poll_flag
= 0;
826 nb_fd
= LTTNG_POLL_GETNB(&events
);
828 DBG("Thread kernel polling on %d fds", nb_fd
);
830 /* Zeroed the poll events */
831 lttng_poll_reset(&events
);
833 /* Poll infinite value of time */
834 ret
= lttng_poll_wait(&events
, -1);
837 } else if (ret
== 0) {
838 /* Should not happen since timeout is infinite */
839 ERR("Return value of poll is 0 with an infinite timeout.\n"
840 "This should not have happened! Continuing...");
844 for (i
= 0; i
< nb_fd
; i
++) {
845 /* Fetch once the poll data */
846 revents
= LTTNG_POLL_GETEV(&events
, i
);
847 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
849 /* Thread quit pipe has been closed. Killing thread. */
850 ret
= check_thread_quit_pipe(pollfd
, revents
);
855 /* Check for data on kernel pipe */
856 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
857 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
858 update_poll_flag
= 1;
862 * New CPU detected by the kernel. Adding kernel stream to
863 * kernel session and updating the kernel consumer
865 if (revents
& LPOLLIN
) {
866 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
872 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
873 * and unregister kernel stream at this point.
881 DBG("Kernel thread dying");
882 close(kernel_poll_pipe
[0]);
883 close(kernel_poll_pipe
[1]);
885 lttng_poll_clean(&events
);
891 * This thread manage the consumer error sent back to the session daemon.
893 static void *thread_manage_consumer(void *data
)
895 int sock
= 0, i
, ret
, pollfd
;
896 uint32_t revents
, nb_fd
;
897 enum lttcomm_return_code code
;
898 struct lttng_poll_event events
;
899 struct consumer_data
*consumer_data
= data
;
901 DBG("[thread] Manage consumer started");
903 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
909 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
910 * Nothing more will be added to this poll set.
912 ret
= create_thread_poll_set(&events
, 2);
917 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
922 nb_fd
= LTTNG_POLL_GETNB(&events
);
924 /* Inifinite blocking call, waiting for transmission */
925 ret
= lttng_poll_wait(&events
, -1);
930 for (i
= 0; i
< nb_fd
; i
++) {
931 /* Fetch once the poll data */
932 revents
= LTTNG_POLL_GETEV(&events
, i
);
933 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
935 /* Thread quit pipe has been closed. Killing thread. */
936 ret
= check_thread_quit_pipe(pollfd
, revents
);
941 /* Event on the registration socket */
942 if (pollfd
== consumer_data
->err_sock
) {
943 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
944 ERR("consumer err socket poll error");
950 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
955 DBG2("Receiving code from consumer err_sock");
957 /* Getting status code from kconsumerd */
958 ret
= lttcomm_recv_unix_sock(sock
, &code
,
959 sizeof(enum lttcomm_return_code
));
964 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
965 consumer_data
->cmd_sock
=
966 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
967 if (consumer_data
->cmd_sock
< 0) {
968 sem_post(&consumer_data
->sem
);
969 PERROR("consumer connect");
972 /* Signal condition to tell that the kconsumerd is ready */
973 sem_post(&consumer_data
->sem
);
974 DBG("consumer command socket ready");
976 ERR("consumer error when waiting for SOCK_READY : %s",
977 lttcomm_get_readable_code(-code
));
981 /* Remove the kconsumerd error sock since we've established a connexion */
982 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
987 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
992 /* Update number of fd */
993 nb_fd
= LTTNG_POLL_GETNB(&events
);
995 /* Inifinite blocking call, waiting for transmission */
996 ret
= lttng_poll_wait(&events
, -1);
1001 for (i
= 0; i
< nb_fd
; i
++) {
1002 /* Fetch once the poll data */
1003 revents
= LTTNG_POLL_GETEV(&events
, i
);
1004 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1006 /* Thread quit pipe has been closed. Killing thread. */
1007 ret
= check_thread_quit_pipe(pollfd
, revents
);
1012 /* Event on the kconsumerd socket */
1013 if (pollfd
== sock
) {
1014 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1015 ERR("consumer err socket second poll error");
1021 /* Wait for any kconsumerd error */
1022 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1023 sizeof(enum lttcomm_return_code
));
1025 ERR("consumer closed the command socket");
1029 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1032 DBG("consumer thread dying");
1033 close(consumer_data
->err_sock
);
1034 close(consumer_data
->cmd_sock
);
1037 unlink(consumer_data
->err_unix_sock_path
);
1038 unlink(consumer_data
->cmd_unix_sock_path
);
1039 consumer_data
->pid
= 0;
1041 lttng_poll_clean(&events
);
1047 * This thread manage application communication.
1049 static void *thread_manage_apps(void *data
)
1052 uint32_t revents
, nb_fd
;
1053 struct ust_command ust_cmd
;
1054 struct lttng_poll_event events
;
1056 DBG("[thread] Manage application started");
1058 rcu_register_thread();
1059 rcu_thread_online();
1061 ret
= create_thread_poll_set(&events
, 2);
1066 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1072 /* Zeroed the events structure */
1073 lttng_poll_reset(&events
);
1075 nb_fd
= LTTNG_POLL_GETNB(&events
);
1077 DBG("Apps thread polling on %d fds", nb_fd
);
1079 /* Inifinite blocking call, waiting for transmission */
1080 ret
= lttng_poll_wait(&events
, -1);
1085 for (i
= 0; i
< nb_fd
; i
++) {
1086 /* Fetch once the poll data */
1087 revents
= LTTNG_POLL_GETEV(&events
, i
);
1088 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1090 /* Thread quit pipe has been closed. Killing thread. */
1091 ret
= check_thread_quit_pipe(pollfd
, revents
);
1096 /* Inspect the apps cmd pipe */
1097 if (pollfd
== apps_cmd_pipe
[0]) {
1098 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1099 ERR("Apps command pipe error");
1101 } else if (revents
& LPOLLIN
) {
1103 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1104 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1105 perror("read apps cmd pipe");
1109 /* Register applicaton to the session daemon */
1110 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1112 if (ret
== -ENOMEM
) {
1114 } else if (ret
< 0) {
1119 * Validate UST version compatibility.
1121 ret
= ust_app_validate_version(ust_cmd
.sock
);
1124 * Add channel(s) and event(s) to newly registered apps
1125 * from lttng global UST domain.
1127 update_ust_app(ust_cmd
.sock
);
1130 ret
= ust_app_register_done(ust_cmd
.sock
);
1133 * If the registration is not possible, we simply
1134 * unregister the apps and continue
1136 ust_app_unregister(ust_cmd
.sock
);
1139 * We just need here to monitor the close of the UST
1140 * socket and poll set monitor those by default.
1142 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1147 DBG("Apps with sock %d added to poll set",
1155 * At this point, we know that a registered application made
1156 * the event at poll_wait.
1158 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1159 /* Removing from the poll set */
1160 ret
= lttng_poll_del(&events
, pollfd
);
1165 /* Socket closed on remote end. */
1166 ust_app_unregister(pollfd
);
1174 DBG("Application communication apps dying");
1175 close(apps_cmd_pipe
[0]);
1176 close(apps_cmd_pipe
[1]);
1178 lttng_poll_clean(&events
);
1180 rcu_thread_offline();
1181 rcu_unregister_thread();
1186 * Dispatch request from the registration threads to the application
1187 * communication thread.
1189 static void *thread_dispatch_ust_registration(void *data
)
1192 struct cds_wfq_node
*node
;
1193 struct ust_command
*ust_cmd
= NULL
;
1195 DBG("[thread] Dispatch UST command started");
1197 while (!dispatch_thread_exit
) {
1198 /* Atomically prepare the queue futex */
1199 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1202 /* Dequeue command for registration */
1203 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1205 DBG("Woken up but nothing in the UST command queue");
1206 /* Continue thread execution */
1210 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1212 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1213 " gid:%d sock:%d name:%s (version %d.%d)",
1214 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1215 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1216 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1217 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1219 * Inform apps thread of the new application registration. This
1220 * call is blocking so we can be assured that the data will be read
1221 * at some point in time or wait to the end of the world :)
1223 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1224 sizeof(struct ust_command
));
1226 perror("write apps cmd pipe");
1227 if (errno
== EBADF
) {
1229 * We can't inform the application thread to process
1230 * registration. We will exit or else application
1231 * registration will not occur and tracing will never
1238 } while (node
!= NULL
);
1240 /* Futex wait on queue. Blocking call on futex() */
1241 futex_nto1_wait(&ust_cmd_queue
.futex
);
1245 DBG("Dispatch thread dying");
1250 * This thread manage application registration.
1252 static void *thread_registration_apps(void *data
)
1254 int sock
= 0, i
, ret
, pollfd
;
1255 uint32_t revents
, nb_fd
;
1256 struct lttng_poll_event events
;
1258 * Get allocated in this thread, enqueued to a global queue, dequeued and
1259 * freed in the manage apps thread.
1261 struct ust_command
*ust_cmd
= NULL
;
1263 DBG("[thread] Manage application registration started");
1265 ret
= lttcomm_listen_unix_sock(apps_sock
);
1271 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1272 * more will be added to this poll set.
1274 ret
= create_thread_poll_set(&events
, 2);
1279 /* Add the application registration socket */
1280 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1285 /* Notify all applications to register */
1286 ret
= notify_ust_apps(1);
1288 ERR("Failed to notify applications or create the wait shared memory.\n"
1289 "Execution continues but there might be problem for already\n"
1290 "running applications that wishes to register.");
1294 DBG("Accepting application registration");
1296 nb_fd
= LTTNG_POLL_GETNB(&events
);
1298 /* Inifinite blocking call, waiting for transmission */
1299 ret
= lttng_poll_wait(&events
, -1);
1304 for (i
= 0; i
< nb_fd
; i
++) {
1305 /* Fetch once the poll data */
1306 revents
= LTTNG_POLL_GETEV(&events
, i
);
1307 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1309 /* Thread quit pipe has been closed. Killing thread. */
1310 ret
= check_thread_quit_pipe(pollfd
, revents
);
1315 /* Event on the registration socket */
1316 if (pollfd
== apps_sock
) {
1317 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1318 ERR("Register apps socket poll error");
1320 } else if (revents
& LPOLLIN
) {
1321 sock
= lttcomm_accept_unix_sock(apps_sock
);
1326 /* Create UST registration command for enqueuing */
1327 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1328 if (ust_cmd
== NULL
) {
1329 perror("ust command zmalloc");
1334 * Using message-based transmissions to ensure we don't
1335 * have to deal with partially received messages.
1337 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1338 sizeof(struct ust_register_msg
));
1339 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1341 perror("lttcomm_recv_unix_sock register apps");
1343 ERR("Wrong size received on apps register");
1350 ust_cmd
->sock
= sock
;
1352 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1353 " gid:%d sock:%d name:%s (version %d.%d)",
1354 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1355 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1356 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1357 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1360 * Lock free enqueue the registration request. The red pill
1361 * has been taken! This apps will be part of the *system*.
1363 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1366 * Wake the registration queue futex. Implicit memory
1367 * barrier with the exchange in cds_wfq_enqueue.
1369 futex_nto1_wake(&ust_cmd_queue
.futex
);
1376 DBG("UST Registration thread dying");
1378 /* Notify that the registration thread is gone */
1383 unlink(apps_unix_sock_path
);
1385 lttng_poll_clean(&events
);
1391 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1392 * exec or it will fails.
1394 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1397 struct timespec timeout
;
1399 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1400 timeout
.tv_nsec
= 0;
1402 /* Setup semaphore */
1403 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1405 PERROR("sem_init consumer semaphore");
1409 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1410 thread_manage_consumer
, consumer_data
);
1412 PERROR("pthread_create consumer");
1417 /* Get time for sem_timedwait absolute timeout */
1418 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1420 PERROR("clock_gettime spawn consumer");
1421 /* Infinite wait for the kconsumerd thread to be ready */
1422 ret
= sem_wait(&consumer_data
->sem
);
1424 /* Normal timeout if the gettime was successful */
1425 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1426 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1430 if (errno
== ETIMEDOUT
) {
1432 * Call has timed out so we kill the kconsumerd_thread and return
1435 ERR("The consumer thread was never ready. Killing it");
1436 ret
= pthread_cancel(consumer_data
->thread
);
1438 PERROR("pthread_cancel consumer thread");
1441 PERROR("semaphore wait failed consumer thread");
1446 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1447 if (consumer_data
->pid
== 0) {
1448 ERR("Kconsumerd did not start");
1449 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1452 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1461 * Join consumer thread
1463 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1468 if (consumer_data
->pid
!= 0) {
1469 ret
= kill(consumer_data
->pid
, SIGTERM
);
1471 ERR("Error killing consumer daemon");
1474 return pthread_join(consumer_data
->thread
, &status
);
1481 * Fork and exec a consumer daemon (consumerd).
1483 * Return pid if successful else -1.
1485 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1489 const char *consumer_to_use
;
1490 const char *verbosity
;
1493 DBG("Spawning consumerd");
1500 if (opt_verbose_consumer
) {
1501 verbosity
= "--verbose";
1503 verbosity
= "--quiet";
1505 switch (consumer_data
->type
) {
1506 case LTTNG_CONSUMER_KERNEL
:
1508 * Find out which consumerd to execute. We will first try the
1509 * 64-bit path, then the sessiond's installation directory, and
1510 * fallback on the 32-bit one,
1512 DBG3("Looking for a kernel consumer at these locations:");
1513 DBG3(" 1) %s", consumerd64_bin
);
1514 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1515 DBG3(" 3) %s", consumerd32_bin
);
1516 if (stat(consumerd64_bin
, &st
) == 0) {
1517 DBG3("Found location #1");
1518 consumer_to_use
= consumerd64_bin
;
1519 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1520 DBG3("Found location #2");
1521 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1522 } else if (stat(consumerd32_bin
, &st
) == 0) {
1523 DBG3("Found location #3");
1524 consumer_to_use
= consumerd32_bin
;
1526 DBG("Could not find any valid consumerd executable");
1529 DBG("Using kernel consumer at: %s", consumer_to_use
);
1530 execl(consumer_to_use
,
1531 "lttng-consumerd", verbosity
, "-k",
1532 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1533 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1536 case LTTNG_CONSUMER64_UST
:
1538 char *tmpnew
= NULL
;
1540 if (consumerd64_libdir
[0] != '\0') {
1544 tmp
= getenv("LD_LIBRARY_PATH");
1548 tmplen
= strlen("LD_LIBRARY_PATH=")
1549 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1550 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1555 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1556 strcat(tmpnew
, consumerd64_libdir
);
1557 if (tmp
[0] != '\0') {
1558 strcat(tmpnew
, ":");
1559 strcat(tmpnew
, tmp
);
1561 ret
= putenv(tmpnew
);
1567 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1568 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1569 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1570 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1572 if (consumerd64_libdir
[0] != '\0') {
1580 case LTTNG_CONSUMER32_UST
:
1582 char *tmpnew
= NULL
;
1584 if (consumerd32_libdir
[0] != '\0') {
1588 tmp
= getenv("LD_LIBRARY_PATH");
1592 tmplen
= strlen("LD_LIBRARY_PATH=")
1593 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1594 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1599 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1600 strcat(tmpnew
, consumerd32_libdir
);
1601 if (tmp
[0] != '\0') {
1602 strcat(tmpnew
, ":");
1603 strcat(tmpnew
, tmp
);
1605 ret
= putenv(tmpnew
);
1611 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1612 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1613 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1614 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1616 if (consumerd32_libdir
[0] != '\0') {
1625 perror("unknown consumer type");
1629 perror("kernel start consumer exec");
1632 } else if (pid
> 0) {
1635 perror("start consumer fork");
1643 * Spawn the consumerd daemon and session daemon thread.
1645 static int start_consumerd(struct consumer_data
*consumer_data
)
1649 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1650 if (consumer_data
->pid
!= 0) {
1651 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1655 ret
= spawn_consumerd(consumer_data
);
1657 ERR("Spawning consumerd failed");
1658 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1662 /* Setting up the consumer_data pid */
1663 consumer_data
->pid
= ret
;
1664 DBG2("Consumer pid %d", consumer_data
->pid
);
1665 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1667 DBG2("Spawning consumer control thread");
1668 ret
= spawn_consumer_thread(consumer_data
);
1670 ERR("Fatal error spawning consumer control thread");
1682 * Check version of the lttng-modules.
1684 static int validate_lttng_modules_version(void)
1686 return kernel_validate_version(kernel_tracer_fd
);
1690 * Setup necessary data for kernel tracer action.
1692 static int init_kernel_tracer(void)
1696 /* Modprobe lttng kernel modules */
1697 ret
= modprobe_lttng_control();
1702 /* Open debugfs lttng */
1703 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1704 if (kernel_tracer_fd
< 0) {
1705 DBG("Failed to open %s", module_proc_lttng
);
1710 /* Validate kernel version */
1711 ret
= validate_lttng_modules_version();
1716 ret
= modprobe_lttng_data();
1721 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1725 modprobe_remove_lttng_control();
1726 close(kernel_tracer_fd
);
1727 kernel_tracer_fd
= 0;
1728 return LTTCOMM_KERN_VERSION
;
1731 close(kernel_tracer_fd
);
1734 modprobe_remove_lttng_control();
1737 WARN("No kernel tracer available");
1738 kernel_tracer_fd
= 0;
1739 return LTTCOMM_KERN_NA
;
1743 * Init tracing by creating trace directory and sending fds kernel consumer.
1745 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1749 if (session
->consumer_fds_sent
== 0) {
1751 * Assign default kernel consumer socket if no consumer assigned to the
1752 * kernel session. At this point, it's NOT suppose to be 0 but this is
1753 * an extra security check.
1755 if (session
->consumer_fd
== 0) {
1756 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1759 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1761 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1765 session
->consumer_fds_sent
= 1;
1773 * Create an UST session and add it to the session ust list.
1775 static int create_ust_session(struct ltt_session
*session
,
1776 struct lttng_domain
*domain
)
1778 struct ltt_ust_session
*lus
= NULL
;
1781 switch (domain
->type
) {
1782 case LTTNG_DOMAIN_UST
:
1785 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1789 DBG("Creating UST session");
1791 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1793 ret
= LTTCOMM_UST_SESS_FAIL
;
1797 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1798 session
->uid
, session
->gid
);
1800 if (ret
!= -EEXIST
) {
1801 ERR("Trace directory creation error");
1802 ret
= LTTCOMM_UST_SESS_FAIL
;
1807 /* The domain type dictate different actions on session creation */
1808 switch (domain
->type
) {
1809 case LTTNG_DOMAIN_UST
:
1810 /* No ustctl for the global UST domain */
1813 ERR("Unknown UST domain on create session %d", domain
->type
);
1816 lus
->uid
= session
->uid
;
1817 lus
->gid
= session
->gid
;
1818 session
->ust_session
= lus
;
1828 * Create a kernel tracer session then create the default channel.
1830 static int create_kernel_session(struct ltt_session
*session
)
1834 DBG("Creating kernel session");
1836 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1838 ret
= LTTCOMM_KERN_SESS_FAIL
;
1842 /* Set kernel consumer socket fd */
1843 if (kconsumer_data
.cmd_sock
) {
1844 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1847 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1848 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1850 if (ret
!= -EEXIST
) {
1851 ERR("Trace directory creation error");
1855 session
->kernel_session
->uid
= session
->uid
;
1856 session
->kernel_session
->gid
= session
->gid
;
1863 * Check if the UID or GID match the session. Root user has access to all
1866 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1868 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1875 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1878 struct ltt_session
*session
;
1880 DBG("Counting number of available session for UID %d GID %d",
1882 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1884 * Only list the sessions the user can control.
1886 if (!session_access_ok(session
, uid
, gid
)) {
1895 * Using the session list, filled a lttng_session array to send back to the
1896 * client for session listing.
1898 * The session list lock MUST be acquired before calling this function. Use
1899 * session_lock_list() and session_unlock_list().
1901 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1905 struct ltt_session
*session
;
1907 DBG("Getting all available session for UID %d GID %d",
1910 * Iterate over session list and append data after the control struct in
1913 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1915 * Only list the sessions the user can control.
1917 if (!session_access_ok(session
, uid
, gid
)) {
1920 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1921 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1922 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1923 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1924 sessions
[i
].enabled
= session
->enabled
;
1930 * Fill lttng_channel array of all channels.
1932 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1933 struct lttng_channel
*channels
)
1936 struct ltt_kernel_channel
*kchan
;
1938 DBG("Listing channels for session %s", session
->name
);
1941 case LTTNG_DOMAIN_KERNEL
:
1942 /* Kernel channels */
1943 if (session
->kernel_session
!= NULL
) {
1944 cds_list_for_each_entry(kchan
,
1945 &session
->kernel_session
->channel_list
.head
, list
) {
1946 /* Copy lttng_channel struct to array */
1947 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1948 channels
[i
].enabled
= kchan
->enabled
;
1953 case LTTNG_DOMAIN_UST
:
1955 struct lttng_ht_iter iter
;
1956 struct ltt_ust_channel
*uchan
;
1958 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1959 &iter
.iter
, uchan
, node
.node
) {
1960 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1961 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1962 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1963 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1964 channels
[i
].attr
.switch_timer_interval
=
1965 uchan
->attr
.switch_timer_interval
;
1966 channels
[i
].attr
.read_timer_interval
=
1967 uchan
->attr
.read_timer_interval
;
1968 channels
[i
].enabled
= uchan
->enabled
;
1969 switch (uchan
->attr
.output
) {
1970 case LTTNG_UST_MMAP
:
1972 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
1985 * Create a list of ust global domain events.
1987 static int list_lttng_ust_global_events(char *channel_name
,
1988 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
1991 unsigned int nb_event
= 0;
1992 struct lttng_ht_iter iter
;
1993 struct lttng_ht_node_str
*node
;
1994 struct ltt_ust_channel
*uchan
;
1995 struct ltt_ust_event
*uevent
;
1996 struct lttng_event
*tmp
;
1998 DBG("Listing UST global events for channel %s", channel_name
);
2002 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2003 node
= lttng_ht_iter_get_node_str(&iter
);
2005 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2009 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2011 nb_event
+= lttng_ht_get_count(uchan
->events
);
2013 if (nb_event
== 0) {
2018 DBG3("Listing UST global %d events", nb_event
);
2020 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2022 ret
= -LTTCOMM_FATAL
;
2026 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2027 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2028 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2029 tmp
[i
].enabled
= uevent
->enabled
;
2030 switch (uevent
->attr
.instrumentation
) {
2031 case LTTNG_UST_TRACEPOINT
:
2032 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2034 case LTTNG_UST_PROBE
:
2035 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2037 case LTTNG_UST_FUNCTION
:
2038 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2041 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2042 switch (uevent
->attr
.loglevel_type
) {
2043 case LTTNG_UST_LOGLEVEL_ALL
:
2044 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2046 case LTTNG_UST_LOGLEVEL_RANGE
:
2047 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2049 case LTTNG_UST_LOGLEVEL_SINGLE
:
2050 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2065 * Fill lttng_event array of all kernel events in the channel.
2067 static int list_lttng_kernel_events(char *channel_name
,
2068 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2071 unsigned int nb_event
;
2072 struct ltt_kernel_event
*event
;
2073 struct ltt_kernel_channel
*kchan
;
2075 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2076 if (kchan
== NULL
) {
2077 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2081 nb_event
= kchan
->event_count
;
2083 DBG("Listing events for channel %s", kchan
->channel
->name
);
2085 if (nb_event
== 0) {
2090 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2091 if (*events
== NULL
) {
2092 ret
= LTTCOMM_FATAL
;
2096 /* Kernel channels */
2097 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2098 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2099 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2100 (*events
)[i
].enabled
= event
->enabled
;
2101 switch (event
->event
->instrumentation
) {
2102 case LTTNG_KERNEL_TRACEPOINT
:
2103 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2105 case LTTNG_KERNEL_KPROBE
:
2106 case LTTNG_KERNEL_KRETPROBE
:
2107 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2108 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2109 sizeof(struct lttng_kernel_kprobe
));
2111 case LTTNG_KERNEL_FUNCTION
:
2112 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2113 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2114 sizeof(struct lttng_kernel_function
));
2116 case LTTNG_KERNEL_NOOP
:
2117 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2119 case LTTNG_KERNEL_SYSCALL
:
2120 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2122 case LTTNG_KERNEL_ALL
:
2136 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2138 static int cmd_disable_channel(struct ltt_session
*session
,
2139 int domain
, char *channel_name
)
2142 struct ltt_ust_session
*usess
;
2144 usess
= session
->ust_session
;
2147 case LTTNG_DOMAIN_KERNEL
:
2149 ret
= channel_kernel_disable(session
->kernel_session
,
2151 if (ret
!= LTTCOMM_OK
) {
2155 kernel_wait_quiescent(kernel_tracer_fd
);
2158 case LTTNG_DOMAIN_UST
:
2160 struct ltt_ust_channel
*uchan
;
2161 struct lttng_ht
*chan_ht
;
2163 chan_ht
= usess
->domain_global
.channels
;
2165 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2166 if (uchan
== NULL
) {
2167 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2171 ret
= channel_ust_disable(usess
, domain
, uchan
);
2172 if (ret
!= LTTCOMM_OK
) {
2178 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2179 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2180 case LTTNG_DOMAIN_UST_PID
:
2183 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2194 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2196 static int cmd_enable_channel(struct ltt_session
*session
,
2197 int domain
, struct lttng_channel
*attr
)
2200 struct ltt_ust_session
*usess
= session
->ust_session
;
2201 struct lttng_ht
*chan_ht
;
2203 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2206 case LTTNG_DOMAIN_KERNEL
:
2208 struct ltt_kernel_channel
*kchan
;
2210 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2211 session
->kernel_session
);
2212 if (kchan
== NULL
) {
2213 ret
= channel_kernel_create(session
->kernel_session
,
2214 attr
, kernel_poll_pipe
[1]);
2216 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2219 if (ret
!= LTTCOMM_OK
) {
2223 kernel_wait_quiescent(kernel_tracer_fd
);
2226 case LTTNG_DOMAIN_UST
:
2228 struct ltt_ust_channel
*uchan
;
2230 chan_ht
= usess
->domain_global
.channels
;
2232 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2233 if (uchan
== NULL
) {
2234 ret
= channel_ust_create(usess
, domain
, attr
);
2236 ret
= channel_ust_enable(usess
, domain
, uchan
);
2241 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2242 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2243 case LTTNG_DOMAIN_UST_PID
:
2246 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2255 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2257 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2258 char *channel_name
, char *event_name
)
2263 case LTTNG_DOMAIN_KERNEL
:
2265 struct ltt_kernel_channel
*kchan
;
2266 struct ltt_kernel_session
*ksess
;
2268 ksess
= session
->kernel_session
;
2270 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2271 if (kchan
== NULL
) {
2272 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2276 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2277 if (ret
!= LTTCOMM_OK
) {
2281 kernel_wait_quiescent(kernel_tracer_fd
);
2284 case LTTNG_DOMAIN_UST
:
2286 struct ltt_ust_channel
*uchan
;
2287 struct ltt_ust_session
*usess
;
2289 usess
= session
->ust_session
;
2291 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2293 if (uchan
== NULL
) {
2294 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2298 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2299 if (ret
!= LTTCOMM_OK
) {
2303 DBG3("Disable UST event %s in channel %s completed", event_name
,
2308 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2309 case LTTNG_DOMAIN_UST_PID
:
2310 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2324 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2326 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2332 case LTTNG_DOMAIN_KERNEL
:
2334 struct ltt_kernel_session
*ksess
;
2335 struct ltt_kernel_channel
*kchan
;
2337 ksess
= session
->kernel_session
;
2339 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2340 if (kchan
== NULL
) {
2341 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2345 ret
= event_kernel_disable_all(ksess
, kchan
);
2346 if (ret
!= LTTCOMM_OK
) {
2350 kernel_wait_quiescent(kernel_tracer_fd
);
2353 case LTTNG_DOMAIN_UST
:
2355 struct ltt_ust_session
*usess
;
2356 struct ltt_ust_channel
*uchan
;
2358 usess
= session
->ust_session
;
2360 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2362 if (uchan
== NULL
) {
2363 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2367 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2372 DBG3("Disable all UST events in channel %s completed", channel_name
);
2377 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2378 case LTTNG_DOMAIN_UST_PID
:
2379 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2393 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2395 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2396 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2401 case LTTNG_DOMAIN_KERNEL
:
2402 /* Add kernel context to kernel tracer */
2403 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2404 event_name
, channel_name
);
2405 if (ret
!= LTTCOMM_OK
) {
2409 case LTTNG_DOMAIN_UST
:
2411 struct ltt_ust_session
*usess
= session
->ust_session
;
2413 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2414 if (ret
!= LTTCOMM_OK
) {
2420 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2421 case LTTNG_DOMAIN_UST_PID
:
2422 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2436 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2438 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2439 char *channel_name
, struct lttng_event
*event
)
2442 struct lttng_channel
*attr
;
2443 struct ltt_ust_session
*usess
= session
->ust_session
;
2446 case LTTNG_DOMAIN_KERNEL
:
2448 struct ltt_kernel_channel
*kchan
;
2450 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2451 session
->kernel_session
);
2452 if (kchan
== NULL
) {
2453 attr
= channel_new_default_attr(domain
);
2455 ret
= LTTCOMM_FATAL
;
2458 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2460 /* This call will notify the kernel thread */
2461 ret
= channel_kernel_create(session
->kernel_session
,
2462 attr
, kernel_poll_pipe
[1]);
2463 if (ret
!= LTTCOMM_OK
) {
2470 /* Get the newly created kernel channel pointer */
2471 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2472 session
->kernel_session
);
2473 if (kchan
== NULL
) {
2474 /* This sould not happen... */
2475 ret
= LTTCOMM_FATAL
;
2479 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2481 if (ret
!= LTTCOMM_OK
) {
2485 kernel_wait_quiescent(kernel_tracer_fd
);
2488 case LTTNG_DOMAIN_UST
:
2490 struct lttng_channel
*attr
;
2491 struct ltt_ust_channel
*uchan
;
2493 /* Get channel from global UST domain */
2494 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2496 if (uchan
== NULL
) {
2497 /* Create default channel */
2498 attr
= channel_new_default_attr(domain
);
2500 ret
= LTTCOMM_FATAL
;
2503 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2504 attr
->name
[NAME_MAX
- 1] = '\0';
2506 ret
= channel_ust_create(usess
, domain
, attr
);
2507 if (ret
!= LTTCOMM_OK
) {
2513 /* Get the newly created channel reference back */
2514 uchan
= trace_ust_find_channel_by_name(
2515 usess
->domain_global
.channels
, channel_name
);
2516 if (uchan
== NULL
) {
2517 /* Something is really wrong */
2518 ret
= LTTCOMM_FATAL
;
2523 /* At this point, the session and channel exist on the tracer */
2524 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2525 if (ret
!= LTTCOMM_OK
) {
2531 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2532 case LTTNG_DOMAIN_UST_PID
:
2533 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2547 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2549 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2550 char *channel_name
, int event_type
)
2553 struct ltt_kernel_channel
*kchan
;
2556 case LTTNG_DOMAIN_KERNEL
:
2557 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2558 session
->kernel_session
);
2559 if (kchan
== NULL
) {
2560 /* This call will notify the kernel thread */
2561 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2562 kernel_poll_pipe
[1]);
2563 if (ret
!= LTTCOMM_OK
) {
2567 /* Get the newly created kernel channel pointer */
2568 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2569 session
->kernel_session
);
2570 if (kchan
== NULL
) {
2571 /* This sould not happen... */
2572 ret
= LTTCOMM_FATAL
;
2578 switch (event_type
) {
2579 case LTTNG_EVENT_SYSCALL
:
2580 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2581 kchan
, kernel_tracer_fd
);
2583 case LTTNG_EVENT_TRACEPOINT
:
2585 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2586 * events already registered to the channel.
2588 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2589 kchan
, kernel_tracer_fd
);
2591 case LTTNG_EVENT_ALL
:
2592 /* Enable syscalls and tracepoints */
2593 ret
= event_kernel_enable_all(session
->kernel_session
,
2594 kchan
, kernel_tracer_fd
);
2597 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2601 /* Manage return value */
2602 if (ret
!= LTTCOMM_OK
) {
2606 kernel_wait_quiescent(kernel_tracer_fd
);
2608 case LTTNG_DOMAIN_UST
:
2610 struct lttng_channel
*attr
;
2611 struct ltt_ust_channel
*uchan
;
2612 struct ltt_ust_session
*usess
= session
->ust_session
;
2614 /* Get channel from global UST domain */
2615 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2617 if (uchan
== NULL
) {
2618 /* Create default channel */
2619 attr
= channel_new_default_attr(domain
);
2621 ret
= LTTCOMM_FATAL
;
2624 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2625 attr
->name
[NAME_MAX
- 1] = '\0';
2627 /* Use the internal command enable channel */
2628 ret
= channel_ust_create(usess
, domain
, attr
);
2629 if (ret
!= LTTCOMM_OK
) {
2635 /* Get the newly created channel reference back */
2636 uchan
= trace_ust_find_channel_by_name(
2637 usess
->domain_global
.channels
, channel_name
);
2638 if (uchan
== NULL
) {
2639 /* Something is really wrong */
2640 ret
= LTTCOMM_FATAL
;
2645 /* At this point, the session and channel exist on the tracer */
2647 switch (event_type
) {
2648 case LTTNG_EVENT_ALL
:
2649 case LTTNG_EVENT_TRACEPOINT
:
2650 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2651 if (ret
!= LTTCOMM_OK
) {
2656 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2660 /* Manage return value */
2661 if (ret
!= LTTCOMM_OK
) {
2668 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2669 case LTTNG_DOMAIN_UST_PID
:
2670 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2684 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2686 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2689 ssize_t nb_events
= 0;
2692 case LTTNG_DOMAIN_KERNEL
:
2693 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2694 if (nb_events
< 0) {
2695 ret
= LTTCOMM_KERN_LIST_FAIL
;
2699 case LTTNG_DOMAIN_UST
:
2700 nb_events
= ust_app_list_events(events
);
2701 if (nb_events
< 0) {
2702 ret
= LTTCOMM_UST_LIST_FAIL
;
2714 /* Return negative value to differentiate return code */
2719 * Command LTTNG_START_TRACE processed by the client thread.
2721 static int cmd_start_trace(struct ltt_session
*session
)
2724 struct ltt_kernel_session
*ksession
;
2725 struct ltt_ust_session
*usess
;
2728 ksession
= session
->kernel_session
;
2729 usess
= session
->ust_session
;
2731 if (session
->enabled
) {
2732 ret
= LTTCOMM_UST_START_FAIL
;
2736 session
->enabled
= 1;
2738 /* Kernel tracing */
2739 if (ksession
!= NULL
) {
2740 struct ltt_kernel_channel
*kchan
;
2742 /* Open kernel metadata */
2743 if (ksession
->metadata
== NULL
) {
2744 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2746 ret
= LTTCOMM_KERN_META_FAIL
;
2751 /* Open kernel metadata stream */
2752 if (ksession
->metadata_stream_fd
== 0) {
2753 ret
= kernel_open_metadata_stream(ksession
);
2755 ERR("Kernel create metadata stream failed");
2756 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2761 /* For each channel */
2762 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2763 if (kchan
->stream_count
== 0) {
2764 ret
= kernel_open_channel_stream(kchan
);
2766 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2769 /* Update the stream global counter */
2770 ksession
->stream_count_global
+= ret
;
2774 /* Setup kernel consumer socket and send fds to it */
2775 ret
= init_kernel_tracing(ksession
);
2777 ret
= LTTCOMM_KERN_START_FAIL
;
2781 /* This start the kernel tracing */
2782 ret
= kernel_start_session(ksession
);
2784 ret
= LTTCOMM_KERN_START_FAIL
;
2788 /* Quiescent wait after starting trace */
2789 kernel_wait_quiescent(kernel_tracer_fd
);
2792 /* Flag session that trace should start automatically */
2794 usess
->start_trace
= 1;
2796 ret
= ust_app_start_trace_all(usess
);
2798 ret
= LTTCOMM_UST_START_FAIL
;
2810 * Command LTTNG_STOP_TRACE processed by the client thread.
2812 static int cmd_stop_trace(struct ltt_session
*session
)
2815 struct ltt_kernel_channel
*kchan
;
2816 struct ltt_kernel_session
*ksession
;
2817 struct ltt_ust_session
*usess
;
2820 ksession
= session
->kernel_session
;
2821 usess
= session
->ust_session
;
2823 if (!session
->enabled
) {
2824 ret
= LTTCOMM_UST_STOP_FAIL
;
2828 session
->enabled
= 0;
2831 if (ksession
!= NULL
) {
2832 DBG("Stop kernel tracing");
2834 /* Flush all buffers before stopping */
2835 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2837 ERR("Kernel metadata flush failed");
2840 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2841 ret
= kernel_flush_buffer(kchan
);
2843 ERR("Kernel flush buffer error");
2847 ret
= kernel_stop_session(ksession
);
2849 ret
= LTTCOMM_KERN_STOP_FAIL
;
2853 kernel_wait_quiescent(kernel_tracer_fd
);
2857 usess
->start_trace
= 0;
2859 ret
= ust_app_stop_trace_all(usess
);
2861 ret
= LTTCOMM_UST_STOP_FAIL
;
2873 * Command LTTNG_CREATE_SESSION processed by the client thread.
2875 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2879 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2880 if (ret
!= LTTCOMM_OK
) {
2891 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2893 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2897 /* Clean kernel session teardown */
2898 teardown_kernel_session(session
);
2899 /* UST session teardown */
2900 teardown_ust_session(session
);
2903 * Must notify the kernel thread here to update it's poll setin order
2904 * to remove the channel(s)' fd just destroyed.
2906 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2908 perror("write kernel poll pipe");
2911 ret
= session_destroy(session
);
2917 * Command LTTNG_CALIBRATE processed by the client thread.
2919 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2924 case LTTNG_DOMAIN_KERNEL
:
2926 struct lttng_kernel_calibrate kcalibrate
;
2928 kcalibrate
.type
= calibrate
->type
;
2929 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2931 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2936 case LTTNG_DOMAIN_UST
:
2938 struct lttng_ust_calibrate ucalibrate
;
2940 ucalibrate
.type
= calibrate
->type
;
2941 ret
= ust_app_calibrate_glb(&ucalibrate
);
2943 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2960 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2962 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2968 case LTTNG_DOMAIN_KERNEL
:
2969 /* Can't register a consumer if there is already one */
2970 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
2971 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2975 sock
= lttcomm_connect_unix_sock(sock_path
);
2977 ret
= LTTCOMM_CONNECT_FAIL
;
2981 session
->kernel_session
->consumer_fd
= sock
;
2984 /* TODO: Userspace tracing */
2996 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2998 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
2999 struct lttng_domain
**domains
)
3004 if (session
->kernel_session
!= NULL
) {
3005 DBG3("Listing domains found kernel domain");
3009 if (session
->ust_session
!= NULL
) {
3010 DBG3("Listing domains found UST global domain");
3014 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3015 if (*domains
== NULL
) {
3016 ret
= -LTTCOMM_FATAL
;
3020 if (session
->kernel_session
!= NULL
) {
3021 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3025 if (session
->ust_session
!= NULL
) {
3026 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3037 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3039 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3040 struct lttng_channel
**channels
)
3043 ssize_t nb_chan
= 0;
3046 case LTTNG_DOMAIN_KERNEL
:
3047 if (session
->kernel_session
!= NULL
) {
3048 nb_chan
= session
->kernel_session
->channel_count
;
3050 DBG3("Number of kernel channels %zd", nb_chan
);
3052 case LTTNG_DOMAIN_UST
:
3053 if (session
->ust_session
!= NULL
) {
3054 nb_chan
= lttng_ht_get_count(
3055 session
->ust_session
->domain_global
.channels
);
3057 DBG3("Number of UST global channels %zd", nb_chan
);
3066 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3067 if (*channels
== NULL
) {
3068 ret
= -LTTCOMM_FATAL
;
3072 list_lttng_channels(domain
, session
, *channels
);
3084 * Command LTTNG_LIST_EVENTS processed by the client thread.
3086 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3087 char *channel_name
, struct lttng_event
**events
)
3090 ssize_t nb_event
= 0;
3093 case LTTNG_DOMAIN_KERNEL
:
3094 if (session
->kernel_session
!= NULL
) {
3095 nb_event
= list_lttng_kernel_events(channel_name
,
3096 session
->kernel_session
, events
);
3099 case LTTNG_DOMAIN_UST
:
3101 if (session
->ust_session
!= NULL
) {
3102 nb_event
= list_lttng_ust_global_events(channel_name
,
3103 &session
->ust_session
->domain_global
, events
);
3119 * Process the command requested by the lttng client within the command
3120 * context structure. This function make sure that the return structure (llm)
3121 * is set and ready for transmission before returning.
3123 * Return any error encountered or 0 for success.
3125 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3127 int ret
= LTTCOMM_OK
;
3128 int need_tracing_session
= 1;
3131 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3133 switch (cmd_ctx
->lsm
->cmd_type
) {
3134 case LTTNG_CREATE_SESSION
:
3135 case LTTNG_DESTROY_SESSION
:
3136 case LTTNG_LIST_SESSIONS
:
3137 case LTTNG_LIST_DOMAINS
:
3138 case LTTNG_START_TRACE
:
3139 case LTTNG_STOP_TRACE
:
3146 if (opt_no_kernel
&& need_domain
3147 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3148 ret
= LTTCOMM_KERN_NA
;
3153 * Check for command that don't needs to allocate a returned payload. We do
3154 * this here so we don't have to make the call for no payload at each
3157 switch(cmd_ctx
->lsm
->cmd_type
) {
3158 case LTTNG_LIST_SESSIONS
:
3159 case LTTNG_LIST_TRACEPOINTS
:
3160 case LTTNG_LIST_DOMAINS
:
3161 case LTTNG_LIST_CHANNELS
:
3162 case LTTNG_LIST_EVENTS
:
3165 /* Setup lttng message with no payload */
3166 ret
= setup_lttng_msg(cmd_ctx
, 0);
3168 /* This label does not try to unlock the session */
3169 goto init_setup_error
;
3173 /* Commands that DO NOT need a session. */
3174 switch (cmd_ctx
->lsm
->cmd_type
) {
3175 case LTTNG_CREATE_SESSION
:
3176 case LTTNG_CALIBRATE
:
3177 case LTTNG_LIST_SESSIONS
:
3178 case LTTNG_LIST_TRACEPOINTS
:
3179 need_tracing_session
= 0;
3182 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3183 session_lock_list();
3184 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3185 session_unlock_list();
3186 if (cmd_ctx
->session
== NULL
) {
3187 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3188 ret
= LTTCOMM_SESS_NOT_FOUND
;
3190 /* If no session name specified */
3191 ret
= LTTCOMM_SELECT_SESS
;
3195 /* Acquire lock for the session */
3196 session_lock(cmd_ctx
->session
);
3205 * Check domain type for specific "pre-action".
3207 switch (cmd_ctx
->lsm
->domain
.type
) {
3208 case LTTNG_DOMAIN_KERNEL
:
3210 ret
= LTTCOMM_KERN_NA
;
3214 /* Kernel tracer check */
3215 if (kernel_tracer_fd
== 0) {
3216 /* Basically, load kernel tracer modules */
3217 ret
= init_kernel_tracer();
3223 /* Need a session for kernel command */
3224 if (need_tracing_session
) {
3225 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3226 ret
= create_kernel_session(cmd_ctx
->session
);
3228 ret
= LTTCOMM_KERN_SESS_FAIL
;
3233 /* Start the kernel consumer daemon */
3234 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3235 if (kconsumer_data
.pid
== 0 &&
3236 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3237 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3238 ret
= start_consumerd(&kconsumer_data
);
3240 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3244 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3248 case LTTNG_DOMAIN_UST
:
3250 if (need_tracing_session
) {
3251 if (cmd_ctx
->session
->ust_session
== NULL
) {
3252 ret
= create_ust_session(cmd_ctx
->session
,
3253 &cmd_ctx
->lsm
->domain
);
3254 if (ret
!= LTTCOMM_OK
) {
3258 /* Start the UST consumer daemons */
3260 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3261 if (consumerd64_bin
[0] != '\0' &&
3262 ustconsumer64_data
.pid
== 0 &&
3263 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3264 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3265 ret
= start_consumerd(&ustconsumer64_data
);
3267 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3268 ust_consumerd64_fd
= -EINVAL
;
3272 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3274 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3277 if (consumerd32_bin
[0] != '\0' &&
3278 ustconsumer32_data
.pid
== 0 &&
3279 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3280 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3281 ret
= start_consumerd(&ustconsumer32_data
);
3283 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3284 ust_consumerd32_fd
= -EINVAL
;
3287 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3289 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3300 * Check that the UID or GID match that of the tracing session.
3301 * The root user can interact with all sessions.
3303 if (need_tracing_session
) {
3304 if (!session_access_ok(cmd_ctx
->session
,
3305 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3306 ret
= LTTCOMM_EPERM
;
3311 /* Process by command type */
3312 switch (cmd_ctx
->lsm
->cmd_type
) {
3313 case LTTNG_ADD_CONTEXT
:
3315 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3316 cmd_ctx
->lsm
->u
.context
.channel_name
,
3317 cmd_ctx
->lsm
->u
.context
.event_name
,
3318 &cmd_ctx
->lsm
->u
.context
.ctx
);
3321 case LTTNG_DISABLE_CHANNEL
:
3323 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3324 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3327 case LTTNG_DISABLE_EVENT
:
3329 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3330 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3331 cmd_ctx
->lsm
->u
.disable
.name
);
3334 case LTTNG_DISABLE_ALL_EVENT
:
3336 DBG("Disabling all events");
3338 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3339 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3342 case LTTNG_ENABLE_CHANNEL
:
3344 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3345 &cmd_ctx
->lsm
->u
.channel
.chan
);
3348 case LTTNG_ENABLE_EVENT
:
3350 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3351 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3352 &cmd_ctx
->lsm
->u
.enable
.event
);
3355 case LTTNG_ENABLE_ALL_EVENT
:
3357 DBG("Enabling all events");
3359 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3360 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3361 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3364 case LTTNG_LIST_TRACEPOINTS
:
3366 struct lttng_event
*events
;
3369 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3370 if (nb_events
< 0) {
3376 * Setup lttng message with payload size set to the event list size in
3377 * bytes and then copy list into the llm payload.
3379 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3385 /* Copy event list into message payload */
3386 memcpy(cmd_ctx
->llm
->payload
, events
,
3387 sizeof(struct lttng_event
) * nb_events
);
3394 case LTTNG_START_TRACE
:
3396 ret
= cmd_start_trace(cmd_ctx
->session
);
3399 case LTTNG_STOP_TRACE
:
3401 ret
= cmd_stop_trace(cmd_ctx
->session
);
3404 case LTTNG_CREATE_SESSION
:
3406 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3407 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3410 case LTTNG_DESTROY_SESSION
:
3412 ret
= cmd_destroy_session(cmd_ctx
->session
,
3413 cmd_ctx
->lsm
->session
.name
);
3416 case LTTNG_LIST_DOMAINS
:
3419 struct lttng_domain
*domains
;
3421 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3427 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3432 /* Copy event list into message payload */
3433 memcpy(cmd_ctx
->llm
->payload
, domains
,
3434 nb_dom
* sizeof(struct lttng_domain
));
3441 case LTTNG_LIST_CHANNELS
:
3444 struct lttng_channel
*channels
;
3446 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3447 cmd_ctx
->session
, &channels
);
3453 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3458 /* Copy event list into message payload */
3459 memcpy(cmd_ctx
->llm
->payload
, channels
,
3460 nb_chan
* sizeof(struct lttng_channel
));
3467 case LTTNG_LIST_EVENTS
:
3470 struct lttng_event
*events
= NULL
;
3472 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3473 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3479 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3484 /* Copy event list into message payload */
3485 memcpy(cmd_ctx
->llm
->payload
, events
,
3486 nb_event
* sizeof(struct lttng_event
));
3493 case LTTNG_LIST_SESSIONS
:
3495 unsigned int nr_sessions
;
3497 session_lock_list();
3498 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3500 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3502 session_unlock_list();
3506 /* Filled the session array */
3507 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3508 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3510 session_unlock_list();
3515 case LTTNG_CALIBRATE
:
3517 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3518 &cmd_ctx
->lsm
->u
.calibrate
);
3521 case LTTNG_REGISTER_CONSUMER
:
3523 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3524 cmd_ctx
->lsm
->u
.reg
.path
);
3533 if (cmd_ctx
->llm
== NULL
) {
3534 DBG("Missing llm structure. Allocating one.");
3535 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3539 /* Set return code */
3540 cmd_ctx
->llm
->ret_code
= ret
;
3542 if (cmd_ctx
->session
) {
3543 session_unlock(cmd_ctx
->session
);
3550 * This thread manage all clients request using the unix client socket for
3553 static void *thread_manage_clients(void *data
)
3555 int sock
= 0, ret
, i
, pollfd
;
3556 uint32_t revents
, nb_fd
;
3557 struct command_ctx
*cmd_ctx
= NULL
;
3558 struct lttng_poll_event events
;
3560 DBG("[thread] Manage client started");
3562 rcu_register_thread();
3564 ret
= lttcomm_listen_unix_sock(client_sock
);
3570 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3571 * more will be added to this poll set.
3573 ret
= create_thread_poll_set(&events
, 2);
3578 /* Add the application registration socket */
3579 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3585 * Notify parent pid that we are ready to accept command for client side.
3587 if (opt_sig_parent
) {
3588 kill(ppid
, SIGUSR1
);
3592 DBG("Accepting client command ...");
3594 nb_fd
= LTTNG_POLL_GETNB(&events
);
3596 /* Inifinite blocking call, waiting for transmission */
3597 ret
= lttng_poll_wait(&events
, -1);
3602 for (i
= 0; i
< nb_fd
; i
++) {
3603 /* Fetch once the poll data */
3604 revents
= LTTNG_POLL_GETEV(&events
, i
);
3605 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3607 /* Thread quit pipe has been closed. Killing thread. */
3608 ret
= check_thread_quit_pipe(pollfd
, revents
);
3613 /* Event on the registration socket */
3614 if (pollfd
== client_sock
) {
3615 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3616 ERR("Client socket poll error");
3622 DBG("Wait for client response");
3624 sock
= lttcomm_accept_unix_sock(client_sock
);
3629 /* Set socket option for credentials retrieval */
3630 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3635 /* Allocate context command to process the client request */
3636 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3637 if (cmd_ctx
== NULL
) {
3638 perror("zmalloc cmd_ctx");
3642 /* Allocate data buffer for reception */
3643 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3644 if (cmd_ctx
->lsm
== NULL
) {
3645 perror("zmalloc cmd_ctx->lsm");
3649 cmd_ctx
->llm
= NULL
;
3650 cmd_ctx
->session
= NULL
;
3653 * Data is received from the lttng client. The struct
3654 * lttcomm_session_msg (lsm) contains the command and data request of
3657 DBG("Receiving data from client ...");
3658 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3659 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3661 DBG("Nothing recv() from client... continuing");
3667 // TODO: Validate cmd_ctx including sanity check for
3668 // security purpose.
3670 rcu_thread_online();
3672 * This function dispatch the work to the kernel or userspace tracer
3673 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3674 * informations for the client. The command context struct contains
3675 * everything this function may needs.
3677 ret
= process_client_msg(cmd_ctx
);
3678 rcu_thread_offline();
3681 * TODO: Inform client somehow of the fatal error. At
3682 * this point, ret < 0 means that a zmalloc failed
3683 * (ENOMEM). Error detected but still accept command.
3685 clean_command_ctx(&cmd_ctx
);
3689 DBG("Sending response (size: %d, retcode: %s)",
3690 cmd_ctx
->lttng_msg_size
,
3691 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3692 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3694 ERR("Failed to send data back to client");
3697 /* End of transmission */
3700 clean_command_ctx(&cmd_ctx
);
3704 DBG("Client thread dying");
3705 unlink(client_unix_sock_path
);
3709 lttng_poll_clean(&events
);
3710 clean_command_ctx(&cmd_ctx
);
3712 rcu_unregister_thread();
3718 * usage function on stderr
3720 static void usage(void)
3722 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3723 fprintf(stderr
, " -h, --help Display this usage.\n");
3724 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3725 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3726 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3727 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3728 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3729 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3730 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3731 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3732 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3733 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3734 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3735 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3736 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3737 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3738 fprintf(stderr
, " -V, --version Show version number.\n");
3739 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3740 fprintf(stderr
, " -q, --quiet No output at all.\n");
3741 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3742 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3743 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3747 * daemon argument parsing
3749 static int parse_args(int argc
, char **argv
)
3753 static struct option long_options
[] = {
3754 { "client-sock", 1, 0, 'c' },
3755 { "apps-sock", 1, 0, 'a' },
3756 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3757 { "kconsumerd-err-sock", 1, 0, 'E' },
3758 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3759 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3760 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3761 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3762 { "consumerd32-path", 1, 0, 'u' },
3763 { "consumerd32-libdir", 1, 0, 'U' },
3764 { "consumerd64-path", 1, 0, 't' },
3765 { "consumerd64-libdir", 1, 0, 'T' },
3766 { "daemonize", 0, 0, 'd' },
3767 { "sig-parent", 0, 0, 'S' },
3768 { "help", 0, 0, 'h' },
3769 { "group", 1, 0, 'g' },
3770 { "version", 0, 0, 'V' },
3771 { "quiet", 0, 0, 'q' },
3772 { "verbose", 0, 0, 'v' },
3773 { "verbose-consumer", 0, 0, 'Z' },
3774 { "no-kernel", 0, 0, 'N' },
3779 int option_index
= 0;
3780 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3781 long_options
, &option_index
);
3788 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3790 fprintf(stderr
, " with arg %s\n", optarg
);
3794 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3797 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3803 opt_tracing_group
= optarg
;
3809 fprintf(stdout
, "%s\n", VERSION
);
3815 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3818 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3821 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3824 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3827 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3830 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3839 /* Verbose level can increase using multiple -v */
3843 opt_verbose_consumer
+= 1;
3846 consumerd32_bin
= optarg
;
3849 consumerd32_libdir
= optarg
;
3852 consumerd64_bin
= optarg
;
3855 consumerd64_libdir
= optarg
;
3858 /* Unknown option or other error.
3859 * Error is printed by getopt, just return */
3868 * Creates the two needed socket by the daemon.
3869 * apps_sock - The communication socket for all UST apps.
3870 * client_sock - The communication of the cli tool (lttng).
3872 static int init_daemon_socket(void)
3877 old_umask
= umask(0);
3879 /* Create client tool unix socket */
3880 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3881 if (client_sock
< 0) {
3882 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3887 /* File permission MUST be 660 */
3888 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3890 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3895 /* Create the application unix socket */
3896 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3897 if (apps_sock
< 0) {
3898 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3903 /* File permission MUST be 666 */
3904 ret
= chmod(apps_unix_sock_path
,
3905 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3907 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3918 * Check if the global socket is available, and if a daemon is answering at the
3919 * other side. If yes, error is returned.
3921 static int check_existing_daemon(void)
3923 /* Is there anybody out there ? */
3924 if (lttng_session_daemon_alive()) {
3932 * Set the tracing group gid onto the client socket.
3934 * Race window between mkdir and chown is OK because we are going from more
3935 * permissive (root.root) to less permissive (root.tracing).
3937 static int set_permissions(char *rundir
)
3942 gid
= allowed_group();
3944 WARN("No tracing group detected");
3949 /* Set lttng run dir */
3950 ret
= chown(rundir
, 0, gid
);
3952 ERR("Unable to set group on %s", rundir
);
3956 /* Ensure tracing group can search the run dir */
3957 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
);
3959 ERR("Unable to set permissions on %s", rundir
);
3963 /* lttng client socket path */
3964 ret
= chown(client_unix_sock_path
, 0, gid
);
3966 ERR("Unable to set group on %s", client_unix_sock_path
);
3970 /* kconsumer error socket path */
3971 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3973 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3977 /* 64-bit ustconsumer error socket path */
3978 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3980 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3984 /* 32-bit ustconsumer compat32 error socket path */
3985 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3987 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
3991 DBG("All permissions are set");
3998 * Create the pipe used to wake up the kernel thread.
4000 static int create_kernel_poll_pipe(void)
4002 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4006 * Create the application command pipe to wake thread_manage_apps.
4008 static int create_apps_cmd_pipe(void)
4010 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4014 * Create the lttng run directory needed for all global sockets and pipe.
4016 static int create_lttng_rundir(const char *rundir
)
4020 DBG3("Creating LTTng run directory: %s", rundir
);
4022 ret
= mkdir(rundir
, S_IRWXU
);
4024 if (errno
!= EEXIST
) {
4025 ERR("Unable to create %s", rundir
);
4037 * Setup sockets and directory needed by the kconsumerd communication with the
4040 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4044 char path
[PATH_MAX
];
4046 switch (consumer_data
->type
) {
4047 case LTTNG_CONSUMER_KERNEL
:
4048 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4050 case LTTNG_CONSUMER64_UST
:
4051 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4053 case LTTNG_CONSUMER32_UST
:
4054 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4057 ERR("Consumer type unknown");
4062 DBG2("Creating consumer directory: %s", path
);
4064 ret
= mkdir(path
, S_IRWXU
);
4066 if (errno
!= EEXIST
) {
4067 ERR("Failed to create %s", path
);
4073 /* Create the kconsumerd error unix socket */
4074 consumer_data
->err_sock
=
4075 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4076 if (consumer_data
->err_sock
< 0) {
4077 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4082 /* File permission MUST be 660 */
4083 ret
= chmod(consumer_data
->err_unix_sock_path
,
4084 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4086 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4096 * Signal handler for the daemon
4098 * Simply stop all worker threads, leaving main() return gracefully after
4099 * joining all threads and calling cleanup().
4101 static void sighandler(int sig
)
4105 DBG("SIGPIPE caught");
4108 DBG("SIGINT caught");
4112 DBG("SIGTERM caught");
4121 * Setup signal handler for :
4122 * SIGINT, SIGTERM, SIGPIPE
4124 static int set_signal_handler(void)
4127 struct sigaction sa
;
4130 if ((ret
= sigemptyset(&sigset
)) < 0) {
4131 perror("sigemptyset");
4135 sa
.sa_handler
= sighandler
;
4136 sa
.sa_mask
= sigset
;
4138 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4139 perror("sigaction");
4143 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4144 perror("sigaction");
4148 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4149 perror("sigaction");
4153 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4159 * Set open files limit to unlimited. This daemon can open a large number of
4160 * file descriptors in order to consumer multiple kernel traces.
4162 static void set_ulimit(void)
4167 /* The kernel does not allowed an infinite limit for open files */
4168 lim
.rlim_cur
= 65535;
4169 lim
.rlim_max
= 65535;
4171 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4173 perror("failed to set open files limit");
4180 int main(int argc
, char **argv
)
4184 const char *home_path
;
4186 init_kernel_workarounds();
4188 rcu_register_thread();
4190 /* Create thread quit pipe */
4191 if ((ret
= init_thread_quit_pipe()) < 0) {
4195 setup_consumerd_path();
4197 /* Parse arguments */
4199 if ((ret
= parse_args(argc
, argv
) < 0)) {
4212 /* Check if daemon is UID = 0 */
4213 is_root
= !getuid();
4216 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4218 /* Create global run dir with root access */
4219 ret
= create_lttng_rundir(rundir
);
4224 if (strlen(apps_unix_sock_path
) == 0) {
4225 snprintf(apps_unix_sock_path
, PATH_MAX
,
4226 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4229 if (strlen(client_unix_sock_path
) == 0) {
4230 snprintf(client_unix_sock_path
, PATH_MAX
,
4231 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4234 /* Set global SHM for ust */
4235 if (strlen(wait_shm_path
) == 0) {
4236 snprintf(wait_shm_path
, PATH_MAX
,
4237 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4240 /* Setup kernel consumerd path */
4241 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4242 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4243 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4244 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4246 DBG2("Kernel consumer err path: %s",
4247 kconsumer_data
.err_unix_sock_path
);
4248 DBG2("Kernel consumer cmd path: %s",
4249 kconsumer_data
.cmd_unix_sock_path
);
4251 home_path
= get_home_dir();
4252 if (home_path
== NULL
) {
4253 /* TODO: Add --socket PATH option */
4254 ERR("Can't get HOME directory for sockets creation.");
4260 * Create rundir from home path. This will create something like
4263 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4269 ret
= create_lttng_rundir(rundir
);
4274 if (strlen(apps_unix_sock_path
) == 0) {
4275 snprintf(apps_unix_sock_path
, PATH_MAX
,
4276 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4279 /* Set the cli tool unix socket path */
4280 if (strlen(client_unix_sock_path
) == 0) {
4281 snprintf(client_unix_sock_path
, PATH_MAX
,
4282 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4285 /* Set global SHM for ust */
4286 if (strlen(wait_shm_path
) == 0) {
4287 snprintf(wait_shm_path
, PATH_MAX
,
4288 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4292 DBG("Client socket path %s", client_unix_sock_path
);
4293 DBG("Application socket path %s", apps_unix_sock_path
);
4294 DBG("LTTng run directory path: %s", rundir
);
4296 /* 32 bits consumerd path setup */
4297 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4298 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4299 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4300 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4302 DBG2("UST consumer 32 bits err path: %s",
4303 ustconsumer32_data
.err_unix_sock_path
);
4304 DBG2("UST consumer 32 bits cmd path: %s",
4305 ustconsumer32_data
.cmd_unix_sock_path
);
4307 /* 64 bits consumerd path setup */
4308 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4309 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4310 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4311 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4313 DBG2("UST consumer 64 bits err path: %s",
4314 ustconsumer64_data
.err_unix_sock_path
);
4315 DBG2("UST consumer 64 bits cmd path: %s",
4316 ustconsumer64_data
.cmd_unix_sock_path
);
4319 * See if daemon already exist.
4321 if ((ret
= check_existing_daemon()) < 0) {
4322 ERR("Already running daemon.\n");
4324 * We do not goto exit because we must not cleanup()
4325 * because a daemon is already running.
4330 /* After this point, we can safely call cleanup() with "goto exit" */
4333 * These actions must be executed as root. We do that *after* setting up
4334 * the sockets path because we MUST make the check for another daemon using
4335 * those paths *before* trying to set the kernel consumer sockets and init
4339 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4344 /* Setup kernel tracer */
4345 if (!opt_no_kernel
) {
4346 init_kernel_tracer();
4349 /* Set ulimit for open files */
4353 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4358 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4363 if ((ret
= set_signal_handler()) < 0) {
4367 /* Setup the needed unix socket */
4368 if ((ret
= init_daemon_socket()) < 0) {
4372 /* Set credentials to socket */
4373 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4377 /* Get parent pid if -S, --sig-parent is specified. */
4378 if (opt_sig_parent
) {
4382 /* Setup the kernel pipe for waking up the kernel thread */
4383 if ((ret
= create_kernel_poll_pipe()) < 0) {
4387 /* Setup the thread apps communication pipe. */
4388 if ((ret
= create_apps_cmd_pipe()) < 0) {
4392 /* Init UST command queue. */
4393 cds_wfq_init(&ust_cmd_queue
.queue
);
4395 /* Init UST app hash table */
4399 * Get session list pointer. This pointer MUST NOT be free(). This list is
4400 * statically declared in session.c
4402 session_list_ptr
= session_get_list();
4404 /* Set up max poll set size */
4405 lttng_poll_set_max_size();
4407 /* Create thread to manage the client socket */
4408 ret
= pthread_create(&client_thread
, NULL
,
4409 thread_manage_clients
, (void *) NULL
);
4411 perror("pthread_create clients");
4415 /* Create thread to dispatch registration */
4416 ret
= pthread_create(&dispatch_thread
, NULL
,
4417 thread_dispatch_ust_registration
, (void *) NULL
);
4419 perror("pthread_create dispatch");
4423 /* Create thread to manage application registration. */
4424 ret
= pthread_create(®_apps_thread
, NULL
,
4425 thread_registration_apps
, (void *) NULL
);
4427 perror("pthread_create registration");
4431 /* Create thread to manage application socket */
4432 ret
= pthread_create(&apps_thread
, NULL
,
4433 thread_manage_apps
, (void *) NULL
);
4435 perror("pthread_create apps");
4439 /* Create kernel thread to manage kernel event */
4440 ret
= pthread_create(&kernel_thread
, NULL
,
4441 thread_manage_kernel
, (void *) NULL
);
4443 perror("pthread_create kernel");
4447 ret
= pthread_join(kernel_thread
, &status
);
4449 perror("pthread_join");
4450 goto error
; /* join error, exit without cleanup */
4454 ret
= pthread_join(apps_thread
, &status
);
4456 perror("pthread_join");
4457 goto error
; /* join error, exit without cleanup */
4461 ret
= pthread_join(reg_apps_thread
, &status
);
4463 perror("pthread_join");
4464 goto error
; /* join error, exit without cleanup */
4468 ret
= pthread_join(dispatch_thread
, &status
);
4470 perror("pthread_join");
4471 goto error
; /* join error, exit without cleanup */
4475 ret
= pthread_join(client_thread
, &status
);
4477 perror("pthread_join");
4478 goto error
; /* join error, exit without cleanup */
4481 ret
= join_consumer_thread(&kconsumer_data
);
4483 perror("join_consumer");
4484 goto error
; /* join error, exit without cleanup */
4490 * cleanup() is called when no other thread is running.
4492 rcu_thread_online();
4494 rcu_thread_offline();
4495 rcu_unregister_thread();