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 <lttng-consumerd.h>
43 #include <lttng-sessiond-comm.h>
44 #include <lttng/lttng-consumer.h>
50 #include "compat/poll.h"
55 #include "lttng-sessiond.h"
61 #define CONSUMERD_FILE "lttng-consumerd"
63 struct consumer_data
{
64 enum lttng_consumer_type type
;
66 pthread_t thread
; /* Worker thread interacting with the consumer */
69 /* Mutex to control consumerd pid assignation */
70 pthread_mutex_t pid_mutex
;
76 /* consumer error and command Unix socket path */
77 char err_unix_sock_path
[PATH_MAX
];
78 char cmd_unix_sock_path
[PATH_MAX
];
82 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
83 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
84 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
85 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
88 int opt_verbose
; /* Not static for lttngerr.h */
89 int opt_verbose_consumer
; /* Not static for lttngerr.h */
90 int opt_quiet
; /* Not static for lttngerr.h */
93 const char *opt_tracing_group
;
94 static int opt_sig_parent
;
95 static int opt_daemon
;
96 static int opt_no_kernel
;
97 static int is_root
; /* Set to 1 if the daemon is running as root */
98 static pid_t ppid
; /* Parent PID for --sig-parent option */
101 /* Consumer daemon specific control data */
102 static struct consumer_data kconsumer_data
= {
103 .type
= LTTNG_CONSUMER_KERNEL
,
104 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
105 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
107 static struct consumer_data ustconsumer64_data
= {
108 .type
= LTTNG_CONSUMER64_UST
,
109 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
110 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
112 static struct consumer_data ustconsumer32_data
= {
113 .type
= LTTNG_CONSUMER32_UST
,
114 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
115 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
118 static int dispatch_thread_exit
;
120 /* Global application Unix socket path */
121 static char apps_unix_sock_path
[PATH_MAX
];
122 /* Global client Unix socket path */
123 static char client_unix_sock_path
[PATH_MAX
];
124 /* global wait shm path for UST */
125 static char wait_shm_path
[PATH_MAX
];
127 /* Sockets and FDs */
128 static int client_sock
;
129 static int apps_sock
;
130 static int kernel_tracer_fd
;
131 static int kernel_poll_pipe
[2];
134 * Quit pipe for all threads. This permits a single cancellation point
135 * for all threads when receiving an event on the pipe.
137 static int thread_quit_pipe
[2];
140 * This pipe is used to inform the thread managing application communication
141 * that a command is queued and ready to be processed.
143 static int apps_cmd_pipe
[2];
145 /* Pthread, Mutexes and Semaphores */
146 static pthread_t apps_thread
;
147 static pthread_t reg_apps_thread
;
148 static pthread_t client_thread
;
149 static pthread_t kernel_thread
;
150 static pthread_t dispatch_thread
;
154 * UST registration command queue. This queue is tied with a futex and uses a N
155 * wakers / 1 waiter implemented and detailed in futex.c/.h
157 * The thread_manage_apps and thread_dispatch_ust_registration interact with
158 * this queue and the wait/wake scheme.
160 static struct ust_cmd_queue ust_cmd_queue
;
163 * Pointer initialized before thread creation.
165 * This points to the tracing session list containing the session count and a
166 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
167 * MUST NOT be taken if you call a public function in session.c.
169 * The lock is nested inside the structure: session_list_ptr->lock. Please use
170 * session_lock_list and session_unlock_list for lock acquisition.
172 static struct ltt_session_list
*session_list_ptr
;
174 int ust_consumerd64_fd
= -1;
175 int ust_consumerd32_fd
= -1;
177 static const char *consumerd32_bin
=
178 __stringify(CONFIG_CONSUMERD32_BIN
);
179 static const char *consumerd64_bin
=
180 __stringify(CONFIG_CONSUMERD64_BIN
);
181 static const char *consumerd32_libdir
=
182 __stringify(CONFIG_CONSUMERD32_LIBDIR
);
183 static const char *consumerd64_libdir
=
184 __stringify(CONFIG_CONSUMERD64_LIBDIR
);
187 void setup_consumerd_path(void)
189 const char *bin
, *libdir
;
192 * Allow INSTALL_BIN_PATH to be used as a target path for the
193 * native architecture size consumer if CONFIG_CONSUMER*_PATH
194 * has not been defined.
196 #if (CAA_BITS_PER_LONG == 32)
197 if (!consumerd32_bin
[0]) {
198 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
200 if (!consumerd32_libdir
[0]) {
201 consumerd32_libdir
= INSTALL_LIB_PATH
;
203 #elif (CAA_BITS_PER_LONG == 64)
204 if (!consumerd64_bin
[0]) {
205 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
207 if (!consumerd64_libdir
[0]) {
208 consumerd64_libdir
= INSTALL_LIB_PATH
;
211 #error "Unknown bitness"
215 * runtime env. var. overrides the build default.
217 bin
= getenv("LTTNG_CONSUMERD32_BIN");
219 consumerd32_bin
= bin
;
221 bin
= getenv("LTTNG_CONSUMERD64_BIN");
223 consumerd64_bin
= bin
;
225 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
227 consumerd32_libdir
= libdir
;
229 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
231 consumerd64_libdir
= libdir
;
236 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
238 static int create_thread_poll_set(struct lttng_poll_event
*events
,
243 if (events
== NULL
|| size
== 0) {
248 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
254 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
266 * Check if the thread quit pipe was triggered.
268 * Return 1 if it was triggered else 0;
270 static int check_thread_quit_pipe(int fd
, uint32_t events
)
272 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
280 * Remove modules in reverse load order.
282 static int modprobe_remove_kernel_modules(void)
287 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
288 ret
= snprintf(modprobe
, sizeof(modprobe
),
289 "/sbin/modprobe -r -q %s",
290 kernel_modules_list
[i
].name
);
292 perror("snprintf modprobe -r");
295 modprobe
[sizeof(modprobe
) - 1] = '\0';
296 ret
= system(modprobe
);
298 ERR("Unable to launch modprobe -r for module %s",
299 kernel_modules_list
[i
].name
);
300 } else if (kernel_modules_list
[i
].required
301 && WEXITSTATUS(ret
) != 0) {
302 ERR("Unable to remove module %s",
303 kernel_modules_list
[i
].name
);
305 DBG("Modprobe removal successful %s",
306 kernel_modules_list
[i
].name
);
315 * Return group ID of the tracing group or -1 if not found.
317 static gid_t
allowed_group(void)
321 if (opt_tracing_group
) {
322 grp
= getgrnam(opt_tracing_group
);
324 grp
= getgrnam(default_tracing_group
);
334 * Init thread quit pipe.
336 * Return -1 on error or 0 if all pipes are created.
338 static int init_thread_quit_pipe(void)
342 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
344 perror("thread quit pipe");
353 * Complete teardown of a kernel session. This free all data structure related
354 * to a kernel session and update counter.
356 static void teardown_kernel_session(struct ltt_session
*session
)
358 if (!session
->kernel_session
) {
359 DBG3("No kernel session when tearingdown session");
363 DBG("Tearing down kernel session");
366 * If a custom kernel consumer was registered, close the socket before
367 * tearing down the complete kernel session structure
369 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
370 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
373 trace_kernel_destroy_session(session
->kernel_session
);
377 * Complete teardown of all UST sessions. This will free everything on his path
378 * and destroy the core essence of all ust sessions :)
380 static void teardown_ust_session(struct ltt_session
*session
)
384 if (!session
->ust_session
) {
385 DBG3("No UST session when tearingdown session");
389 DBG("Tearing down UST session(s)");
391 ret
= ust_app_destroy_trace_all(session
->ust_session
);
393 ERR("Error in ust_app_destroy_trace_all");
396 trace_ust_destroy_session(session
->ust_session
);
400 * Stop all threads by closing the thread quit pipe.
402 static void stop_threads(void)
406 /* Stopping all threads */
407 DBG("Terminating all threads");
408 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
410 ERR("write error on thread quit pipe");
413 /* Dispatch thread */
414 dispatch_thread_exit
= 1;
415 futex_nto1_wake(&ust_cmd_queue
.futex
);
421 static void cleanup(void)
425 struct ltt_session
*sess
, *stmp
;
429 DBG("Removing %s directory", rundir
);
430 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
432 ERR("asprintf failed. Something is really wrong!");
435 /* Remove lttng run directory */
438 ERR("Unable to clean %s", rundir
);
442 DBG("Cleaning up all session");
444 /* Destroy session list mutex */
445 if (session_list_ptr
!= NULL
) {
446 pthread_mutex_destroy(&session_list_ptr
->lock
);
448 /* Cleanup ALL session */
449 cds_list_for_each_entry_safe(sess
, stmp
,
450 &session_list_ptr
->head
, list
) {
451 teardown_kernel_session(sess
);
452 teardown_ust_session(sess
);
457 DBG("Closing all UST sockets");
458 ust_app_clean_list();
460 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
462 if (is_root
&& !opt_no_kernel
) {
463 DBG2("Closing kernel fd");
464 close(kernel_tracer_fd
);
465 DBG("Unloading kernel modules");
466 modprobe_remove_kernel_modules();
469 close(thread_quit_pipe
[0]);
470 close(thread_quit_pipe
[1]);
473 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
474 "Matthew, BEET driven development works!%c[%dm",
475 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
480 * Send data on a unix socket using the liblttsessiondcomm API.
482 * Return lttcomm error code.
484 static int send_unix_sock(int sock
, void *buf
, size_t len
)
486 /* Check valid length */
491 return lttcomm_send_unix_sock(sock
, buf
, len
);
495 * Free memory of a command context structure.
497 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
499 DBG("Clean command context structure");
501 if ((*cmd_ctx
)->llm
) {
502 free((*cmd_ctx
)->llm
);
504 if ((*cmd_ctx
)->lsm
) {
505 free((*cmd_ctx
)->lsm
);
513 * Send all stream fds of kernel channel to the consumer.
515 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
516 int sock
, struct ltt_kernel_channel
*channel
,
517 uid_t uid
, gid_t gid
)
520 struct ltt_kernel_stream
*stream
;
521 struct lttcomm_consumer_msg lkm
;
523 DBG("Sending streams of channel %s to kernel consumer",
524 channel
->channel
->name
);
527 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
528 lkm
.u
.channel
.channel_key
= channel
->fd
;
529 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
530 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
531 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
532 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
534 perror("send consumer channel");
539 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
543 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
544 lkm
.u
.stream
.channel_key
= channel
->fd
;
545 lkm
.u
.stream
.stream_key
= stream
->fd
;
546 lkm
.u
.stream
.state
= stream
->state
;
547 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
548 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
549 lkm
.u
.stream
.uid
= uid
;
550 lkm
.u
.stream
.gid
= gid
;
551 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
552 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
553 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
554 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
556 perror("send consumer stream");
559 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
561 perror("send consumer stream ancillary data");
566 DBG("consumer channel streams sent");
575 * Send all stream fds of the kernel session to the consumer.
577 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
578 struct ltt_kernel_session
*session
)
581 struct ltt_kernel_channel
*chan
;
582 struct lttcomm_consumer_msg lkm
;
583 int sock
= session
->consumer_fd
;
585 DBG("Sending metadata stream fd");
587 /* Extra protection. It's NOT supposed to be set to 0 at this point */
588 if (session
->consumer_fd
== 0) {
589 session
->consumer_fd
= consumer_data
->cmd_sock
;
592 if (session
->metadata_stream_fd
!= 0) {
593 /* Send metadata channel fd */
594 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
595 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
596 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
597 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
598 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
599 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
601 perror("send consumer channel");
605 /* Send metadata stream fd */
606 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
607 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
608 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
609 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
610 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
611 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
612 lkm
.u
.stream
.uid
= session
->uid
;
613 lkm
.u
.stream
.gid
= session
->gid
;
614 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
615 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
616 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
617 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
619 perror("send consumer stream");
622 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
624 perror("send consumer stream");
629 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
630 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
631 session
->uid
, session
->gid
);
637 DBG("consumer fds (metadata and channel streams) sent");
646 * Notify UST applications using the shm mmap futex.
648 static int notify_ust_apps(int active
)
652 DBG("Notifying applications of session daemon state: %d", active
);
654 /* See shm.c for this call implying mmap, shm and futex calls */
655 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
656 if (wait_shm_mmap
== NULL
) {
660 /* Wake waiting process */
661 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
663 /* Apps notified successfully */
671 * Setup the outgoing data buffer for the response (llm) by allocating the
672 * right amount of memory and copying the original information from the lsm
675 * Return total size of the buffer pointed by buf.
677 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
683 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
684 if (cmd_ctx
->llm
== NULL
) {
690 /* Copy common data */
691 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
692 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
694 cmd_ctx
->llm
->data_size
= size
;
695 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
704 * Update the kernel poll set of all channel fd available over all tracing
705 * session. Add the wakeup pipe at the end of the set.
707 static int update_kernel_poll(struct lttng_poll_event
*events
)
710 struct ltt_session
*session
;
711 struct ltt_kernel_channel
*channel
;
713 DBG("Updating kernel poll set");
716 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
717 session_lock(session
);
718 if (session
->kernel_session
== NULL
) {
719 session_unlock(session
);
723 cds_list_for_each_entry(channel
,
724 &session
->kernel_session
->channel_list
.head
, list
) {
725 /* Add channel fd to the kernel poll set */
726 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
728 session_unlock(session
);
731 DBG("Channel fd %d added to kernel set", channel
->fd
);
733 session_unlock(session
);
735 session_unlock_list();
740 session_unlock_list();
745 * Find the channel fd from 'fd' over all tracing session. When found, check
746 * for new channel stream and send those stream fds to the kernel consumer.
748 * Useful for CPU hotplug feature.
750 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
753 struct ltt_session
*session
;
754 struct ltt_kernel_channel
*channel
;
756 DBG("Updating kernel streams for channel fd %d", fd
);
759 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
760 session_lock(session
);
761 if (session
->kernel_session
== NULL
) {
762 session_unlock(session
);
766 /* This is not suppose to be 0 but this is an extra security check */
767 if (session
->kernel_session
->consumer_fd
== 0) {
768 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
771 cds_list_for_each_entry(channel
,
772 &session
->kernel_session
->channel_list
.head
, list
) {
773 if (channel
->fd
== fd
) {
774 DBG("Channel found, updating kernel streams");
775 ret
= kernel_open_channel_stream(channel
);
781 * Have we already sent fds to the consumer? If yes, it means
782 * that tracing is started so it is safe to send our updated
785 if (session
->kernel_session
->consumer_fds_sent
== 1) {
786 ret
= send_kconsumer_channel_streams(consumer_data
,
787 session
->kernel_session
->consumer_fd
, channel
,
788 session
->uid
, session
->gid
);
796 session_unlock(session
);
798 session_unlock_list();
802 session_unlock(session
);
803 session_unlock_list();
808 * For each tracing session, update newly registered apps.
810 static void update_ust_app(int app_sock
)
812 struct ltt_session
*sess
, *stmp
;
814 /* For all tracing session(s) */
815 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
816 if (sess
->ust_session
) {
817 ust_app_global_update(sess
->ust_session
, app_sock
);
823 * This thread manage event coming from the kernel.
825 * Features supported in this thread:
828 static void *thread_manage_kernel(void *data
)
830 int ret
, i
, pollfd
, update_poll_flag
= 1;
831 uint32_t revents
, nb_fd
;
833 struct lttng_poll_event events
;
835 DBG("Thread manage kernel started");
837 ret
= create_thread_poll_set(&events
, 2);
842 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
848 if (update_poll_flag
== 1) {
850 * Reset number of fd in the poll set. Always 2 since there is the thread
851 * quit pipe and the kernel pipe.
855 ret
= update_kernel_poll(&events
);
859 update_poll_flag
= 0;
862 nb_fd
= LTTNG_POLL_GETNB(&events
);
864 DBG("Thread kernel polling on %d fds", nb_fd
);
866 /* Zeroed the poll events */
867 lttng_poll_reset(&events
);
869 /* Poll infinite value of time */
870 ret
= lttng_poll_wait(&events
, -1);
873 } else if (ret
== 0) {
874 /* Should not happen since timeout is infinite */
875 ERR("Return value of poll is 0 with an infinite timeout.\n"
876 "This should not have happened! Continuing...");
880 for (i
= 0; i
< nb_fd
; i
++) {
881 /* Fetch once the poll data */
882 revents
= LTTNG_POLL_GETEV(&events
, i
);
883 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
885 /* Thread quit pipe has been closed. Killing thread. */
886 ret
= check_thread_quit_pipe(pollfd
, revents
);
891 /* Check for data on kernel pipe */
892 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
893 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
894 update_poll_flag
= 1;
898 * New CPU detected by the kernel. Adding kernel stream to
899 * kernel session and updating the kernel consumer
901 if (revents
& LPOLLIN
) {
902 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
908 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
909 * and unregister kernel stream at this point.
917 DBG("Kernel thread dying");
918 close(kernel_poll_pipe
[0]);
919 close(kernel_poll_pipe
[1]);
921 lttng_poll_clean(&events
);
927 * This thread manage the consumer error sent back to the session daemon.
929 static void *thread_manage_consumer(void *data
)
931 int sock
= 0, i
, ret
, pollfd
;
932 uint32_t revents
, nb_fd
;
933 enum lttcomm_return_code code
;
934 struct lttng_poll_event events
;
935 struct consumer_data
*consumer_data
= data
;
937 DBG("[thread] Manage consumer started");
939 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
945 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
946 * Nothing more will be added to this poll set.
948 ret
= create_thread_poll_set(&events
, 2);
953 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
958 nb_fd
= LTTNG_POLL_GETNB(&events
);
960 /* Inifinite blocking call, waiting for transmission */
961 ret
= lttng_poll_wait(&events
, -1);
966 for (i
= 0; i
< nb_fd
; i
++) {
967 /* Fetch once the poll data */
968 revents
= LTTNG_POLL_GETEV(&events
, i
);
969 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
971 /* Thread quit pipe has been closed. Killing thread. */
972 ret
= check_thread_quit_pipe(pollfd
, revents
);
977 /* Event on the registration socket */
978 if (pollfd
== consumer_data
->err_sock
) {
979 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
980 ERR("consumer err socket poll error");
986 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
991 DBG2("Receiving code from consumer err_sock");
993 /* Getting status code from kconsumerd */
994 ret
= lttcomm_recv_unix_sock(sock
, &code
,
995 sizeof(enum lttcomm_return_code
));
1000 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1001 consumer_data
->cmd_sock
=
1002 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1003 if (consumer_data
->cmd_sock
< 0) {
1004 sem_post(&consumer_data
->sem
);
1005 PERROR("consumer connect");
1008 /* Signal condition to tell that the kconsumerd is ready */
1009 sem_post(&consumer_data
->sem
);
1010 DBG("consumer command socket ready");
1012 ERR("consumer error when waiting for SOCK_READY : %s",
1013 lttcomm_get_readable_code(-code
));
1017 /* Remove the kconsumerd error sock since we've established a connexion */
1018 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1023 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1028 /* Update number of fd */
1029 nb_fd
= LTTNG_POLL_GETNB(&events
);
1031 /* Inifinite blocking call, waiting for transmission */
1032 ret
= lttng_poll_wait(&events
, -1);
1037 for (i
= 0; i
< nb_fd
; i
++) {
1038 /* Fetch once the poll data */
1039 revents
= LTTNG_POLL_GETEV(&events
, i
);
1040 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1042 /* Thread quit pipe has been closed. Killing thread. */
1043 ret
= check_thread_quit_pipe(pollfd
, revents
);
1048 /* Event on the kconsumerd socket */
1049 if (pollfd
== sock
) {
1050 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1051 ERR("consumer err socket second poll error");
1057 /* Wait for any kconsumerd error */
1058 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1059 sizeof(enum lttcomm_return_code
));
1061 ERR("consumer closed the command socket");
1065 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1068 DBG("consumer thread dying");
1069 close(consumer_data
->err_sock
);
1070 close(consumer_data
->cmd_sock
);
1073 unlink(consumer_data
->err_unix_sock_path
);
1074 unlink(consumer_data
->cmd_unix_sock_path
);
1075 consumer_data
->pid
= 0;
1077 lttng_poll_clean(&events
);
1083 * This thread manage application communication.
1085 static void *thread_manage_apps(void *data
)
1088 uint32_t revents
, nb_fd
;
1089 struct ust_command ust_cmd
;
1090 struct lttng_poll_event events
;
1092 DBG("[thread] Manage application started");
1094 rcu_register_thread();
1095 rcu_thread_online();
1097 ret
= create_thread_poll_set(&events
, 2);
1102 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1108 /* Zeroed the events structure */
1109 lttng_poll_reset(&events
);
1111 nb_fd
= LTTNG_POLL_GETNB(&events
);
1113 DBG("Apps thread polling on %d fds", nb_fd
);
1115 /* Inifinite blocking call, waiting for transmission */
1116 ret
= lttng_poll_wait(&events
, -1);
1121 for (i
= 0; i
< nb_fd
; i
++) {
1122 /* Fetch once the poll data */
1123 revents
= LTTNG_POLL_GETEV(&events
, i
);
1124 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1126 /* Thread quit pipe has been closed. Killing thread. */
1127 ret
= check_thread_quit_pipe(pollfd
, revents
);
1132 /* Inspect the apps cmd pipe */
1133 if (pollfd
== apps_cmd_pipe
[0]) {
1134 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1135 ERR("Apps command pipe error");
1137 } else if (revents
& LPOLLIN
) {
1139 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1140 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1141 perror("read apps cmd pipe");
1145 /* Register applicaton to the session daemon */
1146 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1148 if (ret
== -ENOMEM
) {
1150 } else if (ret
< 0) {
1155 * Add channel(s) and event(s) to newly registered apps
1156 * from lttng global UST domain.
1158 update_ust_app(ust_cmd
.sock
);
1160 ret
= ust_app_register_done(ust_cmd
.sock
);
1163 * If the registration is not possible, we simply
1164 * unregister the apps and continue
1166 ust_app_unregister(ust_cmd
.sock
);
1169 * We just need here to monitor the close of the UST
1170 * socket and poll set monitor those by default.
1172 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
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 */
1329 ret
= lttng_poll_wait(&events
, -1);
1334 for (i
= 0; i
< nb_fd
; i
++) {
1335 /* Fetch once the poll data */
1336 revents
= LTTNG_POLL_GETEV(&events
, i
);
1337 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1339 /* Thread quit pipe has been closed. Killing thread. */
1340 ret
= check_thread_quit_pipe(pollfd
, revents
);
1345 /* Event on the registration socket */
1346 if (pollfd
== apps_sock
) {
1347 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1348 ERR("Register apps socket poll error");
1350 } else if (revents
& LPOLLIN
) {
1351 sock
= lttcomm_accept_unix_sock(apps_sock
);
1356 /* Create UST registration command for enqueuing */
1357 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1358 if (ust_cmd
== NULL
) {
1359 perror("ust command zmalloc");
1364 * Using message-based transmissions to ensure we don't
1365 * have to deal with partially received messages.
1367 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1368 sizeof(struct ust_register_msg
));
1369 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1371 perror("lttcomm_recv_unix_sock register apps");
1373 ERR("Wrong size received on apps register");
1380 ust_cmd
->sock
= sock
;
1382 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1383 " gid:%d sock:%d name:%s (version %d.%d)",
1384 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1385 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1386 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1387 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1390 * Lock free enqueue the registration request. The red pill
1391 * has been taken! This apps will be part of the *system*.
1393 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1396 * Wake the registration queue futex. Implicit memory
1397 * barrier with the exchange in cds_wfq_enqueue.
1399 futex_nto1_wake(&ust_cmd_queue
.futex
);
1406 DBG("UST Registration thread dying");
1408 /* Notify that the registration thread is gone */
1413 unlink(apps_unix_sock_path
);
1415 lttng_poll_clean(&events
);
1421 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1422 * exec or it will fails.
1424 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1427 struct timespec timeout
;
1429 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1430 timeout
.tv_nsec
= 0;
1432 /* Setup semaphore */
1433 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1435 PERROR("sem_init consumer semaphore");
1439 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1440 thread_manage_consumer
, consumer_data
);
1442 PERROR("pthread_create consumer");
1447 /* Get time for sem_timedwait absolute timeout */
1448 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1450 PERROR("clock_gettime spawn consumer");
1451 /* Infinite wait for the kconsumerd thread to be ready */
1452 ret
= sem_wait(&consumer_data
->sem
);
1454 /* Normal timeout if the gettime was successful */
1455 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1456 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1460 if (errno
== ETIMEDOUT
) {
1462 * Call has timed out so we kill the kconsumerd_thread and return
1465 ERR("The consumer thread was never ready. Killing it");
1466 ret
= pthread_cancel(consumer_data
->thread
);
1468 PERROR("pthread_cancel consumer thread");
1471 PERROR("semaphore wait failed consumer thread");
1476 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1477 if (consumer_data
->pid
== 0) {
1478 ERR("Kconsumerd did not start");
1479 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1482 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1491 * Join consumer thread
1493 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1498 if (consumer_data
->pid
!= 0) {
1499 ret
= kill(consumer_data
->pid
, SIGTERM
);
1501 ERR("Error killing consumer daemon");
1504 return pthread_join(consumer_data
->thread
, &status
);
1511 * Fork and exec a consumer daemon (consumerd).
1513 * Return pid if successful else -1.
1515 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1519 const char *consumer_to_use
;
1520 const char *verbosity
;
1523 DBG("Spawning consumerd");
1530 if (opt_verbose_consumer
) {
1531 verbosity
= "--verbose";
1533 verbosity
= "--quiet";
1535 switch (consumer_data
->type
) {
1536 case LTTNG_CONSUMER_KERNEL
:
1538 * Find out which consumerd to execute. We will
1539 * first try the 64-bit path, then the
1540 * sessiond's installation directory, and
1541 * fallback on the 32-bit one,
1543 DBG3("Looking for a kernel consumer at these locations:");
1544 DBG3(" 1) %s", consumerd64_bin
);
1545 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1546 DBG3(" 3) %s", consumerd32_bin
);
1547 if (stat(consumerd64_bin
, &st
) == 0) {
1548 DBG3("Found location #1");
1549 consumer_to_use
= consumerd64_bin
;
1550 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1551 DBG3("Found location #2");
1552 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1553 } else if (stat(consumerd32_bin
, &st
) == 0) {
1554 DBG3("Found location #3");
1555 consumer_to_use
= consumerd32_bin
;
1557 DBG("Could not find any valid consumerd executable");
1560 DBG("Using kernel consumer at: %s", consumer_to_use
);
1561 execl(consumer_to_use
,
1562 "lttng-consumerd", verbosity
, "-k",
1563 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1564 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1567 case LTTNG_CONSUMER64_UST
:
1569 char *tmpnew
= NULL
;
1571 if (consumerd64_libdir
[0] != '\0') {
1575 tmp
= getenv("LD_LIBRARY_PATH");
1579 tmplen
= strlen("LD_LIBRARY_PATH=")
1580 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1581 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1586 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1587 strcat(tmpnew
, consumerd64_libdir
);
1588 if (tmp
[0] != '\0') {
1589 strcat(tmpnew
, ":");
1590 strcat(tmpnew
, tmp
);
1592 ret
= putenv(tmpnew
);
1598 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1599 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1600 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1601 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1603 if (consumerd64_libdir
[0] != '\0') {
1611 case LTTNG_CONSUMER32_UST
:
1613 char *tmpnew
= NULL
;
1615 if (consumerd32_libdir
[0] != '\0') {
1619 tmp
= getenv("LD_LIBRARY_PATH");
1623 tmplen
= strlen("LD_LIBRARY_PATH=")
1624 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1625 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1630 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1631 strcat(tmpnew
, consumerd32_libdir
);
1632 if (tmp
[0] != '\0') {
1633 strcat(tmpnew
, ":");
1634 strcat(tmpnew
, tmp
);
1636 ret
= putenv(tmpnew
);
1642 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1643 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1644 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1645 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1647 if (consumerd32_libdir
[0] != '\0') {
1656 perror("unknown consumer type");
1660 perror("kernel start consumer exec");
1663 } else if (pid
> 0) {
1666 perror("start consumer fork");
1674 * Spawn the consumerd daemon and session daemon thread.
1676 static int start_consumerd(struct consumer_data
*consumer_data
)
1680 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1681 if (consumer_data
->pid
!= 0) {
1682 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1686 ret
= spawn_consumerd(consumer_data
);
1688 ERR("Spawning consumerd failed");
1689 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1693 /* Setting up the consumer_data pid */
1694 consumer_data
->pid
= ret
;
1695 DBG2("Consumer pid %d", consumer_data
->pid
);
1696 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1698 DBG2("Spawning consumer control thread");
1699 ret
= spawn_consumer_thread(consumer_data
);
1701 ERR("Fatal error spawning consumer control thread");
1713 * modprobe_kernel_modules
1715 static int modprobe_kernel_modules(void)
1720 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1721 ret
= snprintf(modprobe
, sizeof(modprobe
),
1722 "/sbin/modprobe %s%s",
1723 kernel_modules_list
[i
].required
? "" : "-q ",
1724 kernel_modules_list
[i
].name
);
1726 perror("snprintf modprobe");
1729 modprobe
[sizeof(modprobe
) - 1] = '\0';
1730 ret
= system(modprobe
);
1732 ERR("Unable to launch modprobe for module %s",
1733 kernel_modules_list
[i
].name
);
1734 } else if (kernel_modules_list
[i
].required
1735 && WEXITSTATUS(ret
) != 0) {
1736 ERR("Unable to load module %s",
1737 kernel_modules_list
[i
].name
);
1739 DBG("Modprobe successfully %s",
1740 kernel_modules_list
[i
].name
);
1751 static int mount_debugfs(char *path
)
1754 char *type
= "debugfs";
1756 ret
= mkdir_recursive_run_as(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1758 PERROR("Cannot create debugfs path");
1762 ret
= mount(type
, path
, type
, 0, NULL
);
1764 PERROR("Cannot mount debugfs");
1768 DBG("Mounted debugfs successfully at %s", path
);
1775 * Setup necessary data for kernel tracer action.
1777 static void init_kernel_tracer(void)
1780 char *proc_mounts
= "/proc/mounts";
1782 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1785 /* Detect debugfs */
1786 fp
= fopen(proc_mounts
, "r");
1788 ERR("Unable to probe %s", proc_mounts
);
1792 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1793 if (strstr(line
, "debugfs") != NULL
) {
1794 /* Remove first string */
1796 /* Dup string here so we can reuse line later on */
1797 debugfs_path
= strdup(strtok(NULL
, " "));
1798 DBG("Got debugfs path : %s", debugfs_path
);
1805 /* Mount debugfs if needded */
1806 if (debugfs_path
== NULL
) {
1807 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1809 perror("asprintf debugfs path");
1812 ret
= mount_debugfs(debugfs_path
);
1814 perror("Cannot mount debugfs");
1819 /* Modprobe lttng kernel modules */
1820 ret
= modprobe_kernel_modules();
1825 /* Setup lttng kernel path */
1826 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1828 perror("asprintf lttng path");
1832 /* Open debugfs lttng */
1833 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1834 if (kernel_tracer_fd
< 0) {
1835 DBG("Failed to open %s", lttng_path
);
1841 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1851 WARN("No kernel tracer available");
1852 kernel_tracer_fd
= 0;
1857 * Init tracing by creating trace directory and sending fds kernel consumer.
1859 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1863 if (session
->consumer_fds_sent
== 0) {
1865 * Assign default kernel consumer socket if no consumer assigned to the
1866 * kernel session. At this point, it's NOT suppose to be 0 but this is
1867 * an extra security check.
1869 if (session
->consumer_fd
== 0) {
1870 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1873 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1875 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1879 session
->consumer_fds_sent
= 1;
1887 * Create an UST session and add it to the session ust list.
1889 static int create_ust_session(struct ltt_session
*session
,
1890 struct lttng_domain
*domain
)
1892 struct ltt_ust_session
*lus
= NULL
;
1895 switch (domain
->type
) {
1896 case LTTNG_DOMAIN_UST
:
1899 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1903 DBG("Creating UST session");
1905 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1907 ret
= LTTCOMM_UST_SESS_FAIL
;
1911 ret
= mkdir_recursive_run_as(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1912 session
->uid
, session
->gid
);
1914 if (ret
!= -EEXIST
) {
1915 ERR("Trace directory creation error");
1916 ret
= LTTCOMM_UST_SESS_FAIL
;
1921 /* The domain type dictate different actions on session creation */
1922 switch (domain
->type
) {
1923 case LTTNG_DOMAIN_UST
:
1924 /* No ustctl for the global UST domain */
1927 ERR("Unknown UST domain on create session %d", domain
->type
);
1930 lus
->uid
= session
->uid
;
1931 lus
->gid
= session
->gid
;
1932 session
->ust_session
= lus
;
1942 * Create a kernel tracer session then create the default channel.
1944 static int create_kernel_session(struct ltt_session
*session
)
1948 DBG("Creating kernel session");
1950 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1952 ret
= LTTCOMM_KERN_SESS_FAIL
;
1956 /* Set kernel consumer socket fd */
1957 if (kconsumer_data
.cmd_sock
) {
1958 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1961 ret
= mkdir_recursive_run_as(session
->kernel_session
->trace_path
,
1962 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1964 if (ret
!= -EEXIST
) {
1965 ERR("Trace directory creation error");
1969 session
->kernel_session
->uid
= session
->uid
;
1970 session
->kernel_session
->gid
= session
->gid
;
1977 * Check if the UID or GID match the session. Root user has access to
1980 static int session_access_ok(struct ltt_session
*session
,
1981 uid_t uid
, gid_t gid
)
1983 if (uid
!= session
->uid
&& gid
!= session
->gid
1991 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1994 struct ltt_session
*session
;
1996 DBG("Counting number of available session for UID %d GID %d",
1998 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2000 * Only list the sessions the user can control.
2002 if (!session_access_ok(session
, uid
, gid
)) {
2011 * Using the session list, filled a lttng_session array to send back to the
2012 * client for session listing.
2014 * The session list lock MUST be acquired before calling this function. Use
2015 * session_lock_list() and session_unlock_list().
2017 static void list_lttng_sessions(struct lttng_session
*sessions
,
2018 uid_t uid
, gid_t gid
)
2021 struct ltt_session
*session
;
2023 DBG("Getting all available session for UID %d GID %d",
2026 * Iterate over session list and append data after the control struct in
2029 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2031 * Only list the sessions the user can control.
2033 if (!session_access_ok(session
, uid
, gid
)) {
2036 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2037 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2038 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2039 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2040 sessions
[i
].enabled
= session
->enabled
;
2046 * Fill lttng_channel array of all channels.
2048 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2049 struct lttng_channel
*channels
)
2052 struct ltt_kernel_channel
*kchan
;
2054 DBG("Listing channels for session %s", session
->name
);
2057 case LTTNG_DOMAIN_KERNEL
:
2058 /* Kernel channels */
2059 if (session
->kernel_session
!= NULL
) {
2060 cds_list_for_each_entry(kchan
,
2061 &session
->kernel_session
->channel_list
.head
, list
) {
2062 /* Copy lttng_channel struct to array */
2063 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2064 channels
[i
].enabled
= kchan
->enabled
;
2069 case LTTNG_DOMAIN_UST
:
2071 struct lttng_ht_iter iter
;
2072 struct ltt_ust_channel
*uchan
;
2074 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2075 &iter
.iter
, uchan
, node
.node
) {
2076 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2077 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2078 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2079 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2080 channels
[i
].attr
.switch_timer_interval
=
2081 uchan
->attr
.switch_timer_interval
;
2082 channels
[i
].attr
.read_timer_interval
=
2083 uchan
->attr
.read_timer_interval
;
2084 channels
[i
].enabled
= uchan
->enabled
;
2085 switch (uchan
->attr
.output
) {
2086 case LTTNG_UST_MMAP
:
2088 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2101 * Create a list of ust global domain events.
2103 static int list_lttng_ust_global_events(char *channel_name
,
2104 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2107 unsigned int nb_event
= 0;
2108 struct lttng_ht_iter iter
;
2109 struct lttng_ht_node_str
*node
;
2110 struct ltt_ust_channel
*uchan
;
2111 struct ltt_ust_event
*uevent
;
2112 struct lttng_event
*tmp
;
2114 DBG("Listing UST global events for channel %s", channel_name
);
2118 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2119 node
= lttng_ht_iter_get_node_str(&iter
);
2121 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2125 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2127 nb_event
+= lttng_ht_get_count(uchan
->events
);
2129 if (nb_event
== 0) {
2134 DBG3("Listing UST global %d events", nb_event
);
2136 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2138 ret
= -LTTCOMM_FATAL
;
2142 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2143 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2144 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2145 tmp
[i
].enabled
= uevent
->enabled
;
2146 switch (uevent
->attr
.instrumentation
) {
2147 case LTTNG_UST_TRACEPOINT
:
2148 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2150 case LTTNG_UST_PROBE
:
2151 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2153 case LTTNG_UST_FUNCTION
:
2154 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2156 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2157 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2172 * Fill lttng_event array of all kernel events in the channel.
2174 static int list_lttng_kernel_events(char *channel_name
,
2175 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2178 unsigned int nb_event
;
2179 struct ltt_kernel_event
*event
;
2180 struct ltt_kernel_channel
*kchan
;
2182 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2183 if (kchan
== NULL
) {
2184 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2188 nb_event
= kchan
->event_count
;
2190 DBG("Listing events for channel %s", kchan
->channel
->name
);
2192 if (nb_event
== 0) {
2197 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2198 if (*events
== NULL
) {
2199 ret
= LTTCOMM_FATAL
;
2203 /* Kernel channels */
2204 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2205 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2206 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2207 (*events
)[i
].enabled
= event
->enabled
;
2208 switch (event
->event
->instrumentation
) {
2209 case LTTNG_KERNEL_TRACEPOINT
:
2210 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2212 case LTTNG_KERNEL_KPROBE
:
2213 case LTTNG_KERNEL_KRETPROBE
:
2214 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2215 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2216 sizeof(struct lttng_kernel_kprobe
));
2218 case LTTNG_KERNEL_FUNCTION
:
2219 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2220 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2221 sizeof(struct lttng_kernel_function
));
2223 case LTTNG_KERNEL_NOOP
:
2224 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2226 case LTTNG_KERNEL_SYSCALL
:
2227 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2229 case LTTNG_KERNEL_ALL
:
2243 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2245 static int cmd_disable_channel(struct ltt_session
*session
,
2246 int domain
, char *channel_name
)
2249 struct ltt_ust_session
*usess
;
2251 usess
= session
->ust_session
;
2254 case LTTNG_DOMAIN_KERNEL
:
2256 ret
= channel_kernel_disable(session
->kernel_session
,
2258 if (ret
!= LTTCOMM_OK
) {
2262 kernel_wait_quiescent(kernel_tracer_fd
);
2265 case LTTNG_DOMAIN_UST
:
2267 struct ltt_ust_channel
*uchan
;
2268 struct lttng_ht
*chan_ht
;
2270 chan_ht
= usess
->domain_global
.channels
;
2272 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2273 if (uchan
== NULL
) {
2274 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2278 ret
= channel_ust_disable(usess
, domain
, uchan
);
2279 if (ret
!= LTTCOMM_OK
) {
2284 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2285 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2286 case LTTNG_DOMAIN_UST_PID
:
2287 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2290 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2301 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2303 static int cmd_enable_channel(struct ltt_session
*session
,
2304 int domain
, struct lttng_channel
*attr
)
2307 struct ltt_ust_session
*usess
= session
->ust_session
;
2308 struct lttng_ht
*chan_ht
;
2310 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2313 case LTTNG_DOMAIN_KERNEL
:
2315 struct ltt_kernel_channel
*kchan
;
2317 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2318 session
->kernel_session
);
2319 if (kchan
== NULL
) {
2320 ret
= channel_kernel_create(session
->kernel_session
,
2321 attr
, kernel_poll_pipe
[1]);
2323 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2326 if (ret
!= LTTCOMM_OK
) {
2330 kernel_wait_quiescent(kernel_tracer_fd
);
2333 case LTTNG_DOMAIN_UST
:
2335 struct ltt_ust_channel
*uchan
;
2337 chan_ht
= usess
->domain_global
.channels
;
2339 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2340 if (uchan
== NULL
) {
2341 ret
= channel_ust_create(usess
, domain
, attr
);
2343 ret
= channel_ust_enable(usess
, domain
, uchan
);
2347 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2348 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2349 case LTTNG_DOMAIN_UST_PID
:
2350 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2353 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2362 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2364 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2365 char *channel_name
, char *event_name
)
2370 case LTTNG_DOMAIN_KERNEL
:
2372 struct ltt_kernel_channel
*kchan
;
2373 struct ltt_kernel_session
*ksess
;
2375 ksess
= session
->kernel_session
;
2377 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2378 if (kchan
== NULL
) {
2379 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2383 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2384 if (ret
!= LTTCOMM_OK
) {
2388 kernel_wait_quiescent(kernel_tracer_fd
);
2391 case LTTNG_DOMAIN_UST
:
2393 struct ltt_ust_channel
*uchan
;
2394 struct ltt_ust_session
*usess
;
2396 usess
= session
->ust_session
;
2398 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2400 if (uchan
== NULL
) {
2401 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2405 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2406 if (ret
!= LTTCOMM_OK
) {
2410 DBG3("Disable UST event %s in channel %s completed", event_name
,
2414 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2415 case LTTNG_DOMAIN_UST_PID
:
2416 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2418 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2429 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2431 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2437 case LTTNG_DOMAIN_KERNEL
:
2439 struct ltt_kernel_session
*ksess
;
2440 struct ltt_kernel_channel
*kchan
;
2442 ksess
= session
->kernel_session
;
2444 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2445 if (kchan
== NULL
) {
2446 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2450 ret
= event_kernel_disable_all(ksess
, kchan
);
2451 if (ret
!= LTTCOMM_OK
) {
2455 kernel_wait_quiescent(kernel_tracer_fd
);
2458 case LTTNG_DOMAIN_UST
:
2460 struct ltt_ust_session
*usess
;
2461 struct ltt_ust_channel
*uchan
;
2463 usess
= session
->ust_session
;
2465 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2467 if (uchan
== NULL
) {
2468 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2472 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2477 DBG3("Disable all UST events in channel %s completed", channel_name
);
2481 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2482 case LTTNG_DOMAIN_UST_PID
:
2483 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2485 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2496 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2498 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2499 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2504 case LTTNG_DOMAIN_KERNEL
:
2505 /* Add kernel context to kernel tracer */
2506 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2507 event_name
, channel_name
);
2508 if (ret
!= LTTCOMM_OK
) {
2512 case LTTNG_DOMAIN_UST
:
2514 struct ltt_ust_session
*usess
= session
->ust_session
;
2516 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2517 if (ret
!= LTTCOMM_OK
) {
2522 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2523 case LTTNG_DOMAIN_UST_PID
:
2524 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2526 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2537 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2539 * TODO: currently, both events and loglevels are kept within the same
2540 * namespace for UST global registry/app registery, so if an event
2541 * happen to have the same name as the loglevel (very unlikely though),
2542 * and an attempt is made to enable/disable both in the same session,
2543 * the first to be created will be the only one allowed to exist.
2545 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2546 char *channel_name
, struct lttng_event
*event
)
2549 struct lttng_channel
*attr
;
2550 struct ltt_ust_session
*usess
= session
->ust_session
;
2553 case LTTNG_DOMAIN_KERNEL
:
2555 struct ltt_kernel_channel
*kchan
;
2557 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2558 session
->kernel_session
);
2559 if (kchan
== NULL
) {
2560 attr
= channel_new_default_attr(domain
);
2562 ret
= LTTCOMM_FATAL
;
2565 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2567 /* This call will notify the kernel thread */
2568 ret
= channel_kernel_create(session
->kernel_session
,
2569 attr
, kernel_poll_pipe
[1]);
2570 if (ret
!= LTTCOMM_OK
) {
2577 /* Get the newly created kernel channel pointer */
2578 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2579 session
->kernel_session
);
2580 if (kchan
== NULL
) {
2581 /* This sould not happen... */
2582 ret
= LTTCOMM_FATAL
;
2586 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2588 if (ret
!= LTTCOMM_OK
) {
2592 kernel_wait_quiescent(kernel_tracer_fd
);
2595 case LTTNG_DOMAIN_UST
:
2597 struct lttng_channel
*attr
;
2598 struct ltt_ust_channel
*uchan
;
2600 /* Get channel from global UST domain */
2601 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2603 if (uchan
== NULL
) {
2604 /* Create default channel */
2605 attr
= channel_new_default_attr(domain
);
2607 ret
= LTTCOMM_FATAL
;
2610 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2611 attr
->name
[NAME_MAX
- 1] = '\0';
2613 ret
= channel_ust_create(usess
, domain
, attr
);
2614 if (ret
!= LTTCOMM_OK
) {
2620 /* Get the newly created channel reference back */
2621 uchan
= trace_ust_find_channel_by_name(
2622 usess
->domain_global
.channels
, channel_name
);
2623 if (uchan
== NULL
) {
2624 /* Something is really wrong */
2625 ret
= LTTCOMM_FATAL
;
2630 /* At this point, the session and channel exist on the tracer */
2631 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2632 if (ret
!= LTTCOMM_OK
) {
2637 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2638 case LTTNG_DOMAIN_UST_PID
:
2639 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2641 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2652 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2654 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2655 char *channel_name
, int event_type
)
2658 struct ltt_kernel_channel
*kchan
;
2661 case LTTNG_DOMAIN_KERNEL
:
2662 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2663 session
->kernel_session
);
2664 if (kchan
== NULL
) {
2665 /* This call will notify the kernel thread */
2666 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2667 kernel_poll_pipe
[1]);
2668 if (ret
!= LTTCOMM_OK
) {
2672 /* Get the newly created kernel channel pointer */
2673 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2674 session
->kernel_session
);
2675 if (kchan
== NULL
) {
2676 /* This sould not happen... */
2677 ret
= LTTCOMM_FATAL
;
2683 switch (event_type
) {
2684 case LTTNG_EVENT_SYSCALL
:
2685 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2686 kchan
, kernel_tracer_fd
);
2688 case LTTNG_EVENT_TRACEPOINT
:
2690 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2691 * events already registered to the channel.
2693 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2694 kchan
, kernel_tracer_fd
);
2696 case LTTNG_EVENT_ALL
:
2697 /* Enable syscalls and tracepoints */
2698 ret
= event_kernel_enable_all(session
->kernel_session
,
2699 kchan
, kernel_tracer_fd
);
2702 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2706 /* Manage return value */
2707 if (ret
!= LTTCOMM_OK
) {
2711 kernel_wait_quiescent(kernel_tracer_fd
);
2713 case LTTNG_DOMAIN_UST
:
2715 struct lttng_channel
*attr
;
2716 struct ltt_ust_channel
*uchan
;
2717 struct ltt_ust_session
*usess
= session
->ust_session
;
2719 /* Get channel from global UST domain */
2720 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2722 if (uchan
== NULL
) {
2723 /* Create default channel */
2724 attr
= channel_new_default_attr(domain
);
2726 ret
= LTTCOMM_FATAL
;
2729 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2730 attr
->name
[NAME_MAX
- 1] = '\0';
2732 /* Use the internal command enable channel */
2733 ret
= channel_ust_create(usess
, domain
, attr
);
2734 if (ret
!= LTTCOMM_OK
) {
2740 /* Get the newly created channel reference back */
2741 uchan
= trace_ust_find_channel_by_name(
2742 usess
->domain_global
.channels
, channel_name
);
2743 if (uchan
== NULL
) {
2744 /* Something is really wrong */
2745 ret
= LTTCOMM_FATAL
;
2750 /* At this point, the session and channel exist on the tracer */
2752 switch (event_type
) {
2753 case LTTNG_EVENT_ALL
:
2754 case LTTNG_EVENT_TRACEPOINT
:
2755 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2756 if (ret
!= LTTCOMM_OK
) {
2761 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2765 /* Manage return value */
2766 if (ret
!= LTTCOMM_OK
) {
2772 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2773 case LTTNG_DOMAIN_UST_PID
:
2774 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2776 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2787 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2789 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2792 ssize_t nb_events
= 0;
2795 case LTTNG_DOMAIN_KERNEL
:
2796 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2797 if (nb_events
< 0) {
2798 ret
= LTTCOMM_KERN_LIST_FAIL
;
2802 case LTTNG_DOMAIN_UST
:
2803 nb_events
= ust_app_list_events(events
);
2804 if (nb_events
< 0) {
2805 ret
= LTTCOMM_UST_LIST_FAIL
;
2810 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2817 /* Return negative value to differentiate return code */
2822 * Command LTTNG_START_TRACE processed by the client thread.
2824 static int cmd_start_trace(struct ltt_session
*session
)
2827 struct ltt_kernel_session
*ksession
;
2828 struct ltt_ust_session
*usess
;
2831 ksession
= session
->kernel_session
;
2832 usess
= session
->ust_session
;
2834 if (session
->enabled
) {
2835 ret
= LTTCOMM_UST_START_FAIL
;
2839 session
->enabled
= 1;
2841 /* Kernel tracing */
2842 if (ksession
!= NULL
) {
2843 struct ltt_kernel_channel
*kchan
;
2845 /* Open kernel metadata */
2846 if (ksession
->metadata
== NULL
) {
2847 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2849 ret
= LTTCOMM_KERN_META_FAIL
;
2854 /* Open kernel metadata stream */
2855 if (ksession
->metadata_stream_fd
== 0) {
2856 ret
= kernel_open_metadata_stream(ksession
);
2858 ERR("Kernel create metadata stream failed");
2859 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2864 /* For each channel */
2865 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2866 if (kchan
->stream_count
== 0) {
2867 ret
= kernel_open_channel_stream(kchan
);
2869 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2872 /* Update the stream global counter */
2873 ksession
->stream_count_global
+= ret
;
2877 /* Setup kernel consumer socket and send fds to it */
2878 ret
= init_kernel_tracing(ksession
);
2880 ret
= LTTCOMM_KERN_START_FAIL
;
2884 /* This start the kernel tracing */
2885 ret
= kernel_start_session(ksession
);
2887 ret
= LTTCOMM_KERN_START_FAIL
;
2891 /* Quiescent wait after starting trace */
2892 kernel_wait_quiescent(kernel_tracer_fd
);
2895 /* Flag session that trace should start automatically */
2897 usess
->start_trace
= 1;
2899 ret
= ust_app_start_trace_all(usess
);
2901 ret
= LTTCOMM_UST_START_FAIL
;
2913 * Command LTTNG_STOP_TRACE processed by the client thread.
2915 static int cmd_stop_trace(struct ltt_session
*session
)
2918 struct ltt_kernel_channel
*kchan
;
2919 struct ltt_kernel_session
*ksession
;
2920 struct ltt_ust_session
*usess
;
2923 ksession
= session
->kernel_session
;
2924 usess
= session
->ust_session
;
2926 if (!session
->enabled
) {
2927 ret
= LTTCOMM_UST_STOP_FAIL
;
2931 session
->enabled
= 0;
2934 if (ksession
!= NULL
) {
2935 DBG("Stop kernel tracing");
2937 /* Flush all buffers before stopping */
2938 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2940 ERR("Kernel metadata flush failed");
2943 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2944 ret
= kernel_flush_buffer(kchan
);
2946 ERR("Kernel flush buffer error");
2950 ret
= kernel_stop_session(ksession
);
2952 ret
= LTTCOMM_KERN_STOP_FAIL
;
2956 kernel_wait_quiescent(kernel_tracer_fd
);
2960 usess
->start_trace
= 0;
2962 ret
= ust_app_stop_trace_all(usess
);
2964 ret
= LTTCOMM_UST_STOP_FAIL
;
2976 * Command LTTNG_CREATE_SESSION processed by the client thread.
2978 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2982 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2983 if (ret
!= LTTCOMM_OK
) {
2994 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2996 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3000 /* Clean kernel session teardown */
3001 teardown_kernel_session(session
);
3002 /* UST session teardown */
3003 teardown_ust_session(session
);
3006 * Must notify the kernel thread here to update it's poll setin order
3007 * to remove the channel(s)' fd just destroyed.
3009 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3011 perror("write kernel poll pipe");
3014 ret
= session_destroy(session
);
3020 * Command LTTNG_CALIBRATE processed by the client thread.
3022 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3027 case LTTNG_DOMAIN_KERNEL
:
3029 struct lttng_kernel_calibrate kcalibrate
;
3031 kcalibrate
.type
= calibrate
->type
;
3032 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3034 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3040 /* TODO: Userspace tracing */
3041 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3052 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3054 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3060 case LTTNG_DOMAIN_KERNEL
:
3061 /* Can't register a consumer if there is already one */
3062 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3063 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3067 sock
= lttcomm_connect_unix_sock(sock_path
);
3069 ret
= LTTCOMM_CONNECT_FAIL
;
3073 session
->kernel_session
->consumer_fd
= sock
;
3076 /* TODO: Userspace tracing */
3077 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3088 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3090 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3091 struct lttng_domain
**domains
)
3096 if (session
->kernel_session
!= NULL
) {
3097 DBG3("Listing domains found kernel domain");
3101 if (session
->ust_session
!= NULL
) {
3102 DBG3("Listing domains found UST global domain");
3106 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3107 if (*domains
== NULL
) {
3108 ret
= -LTTCOMM_FATAL
;
3112 if (session
->kernel_session
!= NULL
) {
3113 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3117 if (session
->ust_session
!= NULL
) {
3118 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3129 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3131 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3132 struct lttng_channel
**channels
)
3135 ssize_t nb_chan
= 0;
3138 case LTTNG_DOMAIN_KERNEL
:
3139 if (session
->kernel_session
!= NULL
) {
3140 nb_chan
= session
->kernel_session
->channel_count
;
3142 DBG3("Number of kernel channels %zd", nb_chan
);
3144 case LTTNG_DOMAIN_UST
:
3145 if (session
->ust_session
!= NULL
) {
3146 nb_chan
= lttng_ht_get_count(
3147 session
->ust_session
->domain_global
.channels
);
3149 DBG3("Number of UST global channels %zd", nb_chan
);
3153 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3158 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3159 if (*channels
== NULL
) {
3160 ret
= -LTTCOMM_FATAL
;
3164 list_lttng_channels(domain
, session
, *channels
);
3176 * Command LTTNG_LIST_EVENTS processed by the client thread.
3178 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3179 char *channel_name
, struct lttng_event
**events
)
3182 ssize_t nb_event
= 0;
3185 case LTTNG_DOMAIN_KERNEL
:
3186 if (session
->kernel_session
!= NULL
) {
3187 nb_event
= list_lttng_kernel_events(channel_name
,
3188 session
->kernel_session
, events
);
3191 case LTTNG_DOMAIN_UST
:
3193 if (session
->ust_session
!= NULL
) {
3194 nb_event
= list_lttng_ust_global_events(channel_name
,
3195 &session
->ust_session
->domain_global
, events
);
3200 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3211 * Process the command requested by the lttng client within the command
3212 * context structure. This function make sure that the return structure (llm)
3213 * is set and ready for transmission before returning.
3215 * Return any error encountered or 0 for success.
3217 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3219 int ret
= LTTCOMM_OK
;
3220 int need_tracing_session
= 1;
3222 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3224 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3225 ret
= LTTCOMM_KERN_NA
;
3230 * Check for command that don't needs to allocate a returned payload. We do
3231 * this here so we don't have to make the call for no payload at each
3234 switch(cmd_ctx
->lsm
->cmd_type
) {
3235 case LTTNG_LIST_SESSIONS
:
3236 case LTTNG_LIST_TRACEPOINTS
:
3237 case LTTNG_LIST_DOMAINS
:
3238 case LTTNG_LIST_CHANNELS
:
3239 case LTTNG_LIST_EVENTS
:
3242 /* Setup lttng message with no payload */
3243 ret
= setup_lttng_msg(cmd_ctx
, 0);
3245 /* This label does not try to unlock the session */
3246 goto init_setup_error
;
3250 /* Commands that DO NOT need a session. */
3251 switch (cmd_ctx
->lsm
->cmd_type
) {
3252 case LTTNG_CALIBRATE
:
3253 case LTTNG_CREATE_SESSION
:
3254 case LTTNG_LIST_SESSIONS
:
3255 case LTTNG_LIST_TRACEPOINTS
:
3256 need_tracing_session
= 0;
3259 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3260 session_lock_list();
3261 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3262 session_unlock_list();
3263 if (cmd_ctx
->session
== NULL
) {
3264 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3265 ret
= LTTCOMM_SESS_NOT_FOUND
;
3267 /* If no session name specified */
3268 ret
= LTTCOMM_SELECT_SESS
;
3272 /* Acquire lock for the session */
3273 session_lock(cmd_ctx
->session
);
3279 * Check domain type for specific "pre-action".
3281 switch (cmd_ctx
->lsm
->domain
.type
) {
3282 case LTTNG_DOMAIN_KERNEL
:
3283 /* Kernel tracer check */
3284 if (kernel_tracer_fd
== 0) {
3285 /* Basically, load kernel tracer modules */
3286 init_kernel_tracer();
3287 if (kernel_tracer_fd
== 0) {
3288 ret
= LTTCOMM_KERN_NA
;
3293 /* Need a session for kernel command */
3294 if (need_tracing_session
) {
3295 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3296 ret
= create_kernel_session(cmd_ctx
->session
);
3298 ret
= LTTCOMM_KERN_SESS_FAIL
;
3303 /* Start the kernel consumer daemon */
3304 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3305 if (kconsumer_data
.pid
== 0 &&
3306 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3307 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3308 ret
= start_consumerd(&kconsumer_data
);
3310 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3314 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3318 case LTTNG_DOMAIN_UST
:
3320 if (need_tracing_session
) {
3321 if (cmd_ctx
->session
->ust_session
== NULL
) {
3322 ret
= create_ust_session(cmd_ctx
->session
,
3323 &cmd_ctx
->lsm
->domain
);
3324 if (ret
!= LTTCOMM_OK
) {
3328 /* Start the UST consumer daemons */
3330 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3331 if (consumerd64_bin
[0] != '\0' &&
3332 ustconsumer64_data
.pid
== 0 &&
3333 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3334 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3335 ret
= start_consumerd(&ustconsumer64_data
);
3337 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3338 ust_consumerd64_fd
= -EINVAL
;
3342 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3344 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3347 if (consumerd32_bin
[0] != '\0' &&
3348 ustconsumer32_data
.pid
== 0 &&
3349 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3350 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3351 ret
= start_consumerd(&ustconsumer32_data
);
3353 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3354 ust_consumerd32_fd
= -EINVAL
;
3357 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3359 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3369 * Check that the UID or GID match that of the tracing session.
3370 * The root user can interact with all sessions.
3372 if (need_tracing_session
) {
3373 if (!session_access_ok(cmd_ctx
->session
,
3374 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3375 ret
= LTTCOMM_EPERM
;
3380 /* Process by command type */
3381 switch (cmd_ctx
->lsm
->cmd_type
) {
3382 case LTTNG_ADD_CONTEXT
:
3384 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3385 cmd_ctx
->lsm
->u
.context
.channel_name
,
3386 cmd_ctx
->lsm
->u
.context
.event_name
,
3387 &cmd_ctx
->lsm
->u
.context
.ctx
);
3390 case LTTNG_DISABLE_CHANNEL
:
3392 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3393 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3396 case LTTNG_DISABLE_EVENT
:
3398 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3399 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3400 cmd_ctx
->lsm
->u
.disable
.name
);
3404 case LTTNG_DISABLE_ALL_EVENT
:
3406 DBG("Disabling all events");
3408 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3409 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3412 case LTTNG_ENABLE_CHANNEL
:
3414 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3415 &cmd_ctx
->lsm
->u
.channel
.chan
);
3418 case LTTNG_ENABLE_EVENT
:
3420 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3421 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3422 &cmd_ctx
->lsm
->u
.enable
.event
);
3425 case LTTNG_ENABLE_ALL_EVENT
:
3427 DBG("Enabling all events");
3429 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3430 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3431 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3434 case LTTNG_LIST_TRACEPOINTS
:
3436 struct lttng_event
*events
;
3439 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3440 if (nb_events
< 0) {
3446 * Setup lttng message with payload size set to the event list size in
3447 * bytes and then copy list into the llm payload.
3449 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3455 /* Copy event list into message payload */
3456 memcpy(cmd_ctx
->llm
->payload
, events
,
3457 sizeof(struct lttng_event
) * nb_events
);
3464 case LTTNG_START_TRACE
:
3466 ret
= cmd_start_trace(cmd_ctx
->session
);
3469 case LTTNG_STOP_TRACE
:
3471 ret
= cmd_stop_trace(cmd_ctx
->session
);
3474 case LTTNG_CREATE_SESSION
:
3476 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3477 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3480 case LTTNG_DESTROY_SESSION
:
3482 ret
= cmd_destroy_session(cmd_ctx
->session
,
3483 cmd_ctx
->lsm
->session
.name
);
3486 case LTTNG_LIST_DOMAINS
:
3489 struct lttng_domain
*domains
;
3491 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3497 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3502 /* Copy event list into message payload */
3503 memcpy(cmd_ctx
->llm
->payload
, domains
,
3504 nb_dom
* sizeof(struct lttng_domain
));
3511 case LTTNG_LIST_CHANNELS
:
3514 struct lttng_channel
*channels
;
3516 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3517 cmd_ctx
->session
, &channels
);
3523 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3528 /* Copy event list into message payload */
3529 memcpy(cmd_ctx
->llm
->payload
, channels
,
3530 nb_chan
* sizeof(struct lttng_channel
));
3537 case LTTNG_LIST_EVENTS
:
3540 struct lttng_event
*events
= NULL
;
3542 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3543 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3549 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3554 /* Copy event list into message payload */
3555 memcpy(cmd_ctx
->llm
->payload
, events
,
3556 nb_event
* sizeof(struct lttng_event
));
3563 case LTTNG_LIST_SESSIONS
:
3565 unsigned int nr_sessions
;
3567 session_lock_list();
3568 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3569 if (nr_sessions
== 0) {
3570 ret
= LTTCOMM_NO_SESSION
;
3571 session_unlock_list();
3574 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3576 session_unlock_list();
3580 /* Filled the session array */
3581 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3582 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3584 session_unlock_list();
3589 case LTTNG_CALIBRATE
:
3591 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3592 &cmd_ctx
->lsm
->u
.calibrate
);
3595 case LTTNG_REGISTER_CONSUMER
:
3597 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3598 cmd_ctx
->lsm
->u
.reg
.path
);
3607 if (cmd_ctx
->llm
== NULL
) {
3608 DBG("Missing llm structure. Allocating one.");
3609 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3613 /* Set return code */
3614 cmd_ctx
->llm
->ret_code
= ret
;
3616 if (cmd_ctx
->session
) {
3617 session_unlock(cmd_ctx
->session
);
3624 * This thread manage all clients request using the unix client socket for
3627 static void *thread_manage_clients(void *data
)
3629 int sock
= 0, ret
, i
, pollfd
;
3630 uint32_t revents
, nb_fd
;
3631 struct command_ctx
*cmd_ctx
= NULL
;
3632 struct lttng_poll_event events
;
3634 DBG("[thread] Manage client started");
3636 rcu_register_thread();
3638 ret
= lttcomm_listen_unix_sock(client_sock
);
3644 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3645 * more will be added to this poll set.
3647 ret
= create_thread_poll_set(&events
, 2);
3652 /* Add the application registration socket */
3653 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3659 * Notify parent pid that we are ready to accept command for client side.
3661 if (opt_sig_parent
) {
3662 kill(ppid
, SIGCHLD
);
3666 DBG("Accepting client command ...");
3668 nb_fd
= LTTNG_POLL_GETNB(&events
);
3670 /* Inifinite blocking call, waiting for transmission */
3671 ret
= lttng_poll_wait(&events
, -1);
3676 for (i
= 0; i
< nb_fd
; i
++) {
3677 /* Fetch once the poll data */
3678 revents
= LTTNG_POLL_GETEV(&events
, i
);
3679 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3681 /* Thread quit pipe has been closed. Killing thread. */
3682 ret
= check_thread_quit_pipe(pollfd
, revents
);
3687 /* Event on the registration socket */
3688 if (pollfd
== client_sock
) {
3689 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3690 ERR("Client socket poll error");
3696 DBG("Wait for client response");
3698 sock
= lttcomm_accept_unix_sock(client_sock
);
3703 /* Set socket option for credentials retrieval */
3704 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3709 /* Allocate context command to process the client request */
3710 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3711 if (cmd_ctx
== NULL
) {
3712 perror("zmalloc cmd_ctx");
3716 /* Allocate data buffer for reception */
3717 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3718 if (cmd_ctx
->lsm
== NULL
) {
3719 perror("zmalloc cmd_ctx->lsm");
3723 cmd_ctx
->llm
= NULL
;
3724 cmd_ctx
->session
= NULL
;
3727 * Data is received from the lttng client. The struct
3728 * lttcomm_session_msg (lsm) contains the command and data request of
3731 DBG("Receiving data from client ...");
3732 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3733 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3735 DBG("Nothing recv() from client... continuing");
3741 // TODO: Validate cmd_ctx including sanity check for
3742 // security purpose.
3744 rcu_thread_online();
3746 * This function dispatch the work to the kernel or userspace tracer
3747 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3748 * informations for the client. The command context struct contains
3749 * everything this function may needs.
3751 ret
= process_client_msg(cmd_ctx
);
3752 rcu_thread_offline();
3755 * TODO: Inform client somehow of the fatal error. At
3756 * this point, ret < 0 means that a zmalloc failed
3757 * (ENOMEM). Error detected but still accept command.
3759 clean_command_ctx(&cmd_ctx
);
3763 DBG("Sending response (size: %d, retcode: %s)",
3764 cmd_ctx
->lttng_msg_size
,
3765 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3766 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3768 ERR("Failed to send data back to client");
3771 /* End of transmission */
3774 clean_command_ctx(&cmd_ctx
);
3778 DBG("Client thread dying");
3779 unlink(client_unix_sock_path
);
3783 lttng_poll_clean(&events
);
3784 clean_command_ctx(&cmd_ctx
);
3786 rcu_unregister_thread();
3792 * usage function on stderr
3794 static void usage(void)
3796 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3797 fprintf(stderr
, " -h, --help Display this usage.\n");
3798 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3799 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3800 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3801 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3802 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3803 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3804 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3805 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3806 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3807 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3808 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3809 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3810 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3811 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3812 fprintf(stderr
, " -V, --version Show version number.\n");
3813 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3814 fprintf(stderr
, " -q, --quiet No output at all.\n");
3815 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3816 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3817 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3821 * daemon argument parsing
3823 static int parse_args(int argc
, char **argv
)
3827 static struct option long_options
[] = {
3828 { "client-sock", 1, 0, 'c' },
3829 { "apps-sock", 1, 0, 'a' },
3830 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3831 { "kconsumerd-err-sock", 1, 0, 'E' },
3832 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3833 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3834 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3835 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3836 { "consumerd32-path", 1, 0, 'u' },
3837 { "consumerd32-libdir", 1, 0, 'U' },
3838 { "consumerd64-path", 1, 0, 't' },
3839 { "consumerd64-libdir", 1, 0, 'T' },
3840 { "daemonize", 0, 0, 'd' },
3841 { "sig-parent", 0, 0, 'S' },
3842 { "help", 0, 0, 'h' },
3843 { "group", 1, 0, 'g' },
3844 { "version", 0, 0, 'V' },
3845 { "quiet", 0, 0, 'q' },
3846 { "verbose", 0, 0, 'v' },
3847 { "verbose-consumer", 0, 0, 'Z' },
3848 { "no-kernel", 0, 0, 'N' },
3853 int option_index
= 0;
3854 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3855 long_options
, &option_index
);
3862 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3864 fprintf(stderr
, " with arg %s\n", optarg
);
3868 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3871 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3877 opt_tracing_group
= optarg
;
3883 fprintf(stdout
, "%s\n", VERSION
);
3889 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3892 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3895 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3898 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3901 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3904 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3913 /* Verbose level can increase using multiple -v */
3917 opt_verbose_consumer
+= 1;
3920 consumerd32_bin
= optarg
;
3923 consumerd32_libdir
= optarg
;
3926 consumerd64_bin
= optarg
;
3929 consumerd64_libdir
= optarg
;
3932 /* Unknown option or other error.
3933 * Error is printed by getopt, just return */
3942 * Creates the two needed socket by the daemon.
3943 * apps_sock - The communication socket for all UST apps.
3944 * client_sock - The communication of the cli tool (lttng).
3946 static int init_daemon_socket(void)
3951 old_umask
= umask(0);
3953 /* Create client tool unix socket */
3954 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3955 if (client_sock
< 0) {
3956 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3961 /* File permission MUST be 660 */
3962 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3964 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3969 /* Create the application unix socket */
3970 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3971 if (apps_sock
< 0) {
3972 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3977 /* File permission MUST be 666 */
3978 ret
= chmod(apps_unix_sock_path
,
3979 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3981 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3992 * Check if the global socket is available, and if a daemon is answering at the
3993 * other side. If yes, error is returned.
3995 static int check_existing_daemon(void)
3997 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3998 access(apps_unix_sock_path
, F_OK
) < 0) {
4002 /* Is there anybody out there ? */
4003 if (lttng_session_daemon_alive()) {
4011 * Set the tracing group gid onto the client socket.
4013 * Race window between mkdir and chown is OK because we are going from more
4014 * permissive (root.root) to les permissive (root.tracing).
4016 static int set_permissions(char *rundir
)
4021 gid
= allowed_group();
4023 WARN("No tracing group detected");
4028 /* Set lttng run dir */
4029 ret
= chown(rundir
, 0, gid
);
4031 ERR("Unable to set group on %s", rundir
);
4035 /* lttng client socket path */
4036 ret
= chown(client_unix_sock_path
, 0, gid
);
4038 ERR("Unable to set group on %s", client_unix_sock_path
);
4042 /* kconsumer error socket path */
4043 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4045 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4049 /* 64-bit ustconsumer error socket path */
4050 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4052 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4056 /* 32-bit ustconsumer compat32 error socket path */
4057 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4059 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4063 DBG("All permissions are set");
4070 * Create the pipe used to wake up the kernel thread.
4072 static int create_kernel_poll_pipe(void)
4074 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4078 * Create the application command pipe to wake thread_manage_apps.
4080 static int create_apps_cmd_pipe(void)
4082 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4086 * Create the lttng run directory needed for all global sockets and pipe.
4088 static int create_lttng_rundir(const char *rundir
)
4092 DBG3("Creating LTTng run directory: %s", rundir
);
4094 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4096 if (errno
!= EEXIST
) {
4097 ERR("Unable to create %s", rundir
);
4109 * Setup sockets and directory needed by the kconsumerd communication with the
4112 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4116 char path
[PATH_MAX
];
4118 switch (consumer_data
->type
) {
4119 case LTTNG_CONSUMER_KERNEL
:
4120 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4122 case LTTNG_CONSUMER64_UST
:
4123 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4125 case LTTNG_CONSUMER32_UST
:
4126 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4129 ERR("Consumer type unknown");
4134 DBG2("Creating consumer directory: %s", path
);
4136 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4138 if (errno
!= EEXIST
) {
4139 ERR("Failed to create %s", path
);
4145 /* Create the kconsumerd error unix socket */
4146 consumer_data
->err_sock
=
4147 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4148 if (consumer_data
->err_sock
< 0) {
4149 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4154 /* File permission MUST be 660 */
4155 ret
= chmod(consumer_data
->err_unix_sock_path
,
4156 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4158 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4168 * Signal handler for the daemon
4170 * Simply stop all worker threads, leaving main() return gracefully after
4171 * joining all threads and calling cleanup().
4173 static void sighandler(int sig
)
4177 DBG("SIGPIPE catched");
4180 DBG("SIGINT catched");
4184 DBG("SIGTERM catched");
4193 * Setup signal handler for :
4194 * SIGINT, SIGTERM, SIGPIPE
4196 static int set_signal_handler(void)
4199 struct sigaction sa
;
4202 if ((ret
= sigemptyset(&sigset
)) < 0) {
4203 perror("sigemptyset");
4207 sa
.sa_handler
= sighandler
;
4208 sa
.sa_mask
= sigset
;
4210 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4211 perror("sigaction");
4215 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4216 perror("sigaction");
4220 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4221 perror("sigaction");
4225 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4231 * Set open files limit to unlimited. This daemon can open a large number of
4232 * file descriptors in order to consumer multiple kernel traces.
4234 static void set_ulimit(void)
4239 /* The kernel does not allowed an infinite limit for open files */
4240 lim
.rlim_cur
= 65535;
4241 lim
.rlim_max
= 65535;
4243 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4245 perror("failed to set open files limit");
4252 int main(int argc
, char **argv
)
4256 const char *home_path
;
4258 rcu_register_thread();
4260 /* Create thread quit pipe */
4261 if ((ret
= init_thread_quit_pipe()) < 0) {
4265 setup_consumerd_path();
4267 /* Parse arguments */
4269 if ((ret
= parse_args(argc
, argv
) < 0)) {
4282 /* Check if daemon is UID = 0 */
4283 is_root
= !getuid();
4286 rundir
= strdup(LTTNG_RUNDIR
);
4288 /* Create global run dir with root access */
4289 ret
= create_lttng_rundir(rundir
);
4294 if (strlen(apps_unix_sock_path
) == 0) {
4295 snprintf(apps_unix_sock_path
, PATH_MAX
,
4296 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4299 if (strlen(client_unix_sock_path
) == 0) {
4300 snprintf(client_unix_sock_path
, PATH_MAX
,
4301 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4304 /* Set global SHM for ust */
4305 if (strlen(wait_shm_path
) == 0) {
4306 snprintf(wait_shm_path
, PATH_MAX
,
4307 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4310 /* Setup kernel consumerd path */
4311 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4312 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4313 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4314 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4316 DBG2("Kernel consumer err path: %s",
4317 kconsumer_data
.err_unix_sock_path
);
4318 DBG2("Kernel consumer cmd path: %s",
4319 kconsumer_data
.cmd_unix_sock_path
);
4321 home_path
= get_home_dir();
4322 if (home_path
== NULL
) {
4323 /* TODO: Add --socket PATH option */
4324 ERR("Can't get HOME directory for sockets creation.");
4330 * Create rundir from home path. This will create something like
4333 ret
= asprintf(&rundir
, LTTNG_HOME_RUNDIR
, home_path
);
4339 ret
= create_lttng_rundir(rundir
);
4344 if (strlen(apps_unix_sock_path
) == 0) {
4345 snprintf(apps_unix_sock_path
, PATH_MAX
,
4346 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4349 /* Set the cli tool unix socket path */
4350 if (strlen(client_unix_sock_path
) == 0) {
4351 snprintf(client_unix_sock_path
, PATH_MAX
,
4352 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4355 /* Set global SHM for ust */
4356 if (strlen(wait_shm_path
) == 0) {
4357 snprintf(wait_shm_path
, PATH_MAX
,
4358 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4362 DBG("Client socket path %s", client_unix_sock_path
);
4363 DBG("Application socket path %s", apps_unix_sock_path
);
4364 DBG("LTTng run directory path: %s", rundir
);
4366 /* 32 bits consumerd path setup */
4367 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4368 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4369 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4370 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4372 DBG2("UST consumer 32 bits err path: %s",
4373 ustconsumer32_data
.err_unix_sock_path
);
4374 DBG2("UST consumer 32 bits cmd path: %s",
4375 ustconsumer32_data
.cmd_unix_sock_path
);
4377 /* 64 bits consumerd path setup */
4378 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4379 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4380 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4381 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4383 DBG2("UST consumer 64 bits err path: %s",
4384 ustconsumer64_data
.err_unix_sock_path
);
4385 DBG2("UST consumer 64 bits cmd path: %s",
4386 ustconsumer64_data
.cmd_unix_sock_path
);
4389 * See if daemon already exist.
4391 if ((ret
= check_existing_daemon()) < 0) {
4392 ERR("Already running daemon.\n");
4394 * We do not goto exit because we must not cleanup()
4395 * because a daemon is already running.
4400 /* After this point, we can safely call cleanup() with "goto exit" */
4403 * These actions must be executed as root. We do that *after* setting up
4404 * the sockets path because we MUST make the check for another daemon using
4405 * those paths *before* trying to set the kernel consumer sockets and init
4409 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4414 /* Setup kernel tracer */
4415 if (!opt_no_kernel
) {
4416 init_kernel_tracer();
4419 /* Set ulimit for open files */
4423 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4428 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4433 if ((ret
= set_signal_handler()) < 0) {
4437 /* Setup the needed unix socket */
4438 if ((ret
= init_daemon_socket()) < 0) {
4442 /* Set credentials to socket */
4443 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4447 /* Get parent pid if -S, --sig-parent is specified. */
4448 if (opt_sig_parent
) {
4452 /* Setup the kernel pipe for waking up the kernel thread */
4453 if ((ret
= create_kernel_poll_pipe()) < 0) {
4457 /* Setup the thread apps communication pipe. */
4458 if ((ret
= create_apps_cmd_pipe()) < 0) {
4462 /* Init UST command queue. */
4463 cds_wfq_init(&ust_cmd_queue
.queue
);
4465 /* Init UST app hash table */
4469 * Get session list pointer. This pointer MUST NOT be free(). This list is
4470 * statically declared in session.c
4472 session_list_ptr
= session_get_list();
4474 /* Set up max poll set size */
4475 lttng_poll_set_max_size();
4477 /* Create thread to manage the client socket */
4478 ret
= pthread_create(&client_thread
, NULL
,
4479 thread_manage_clients
, (void *) NULL
);
4481 perror("pthread_create clients");
4485 /* Create thread to dispatch registration */
4486 ret
= pthread_create(&dispatch_thread
, NULL
,
4487 thread_dispatch_ust_registration
, (void *) NULL
);
4489 perror("pthread_create dispatch");
4493 /* Create thread to manage application registration. */
4494 ret
= pthread_create(®_apps_thread
, NULL
,
4495 thread_registration_apps
, (void *) NULL
);
4497 perror("pthread_create registration");
4501 /* Create thread to manage application socket */
4502 ret
= pthread_create(&apps_thread
, NULL
,
4503 thread_manage_apps
, (void *) NULL
);
4505 perror("pthread_create apps");
4509 /* Create kernel thread to manage kernel event */
4510 ret
= pthread_create(&kernel_thread
, NULL
,
4511 thread_manage_kernel
, (void *) NULL
);
4513 perror("pthread_create kernel");
4517 ret
= pthread_join(kernel_thread
, &status
);
4519 perror("pthread_join");
4520 goto error
; /* join error, exit without cleanup */
4524 ret
= pthread_join(apps_thread
, &status
);
4526 perror("pthread_join");
4527 goto error
; /* join error, exit without cleanup */
4531 ret
= pthread_join(reg_apps_thread
, &status
);
4533 perror("pthread_join");
4534 goto error
; /* join error, exit without cleanup */
4538 ret
= pthread_join(dispatch_thread
, &status
);
4540 perror("pthread_join");
4541 goto error
; /* join error, exit without cleanup */
4545 ret
= pthread_join(client_thread
, &status
);
4547 perror("pthread_join");
4548 goto error
; /* join error, exit without cleanup */
4551 ret
= join_consumer_thread(&kconsumer_data
);
4553 perror("join_consumer");
4554 goto error
; /* join error, exit without cleanup */
4560 * cleanup() is called when no other thread is running.
4562 rcu_thread_online();
4564 rcu_thread_offline();
4565 rcu_unregister_thread();