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 */
835 ret
= lttng_poll_wait(&events
, -1);
838 * Restart interrupted system call.
840 if (errno
== EINTR
) {
844 } else if (ret
== 0) {
845 /* Should not happen since timeout is infinite */
846 ERR("Return value of poll is 0 with an infinite timeout.\n"
847 "This should not have happened! Continuing...");
851 for (i
= 0; i
< nb_fd
; i
++) {
852 /* Fetch once the poll data */
853 revents
= LTTNG_POLL_GETEV(&events
, i
);
854 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
856 /* Thread quit pipe has been closed. Killing thread. */
857 ret
= check_thread_quit_pipe(pollfd
, revents
);
862 /* Check for data on kernel pipe */
863 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
864 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
865 update_poll_flag
= 1;
869 * New CPU detected by the kernel. Adding kernel stream to
870 * kernel session and updating the kernel consumer
872 if (revents
& LPOLLIN
) {
873 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
879 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
880 * and unregister kernel stream at this point.
888 DBG("Kernel thread dying");
889 close(kernel_poll_pipe
[0]);
890 close(kernel_poll_pipe
[1]);
892 lttng_poll_clean(&events
);
898 * This thread manage the consumer error sent back to the session daemon.
900 static void *thread_manage_consumer(void *data
)
902 int sock
= 0, i
, ret
, pollfd
;
903 uint32_t revents
, nb_fd
;
904 enum lttcomm_return_code code
;
905 struct lttng_poll_event events
;
906 struct consumer_data
*consumer_data
= data
;
908 DBG("[thread] Manage consumer started");
910 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
916 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
917 * Nothing more will be added to this poll set.
919 ret
= create_thread_poll_set(&events
, 2);
924 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
929 nb_fd
= LTTNG_POLL_GETNB(&events
);
931 /* Inifinite blocking call, waiting for transmission */
933 ret
= lttng_poll_wait(&events
, -1);
936 * Restart interrupted system call.
938 if (errno
== EINTR
) {
944 for (i
= 0; i
< nb_fd
; i
++) {
945 /* Fetch once the poll data */
946 revents
= LTTNG_POLL_GETEV(&events
, i
);
947 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
949 /* Thread quit pipe has been closed. Killing thread. */
950 ret
= check_thread_quit_pipe(pollfd
, revents
);
955 /* Event on the registration socket */
956 if (pollfd
== consumer_data
->err_sock
) {
957 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
958 ERR("consumer err socket poll error");
964 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
969 DBG2("Receiving code from consumer err_sock");
971 /* Getting status code from kconsumerd */
972 ret
= lttcomm_recv_unix_sock(sock
, &code
,
973 sizeof(enum lttcomm_return_code
));
978 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
979 consumer_data
->cmd_sock
=
980 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
981 if (consumer_data
->cmd_sock
< 0) {
982 sem_post(&consumer_data
->sem
);
983 PERROR("consumer connect");
986 /* Signal condition to tell that the kconsumerd is ready */
987 sem_post(&consumer_data
->sem
);
988 DBG("consumer command socket ready");
990 ERR("consumer error when waiting for SOCK_READY : %s",
991 lttcomm_get_readable_code(-code
));
995 /* Remove the kconsumerd error sock since we've established a connexion */
996 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1001 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1006 /* Update number of fd */
1007 nb_fd
= LTTNG_POLL_GETNB(&events
);
1009 /* Inifinite blocking call, waiting for transmission */
1011 ret
= lttng_poll_wait(&events
, -1);
1014 * Restart interrupted system call.
1016 if (errno
== EINTR
) {
1022 for (i
= 0; i
< nb_fd
; i
++) {
1023 /* Fetch once the poll data */
1024 revents
= LTTNG_POLL_GETEV(&events
, i
);
1025 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1027 /* Thread quit pipe has been closed. Killing thread. */
1028 ret
= check_thread_quit_pipe(pollfd
, revents
);
1033 /* Event on the kconsumerd socket */
1034 if (pollfd
== sock
) {
1035 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1036 ERR("consumer err socket second poll error");
1042 /* Wait for any kconsumerd error */
1043 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1044 sizeof(enum lttcomm_return_code
));
1046 ERR("consumer closed the command socket");
1050 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1053 DBG("consumer thread dying");
1054 close(consumer_data
->err_sock
);
1055 close(consumer_data
->cmd_sock
);
1058 unlink(consumer_data
->err_unix_sock_path
);
1059 unlink(consumer_data
->cmd_unix_sock_path
);
1060 consumer_data
->pid
= 0;
1062 lttng_poll_clean(&events
);
1068 * This thread manage application communication.
1070 static void *thread_manage_apps(void *data
)
1073 uint32_t revents
, nb_fd
;
1074 struct ust_command ust_cmd
;
1075 struct lttng_poll_event events
;
1077 DBG("[thread] Manage application started");
1079 rcu_register_thread();
1080 rcu_thread_online();
1082 ret
= create_thread_poll_set(&events
, 2);
1087 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1093 /* Zeroed the events structure */
1094 lttng_poll_reset(&events
);
1096 nb_fd
= LTTNG_POLL_GETNB(&events
);
1098 DBG("Apps thread polling on %d fds", nb_fd
);
1100 /* Inifinite blocking call, waiting for transmission */
1102 ret
= lttng_poll_wait(&events
, -1);
1105 * Restart interrupted system call.
1107 if (errno
== EINTR
) {
1113 for (i
= 0; i
< nb_fd
; i
++) {
1114 /* Fetch once the poll data */
1115 revents
= LTTNG_POLL_GETEV(&events
, i
);
1116 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1118 /* Thread quit pipe has been closed. Killing thread. */
1119 ret
= check_thread_quit_pipe(pollfd
, revents
);
1124 /* Inspect the apps cmd pipe */
1125 if (pollfd
== apps_cmd_pipe
[0]) {
1126 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1127 ERR("Apps command pipe error");
1129 } else if (revents
& LPOLLIN
) {
1131 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1132 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1133 perror("read apps cmd pipe");
1137 /* Register applicaton to the session daemon */
1138 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1140 if (ret
== -ENOMEM
) {
1142 } else if (ret
< 0) {
1147 * Validate UST version compatibility.
1149 ret
= ust_app_validate_version(ust_cmd
.sock
);
1152 * Add channel(s) and event(s) to newly registered apps
1153 * from lttng global UST domain.
1155 update_ust_app(ust_cmd
.sock
);
1158 ret
= ust_app_register_done(ust_cmd
.sock
);
1161 * If the registration is not possible, we simply
1162 * unregister the apps and continue
1164 ust_app_unregister(ust_cmd
.sock
);
1167 * We just need here to monitor the close of the UST
1168 * socket and poll set monitor those by default.
1169 * Listen on POLLIN (even if we never expect any
1170 * data) to ensure that hangup wakes us.
1172 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1177 DBG("Apps with sock %d added to poll set",
1185 * At this point, we know that a registered application made
1186 * the event at poll_wait.
1188 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1189 /* Removing from the poll set */
1190 ret
= lttng_poll_del(&events
, pollfd
);
1195 /* Socket closed on remote end. */
1196 ust_app_unregister(pollfd
);
1204 DBG("Application communication apps dying");
1205 close(apps_cmd_pipe
[0]);
1206 close(apps_cmd_pipe
[1]);
1208 lttng_poll_clean(&events
);
1210 rcu_thread_offline();
1211 rcu_unregister_thread();
1216 * Dispatch request from the registration threads to the application
1217 * communication thread.
1219 static void *thread_dispatch_ust_registration(void *data
)
1222 struct cds_wfq_node
*node
;
1223 struct ust_command
*ust_cmd
= NULL
;
1225 DBG("[thread] Dispatch UST command started");
1227 while (!dispatch_thread_exit
) {
1228 /* Atomically prepare the queue futex */
1229 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1232 /* Dequeue command for registration */
1233 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1235 DBG("Woken up but nothing in the UST command queue");
1236 /* Continue thread execution */
1240 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1242 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1243 " gid:%d sock:%d name:%s (version %d.%d)",
1244 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1245 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1246 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1247 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1249 * Inform apps thread of the new application registration. This
1250 * call is blocking so we can be assured that the data will be read
1251 * at some point in time or wait to the end of the world :)
1253 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1254 sizeof(struct ust_command
));
1256 perror("write apps cmd pipe");
1257 if (errno
== EBADF
) {
1259 * We can't inform the application thread to process
1260 * registration. We will exit or else application
1261 * registration will not occur and tracing will never
1268 } while (node
!= NULL
);
1270 /* Futex wait on queue. Blocking call on futex() */
1271 futex_nto1_wait(&ust_cmd_queue
.futex
);
1275 DBG("Dispatch thread dying");
1280 * This thread manage application registration.
1282 static void *thread_registration_apps(void *data
)
1284 int sock
= 0, i
, ret
, pollfd
;
1285 uint32_t revents
, nb_fd
;
1286 struct lttng_poll_event events
;
1288 * Get allocated in this thread, enqueued to a global queue, dequeued and
1289 * freed in the manage apps thread.
1291 struct ust_command
*ust_cmd
= NULL
;
1293 DBG("[thread] Manage application registration started");
1295 ret
= lttcomm_listen_unix_sock(apps_sock
);
1301 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1302 * more will be added to this poll set.
1304 ret
= create_thread_poll_set(&events
, 2);
1309 /* Add the application registration socket */
1310 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1315 /* Notify all applications to register */
1316 ret
= notify_ust_apps(1);
1318 ERR("Failed to notify applications or create the wait shared memory.\n"
1319 "Execution continues but there might be problem for already\n"
1320 "running applications that wishes to register.");
1324 DBG("Accepting application registration");
1326 nb_fd
= LTTNG_POLL_GETNB(&events
);
1328 /* Inifinite blocking call, waiting for transmission */
1330 ret
= lttng_poll_wait(&events
, -1);
1333 * Restart interrupted system call.
1335 if (errno
== EINTR
) {
1341 for (i
= 0; i
< nb_fd
; i
++) {
1342 /* Fetch once the poll data */
1343 revents
= LTTNG_POLL_GETEV(&events
, i
);
1344 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1346 /* Thread quit pipe has been closed. Killing thread. */
1347 ret
= check_thread_quit_pipe(pollfd
, revents
);
1352 /* Event on the registration socket */
1353 if (pollfd
== apps_sock
) {
1354 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1355 ERR("Register apps socket poll error");
1357 } else if (revents
& LPOLLIN
) {
1358 sock
= lttcomm_accept_unix_sock(apps_sock
);
1363 /* Create UST registration command for enqueuing */
1364 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1365 if (ust_cmd
== NULL
) {
1366 perror("ust command zmalloc");
1371 * Using message-based transmissions to ensure we don't
1372 * have to deal with partially received messages.
1374 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1375 sizeof(struct ust_register_msg
));
1376 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1378 perror("lttcomm_recv_unix_sock register apps");
1380 ERR("Wrong size received on apps register");
1387 ust_cmd
->sock
= sock
;
1389 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1390 " gid:%d sock:%d name:%s (version %d.%d)",
1391 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1392 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1393 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1394 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1397 * Lock free enqueue the registration request. The red pill
1398 * has been taken! This apps will be part of the *system*.
1400 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1403 * Wake the registration queue futex. Implicit memory
1404 * barrier with the exchange in cds_wfq_enqueue.
1406 futex_nto1_wake(&ust_cmd_queue
.futex
);
1413 DBG("UST Registration thread dying");
1415 /* Notify that the registration thread is gone */
1420 unlink(apps_unix_sock_path
);
1422 lttng_poll_clean(&events
);
1428 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1429 * exec or it will fails.
1431 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1434 struct timespec timeout
;
1436 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1437 timeout
.tv_nsec
= 0;
1439 /* Setup semaphore */
1440 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1442 PERROR("sem_init consumer semaphore");
1446 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1447 thread_manage_consumer
, consumer_data
);
1449 PERROR("pthread_create consumer");
1454 /* Get time for sem_timedwait absolute timeout */
1455 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1457 PERROR("clock_gettime spawn consumer");
1458 /* Infinite wait for the kconsumerd thread to be ready */
1459 ret
= sem_wait(&consumer_data
->sem
);
1461 /* Normal timeout if the gettime was successful */
1462 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1463 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1467 if (errno
== ETIMEDOUT
) {
1469 * Call has timed out so we kill the kconsumerd_thread and return
1472 ERR("The consumer thread was never ready. Killing it");
1473 ret
= pthread_cancel(consumer_data
->thread
);
1475 PERROR("pthread_cancel consumer thread");
1478 PERROR("semaphore wait failed consumer thread");
1483 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1484 if (consumer_data
->pid
== 0) {
1485 ERR("Kconsumerd did not start");
1486 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1489 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1498 * Join consumer thread
1500 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1505 if (consumer_data
->pid
!= 0) {
1506 ret
= kill(consumer_data
->pid
, SIGTERM
);
1508 ERR("Error killing consumer daemon");
1511 return pthread_join(consumer_data
->thread
, &status
);
1518 * Fork and exec a consumer daemon (consumerd).
1520 * Return pid if successful else -1.
1522 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1526 const char *consumer_to_use
;
1527 const char *verbosity
;
1530 DBG("Spawning consumerd");
1537 if (opt_verbose_consumer
) {
1538 verbosity
= "--verbose";
1540 verbosity
= "--quiet";
1542 switch (consumer_data
->type
) {
1543 case LTTNG_CONSUMER_KERNEL
:
1545 * Find out which consumerd to execute. We will first try the
1546 * 64-bit path, then the sessiond's installation directory, and
1547 * fallback on the 32-bit one,
1549 DBG3("Looking for a kernel consumer at these locations:");
1550 DBG3(" 1) %s", consumerd64_bin
);
1551 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1552 DBG3(" 3) %s", consumerd32_bin
);
1553 if (stat(consumerd64_bin
, &st
) == 0) {
1554 DBG3("Found location #1");
1555 consumer_to_use
= consumerd64_bin
;
1556 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1557 DBG3("Found location #2");
1558 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1559 } else if (stat(consumerd32_bin
, &st
) == 0) {
1560 DBG3("Found location #3");
1561 consumer_to_use
= consumerd32_bin
;
1563 DBG("Could not find any valid consumerd executable");
1566 DBG("Using kernel consumer at: %s", consumer_to_use
);
1567 execl(consumer_to_use
,
1568 "lttng-consumerd", verbosity
, "-k",
1569 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1570 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1573 case LTTNG_CONSUMER64_UST
:
1575 char *tmpnew
= NULL
;
1577 if (consumerd64_libdir
[0] != '\0') {
1581 tmp
= getenv("LD_LIBRARY_PATH");
1585 tmplen
= strlen("LD_LIBRARY_PATH=")
1586 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1587 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1592 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1593 strcat(tmpnew
, consumerd64_libdir
);
1594 if (tmp
[0] != '\0') {
1595 strcat(tmpnew
, ":");
1596 strcat(tmpnew
, tmp
);
1598 ret
= putenv(tmpnew
);
1604 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1605 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1606 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1607 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1609 if (consumerd64_libdir
[0] != '\0') {
1617 case LTTNG_CONSUMER32_UST
:
1619 char *tmpnew
= NULL
;
1621 if (consumerd32_libdir
[0] != '\0') {
1625 tmp
= getenv("LD_LIBRARY_PATH");
1629 tmplen
= strlen("LD_LIBRARY_PATH=")
1630 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1631 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1636 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1637 strcat(tmpnew
, consumerd32_libdir
);
1638 if (tmp
[0] != '\0') {
1639 strcat(tmpnew
, ":");
1640 strcat(tmpnew
, tmp
);
1642 ret
= putenv(tmpnew
);
1648 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1649 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1650 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1651 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1653 if (consumerd32_libdir
[0] != '\0') {
1662 perror("unknown consumer type");
1666 perror("kernel start consumer exec");
1669 } else if (pid
> 0) {
1672 perror("start consumer fork");
1680 * Spawn the consumerd daemon and session daemon thread.
1682 static int start_consumerd(struct consumer_data
*consumer_data
)
1686 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1687 if (consumer_data
->pid
!= 0) {
1688 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1692 ret
= spawn_consumerd(consumer_data
);
1694 ERR("Spawning consumerd failed");
1695 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1699 /* Setting up the consumer_data pid */
1700 consumer_data
->pid
= ret
;
1701 DBG2("Consumer pid %d", consumer_data
->pid
);
1702 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1704 DBG2("Spawning consumer control thread");
1705 ret
= spawn_consumer_thread(consumer_data
);
1707 ERR("Fatal error spawning consumer control thread");
1719 * Check version of the lttng-modules.
1721 static int validate_lttng_modules_version(void)
1723 return kernel_validate_version(kernel_tracer_fd
);
1727 * Setup necessary data for kernel tracer action.
1729 static int init_kernel_tracer(void)
1733 /* Modprobe lttng kernel modules */
1734 ret
= modprobe_lttng_control();
1739 /* Open debugfs lttng */
1740 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1741 if (kernel_tracer_fd
< 0) {
1742 DBG("Failed to open %s", module_proc_lttng
);
1747 /* Validate kernel version */
1748 ret
= validate_lttng_modules_version();
1753 ret
= modprobe_lttng_data();
1758 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1762 modprobe_remove_lttng_control();
1763 close(kernel_tracer_fd
);
1764 kernel_tracer_fd
= 0;
1765 return LTTCOMM_KERN_VERSION
;
1768 close(kernel_tracer_fd
);
1771 modprobe_remove_lttng_control();
1774 WARN("No kernel tracer available");
1775 kernel_tracer_fd
= 0;
1776 return LTTCOMM_KERN_NA
;
1780 * Init tracing by creating trace directory and sending fds kernel consumer.
1782 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1786 if (session
->consumer_fds_sent
== 0) {
1788 * Assign default kernel consumer socket if no consumer assigned to the
1789 * kernel session. At this point, it's NOT suppose to be 0 but this is
1790 * an extra security check.
1792 if (session
->consumer_fd
== 0) {
1793 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1796 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1798 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1802 session
->consumer_fds_sent
= 1;
1810 * Create an UST session and add it to the session ust list.
1812 static int create_ust_session(struct ltt_session
*session
,
1813 struct lttng_domain
*domain
)
1815 struct ltt_ust_session
*lus
= NULL
;
1818 switch (domain
->type
) {
1819 case LTTNG_DOMAIN_UST
:
1822 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1826 DBG("Creating UST session");
1828 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1830 ret
= LTTCOMM_UST_SESS_FAIL
;
1834 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1835 session
->uid
, session
->gid
);
1837 if (ret
!= -EEXIST
) {
1838 ERR("Trace directory creation error");
1839 ret
= LTTCOMM_UST_SESS_FAIL
;
1844 /* The domain type dictate different actions on session creation */
1845 switch (domain
->type
) {
1846 case LTTNG_DOMAIN_UST
:
1847 /* No ustctl for the global UST domain */
1850 ERR("Unknown UST domain on create session %d", domain
->type
);
1853 lus
->uid
= session
->uid
;
1854 lus
->gid
= session
->gid
;
1855 session
->ust_session
= lus
;
1865 * Create a kernel tracer session then create the default channel.
1867 static int create_kernel_session(struct ltt_session
*session
)
1871 DBG("Creating kernel session");
1873 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1875 ret
= LTTCOMM_KERN_SESS_FAIL
;
1879 /* Set kernel consumer socket fd */
1880 if (kconsumer_data
.cmd_sock
) {
1881 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1884 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1885 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1887 if (ret
!= -EEXIST
) {
1888 ERR("Trace directory creation error");
1892 session
->kernel_session
->uid
= session
->uid
;
1893 session
->kernel_session
->gid
= session
->gid
;
1900 * Check if the UID or GID match the session. Root user has access to all
1903 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1905 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1912 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1915 struct ltt_session
*session
;
1917 DBG("Counting number of available session for UID %d GID %d",
1919 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1921 * Only list the sessions the user can control.
1923 if (!session_access_ok(session
, uid
, gid
)) {
1932 * Using the session list, filled a lttng_session array to send back to the
1933 * client for session listing.
1935 * The session list lock MUST be acquired before calling this function. Use
1936 * session_lock_list() and session_unlock_list().
1938 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1942 struct ltt_session
*session
;
1944 DBG("Getting all available session for UID %d GID %d",
1947 * Iterate over session list and append data after the control struct in
1950 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1952 * Only list the sessions the user can control.
1954 if (!session_access_ok(session
, uid
, gid
)) {
1957 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1958 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1959 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1960 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1961 sessions
[i
].enabled
= session
->enabled
;
1967 * Fill lttng_channel array of all channels.
1969 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1970 struct lttng_channel
*channels
)
1973 struct ltt_kernel_channel
*kchan
;
1975 DBG("Listing channels for session %s", session
->name
);
1978 case LTTNG_DOMAIN_KERNEL
:
1979 /* Kernel channels */
1980 if (session
->kernel_session
!= NULL
) {
1981 cds_list_for_each_entry(kchan
,
1982 &session
->kernel_session
->channel_list
.head
, list
) {
1983 /* Copy lttng_channel struct to array */
1984 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1985 channels
[i
].enabled
= kchan
->enabled
;
1990 case LTTNG_DOMAIN_UST
:
1992 struct lttng_ht_iter iter
;
1993 struct ltt_ust_channel
*uchan
;
1995 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1996 &iter
.iter
, uchan
, node
.node
) {
1997 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1998 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1999 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2000 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2001 channels
[i
].attr
.switch_timer_interval
=
2002 uchan
->attr
.switch_timer_interval
;
2003 channels
[i
].attr
.read_timer_interval
=
2004 uchan
->attr
.read_timer_interval
;
2005 channels
[i
].enabled
= uchan
->enabled
;
2006 switch (uchan
->attr
.output
) {
2007 case LTTNG_UST_MMAP
:
2009 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2022 * Create a list of ust global domain events.
2024 static int list_lttng_ust_global_events(char *channel_name
,
2025 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2028 unsigned int nb_event
= 0;
2029 struct lttng_ht_iter iter
;
2030 struct lttng_ht_node_str
*node
;
2031 struct ltt_ust_channel
*uchan
;
2032 struct ltt_ust_event
*uevent
;
2033 struct lttng_event
*tmp
;
2035 DBG("Listing UST global events for channel %s", channel_name
);
2039 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2040 node
= lttng_ht_iter_get_node_str(&iter
);
2042 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2046 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2048 nb_event
+= lttng_ht_get_count(uchan
->events
);
2050 if (nb_event
== 0) {
2055 DBG3("Listing UST global %d events", nb_event
);
2057 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2059 ret
= -LTTCOMM_FATAL
;
2063 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2064 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2065 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2066 tmp
[i
].enabled
= uevent
->enabled
;
2067 switch (uevent
->attr
.instrumentation
) {
2068 case LTTNG_UST_TRACEPOINT
:
2069 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2071 case LTTNG_UST_PROBE
:
2072 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2074 case LTTNG_UST_FUNCTION
:
2075 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2078 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2079 switch (uevent
->attr
.loglevel_type
) {
2080 case LTTNG_UST_LOGLEVEL_ALL
:
2081 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2083 case LTTNG_UST_LOGLEVEL_RANGE
:
2084 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2086 case LTTNG_UST_LOGLEVEL_SINGLE
:
2087 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2102 * Fill lttng_event array of all kernel events in the channel.
2104 static int list_lttng_kernel_events(char *channel_name
,
2105 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2108 unsigned int nb_event
;
2109 struct ltt_kernel_event
*event
;
2110 struct ltt_kernel_channel
*kchan
;
2112 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2113 if (kchan
== NULL
) {
2114 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2118 nb_event
= kchan
->event_count
;
2120 DBG("Listing events for channel %s", kchan
->channel
->name
);
2122 if (nb_event
== 0) {
2127 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2128 if (*events
== NULL
) {
2129 ret
= LTTCOMM_FATAL
;
2133 /* Kernel channels */
2134 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2135 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2136 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2137 (*events
)[i
].enabled
= event
->enabled
;
2138 switch (event
->event
->instrumentation
) {
2139 case LTTNG_KERNEL_TRACEPOINT
:
2140 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2142 case LTTNG_KERNEL_KPROBE
:
2143 case LTTNG_KERNEL_KRETPROBE
:
2144 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2145 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2146 sizeof(struct lttng_kernel_kprobe
));
2148 case LTTNG_KERNEL_FUNCTION
:
2149 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2150 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2151 sizeof(struct lttng_kernel_function
));
2153 case LTTNG_KERNEL_NOOP
:
2154 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2156 case LTTNG_KERNEL_SYSCALL
:
2157 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2159 case LTTNG_KERNEL_ALL
:
2173 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2175 static int cmd_disable_channel(struct ltt_session
*session
,
2176 int domain
, char *channel_name
)
2179 struct ltt_ust_session
*usess
;
2181 usess
= session
->ust_session
;
2184 case LTTNG_DOMAIN_KERNEL
:
2186 ret
= channel_kernel_disable(session
->kernel_session
,
2188 if (ret
!= LTTCOMM_OK
) {
2192 kernel_wait_quiescent(kernel_tracer_fd
);
2195 case LTTNG_DOMAIN_UST
:
2197 struct ltt_ust_channel
*uchan
;
2198 struct lttng_ht
*chan_ht
;
2200 chan_ht
= usess
->domain_global
.channels
;
2202 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2203 if (uchan
== NULL
) {
2204 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2208 ret
= channel_ust_disable(usess
, domain
, uchan
);
2209 if (ret
!= LTTCOMM_OK
) {
2215 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2216 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2217 case LTTNG_DOMAIN_UST_PID
:
2220 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2231 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2233 static int cmd_enable_channel(struct ltt_session
*session
,
2234 int domain
, struct lttng_channel
*attr
)
2237 struct ltt_ust_session
*usess
= session
->ust_session
;
2238 struct lttng_ht
*chan_ht
;
2240 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2243 case LTTNG_DOMAIN_KERNEL
:
2245 struct ltt_kernel_channel
*kchan
;
2247 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2248 session
->kernel_session
);
2249 if (kchan
== NULL
) {
2250 ret
= channel_kernel_create(session
->kernel_session
,
2251 attr
, kernel_poll_pipe
[1]);
2253 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2256 if (ret
!= LTTCOMM_OK
) {
2260 kernel_wait_quiescent(kernel_tracer_fd
);
2263 case LTTNG_DOMAIN_UST
:
2265 struct ltt_ust_channel
*uchan
;
2267 chan_ht
= usess
->domain_global
.channels
;
2269 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2270 if (uchan
== NULL
) {
2271 ret
= channel_ust_create(usess
, domain
, attr
);
2273 ret
= channel_ust_enable(usess
, domain
, uchan
);
2278 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2279 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2280 case LTTNG_DOMAIN_UST_PID
:
2283 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2292 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2294 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2295 char *channel_name
, char *event_name
)
2300 case LTTNG_DOMAIN_KERNEL
:
2302 struct ltt_kernel_channel
*kchan
;
2303 struct ltt_kernel_session
*ksess
;
2305 ksess
= session
->kernel_session
;
2307 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2308 if (kchan
== NULL
) {
2309 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2313 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2314 if (ret
!= LTTCOMM_OK
) {
2318 kernel_wait_quiescent(kernel_tracer_fd
);
2321 case LTTNG_DOMAIN_UST
:
2323 struct ltt_ust_channel
*uchan
;
2324 struct ltt_ust_session
*usess
;
2326 usess
= session
->ust_session
;
2328 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2330 if (uchan
== NULL
) {
2331 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2335 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2336 if (ret
!= LTTCOMM_OK
) {
2340 DBG3("Disable UST event %s in channel %s completed", event_name
,
2345 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2346 case LTTNG_DOMAIN_UST_PID
:
2347 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2361 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2363 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2369 case LTTNG_DOMAIN_KERNEL
:
2371 struct ltt_kernel_session
*ksess
;
2372 struct ltt_kernel_channel
*kchan
;
2374 ksess
= session
->kernel_session
;
2376 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2377 if (kchan
== NULL
) {
2378 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2382 ret
= event_kernel_disable_all(ksess
, kchan
);
2383 if (ret
!= LTTCOMM_OK
) {
2387 kernel_wait_quiescent(kernel_tracer_fd
);
2390 case LTTNG_DOMAIN_UST
:
2392 struct ltt_ust_session
*usess
;
2393 struct ltt_ust_channel
*uchan
;
2395 usess
= session
->ust_session
;
2397 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2399 if (uchan
== NULL
) {
2400 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2404 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2409 DBG3("Disable all UST events in channel %s completed", channel_name
);
2414 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2415 case LTTNG_DOMAIN_UST_PID
:
2416 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2430 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2432 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2433 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2438 case LTTNG_DOMAIN_KERNEL
:
2439 /* Add kernel context to kernel tracer */
2440 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2441 event_name
, channel_name
);
2442 if (ret
!= LTTCOMM_OK
) {
2446 case LTTNG_DOMAIN_UST
:
2448 struct ltt_ust_session
*usess
= session
->ust_session
;
2450 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2451 if (ret
!= LTTCOMM_OK
) {
2457 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2458 case LTTNG_DOMAIN_UST_PID
:
2459 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2473 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2475 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2476 char *channel_name
, struct lttng_event
*event
)
2479 struct lttng_channel
*attr
;
2480 struct ltt_ust_session
*usess
= session
->ust_session
;
2483 case LTTNG_DOMAIN_KERNEL
:
2485 struct ltt_kernel_channel
*kchan
;
2487 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2488 session
->kernel_session
);
2489 if (kchan
== NULL
) {
2490 attr
= channel_new_default_attr(domain
);
2492 ret
= LTTCOMM_FATAL
;
2495 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2497 /* This call will notify the kernel thread */
2498 ret
= channel_kernel_create(session
->kernel_session
,
2499 attr
, kernel_poll_pipe
[1]);
2500 if (ret
!= LTTCOMM_OK
) {
2507 /* Get the newly created kernel channel pointer */
2508 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2509 session
->kernel_session
);
2510 if (kchan
== NULL
) {
2511 /* This sould not happen... */
2512 ret
= LTTCOMM_FATAL
;
2516 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2518 if (ret
!= LTTCOMM_OK
) {
2522 kernel_wait_quiescent(kernel_tracer_fd
);
2525 case LTTNG_DOMAIN_UST
:
2527 struct lttng_channel
*attr
;
2528 struct ltt_ust_channel
*uchan
;
2530 /* Get channel from global UST domain */
2531 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2533 if (uchan
== NULL
) {
2534 /* Create default channel */
2535 attr
= channel_new_default_attr(domain
);
2537 ret
= LTTCOMM_FATAL
;
2540 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2541 attr
->name
[NAME_MAX
- 1] = '\0';
2543 ret
= channel_ust_create(usess
, domain
, attr
);
2544 if (ret
!= LTTCOMM_OK
) {
2550 /* Get the newly created channel reference back */
2551 uchan
= trace_ust_find_channel_by_name(
2552 usess
->domain_global
.channels
, channel_name
);
2553 if (uchan
== NULL
) {
2554 /* Something is really wrong */
2555 ret
= LTTCOMM_FATAL
;
2560 /* At this point, the session and channel exist on the tracer */
2561 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2562 if (ret
!= LTTCOMM_OK
) {
2568 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2569 case LTTNG_DOMAIN_UST_PID
:
2570 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2584 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2586 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2587 char *channel_name
, int event_type
)
2590 struct ltt_kernel_channel
*kchan
;
2593 case LTTNG_DOMAIN_KERNEL
:
2594 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2595 session
->kernel_session
);
2596 if (kchan
== NULL
) {
2597 /* This call will notify the kernel thread */
2598 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2599 kernel_poll_pipe
[1]);
2600 if (ret
!= LTTCOMM_OK
) {
2604 /* Get the newly created kernel channel pointer */
2605 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2606 session
->kernel_session
);
2607 if (kchan
== NULL
) {
2608 /* This sould not happen... */
2609 ret
= LTTCOMM_FATAL
;
2615 switch (event_type
) {
2616 case LTTNG_EVENT_SYSCALL
:
2617 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2618 kchan
, kernel_tracer_fd
);
2620 case LTTNG_EVENT_TRACEPOINT
:
2622 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2623 * events already registered to the channel.
2625 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2626 kchan
, kernel_tracer_fd
);
2628 case LTTNG_EVENT_ALL
:
2629 /* Enable syscalls and tracepoints */
2630 ret
= event_kernel_enable_all(session
->kernel_session
,
2631 kchan
, kernel_tracer_fd
);
2634 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2638 /* Manage return value */
2639 if (ret
!= LTTCOMM_OK
) {
2643 kernel_wait_quiescent(kernel_tracer_fd
);
2645 case LTTNG_DOMAIN_UST
:
2647 struct lttng_channel
*attr
;
2648 struct ltt_ust_channel
*uchan
;
2649 struct ltt_ust_session
*usess
= session
->ust_session
;
2651 /* Get channel from global UST domain */
2652 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2654 if (uchan
== NULL
) {
2655 /* Create default channel */
2656 attr
= channel_new_default_attr(domain
);
2658 ret
= LTTCOMM_FATAL
;
2661 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2662 attr
->name
[NAME_MAX
- 1] = '\0';
2664 /* Use the internal command enable channel */
2665 ret
= channel_ust_create(usess
, domain
, attr
);
2666 if (ret
!= LTTCOMM_OK
) {
2672 /* Get the newly created channel reference back */
2673 uchan
= trace_ust_find_channel_by_name(
2674 usess
->domain_global
.channels
, channel_name
);
2675 if (uchan
== NULL
) {
2676 /* Something is really wrong */
2677 ret
= LTTCOMM_FATAL
;
2682 /* At this point, the session and channel exist on the tracer */
2684 switch (event_type
) {
2685 case LTTNG_EVENT_ALL
:
2686 case LTTNG_EVENT_TRACEPOINT
:
2687 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2688 if (ret
!= LTTCOMM_OK
) {
2693 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2697 /* Manage return value */
2698 if (ret
!= LTTCOMM_OK
) {
2705 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2706 case LTTNG_DOMAIN_UST_PID
:
2707 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2721 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2723 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2726 ssize_t nb_events
= 0;
2729 case LTTNG_DOMAIN_KERNEL
:
2730 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2731 if (nb_events
< 0) {
2732 ret
= LTTCOMM_KERN_LIST_FAIL
;
2736 case LTTNG_DOMAIN_UST
:
2737 nb_events
= ust_app_list_events(events
);
2738 if (nb_events
< 0) {
2739 ret
= LTTCOMM_UST_LIST_FAIL
;
2751 /* Return negative value to differentiate return code */
2756 * Command LTTNG_START_TRACE processed by the client thread.
2758 static int cmd_start_trace(struct ltt_session
*session
)
2761 struct ltt_kernel_session
*ksession
;
2762 struct ltt_ust_session
*usess
;
2765 ksession
= session
->kernel_session
;
2766 usess
= session
->ust_session
;
2768 if (session
->enabled
) {
2769 ret
= LTTCOMM_UST_START_FAIL
;
2773 session
->enabled
= 1;
2775 /* Kernel tracing */
2776 if (ksession
!= NULL
) {
2777 struct ltt_kernel_channel
*kchan
;
2779 /* Open kernel metadata */
2780 if (ksession
->metadata
== NULL
) {
2781 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2783 ret
= LTTCOMM_KERN_META_FAIL
;
2788 /* Open kernel metadata stream */
2789 if (ksession
->metadata_stream_fd
== 0) {
2790 ret
= kernel_open_metadata_stream(ksession
);
2792 ERR("Kernel create metadata stream failed");
2793 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2798 /* For each channel */
2799 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2800 if (kchan
->stream_count
== 0) {
2801 ret
= kernel_open_channel_stream(kchan
);
2803 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2806 /* Update the stream global counter */
2807 ksession
->stream_count_global
+= ret
;
2811 /* Setup kernel consumer socket and send fds to it */
2812 ret
= init_kernel_tracing(ksession
);
2814 ret
= LTTCOMM_KERN_START_FAIL
;
2818 /* This start the kernel tracing */
2819 ret
= kernel_start_session(ksession
);
2821 ret
= LTTCOMM_KERN_START_FAIL
;
2825 /* Quiescent wait after starting trace */
2826 kernel_wait_quiescent(kernel_tracer_fd
);
2829 /* Flag session that trace should start automatically */
2831 usess
->start_trace
= 1;
2833 ret
= ust_app_start_trace_all(usess
);
2835 ret
= LTTCOMM_UST_START_FAIL
;
2847 * Command LTTNG_STOP_TRACE processed by the client thread.
2849 static int cmd_stop_trace(struct ltt_session
*session
)
2852 struct ltt_kernel_channel
*kchan
;
2853 struct ltt_kernel_session
*ksession
;
2854 struct ltt_ust_session
*usess
;
2857 ksession
= session
->kernel_session
;
2858 usess
= session
->ust_session
;
2860 if (!session
->enabled
) {
2861 ret
= LTTCOMM_UST_STOP_FAIL
;
2865 session
->enabled
= 0;
2868 if (ksession
!= NULL
) {
2869 DBG("Stop kernel tracing");
2871 /* Flush all buffers before stopping */
2872 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2874 ERR("Kernel metadata flush failed");
2877 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2878 ret
= kernel_flush_buffer(kchan
);
2880 ERR("Kernel flush buffer error");
2884 ret
= kernel_stop_session(ksession
);
2886 ret
= LTTCOMM_KERN_STOP_FAIL
;
2890 kernel_wait_quiescent(kernel_tracer_fd
);
2894 usess
->start_trace
= 0;
2896 ret
= ust_app_stop_trace_all(usess
);
2898 ret
= LTTCOMM_UST_STOP_FAIL
;
2910 * Command LTTNG_CREATE_SESSION processed by the client thread.
2912 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2916 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2917 if (ret
!= LTTCOMM_OK
) {
2928 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2930 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2934 /* Clean kernel session teardown */
2935 teardown_kernel_session(session
);
2936 /* UST session teardown */
2937 teardown_ust_session(session
);
2940 * Must notify the kernel thread here to update it's poll setin order
2941 * to remove the channel(s)' fd just destroyed.
2943 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2945 perror("write kernel poll pipe");
2948 ret
= session_destroy(session
);
2954 * Command LTTNG_CALIBRATE processed by the client thread.
2956 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2961 case LTTNG_DOMAIN_KERNEL
:
2963 struct lttng_kernel_calibrate kcalibrate
;
2965 kcalibrate
.type
= calibrate
->type
;
2966 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2968 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2973 case LTTNG_DOMAIN_UST
:
2975 struct lttng_ust_calibrate ucalibrate
;
2977 ucalibrate
.type
= calibrate
->type
;
2978 ret
= ust_app_calibrate_glb(&ucalibrate
);
2980 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2997 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2999 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3005 case LTTNG_DOMAIN_KERNEL
:
3006 /* Can't register a consumer if there is already one */
3007 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3008 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3012 sock
= lttcomm_connect_unix_sock(sock_path
);
3014 ret
= LTTCOMM_CONNECT_FAIL
;
3018 session
->kernel_session
->consumer_fd
= sock
;
3021 /* TODO: Userspace tracing */
3033 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3035 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3036 struct lttng_domain
**domains
)
3041 if (session
->kernel_session
!= NULL
) {
3042 DBG3("Listing domains found kernel domain");
3046 if (session
->ust_session
!= NULL
) {
3047 DBG3("Listing domains found UST global domain");
3051 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3052 if (*domains
== NULL
) {
3053 ret
= -LTTCOMM_FATAL
;
3057 if (session
->kernel_session
!= NULL
) {
3058 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3062 if (session
->ust_session
!= NULL
) {
3063 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3074 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3076 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3077 struct lttng_channel
**channels
)
3080 ssize_t nb_chan
= 0;
3083 case LTTNG_DOMAIN_KERNEL
:
3084 if (session
->kernel_session
!= NULL
) {
3085 nb_chan
= session
->kernel_session
->channel_count
;
3087 DBG3("Number of kernel channels %zd", nb_chan
);
3089 case LTTNG_DOMAIN_UST
:
3090 if (session
->ust_session
!= NULL
) {
3091 nb_chan
= lttng_ht_get_count(
3092 session
->ust_session
->domain_global
.channels
);
3094 DBG3("Number of UST global channels %zd", nb_chan
);
3103 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3104 if (*channels
== NULL
) {
3105 ret
= -LTTCOMM_FATAL
;
3109 list_lttng_channels(domain
, session
, *channels
);
3121 * Command LTTNG_LIST_EVENTS processed by the client thread.
3123 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3124 char *channel_name
, struct lttng_event
**events
)
3127 ssize_t nb_event
= 0;
3130 case LTTNG_DOMAIN_KERNEL
:
3131 if (session
->kernel_session
!= NULL
) {
3132 nb_event
= list_lttng_kernel_events(channel_name
,
3133 session
->kernel_session
, events
);
3136 case LTTNG_DOMAIN_UST
:
3138 if (session
->ust_session
!= NULL
) {
3139 nb_event
= list_lttng_ust_global_events(channel_name
,
3140 &session
->ust_session
->domain_global
, events
);
3156 * Process the command requested by the lttng client within the command
3157 * context structure. This function make sure that the return structure (llm)
3158 * is set and ready for transmission before returning.
3160 * Return any error encountered or 0 for success.
3162 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3164 int ret
= LTTCOMM_OK
;
3165 int need_tracing_session
= 1;
3168 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3170 switch (cmd_ctx
->lsm
->cmd_type
) {
3171 case LTTNG_CREATE_SESSION
:
3172 case LTTNG_DESTROY_SESSION
:
3173 case LTTNG_LIST_SESSIONS
:
3174 case LTTNG_LIST_DOMAINS
:
3175 case LTTNG_START_TRACE
:
3176 case LTTNG_STOP_TRACE
:
3183 if (opt_no_kernel
&& need_domain
3184 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3185 ret
= LTTCOMM_KERN_NA
;
3190 * Check for command that don't needs to allocate a returned payload. We do
3191 * this here so we don't have to make the call for no payload at each
3194 switch(cmd_ctx
->lsm
->cmd_type
) {
3195 case LTTNG_LIST_SESSIONS
:
3196 case LTTNG_LIST_TRACEPOINTS
:
3197 case LTTNG_LIST_DOMAINS
:
3198 case LTTNG_LIST_CHANNELS
:
3199 case LTTNG_LIST_EVENTS
:
3202 /* Setup lttng message with no payload */
3203 ret
= setup_lttng_msg(cmd_ctx
, 0);
3205 /* This label does not try to unlock the session */
3206 goto init_setup_error
;
3210 /* Commands that DO NOT need a session. */
3211 switch (cmd_ctx
->lsm
->cmd_type
) {
3212 case LTTNG_CREATE_SESSION
:
3213 case LTTNG_CALIBRATE
:
3214 case LTTNG_LIST_SESSIONS
:
3215 case LTTNG_LIST_TRACEPOINTS
:
3216 need_tracing_session
= 0;
3219 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3220 session_lock_list();
3221 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3222 session_unlock_list();
3223 if (cmd_ctx
->session
== NULL
) {
3224 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3225 ret
= LTTCOMM_SESS_NOT_FOUND
;
3227 /* If no session name specified */
3228 ret
= LTTCOMM_SELECT_SESS
;
3232 /* Acquire lock for the session */
3233 session_lock(cmd_ctx
->session
);
3242 * Check domain type for specific "pre-action".
3244 switch (cmd_ctx
->lsm
->domain
.type
) {
3245 case LTTNG_DOMAIN_KERNEL
:
3247 ret
= LTTCOMM_KERN_NA
;
3251 /* Kernel tracer check */
3252 if (kernel_tracer_fd
== 0) {
3253 /* Basically, load kernel tracer modules */
3254 ret
= init_kernel_tracer();
3260 /* Need a session for kernel command */
3261 if (need_tracing_session
) {
3262 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3263 ret
= create_kernel_session(cmd_ctx
->session
);
3265 ret
= LTTCOMM_KERN_SESS_FAIL
;
3270 /* Start the kernel consumer daemon */
3271 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3272 if (kconsumer_data
.pid
== 0 &&
3273 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3274 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3275 ret
= start_consumerd(&kconsumer_data
);
3277 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3281 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3285 case LTTNG_DOMAIN_UST
:
3287 if (need_tracing_session
) {
3288 if (cmd_ctx
->session
->ust_session
== NULL
) {
3289 ret
= create_ust_session(cmd_ctx
->session
,
3290 &cmd_ctx
->lsm
->domain
);
3291 if (ret
!= LTTCOMM_OK
) {
3295 /* Start the UST consumer daemons */
3297 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3298 if (consumerd64_bin
[0] != '\0' &&
3299 ustconsumer64_data
.pid
== 0 &&
3300 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3301 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3302 ret
= start_consumerd(&ustconsumer64_data
);
3304 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3305 ust_consumerd64_fd
= -EINVAL
;
3309 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3311 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3314 if (consumerd32_bin
[0] != '\0' &&
3315 ustconsumer32_data
.pid
== 0 &&
3316 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3317 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3318 ret
= start_consumerd(&ustconsumer32_data
);
3320 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3321 ust_consumerd32_fd
= -EINVAL
;
3324 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3326 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3337 * Check that the UID or GID match that of the tracing session.
3338 * The root user can interact with all sessions.
3340 if (need_tracing_session
) {
3341 if (!session_access_ok(cmd_ctx
->session
,
3342 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3343 ret
= LTTCOMM_EPERM
;
3348 /* Process by command type */
3349 switch (cmd_ctx
->lsm
->cmd_type
) {
3350 case LTTNG_ADD_CONTEXT
:
3352 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3353 cmd_ctx
->lsm
->u
.context
.channel_name
,
3354 cmd_ctx
->lsm
->u
.context
.event_name
,
3355 &cmd_ctx
->lsm
->u
.context
.ctx
);
3358 case LTTNG_DISABLE_CHANNEL
:
3360 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3361 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3364 case LTTNG_DISABLE_EVENT
:
3366 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3367 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3368 cmd_ctx
->lsm
->u
.disable
.name
);
3371 case LTTNG_DISABLE_ALL_EVENT
:
3373 DBG("Disabling all events");
3375 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3376 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3379 case LTTNG_ENABLE_CHANNEL
:
3381 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3382 &cmd_ctx
->lsm
->u
.channel
.chan
);
3385 case LTTNG_ENABLE_EVENT
:
3387 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3388 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3389 &cmd_ctx
->lsm
->u
.enable
.event
);
3392 case LTTNG_ENABLE_ALL_EVENT
:
3394 DBG("Enabling all events");
3396 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3397 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3398 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3401 case LTTNG_LIST_TRACEPOINTS
:
3403 struct lttng_event
*events
;
3406 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3407 if (nb_events
< 0) {
3413 * Setup lttng message with payload size set to the event list size in
3414 * bytes and then copy list into the llm payload.
3416 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3422 /* Copy event list into message payload */
3423 memcpy(cmd_ctx
->llm
->payload
, events
,
3424 sizeof(struct lttng_event
) * nb_events
);
3431 case LTTNG_START_TRACE
:
3433 ret
= cmd_start_trace(cmd_ctx
->session
);
3436 case LTTNG_STOP_TRACE
:
3438 ret
= cmd_stop_trace(cmd_ctx
->session
);
3441 case LTTNG_CREATE_SESSION
:
3443 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3444 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3447 case LTTNG_DESTROY_SESSION
:
3449 ret
= cmd_destroy_session(cmd_ctx
->session
,
3450 cmd_ctx
->lsm
->session
.name
);
3453 case LTTNG_LIST_DOMAINS
:
3456 struct lttng_domain
*domains
;
3458 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3464 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3469 /* Copy event list into message payload */
3470 memcpy(cmd_ctx
->llm
->payload
, domains
,
3471 nb_dom
* sizeof(struct lttng_domain
));
3478 case LTTNG_LIST_CHANNELS
:
3481 struct lttng_channel
*channels
;
3483 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3484 cmd_ctx
->session
, &channels
);
3490 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3495 /* Copy event list into message payload */
3496 memcpy(cmd_ctx
->llm
->payload
, channels
,
3497 nb_chan
* sizeof(struct lttng_channel
));
3504 case LTTNG_LIST_EVENTS
:
3507 struct lttng_event
*events
= NULL
;
3509 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3510 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3516 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3521 /* Copy event list into message payload */
3522 memcpy(cmd_ctx
->llm
->payload
, events
,
3523 nb_event
* sizeof(struct lttng_event
));
3530 case LTTNG_LIST_SESSIONS
:
3532 unsigned int nr_sessions
;
3534 session_lock_list();
3535 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3537 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3539 session_unlock_list();
3543 /* Filled the session array */
3544 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3545 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3547 session_unlock_list();
3552 case LTTNG_CALIBRATE
:
3554 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3555 &cmd_ctx
->lsm
->u
.calibrate
);
3558 case LTTNG_REGISTER_CONSUMER
:
3560 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3561 cmd_ctx
->lsm
->u
.reg
.path
);
3570 if (cmd_ctx
->llm
== NULL
) {
3571 DBG("Missing llm structure. Allocating one.");
3572 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3576 /* Set return code */
3577 cmd_ctx
->llm
->ret_code
= ret
;
3579 if (cmd_ctx
->session
) {
3580 session_unlock(cmd_ctx
->session
);
3587 * This thread manage all clients request using the unix client socket for
3590 static void *thread_manage_clients(void *data
)
3592 int sock
= 0, ret
, i
, pollfd
;
3593 uint32_t revents
, nb_fd
;
3594 struct command_ctx
*cmd_ctx
= NULL
;
3595 struct lttng_poll_event events
;
3597 DBG("[thread] Manage client started");
3599 rcu_register_thread();
3601 ret
= lttcomm_listen_unix_sock(client_sock
);
3607 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3608 * more will be added to this poll set.
3610 ret
= create_thread_poll_set(&events
, 2);
3615 /* Add the application registration socket */
3616 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3622 * Notify parent pid that we are ready to accept command for client side.
3624 if (opt_sig_parent
) {
3625 kill(ppid
, SIGUSR1
);
3629 DBG("Accepting client command ...");
3631 nb_fd
= LTTNG_POLL_GETNB(&events
);
3633 /* Inifinite blocking call, waiting for transmission */
3635 ret
= lttng_poll_wait(&events
, -1);
3638 * Restart interrupted system call.
3640 if (errno
== EINTR
) {
3646 for (i
= 0; i
< nb_fd
; i
++) {
3647 /* Fetch once the poll data */
3648 revents
= LTTNG_POLL_GETEV(&events
, i
);
3649 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3651 /* Thread quit pipe has been closed. Killing thread. */
3652 ret
= check_thread_quit_pipe(pollfd
, revents
);
3657 /* Event on the registration socket */
3658 if (pollfd
== client_sock
) {
3659 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3660 ERR("Client socket poll error");
3666 DBG("Wait for client response");
3668 sock
= lttcomm_accept_unix_sock(client_sock
);
3673 /* Set socket option for credentials retrieval */
3674 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3679 /* Allocate context command to process the client request */
3680 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3681 if (cmd_ctx
== NULL
) {
3682 perror("zmalloc cmd_ctx");
3686 /* Allocate data buffer for reception */
3687 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3688 if (cmd_ctx
->lsm
== NULL
) {
3689 perror("zmalloc cmd_ctx->lsm");
3693 cmd_ctx
->llm
= NULL
;
3694 cmd_ctx
->session
= NULL
;
3697 * Data is received from the lttng client. The struct
3698 * lttcomm_session_msg (lsm) contains the command and data request of
3701 DBG("Receiving data from client ...");
3702 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3703 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3705 DBG("Nothing recv() from client... continuing");
3711 // TODO: Validate cmd_ctx including sanity check for
3712 // security purpose.
3714 rcu_thread_online();
3716 * This function dispatch the work to the kernel or userspace tracer
3717 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3718 * informations for the client. The command context struct contains
3719 * everything this function may needs.
3721 ret
= process_client_msg(cmd_ctx
);
3722 rcu_thread_offline();
3725 * TODO: Inform client somehow of the fatal error. At
3726 * this point, ret < 0 means that a zmalloc failed
3727 * (ENOMEM). Error detected but still accept command.
3729 clean_command_ctx(&cmd_ctx
);
3733 DBG("Sending response (size: %d, retcode: %s)",
3734 cmd_ctx
->lttng_msg_size
,
3735 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3736 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3738 ERR("Failed to send data back to client");
3741 /* End of transmission */
3744 clean_command_ctx(&cmd_ctx
);
3748 DBG("Client thread dying");
3749 unlink(client_unix_sock_path
);
3753 lttng_poll_clean(&events
);
3754 clean_command_ctx(&cmd_ctx
);
3756 rcu_unregister_thread();
3762 * usage function on stderr
3764 static void usage(void)
3766 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3767 fprintf(stderr
, " -h, --help Display this usage.\n");
3768 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3769 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3770 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3771 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3772 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3773 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3774 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3775 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3776 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3777 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3778 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3779 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3780 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3781 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3782 fprintf(stderr
, " -V, --version Show version number.\n");
3783 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3784 fprintf(stderr
, " -q, --quiet No output at all.\n");
3785 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3786 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3787 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3791 * daemon argument parsing
3793 static int parse_args(int argc
, char **argv
)
3797 static struct option long_options
[] = {
3798 { "client-sock", 1, 0, 'c' },
3799 { "apps-sock", 1, 0, 'a' },
3800 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3801 { "kconsumerd-err-sock", 1, 0, 'E' },
3802 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3803 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3804 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3805 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3806 { "consumerd32-path", 1, 0, 'u' },
3807 { "consumerd32-libdir", 1, 0, 'U' },
3808 { "consumerd64-path", 1, 0, 't' },
3809 { "consumerd64-libdir", 1, 0, 'T' },
3810 { "daemonize", 0, 0, 'd' },
3811 { "sig-parent", 0, 0, 'S' },
3812 { "help", 0, 0, 'h' },
3813 { "group", 1, 0, 'g' },
3814 { "version", 0, 0, 'V' },
3815 { "quiet", 0, 0, 'q' },
3816 { "verbose", 0, 0, 'v' },
3817 { "verbose-consumer", 0, 0, 'Z' },
3818 { "no-kernel", 0, 0, 'N' },
3823 int option_index
= 0;
3824 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3825 long_options
, &option_index
);
3832 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3834 fprintf(stderr
, " with arg %s\n", optarg
);
3838 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3841 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3847 opt_tracing_group
= optarg
;
3853 fprintf(stdout
, "%s\n", VERSION
);
3859 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3862 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3865 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3868 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3871 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3874 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3883 /* Verbose level can increase using multiple -v */
3887 opt_verbose_consumer
+= 1;
3890 consumerd32_bin
= optarg
;
3893 consumerd32_libdir
= optarg
;
3896 consumerd64_bin
= optarg
;
3899 consumerd64_libdir
= optarg
;
3902 /* Unknown option or other error.
3903 * Error is printed by getopt, just return */
3912 * Creates the two needed socket by the daemon.
3913 * apps_sock - The communication socket for all UST apps.
3914 * client_sock - The communication of the cli tool (lttng).
3916 static int init_daemon_socket(void)
3921 old_umask
= umask(0);
3923 /* Create client tool unix socket */
3924 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3925 if (client_sock
< 0) {
3926 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3931 /* File permission MUST be 660 */
3932 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3934 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3939 /* Create the application unix socket */
3940 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3941 if (apps_sock
< 0) {
3942 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3947 /* File permission MUST be 666 */
3948 ret
= chmod(apps_unix_sock_path
,
3949 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3951 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3962 * Check if the global socket is available, and if a daemon is answering at the
3963 * other side. If yes, error is returned.
3965 static int check_existing_daemon(void)
3967 /* Is there anybody out there ? */
3968 if (lttng_session_daemon_alive()) {
3976 * Set the tracing group gid onto the client socket.
3978 * Race window between mkdir and chown is OK because we are going from more
3979 * permissive (root.root) to less permissive (root.tracing).
3981 static int set_permissions(char *rundir
)
3986 gid
= allowed_group();
3988 WARN("No tracing group detected");
3993 /* Set lttng run dir */
3994 ret
= chown(rundir
, 0, gid
);
3996 ERR("Unable to set group on %s", rundir
);
4000 /* Ensure tracing group can search the run dir */
4001 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4003 ERR("Unable to set permissions on %s", rundir
);
4007 /* lttng client socket path */
4008 ret
= chown(client_unix_sock_path
, 0, gid
);
4010 ERR("Unable to set group on %s", client_unix_sock_path
);
4014 /* kconsumer error socket path */
4015 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4017 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4021 /* 64-bit ustconsumer error socket path */
4022 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4024 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4028 /* 32-bit ustconsumer compat32 error socket path */
4029 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4031 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4035 DBG("All permissions are set");
4042 * Create the pipe used to wake up the kernel thread.
4044 static int create_kernel_poll_pipe(void)
4046 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4050 * Create the application command pipe to wake thread_manage_apps.
4052 static int create_apps_cmd_pipe(void)
4054 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4058 * Create the lttng run directory needed for all global sockets and pipe.
4060 static int create_lttng_rundir(const char *rundir
)
4064 DBG3("Creating LTTng run directory: %s", rundir
);
4066 ret
= mkdir(rundir
, S_IRWXU
);
4068 if (errno
!= EEXIST
) {
4069 ERR("Unable to create %s", rundir
);
4081 * Setup sockets and directory needed by the kconsumerd communication with the
4084 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4088 char path
[PATH_MAX
];
4090 switch (consumer_data
->type
) {
4091 case LTTNG_CONSUMER_KERNEL
:
4092 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4094 case LTTNG_CONSUMER64_UST
:
4095 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4097 case LTTNG_CONSUMER32_UST
:
4098 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4101 ERR("Consumer type unknown");
4106 DBG2("Creating consumer directory: %s", path
);
4108 ret
= mkdir(path
, S_IRWXU
);
4110 if (errno
!= EEXIST
) {
4111 ERR("Failed to create %s", path
);
4117 /* Create the kconsumerd error unix socket */
4118 consumer_data
->err_sock
=
4119 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4120 if (consumer_data
->err_sock
< 0) {
4121 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4126 /* File permission MUST be 660 */
4127 ret
= chmod(consumer_data
->err_unix_sock_path
,
4128 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4130 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4140 * Signal handler for the daemon
4142 * Simply stop all worker threads, leaving main() return gracefully after
4143 * joining all threads and calling cleanup().
4145 static void sighandler(int sig
)
4149 DBG("SIGPIPE caught");
4152 DBG("SIGINT caught");
4156 DBG("SIGTERM caught");
4165 * Setup signal handler for :
4166 * SIGINT, SIGTERM, SIGPIPE
4168 static int set_signal_handler(void)
4171 struct sigaction sa
;
4174 if ((ret
= sigemptyset(&sigset
)) < 0) {
4175 perror("sigemptyset");
4179 sa
.sa_handler
= sighandler
;
4180 sa
.sa_mask
= sigset
;
4182 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4183 perror("sigaction");
4187 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4188 perror("sigaction");
4192 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4193 perror("sigaction");
4197 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4203 * Set open files limit to unlimited. This daemon can open a large number of
4204 * file descriptors in order to consumer multiple kernel traces.
4206 static void set_ulimit(void)
4211 /* The kernel does not allowed an infinite limit for open files */
4212 lim
.rlim_cur
= 65535;
4213 lim
.rlim_max
= 65535;
4215 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4217 perror("failed to set open files limit");
4224 int main(int argc
, char **argv
)
4228 const char *home_path
;
4230 init_kernel_workarounds();
4232 rcu_register_thread();
4234 /* Create thread quit pipe */
4235 if ((ret
= init_thread_quit_pipe()) < 0) {
4239 setup_consumerd_path();
4241 /* Parse arguments */
4243 if ((ret
= parse_args(argc
, argv
) < 0)) {
4256 /* Check if daemon is UID = 0 */
4257 is_root
= !getuid();
4260 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4262 /* Create global run dir with root access */
4263 ret
= create_lttng_rundir(rundir
);
4268 if (strlen(apps_unix_sock_path
) == 0) {
4269 snprintf(apps_unix_sock_path
, PATH_MAX
,
4270 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4273 if (strlen(client_unix_sock_path
) == 0) {
4274 snprintf(client_unix_sock_path
, PATH_MAX
,
4275 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4278 /* Set global SHM for ust */
4279 if (strlen(wait_shm_path
) == 0) {
4280 snprintf(wait_shm_path
, PATH_MAX
,
4281 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4284 /* Setup kernel consumerd path */
4285 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4286 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4287 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4288 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4290 DBG2("Kernel consumer err path: %s",
4291 kconsumer_data
.err_unix_sock_path
);
4292 DBG2("Kernel consumer cmd path: %s",
4293 kconsumer_data
.cmd_unix_sock_path
);
4295 home_path
= get_home_dir();
4296 if (home_path
== NULL
) {
4297 /* TODO: Add --socket PATH option */
4298 ERR("Can't get HOME directory for sockets creation.");
4304 * Create rundir from home path. This will create something like
4307 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4313 ret
= create_lttng_rundir(rundir
);
4318 if (strlen(apps_unix_sock_path
) == 0) {
4319 snprintf(apps_unix_sock_path
, PATH_MAX
,
4320 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4323 /* Set the cli tool unix socket path */
4324 if (strlen(client_unix_sock_path
) == 0) {
4325 snprintf(client_unix_sock_path
, PATH_MAX
,
4326 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4329 /* Set global SHM for ust */
4330 if (strlen(wait_shm_path
) == 0) {
4331 snprintf(wait_shm_path
, PATH_MAX
,
4332 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4336 DBG("Client socket path %s", client_unix_sock_path
);
4337 DBG("Application socket path %s", apps_unix_sock_path
);
4338 DBG("LTTng run directory path: %s", rundir
);
4340 /* 32 bits consumerd path setup */
4341 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4342 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4343 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4344 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4346 DBG2("UST consumer 32 bits err path: %s",
4347 ustconsumer32_data
.err_unix_sock_path
);
4348 DBG2("UST consumer 32 bits cmd path: %s",
4349 ustconsumer32_data
.cmd_unix_sock_path
);
4351 /* 64 bits consumerd path setup */
4352 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4353 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4354 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4355 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4357 DBG2("UST consumer 64 bits err path: %s",
4358 ustconsumer64_data
.err_unix_sock_path
);
4359 DBG2("UST consumer 64 bits cmd path: %s",
4360 ustconsumer64_data
.cmd_unix_sock_path
);
4363 * See if daemon already exist.
4365 if ((ret
= check_existing_daemon()) < 0) {
4366 ERR("Already running daemon.\n");
4368 * We do not goto exit because we must not cleanup()
4369 * because a daemon is already running.
4374 /* After this point, we can safely call cleanup() with "goto exit" */
4377 * These actions must be executed as root. We do that *after* setting up
4378 * the sockets path because we MUST make the check for another daemon using
4379 * those paths *before* trying to set the kernel consumer sockets and init
4383 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4388 /* Setup kernel tracer */
4389 if (!opt_no_kernel
) {
4390 init_kernel_tracer();
4393 /* Set ulimit for open files */
4397 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4402 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4407 if ((ret
= set_signal_handler()) < 0) {
4411 /* Setup the needed unix socket */
4412 if ((ret
= init_daemon_socket()) < 0) {
4416 /* Set credentials to socket */
4417 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4421 /* Get parent pid if -S, --sig-parent is specified. */
4422 if (opt_sig_parent
) {
4426 /* Setup the kernel pipe for waking up the kernel thread */
4427 if ((ret
= create_kernel_poll_pipe()) < 0) {
4431 /* Setup the thread apps communication pipe. */
4432 if ((ret
= create_apps_cmd_pipe()) < 0) {
4436 /* Init UST command queue. */
4437 cds_wfq_init(&ust_cmd_queue
.queue
);
4439 /* Init UST app hash table */
4443 * Get session list pointer. This pointer MUST NOT be free(). This list is
4444 * statically declared in session.c
4446 session_list_ptr
= session_get_list();
4448 /* Set up max poll set size */
4449 lttng_poll_set_max_size();
4451 /* Create thread to manage the client socket */
4452 ret
= pthread_create(&client_thread
, NULL
,
4453 thread_manage_clients
, (void *) NULL
);
4455 perror("pthread_create clients");
4459 /* Create thread to dispatch registration */
4460 ret
= pthread_create(&dispatch_thread
, NULL
,
4461 thread_dispatch_ust_registration
, (void *) NULL
);
4463 perror("pthread_create dispatch");
4467 /* Create thread to manage application registration. */
4468 ret
= pthread_create(®_apps_thread
, NULL
,
4469 thread_registration_apps
, (void *) NULL
);
4471 perror("pthread_create registration");
4475 /* Create thread to manage application socket */
4476 ret
= pthread_create(&apps_thread
, NULL
,
4477 thread_manage_apps
, (void *) NULL
);
4479 perror("pthread_create apps");
4483 /* Create kernel thread to manage kernel event */
4484 ret
= pthread_create(&kernel_thread
, NULL
,
4485 thread_manage_kernel
, (void *) NULL
);
4487 perror("pthread_create kernel");
4491 ret
= pthread_join(kernel_thread
, &status
);
4493 perror("pthread_join");
4494 goto error
; /* join error, exit without cleanup */
4498 ret
= pthread_join(apps_thread
, &status
);
4500 perror("pthread_join");
4501 goto error
; /* join error, exit without cleanup */
4505 ret
= pthread_join(reg_apps_thread
, &status
);
4507 perror("pthread_join");
4508 goto error
; /* join error, exit without cleanup */
4512 ret
= pthread_join(dispatch_thread
, &status
);
4514 perror("pthread_join");
4515 goto error
; /* join error, exit without cleanup */
4519 ret
= pthread_join(client_thread
, &status
);
4521 perror("pthread_join");
4522 goto error
; /* join error, exit without cleanup */
4525 ret
= join_consumer_thread(&kconsumer_data
);
4527 perror("join_consumer");
4528 goto error
; /* join error, exit without cleanup */
4534 * cleanup() is called when no other thread is running.
4536 rcu_thread_online();
4538 rcu_thread_offline();
4539 rcu_unregister_thread();