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>
42 #include <lttng-sessiond-comm.h>
43 #include <lttng/lttng-consumer.h>
49 #include "compat/poll.h"
53 #include "hashtable.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
= ustctl_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
> 1 || 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 if (stat(consumerd64_bin
, &st
) == 0) {
1544 consumer_to_use
= consumerd64_bin
;
1545 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1546 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1547 } else if (stat(consumerd32_bin
, &st
) == 0) {
1548 consumer_to_use
= consumerd32_bin
;
1552 DBG("Using kernel consumer at: %s", consumer_to_use
);
1553 execl(consumer_to_use
,
1554 "lttng-consumerd", verbosity
, "-k",
1555 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1556 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1559 case LTTNG_CONSUMER64_UST
:
1561 char *tmpnew
= NULL
;
1563 if (consumerd64_libdir
[0] != '\0') {
1567 tmp
= getenv("LD_LIBRARY_PATH");
1571 tmplen
= strlen("LD_LIBRARY_PATH=")
1572 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1573 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1578 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1579 strcat(tmpnew
, consumerd64_libdir
);
1580 if (tmp
[0] != '\0') {
1581 strcat(tmpnew
, ":");
1582 strcat(tmpnew
, tmp
);
1584 ret
= putenv(tmpnew
);
1590 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1591 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1592 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1593 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1595 if (consumerd64_libdir
[0] != '\0') {
1603 case LTTNG_CONSUMER32_UST
:
1605 char *tmpnew
= NULL
;
1607 if (consumerd32_libdir
[0] != '\0') {
1611 tmp
= getenv("LD_LIBRARY_PATH");
1615 tmplen
= strlen("LD_LIBRARY_PATH=")
1616 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1617 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1622 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1623 strcat(tmpnew
, consumerd32_libdir
);
1624 if (tmp
[0] != '\0') {
1625 strcat(tmpnew
, ":");
1626 strcat(tmpnew
, tmp
);
1628 ret
= putenv(tmpnew
);
1634 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1635 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1636 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1637 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1639 if (consumerd32_libdir
[0] != '\0') {
1648 perror("unknown consumer type");
1652 perror("kernel start consumer exec");
1655 } else if (pid
> 0) {
1658 perror("start consumer fork");
1666 * Spawn the consumerd daemon and session daemon thread.
1668 static int start_consumerd(struct consumer_data
*consumer_data
)
1672 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1673 if (consumer_data
->pid
!= 0) {
1674 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1678 ret
= spawn_consumerd(consumer_data
);
1680 ERR("Spawning consumerd failed");
1681 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1685 /* Setting up the consumer_data pid */
1686 consumer_data
->pid
= ret
;
1687 DBG2("Consumer pid %d", consumer_data
->pid
);
1688 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1690 DBG2("Spawning consumer control thread");
1691 ret
= spawn_consumer_thread(consumer_data
);
1693 ERR("Fatal error spawning consumer control thread");
1705 * modprobe_kernel_modules
1707 static int modprobe_kernel_modules(void)
1712 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1713 ret
= snprintf(modprobe
, sizeof(modprobe
),
1714 "/sbin/modprobe %s%s",
1715 kernel_modules_list
[i
].required
? "" : "-q ",
1716 kernel_modules_list
[i
].name
);
1718 perror("snprintf modprobe");
1721 modprobe
[sizeof(modprobe
) - 1] = '\0';
1722 ret
= system(modprobe
);
1724 ERR("Unable to launch modprobe for module %s",
1725 kernel_modules_list
[i
].name
);
1726 } else if (kernel_modules_list
[i
].required
1727 && WEXITSTATUS(ret
) != 0) {
1728 ERR("Unable to load module %s",
1729 kernel_modules_list
[i
].name
);
1731 DBG("Modprobe successfully %s",
1732 kernel_modules_list
[i
].name
);
1743 static int mount_debugfs(char *path
)
1746 char *type
= "debugfs";
1748 ret
= mkdir_recursive_run_as(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1750 PERROR("Cannot create debugfs path");
1754 ret
= mount(type
, path
, type
, 0, NULL
);
1756 PERROR("Cannot mount debugfs");
1760 DBG("Mounted debugfs successfully at %s", path
);
1767 * Setup necessary data for kernel tracer action.
1769 static void init_kernel_tracer(void)
1772 char *proc_mounts
= "/proc/mounts";
1774 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1777 /* Detect debugfs */
1778 fp
= fopen(proc_mounts
, "r");
1780 ERR("Unable to probe %s", proc_mounts
);
1784 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1785 if (strstr(line
, "debugfs") != NULL
) {
1786 /* Remove first string */
1788 /* Dup string here so we can reuse line later on */
1789 debugfs_path
= strdup(strtok(NULL
, " "));
1790 DBG("Got debugfs path : %s", debugfs_path
);
1797 /* Mount debugfs if needded */
1798 if (debugfs_path
== NULL
) {
1799 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1801 perror("asprintf debugfs path");
1804 ret
= mount_debugfs(debugfs_path
);
1806 perror("Cannot mount debugfs");
1811 /* Modprobe lttng kernel modules */
1812 ret
= modprobe_kernel_modules();
1817 /* Setup lttng kernel path */
1818 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1820 perror("asprintf lttng path");
1824 /* Open debugfs lttng */
1825 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1826 if (kernel_tracer_fd
< 0) {
1827 DBG("Failed to open %s", lttng_path
);
1833 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1843 WARN("No kernel tracer available");
1844 kernel_tracer_fd
= 0;
1849 * Init tracing by creating trace directory and sending fds kernel consumer.
1851 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1855 if (session
->consumer_fds_sent
== 0) {
1857 * Assign default kernel consumer socket if no consumer assigned to the
1858 * kernel session. At this point, it's NOT suppose to be 0 but this is
1859 * an extra security check.
1861 if (session
->consumer_fd
== 0) {
1862 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1865 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1867 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1871 session
->consumer_fds_sent
= 1;
1879 * Create an UST session and add it to the session ust list.
1881 static int create_ust_session(struct ltt_session
*session
,
1882 struct lttng_domain
*domain
)
1884 struct ltt_ust_session
*lus
= NULL
;
1887 switch (domain
->type
) {
1888 case LTTNG_DOMAIN_UST
:
1891 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1895 DBG("Creating UST session");
1897 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1899 ret
= LTTCOMM_UST_SESS_FAIL
;
1903 ret
= mkdir_recursive_run_as(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1904 session
->uid
, session
->gid
);
1906 if (ret
!= -EEXIST
) {
1907 ERR("Trace directory creation error");
1908 ret
= LTTCOMM_UST_SESS_FAIL
;
1913 /* The domain type dictate different actions on session creation */
1914 switch (domain
->type
) {
1915 case LTTNG_DOMAIN_UST
:
1916 /* No ustctl for the global UST domain */
1919 ERR("Unknown UST domain on create session %d", domain
->type
);
1922 lus
->uid
= session
->uid
;
1923 lus
->gid
= session
->gid
;
1924 session
->ust_session
= lus
;
1934 * Create a kernel tracer session then create the default channel.
1936 static int create_kernel_session(struct ltt_session
*session
)
1940 DBG("Creating kernel session");
1942 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1944 ret
= LTTCOMM_KERN_SESS_FAIL
;
1948 /* Set kernel consumer socket fd */
1949 if (kconsumer_data
.cmd_sock
) {
1950 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1953 ret
= mkdir_recursive_run_as(session
->kernel_session
->trace_path
,
1954 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1956 if (ret
!= -EEXIST
) {
1957 ERR("Trace directory creation error");
1961 session
->kernel_session
->uid
= session
->uid
;
1962 session
->kernel_session
->gid
= session
->gid
;
1969 * Using the session list, filled a lttng_session array to send back to the
1970 * client for session listing.
1972 * The session list lock MUST be acquired before calling this function. Use
1973 * session_lock_list() and session_unlock_list().
1975 static void list_lttng_sessions(struct lttng_session
*sessions
)
1978 struct ltt_session
*session
;
1980 DBG("Getting all available session");
1982 * Iterate over session list and append data after the control struct in
1985 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1986 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1987 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1988 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1989 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1990 sessions
[i
].enabled
= session
->enabled
;
1996 * Fill lttng_channel array of all channels.
1998 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1999 struct lttng_channel
*channels
)
2002 struct ltt_kernel_channel
*kchan
;
2004 DBG("Listing channels for session %s", session
->name
);
2007 case LTTNG_DOMAIN_KERNEL
:
2008 /* Kernel channels */
2009 if (session
->kernel_session
!= NULL
) {
2010 cds_list_for_each_entry(kchan
,
2011 &session
->kernel_session
->channel_list
.head
, list
) {
2012 /* Copy lttng_channel struct to array */
2013 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2014 channels
[i
].enabled
= kchan
->enabled
;
2019 case LTTNG_DOMAIN_UST
:
2021 struct cds_lfht_iter iter
;
2022 struct ltt_ust_channel
*uchan
;
2024 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
2025 &iter
, uchan
, node
) {
2026 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2027 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2028 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2029 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2030 channels
[i
].attr
.switch_timer_interval
=
2031 uchan
->attr
.switch_timer_interval
;
2032 channels
[i
].attr
.read_timer_interval
=
2033 uchan
->attr
.read_timer_interval
;
2034 channels
[i
].enabled
= uchan
->enabled
;
2035 switch (uchan
->attr
.output
) {
2036 case LTTNG_UST_MMAP
:
2038 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2051 * Create a list of ust global domain events.
2053 static int list_lttng_ust_global_events(char *channel_name
,
2054 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2057 unsigned int nb_event
= 0;
2058 struct cds_lfht_iter iter
;
2059 struct cds_lfht_node
*node
;
2060 struct ltt_ust_channel
*uchan
;
2061 struct ltt_ust_event
*uevent
;
2062 struct lttng_event
*tmp
;
2064 DBG("Listing UST global events for channel %s", channel_name
);
2068 node
= hashtable_lookup(ust_global
->channels
, (void *) channel_name
,
2069 strlen(channel_name
), &iter
);
2071 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2075 uchan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
2077 nb_event
+= hashtable_get_count(uchan
->events
);
2079 if (nb_event
== 0) {
2084 DBG3("Listing UST global %d events", nb_event
);
2086 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2088 ret
= -LTTCOMM_FATAL
;
2092 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
2093 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2094 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2095 tmp
[i
].enabled
= uevent
->enabled
;
2096 switch (uevent
->attr
.instrumentation
) {
2097 case LTTNG_UST_TRACEPOINT
:
2098 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2100 case LTTNG_UST_PROBE
:
2101 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2103 case LTTNG_UST_FUNCTION
:
2104 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2106 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2107 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2122 * Fill lttng_event array of all kernel events in the channel.
2124 static int list_lttng_kernel_events(char *channel_name
,
2125 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2128 unsigned int nb_event
;
2129 struct ltt_kernel_event
*event
;
2130 struct ltt_kernel_channel
*kchan
;
2132 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2133 if (kchan
== NULL
) {
2134 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2138 nb_event
= kchan
->event_count
;
2140 DBG("Listing events for channel %s", kchan
->channel
->name
);
2142 if (nb_event
== 0) {
2147 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2148 if (*events
== NULL
) {
2149 ret
= LTTCOMM_FATAL
;
2153 /* Kernel channels */
2154 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2155 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2156 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2157 (*events
)[i
].enabled
= event
->enabled
;
2158 switch (event
->event
->instrumentation
) {
2159 case LTTNG_KERNEL_TRACEPOINT
:
2160 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2162 case LTTNG_KERNEL_KPROBE
:
2163 case LTTNG_KERNEL_KRETPROBE
:
2164 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2165 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2166 sizeof(struct lttng_kernel_kprobe
));
2168 case LTTNG_KERNEL_FUNCTION
:
2169 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2170 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2171 sizeof(struct lttng_kernel_function
));
2173 case LTTNG_KERNEL_NOOP
:
2174 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2176 case LTTNG_KERNEL_SYSCALL
:
2177 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2179 case LTTNG_KERNEL_ALL
:
2193 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2195 static int cmd_disable_channel(struct ltt_session
*session
,
2196 int domain
, char *channel_name
)
2199 struct ltt_ust_session
*usess
;
2201 usess
= session
->ust_session
;
2204 case LTTNG_DOMAIN_KERNEL
:
2206 ret
= channel_kernel_disable(session
->kernel_session
,
2208 if (ret
!= LTTCOMM_OK
) {
2212 kernel_wait_quiescent(kernel_tracer_fd
);
2215 case LTTNG_DOMAIN_UST
:
2217 struct ltt_ust_channel
*uchan
;
2218 struct cds_lfht
*chan_ht
;
2220 chan_ht
= usess
->domain_global
.channels
;
2222 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2223 if (uchan
== NULL
) {
2224 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2228 ret
= channel_ust_disable(usess
, domain
, uchan
);
2229 if (ret
!= LTTCOMM_OK
) {
2234 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2235 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2236 case LTTNG_DOMAIN_UST_PID
:
2237 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2240 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2251 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2253 static int cmd_enable_channel(struct ltt_session
*session
,
2254 int domain
, struct lttng_channel
*attr
)
2257 struct ltt_ust_session
*usess
= session
->ust_session
;
2258 struct cds_lfht
*chan_ht
;
2260 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2263 case LTTNG_DOMAIN_KERNEL
:
2265 struct ltt_kernel_channel
*kchan
;
2267 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2268 session
->kernel_session
);
2269 if (kchan
== NULL
) {
2270 ret
= channel_kernel_create(session
->kernel_session
,
2271 attr
, kernel_poll_pipe
[1]);
2273 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2276 if (ret
!= LTTCOMM_OK
) {
2280 kernel_wait_quiescent(kernel_tracer_fd
);
2283 case LTTNG_DOMAIN_UST
:
2285 struct ltt_ust_channel
*uchan
;
2287 chan_ht
= usess
->domain_global
.channels
;
2289 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2290 if (uchan
== NULL
) {
2291 ret
= channel_ust_create(usess
, domain
, attr
);
2293 ret
= channel_ust_enable(usess
, domain
, uchan
);
2297 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2298 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2299 case LTTNG_DOMAIN_UST_PID
:
2300 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2303 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2312 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2314 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2315 char *channel_name
, char *event_name
)
2320 case LTTNG_DOMAIN_KERNEL
:
2322 struct ltt_kernel_channel
*kchan
;
2323 struct ltt_kernel_session
*ksess
;
2325 ksess
= session
->kernel_session
;
2327 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2328 if (kchan
== NULL
) {
2329 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2333 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2334 if (ret
!= LTTCOMM_OK
) {
2338 kernel_wait_quiescent(kernel_tracer_fd
);
2341 case LTTNG_DOMAIN_UST
:
2343 struct ltt_ust_channel
*uchan
;
2344 struct ltt_ust_session
*usess
;
2346 usess
= session
->ust_session
;
2348 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2350 if (uchan
== NULL
) {
2351 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2355 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2356 if (ret
!= LTTCOMM_OK
) {
2360 DBG3("Disable UST event %s in channel %s completed", event_name
,
2364 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2365 case LTTNG_DOMAIN_UST_PID
:
2366 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2368 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2379 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2381 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2387 case LTTNG_DOMAIN_KERNEL
:
2389 struct ltt_kernel_session
*ksess
;
2390 struct ltt_kernel_channel
*kchan
;
2392 ksess
= session
->kernel_session
;
2394 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2395 if (kchan
== NULL
) {
2396 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2400 ret
= event_kernel_disable_all(ksess
, kchan
);
2401 if (ret
!= LTTCOMM_OK
) {
2405 kernel_wait_quiescent(kernel_tracer_fd
);
2408 case LTTNG_DOMAIN_UST
:
2410 struct ltt_ust_session
*usess
;
2411 struct ltt_ust_channel
*uchan
;
2413 usess
= session
->ust_session
;
2415 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2417 if (uchan
== NULL
) {
2418 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2422 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2427 DBG3("Disable all UST events in channel %s completed", channel_name
);
2431 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2432 case LTTNG_DOMAIN_UST_PID
:
2433 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2435 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2446 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2448 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2449 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2454 case LTTNG_DOMAIN_KERNEL
:
2455 /* Add kernel context to kernel tracer */
2456 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2457 event_name
, channel_name
);
2458 if (ret
!= LTTCOMM_OK
) {
2462 case LTTNG_DOMAIN_UST
:
2464 struct ltt_ust_session
*usess
= session
->ust_session
;
2466 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2467 if (ret
!= LTTCOMM_OK
) {
2472 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2473 case LTTNG_DOMAIN_UST_PID
:
2474 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2476 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2487 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2489 * TODO: currently, both events and loglevels are kept within the same
2490 * namespace for UST global registry/app registery, so if an event
2491 * happen to have the same name as the loglevel (very unlikely though),
2492 * and an attempt is made to enable/disable both in the same session,
2493 * the first to be created will be the only one allowed to exist.
2495 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2496 char *channel_name
, struct lttng_event
*event
)
2499 struct lttng_channel
*attr
;
2500 struct ltt_ust_session
*usess
= session
->ust_session
;
2503 case LTTNG_DOMAIN_KERNEL
:
2505 struct ltt_kernel_channel
*kchan
;
2507 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2508 session
->kernel_session
);
2509 if (kchan
== NULL
) {
2510 attr
= channel_new_default_attr(domain
);
2512 ret
= LTTCOMM_FATAL
;
2515 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2517 /* This call will notify the kernel thread */
2518 ret
= channel_kernel_create(session
->kernel_session
,
2519 attr
, kernel_poll_pipe
[1]);
2520 if (ret
!= LTTCOMM_OK
) {
2527 /* Get the newly created kernel channel pointer */
2528 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2529 session
->kernel_session
);
2530 if (kchan
== NULL
) {
2531 /* This sould not happen... */
2532 ret
= LTTCOMM_FATAL
;
2536 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2538 if (ret
!= LTTCOMM_OK
) {
2542 kernel_wait_quiescent(kernel_tracer_fd
);
2545 case LTTNG_DOMAIN_UST
:
2547 struct lttng_channel
*attr
;
2548 struct ltt_ust_channel
*uchan
;
2550 /* Get channel from global UST domain */
2551 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2553 if (uchan
== NULL
) {
2554 /* Create default channel */
2555 attr
= channel_new_default_attr(domain
);
2557 ret
= LTTCOMM_FATAL
;
2560 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2561 attr
->name
[NAME_MAX
- 1] = '\0';
2563 ret
= channel_ust_create(usess
, domain
, attr
);
2564 if (ret
!= LTTCOMM_OK
) {
2570 /* Get the newly created channel reference back */
2571 uchan
= trace_ust_find_channel_by_name(
2572 usess
->domain_global
.channels
, channel_name
);
2573 if (uchan
== NULL
) {
2574 /* Something is really wrong */
2575 ret
= LTTCOMM_FATAL
;
2580 /* At this point, the session and channel exist on the tracer */
2582 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2583 if (ret
!= LTTCOMM_OK
) {
2588 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2589 case LTTNG_DOMAIN_UST_PID
:
2590 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2592 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2603 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2605 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2606 char *channel_name
, int event_type
)
2609 struct ltt_kernel_channel
*kchan
;
2612 case LTTNG_DOMAIN_KERNEL
:
2613 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2614 session
->kernel_session
);
2615 if (kchan
== NULL
) {
2616 /* This call will notify the kernel thread */
2617 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2618 kernel_poll_pipe
[1]);
2619 if (ret
!= LTTCOMM_OK
) {
2623 /* Get the newly created kernel channel pointer */
2624 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2625 session
->kernel_session
);
2626 if (kchan
== NULL
) {
2627 /* This sould not happen... */
2628 ret
= LTTCOMM_FATAL
;
2634 switch (event_type
) {
2635 case LTTNG_EVENT_SYSCALL
:
2636 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2637 kchan
, kernel_tracer_fd
);
2639 case LTTNG_EVENT_TRACEPOINT
:
2641 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2642 * events already registered to the channel.
2644 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2645 kchan
, kernel_tracer_fd
);
2647 case LTTNG_EVENT_ALL
:
2648 /* Enable syscalls and tracepoints */
2649 ret
= event_kernel_enable_all(session
->kernel_session
,
2650 kchan
, kernel_tracer_fd
);
2653 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2657 /* Manage return value */
2658 if (ret
!= LTTCOMM_OK
) {
2662 kernel_wait_quiescent(kernel_tracer_fd
);
2664 case LTTNG_DOMAIN_UST
:
2666 struct lttng_channel
*attr
;
2667 struct ltt_ust_channel
*uchan
;
2668 struct ltt_ust_session
*usess
= session
->ust_session
;
2670 /* Get channel from global UST domain */
2671 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2673 if (uchan
== NULL
) {
2674 /* Create default channel */
2675 attr
= channel_new_default_attr(domain
);
2677 ret
= LTTCOMM_FATAL
;
2680 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2681 attr
->name
[NAME_MAX
- 1] = '\0';
2683 /* Use the internal command enable channel */
2684 ret
= channel_ust_create(usess
, domain
, attr
);
2685 if (ret
!= LTTCOMM_OK
) {
2691 /* Get the newly created channel reference back */
2692 uchan
= trace_ust_find_channel_by_name(
2693 usess
->domain_global
.channels
, channel_name
);
2694 if (uchan
== NULL
) {
2695 /* Something is really wrong */
2696 ret
= LTTCOMM_FATAL
;
2701 /* At this point, the session and channel exist on the tracer */
2703 switch (event_type
) {
2704 case LTTNG_EVENT_ALL
:
2705 case LTTNG_EVENT_TRACEPOINT
:
2706 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2707 if (ret
!= LTTCOMM_OK
) {
2712 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2716 /* Manage return value */
2717 if (ret
!= LTTCOMM_OK
) {
2723 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2724 case LTTNG_DOMAIN_UST_PID
:
2725 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2727 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2738 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2740 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2743 ssize_t nb_events
= 0;
2746 case LTTNG_DOMAIN_KERNEL
:
2747 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2748 if (nb_events
< 0) {
2749 ret
= LTTCOMM_KERN_LIST_FAIL
;
2753 case LTTNG_DOMAIN_UST
:
2754 nb_events
= ust_app_list_events(events
);
2755 if (nb_events
< 0) {
2756 ret
= LTTCOMM_UST_LIST_FAIL
;
2761 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2768 /* Return negative value to differentiate return code */
2773 * Command LTTNG_START_TRACE processed by the client thread.
2775 static int cmd_start_trace(struct ltt_session
*session
)
2778 struct ltt_kernel_session
*ksession
;
2779 struct ltt_ust_session
*usess
;
2782 ksession
= session
->kernel_session
;
2783 usess
= session
->ust_session
;
2785 if (session
->enabled
) {
2786 ret
= LTTCOMM_UST_START_FAIL
;
2790 session
->enabled
= 1;
2792 /* Kernel tracing */
2793 if (ksession
!= NULL
) {
2794 struct ltt_kernel_channel
*kchan
;
2796 /* Open kernel metadata */
2797 if (ksession
->metadata
== NULL
) {
2798 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2800 ret
= LTTCOMM_KERN_META_FAIL
;
2805 /* Open kernel metadata stream */
2806 if (ksession
->metadata_stream_fd
== 0) {
2807 ret
= kernel_open_metadata_stream(ksession
);
2809 ERR("Kernel create metadata stream failed");
2810 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2815 /* For each channel */
2816 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2817 if (kchan
->stream_count
== 0) {
2818 ret
= kernel_open_channel_stream(kchan
);
2820 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2823 /* Update the stream global counter */
2824 ksession
->stream_count_global
+= ret
;
2828 /* Setup kernel consumer socket and send fds to it */
2829 ret
= init_kernel_tracing(ksession
);
2831 ret
= LTTCOMM_KERN_START_FAIL
;
2835 /* This start the kernel tracing */
2836 ret
= kernel_start_session(ksession
);
2838 ret
= LTTCOMM_KERN_START_FAIL
;
2842 /* Quiescent wait after starting trace */
2843 kernel_wait_quiescent(kernel_tracer_fd
);
2846 /* Flag session that trace should start automatically */
2848 usess
->start_trace
= 1;
2850 ret
= ust_app_start_trace_all(usess
);
2852 ret
= LTTCOMM_UST_START_FAIL
;
2864 * Command LTTNG_STOP_TRACE processed by the client thread.
2866 static int cmd_stop_trace(struct ltt_session
*session
)
2869 struct ltt_kernel_channel
*kchan
;
2870 struct ltt_kernel_session
*ksession
;
2871 struct ltt_ust_session
*usess
;
2874 ksession
= session
->kernel_session
;
2875 usess
= session
->ust_session
;
2877 if (!session
->enabled
) {
2878 ret
= LTTCOMM_UST_START_FAIL
;
2882 session
->enabled
= 0;
2885 if (ksession
!= NULL
) {
2886 DBG("Stop kernel tracing");
2888 /* Flush all buffers before stopping */
2889 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2891 ERR("Kernel metadata flush failed");
2894 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2895 ret
= kernel_flush_buffer(kchan
);
2897 ERR("Kernel flush buffer error");
2901 ret
= kernel_stop_session(ksession
);
2903 ret
= LTTCOMM_KERN_STOP_FAIL
;
2907 kernel_wait_quiescent(kernel_tracer_fd
);
2911 usess
->start_trace
= 0;
2913 ret
= ust_app_stop_trace_all(usess
);
2915 ret
= LTTCOMM_UST_START_FAIL
;
2927 * Command LTTNG_CREATE_SESSION processed by the client thread.
2929 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2933 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2934 if (ret
!= LTTCOMM_OK
) {
2945 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2947 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2951 /* Clean kernel session teardown */
2952 teardown_kernel_session(session
);
2953 /* UST session teardown */
2954 teardown_ust_session(session
);
2957 * Must notify the kernel thread here to update it's poll setin order
2958 * to remove the channel(s)' fd just destroyed.
2960 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2962 perror("write kernel poll pipe");
2965 ret
= session_destroy(session
);
2971 * Command LTTNG_CALIBRATE processed by the client thread.
2973 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2978 case LTTNG_DOMAIN_KERNEL
:
2980 struct lttng_kernel_calibrate kcalibrate
;
2982 kcalibrate
.type
= calibrate
->type
;
2983 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2985 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2991 /* TODO: Userspace tracing */
2992 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3003 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3005 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3011 case LTTNG_DOMAIN_KERNEL
:
3012 /* Can't register a consumer if there is already one */
3013 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3014 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3018 sock
= lttcomm_connect_unix_sock(sock_path
);
3020 ret
= LTTCOMM_CONNECT_FAIL
;
3024 session
->kernel_session
->consumer_fd
= sock
;
3027 /* TODO: Userspace tracing */
3028 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3039 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3041 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3042 struct lttng_domain
**domains
)
3047 if (session
->kernel_session
!= NULL
) {
3048 DBG3("Listing domains found kernel domain");
3052 if (session
->ust_session
!= NULL
) {
3053 DBG3("Listing domains found UST global domain");
3057 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3058 if (*domains
== NULL
) {
3059 ret
= -LTTCOMM_FATAL
;
3063 if (session
->kernel_session
!= NULL
) {
3064 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3068 if (session
->ust_session
!= NULL
) {
3069 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3080 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3082 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3083 struct lttng_channel
**channels
)
3086 ssize_t nb_chan
= 0;
3089 case LTTNG_DOMAIN_KERNEL
:
3090 if (session
->kernel_session
!= NULL
) {
3091 nb_chan
= session
->kernel_session
->channel_count
;
3093 DBG3("Number of kernel channels %zd", nb_chan
);
3095 case LTTNG_DOMAIN_UST
:
3096 if (session
->ust_session
!= NULL
) {
3097 nb_chan
= hashtable_get_count(
3098 session
->ust_session
->domain_global
.channels
);
3100 DBG3("Number of UST global channels %zd", nb_chan
);
3104 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3109 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3110 if (*channels
== NULL
) {
3111 ret
= -LTTCOMM_FATAL
;
3115 list_lttng_channels(domain
, session
, *channels
);
3127 * Command LTTNG_LIST_EVENTS processed by the client thread.
3129 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3130 char *channel_name
, struct lttng_event
**events
)
3133 ssize_t nb_event
= 0;
3136 case LTTNG_DOMAIN_KERNEL
:
3137 if (session
->kernel_session
!= NULL
) {
3138 nb_event
= list_lttng_kernel_events(channel_name
,
3139 session
->kernel_session
, events
);
3142 case LTTNG_DOMAIN_UST
:
3144 if (session
->ust_session
!= NULL
) {
3145 nb_event
= list_lttng_ust_global_events(channel_name
,
3146 &session
->ust_session
->domain_global
, events
);
3151 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3162 * Process the command requested by the lttng client within the command
3163 * context structure. This function make sure that the return structure (llm)
3164 * is set and ready for transmission before returning.
3166 * Return any error encountered or 0 for success.
3168 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3170 int ret
= LTTCOMM_OK
;
3171 int need_tracing_session
= 1;
3173 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3175 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3176 ret
= LTTCOMM_KERN_NA
;
3181 * Check for command that don't needs to allocate a returned payload. We do
3182 * this here so we don't have to make the call for no payload at each
3185 switch(cmd_ctx
->lsm
->cmd_type
) {
3186 case LTTNG_LIST_SESSIONS
:
3187 case LTTNG_LIST_TRACEPOINTS
:
3188 case LTTNG_LIST_DOMAINS
:
3189 case LTTNG_LIST_CHANNELS
:
3190 case LTTNG_LIST_EVENTS
:
3193 /* Setup lttng message with no payload */
3194 ret
= setup_lttng_msg(cmd_ctx
, 0);
3196 /* This label does not try to unlock the session */
3197 goto init_setup_error
;
3201 /* Commands that DO NOT need a session. */
3202 switch (cmd_ctx
->lsm
->cmd_type
) {
3203 case LTTNG_CALIBRATE
:
3204 case LTTNG_CREATE_SESSION
:
3205 case LTTNG_LIST_SESSIONS
:
3206 case LTTNG_LIST_TRACEPOINTS
:
3207 need_tracing_session
= 0;
3210 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3211 session_lock_list();
3212 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3213 session_unlock_list();
3214 if (cmd_ctx
->session
== NULL
) {
3215 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3216 ret
= LTTCOMM_SESS_NOT_FOUND
;
3218 /* If no session name specified */
3219 ret
= LTTCOMM_SELECT_SESS
;
3223 /* Acquire lock for the session */
3224 session_lock(cmd_ctx
->session
);
3230 * Check domain type for specific "pre-action".
3232 switch (cmd_ctx
->lsm
->domain
.type
) {
3233 case LTTNG_DOMAIN_KERNEL
:
3234 /* Kernel tracer check */
3235 if (kernel_tracer_fd
== 0) {
3236 /* Basically, load kernel tracer modules */
3237 init_kernel_tracer();
3238 if (kernel_tracer_fd
== 0) {
3239 ret
= LTTCOMM_KERN_NA
;
3244 /* Need a session for kernel command */
3245 if (need_tracing_session
) {
3246 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3247 ret
= create_kernel_session(cmd_ctx
->session
);
3249 ret
= LTTCOMM_KERN_SESS_FAIL
;
3254 /* Start the kernel consumer daemon */
3255 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3256 if (kconsumer_data
.pid
== 0 &&
3257 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3258 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3259 ret
= start_consumerd(&kconsumer_data
);
3261 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3265 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3269 case LTTNG_DOMAIN_UST
:
3271 if (need_tracing_session
) {
3272 if (cmd_ctx
->session
->ust_session
== NULL
) {
3273 ret
= create_ust_session(cmd_ctx
->session
,
3274 &cmd_ctx
->lsm
->domain
);
3275 if (ret
!= LTTCOMM_OK
) {
3279 /* Start the UST consumer daemons */
3281 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3282 if (consumerd64_bin
[0] != '\0' &&
3283 ustconsumer64_data
.pid
== 0 &&
3284 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3285 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3286 ret
= start_consumerd(&ustconsumer64_data
);
3288 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3289 ust_consumerd64_fd
= -EINVAL
;
3293 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3295 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3298 if (consumerd32_bin
[0] != '\0' &&
3299 ustconsumer32_data
.pid
== 0 &&
3300 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3301 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3302 ret
= start_consumerd(&ustconsumer32_data
);
3304 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3305 ust_consumerd32_fd
= -EINVAL
;
3308 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3310 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3319 /* Process by command type */
3320 switch (cmd_ctx
->lsm
->cmd_type
) {
3321 case LTTNG_ADD_CONTEXT
:
3323 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3324 cmd_ctx
->lsm
->u
.context
.channel_name
,
3325 cmd_ctx
->lsm
->u
.context
.event_name
,
3326 &cmd_ctx
->lsm
->u
.context
.ctx
);
3329 case LTTNG_DISABLE_CHANNEL
:
3331 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3332 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3335 case LTTNG_DISABLE_EVENT
:
3337 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3338 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3339 cmd_ctx
->lsm
->u
.disable
.name
);
3343 case LTTNG_DISABLE_ALL_EVENT
:
3345 DBG("Disabling all events");
3347 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3348 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3351 case LTTNG_ENABLE_CHANNEL
:
3353 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3354 &cmd_ctx
->lsm
->u
.channel
.chan
);
3357 case LTTNG_ENABLE_EVENT
:
3359 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3360 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3361 &cmd_ctx
->lsm
->u
.enable
.event
);
3364 case LTTNG_ENABLE_ALL_EVENT
:
3366 DBG("Enabling all events");
3368 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3369 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3370 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3373 case LTTNG_LIST_TRACEPOINTS
:
3375 struct lttng_event
*events
;
3378 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3379 if (nb_events
< 0) {
3385 * Setup lttng message with payload size set to the event list size in
3386 * bytes and then copy list into the llm payload.
3388 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3394 /* Copy event list into message payload */
3395 memcpy(cmd_ctx
->llm
->payload
, events
,
3396 sizeof(struct lttng_event
) * nb_events
);
3403 case LTTNG_START_TRACE
:
3405 ret
= cmd_start_trace(cmd_ctx
->session
);
3408 case LTTNG_STOP_TRACE
:
3410 ret
= cmd_stop_trace(cmd_ctx
->session
);
3413 case LTTNG_CREATE_SESSION
:
3415 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3416 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3419 case LTTNG_DESTROY_SESSION
:
3421 ret
= cmd_destroy_session(cmd_ctx
->session
,
3422 cmd_ctx
->lsm
->session
.name
);
3425 case LTTNG_LIST_DOMAINS
:
3428 struct lttng_domain
*domains
;
3430 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3436 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3441 /* Copy event list into message payload */
3442 memcpy(cmd_ctx
->llm
->payload
, domains
,
3443 nb_dom
* sizeof(struct lttng_domain
));
3450 case LTTNG_LIST_CHANNELS
:
3453 struct lttng_channel
*channels
;
3455 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3456 cmd_ctx
->session
, &channels
);
3462 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3467 /* Copy event list into message payload */
3468 memcpy(cmd_ctx
->llm
->payload
, channels
,
3469 nb_chan
* sizeof(struct lttng_channel
));
3476 case LTTNG_LIST_EVENTS
:
3479 struct lttng_event
*events
= NULL
;
3481 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3482 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3488 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3493 /* Copy event list into message payload */
3494 memcpy(cmd_ctx
->llm
->payload
, events
,
3495 nb_event
* sizeof(struct lttng_event
));
3502 case LTTNG_LIST_SESSIONS
:
3504 session_lock_list();
3506 if (session_list_ptr
->count
== 0) {
3507 ret
= LTTCOMM_NO_SESSION
;
3508 session_unlock_list();
3512 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3513 session_list_ptr
->count
);
3515 session_unlock_list();
3519 /* Filled the session array */
3520 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3522 session_unlock_list();
3527 case LTTNG_CALIBRATE
:
3529 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3530 &cmd_ctx
->lsm
->u
.calibrate
);
3533 case LTTNG_REGISTER_CONSUMER
:
3535 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3536 cmd_ctx
->lsm
->u
.reg
.path
);
3545 if (cmd_ctx
->llm
== NULL
) {
3546 DBG("Missing llm structure. Allocating one.");
3547 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3551 /* Set return code */
3552 cmd_ctx
->llm
->ret_code
= ret
;
3554 if (cmd_ctx
->session
) {
3555 session_unlock(cmd_ctx
->session
);
3562 * This thread manage all clients request using the unix client socket for
3565 static void *thread_manage_clients(void *data
)
3567 int sock
= 0, ret
, i
, pollfd
;
3568 uint32_t revents
, nb_fd
;
3569 struct command_ctx
*cmd_ctx
= NULL
;
3570 struct lttng_poll_event events
;
3572 DBG("[thread] Manage client started");
3574 rcu_register_thread();
3576 ret
= lttcomm_listen_unix_sock(client_sock
);
3582 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3583 * more will be added to this poll set.
3585 ret
= create_thread_poll_set(&events
, 2);
3590 /* Add the application registration socket */
3591 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3597 * Notify parent pid that we are ready to accept command for client side.
3599 if (opt_sig_parent
) {
3600 kill(ppid
, SIGCHLD
);
3604 DBG("Accepting client command ...");
3606 nb_fd
= LTTNG_POLL_GETNB(&events
);
3608 /* Inifinite blocking call, waiting for transmission */
3609 ret
= lttng_poll_wait(&events
, -1);
3614 for (i
= 0; i
< nb_fd
; i
++) {
3615 /* Fetch once the poll data */
3616 revents
= LTTNG_POLL_GETEV(&events
, i
);
3617 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3619 /* Thread quit pipe has been closed. Killing thread. */
3620 ret
= check_thread_quit_pipe(pollfd
, revents
);
3625 /* Event on the registration socket */
3626 if (pollfd
== client_sock
) {
3627 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3628 ERR("Client socket poll error");
3634 DBG("Wait for client response");
3636 sock
= lttcomm_accept_unix_sock(client_sock
);
3641 /* Set socket option for credentials retrieval */
3642 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3647 /* Allocate context command to process the client request */
3648 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3649 if (cmd_ctx
== NULL
) {
3650 perror("zmalloc cmd_ctx");
3654 /* Allocate data buffer for reception */
3655 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3656 if (cmd_ctx
->lsm
== NULL
) {
3657 perror("zmalloc cmd_ctx->lsm");
3661 cmd_ctx
->llm
= NULL
;
3662 cmd_ctx
->session
= NULL
;
3665 * Data is received from the lttng client. The struct
3666 * lttcomm_session_msg (lsm) contains the command and data request of
3669 DBG("Receiving data from client ...");
3670 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3671 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3673 DBG("Nothing recv() from client... continuing");
3679 // TODO: Validate cmd_ctx including sanity check for
3680 // security purpose.
3682 rcu_thread_online();
3684 * This function dispatch the work to the kernel or userspace tracer
3685 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3686 * informations for the client. The command context struct contains
3687 * everything this function may needs.
3689 ret
= process_client_msg(cmd_ctx
);
3690 rcu_thread_offline();
3693 * TODO: Inform client somehow of the fatal error. At
3694 * this point, ret < 0 means that a zmalloc failed
3695 * (ENOMEM). Error detected but still accept command.
3697 clean_command_ctx(&cmd_ctx
);
3701 DBG("Sending response (size: %d, retcode: %s)",
3702 cmd_ctx
->lttng_msg_size
,
3703 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3704 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3706 ERR("Failed to send data back to client");
3709 /* End of transmission */
3712 clean_command_ctx(&cmd_ctx
);
3716 DBG("Client thread dying");
3717 unlink(client_unix_sock_path
);
3721 lttng_poll_clean(&events
);
3722 clean_command_ctx(&cmd_ctx
);
3724 rcu_unregister_thread();
3730 * usage function on stderr
3732 static void usage(void)
3734 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3735 fprintf(stderr
, " -h, --help Display this usage.\n");
3736 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3737 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3738 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3739 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3740 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3741 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3742 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3743 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3744 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3745 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3746 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3747 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3748 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3749 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3750 fprintf(stderr
, " -V, --version Show version number.\n");
3751 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3752 fprintf(stderr
, " -q, --quiet No output at all.\n");
3753 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3754 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3755 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3759 * daemon argument parsing
3761 static int parse_args(int argc
, char **argv
)
3765 static struct option long_options
[] = {
3766 { "client-sock", 1, 0, 'c' },
3767 { "apps-sock", 1, 0, 'a' },
3768 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3769 { "kconsumerd-err-sock", 1, 0, 'E' },
3770 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3771 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3772 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3773 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3774 { "consumerd32-path", 1, 0, 'u' },
3775 { "consumerd32-libdir", 1, 0, 'U' },
3776 { "consumerd64-path", 1, 0, 't' },
3777 { "consumerd64-libdir", 1, 0, 'T' },
3778 { "daemonize", 0, 0, 'd' },
3779 { "sig-parent", 0, 0, 'S' },
3780 { "help", 0, 0, 'h' },
3781 { "group", 1, 0, 'g' },
3782 { "version", 0, 0, 'V' },
3783 { "quiet", 0, 0, 'q' },
3784 { "verbose", 0, 0, 'v' },
3785 { "verbose-consumer", 0, 0, 'Z' },
3786 { "no-kernel", 0, 0, 'N' },
3791 int option_index
= 0;
3792 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3793 long_options
, &option_index
);
3800 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3802 fprintf(stderr
, " with arg %s\n", optarg
);
3806 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3809 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3815 opt_tracing_group
= optarg
;
3821 fprintf(stdout
, "%s\n", VERSION
);
3827 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3830 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3833 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3836 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3839 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3842 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3851 /* Verbose level can increase using multiple -v */
3855 opt_verbose_consumer
+= 1;
3858 consumerd32_bin
= optarg
;
3861 consumerd32_libdir
= optarg
;
3864 consumerd64_bin
= optarg
;
3867 consumerd64_libdir
= optarg
;
3870 /* Unknown option or other error.
3871 * Error is printed by getopt, just return */
3880 * Creates the two needed socket by the daemon.
3881 * apps_sock - The communication socket for all UST apps.
3882 * client_sock - The communication of the cli tool (lttng).
3884 static int init_daemon_socket(void)
3889 old_umask
= umask(0);
3891 /* Create client tool unix socket */
3892 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3893 if (client_sock
< 0) {
3894 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3899 /* File permission MUST be 660 */
3900 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3902 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3907 /* Create the application unix socket */
3908 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3909 if (apps_sock
< 0) {
3910 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3915 /* File permission MUST be 666 */
3916 ret
= chmod(apps_unix_sock_path
,
3917 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3919 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3930 * Check if the global socket is available, and if a daemon is answering at the
3931 * other side. If yes, error is returned.
3933 static int check_existing_daemon(void)
3935 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3936 access(apps_unix_sock_path
, F_OK
) < 0) {
3940 /* Is there anybody out there ? */
3941 if (lttng_session_daemon_alive()) {
3949 * Set the tracing group gid onto the client socket.
3951 * Race window between mkdir and chown is OK because we are going from more
3952 * permissive (root.root) to les permissive (root.tracing).
3954 static int set_permissions(char *rundir
)
3959 gid
= allowed_group();
3961 WARN("No tracing group detected");
3966 /* Set lttng run dir */
3967 ret
= chown(rundir
, 0, gid
);
3969 ERR("Unable to set group on %s", rundir
);
3973 /* lttng client socket path */
3974 ret
= chown(client_unix_sock_path
, 0, gid
);
3976 ERR("Unable to set group on %s", client_unix_sock_path
);
3980 /* kconsumer error socket path */
3981 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3983 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3987 /* 64-bit ustconsumer error socket path */
3988 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3990 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3994 /* 32-bit ustconsumer compat32 error socket path */
3995 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3997 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4001 DBG("All permissions are set");
4008 * Create the pipe used to wake up the kernel thread.
4010 static int create_kernel_poll_pipe(void)
4012 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4016 * Create the application command pipe to wake thread_manage_apps.
4018 static int create_apps_cmd_pipe(void)
4020 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4024 * Create the lttng run directory needed for all global sockets and pipe.
4026 static int create_lttng_rundir(const char *rundir
)
4030 DBG3("Creating LTTng run directory: %s", rundir
);
4032 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4034 if (errno
!= EEXIST
) {
4035 ERR("Unable to create %s", rundir
);
4047 * Setup sockets and directory needed by the kconsumerd communication with the
4050 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4054 char path
[PATH_MAX
];
4056 switch (consumer_data
->type
) {
4057 case LTTNG_CONSUMER_KERNEL
:
4058 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4060 case LTTNG_CONSUMER64_UST
:
4061 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4063 case LTTNG_CONSUMER32_UST
:
4064 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4067 ERR("Consumer type unknown");
4072 DBG2("Creating consumer directory: %s", path
);
4074 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4076 if (errno
!= EEXIST
) {
4077 ERR("Failed to create %s", path
);
4083 /* Create the kconsumerd error unix socket */
4084 consumer_data
->err_sock
=
4085 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4086 if (consumer_data
->err_sock
< 0) {
4087 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4092 /* File permission MUST be 660 */
4093 ret
= chmod(consumer_data
->err_unix_sock_path
,
4094 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4096 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4106 * Signal handler for the daemon
4108 * Simply stop all worker threads, leaving main() return gracefully after
4109 * joining all threads and calling cleanup().
4111 static void sighandler(int sig
)
4115 DBG("SIGPIPE catched");
4118 DBG("SIGINT catched");
4122 DBG("SIGTERM catched");
4131 * Setup signal handler for :
4132 * SIGINT, SIGTERM, SIGPIPE
4134 static int set_signal_handler(void)
4137 struct sigaction sa
;
4140 if ((ret
= sigemptyset(&sigset
)) < 0) {
4141 perror("sigemptyset");
4145 sa
.sa_handler
= sighandler
;
4146 sa
.sa_mask
= sigset
;
4148 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4149 perror("sigaction");
4153 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4154 perror("sigaction");
4158 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4159 perror("sigaction");
4163 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4169 * Set open files limit to unlimited. This daemon can open a large number of
4170 * file descriptors in order to consumer multiple kernel traces.
4172 static void set_ulimit(void)
4177 /* The kernel does not allowed an infinite limit for open files */
4178 lim
.rlim_cur
= 65535;
4179 lim
.rlim_max
= 65535;
4181 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4183 perror("failed to set open files limit");
4190 int main(int argc
, char **argv
)
4194 const char *home_path
;
4196 rcu_register_thread();
4198 /* Create thread quit pipe */
4199 if ((ret
= init_thread_quit_pipe()) < 0) {
4203 setup_consumerd_path();
4205 /* Parse arguments */
4207 if ((ret
= parse_args(argc
, argv
) < 0)) {
4220 /* Check if daemon is UID = 0 */
4221 is_root
= !getuid();
4224 rundir
= strdup(LTTNG_RUNDIR
);
4226 /* Create global run dir with root access */
4227 ret
= create_lttng_rundir(rundir
);
4232 if (strlen(apps_unix_sock_path
) == 0) {
4233 snprintf(apps_unix_sock_path
, PATH_MAX
,
4234 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4237 if (strlen(client_unix_sock_path
) == 0) {
4238 snprintf(client_unix_sock_path
, PATH_MAX
,
4239 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4242 /* Set global SHM for ust */
4243 if (strlen(wait_shm_path
) == 0) {
4244 snprintf(wait_shm_path
, PATH_MAX
,
4245 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4248 /* Setup kernel consumerd path */
4249 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4250 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4251 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4252 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4254 DBG2("Kernel consumer err path: %s",
4255 kconsumer_data
.err_unix_sock_path
);
4256 DBG2("Kernel consumer cmd path: %s",
4257 kconsumer_data
.cmd_unix_sock_path
);
4259 home_path
= get_home_dir();
4260 if (home_path
== NULL
) {
4261 /* TODO: Add --socket PATH option */
4262 ERR("Can't get HOME directory for sockets creation.");
4268 * Create rundir from home path. This will create something like
4271 ret
= asprintf(&rundir
, LTTNG_HOME_RUNDIR
, home_path
);
4277 ret
= create_lttng_rundir(rundir
);
4282 if (strlen(apps_unix_sock_path
) == 0) {
4283 snprintf(apps_unix_sock_path
, PATH_MAX
,
4284 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4287 /* Set the cli tool unix socket path */
4288 if (strlen(client_unix_sock_path
) == 0) {
4289 snprintf(client_unix_sock_path
, PATH_MAX
,
4290 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4293 /* Set global SHM for ust */
4294 if (strlen(wait_shm_path
) == 0) {
4295 snprintf(wait_shm_path
, PATH_MAX
,
4296 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4300 DBG("Client socket path %s", client_unix_sock_path
);
4301 DBG("Application socket path %s", apps_unix_sock_path
);
4302 DBG("LTTng run directory path: %s", rundir
);
4304 /* 32 bits consumerd path setup */
4305 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4306 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4307 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4308 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4310 DBG2("UST consumer 32 bits err path: %s",
4311 ustconsumer32_data
.err_unix_sock_path
);
4312 DBG2("UST consumer 32 bits cmd path: %s",
4313 ustconsumer32_data
.cmd_unix_sock_path
);
4315 /* 64 bits consumerd path setup */
4316 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4317 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4318 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4319 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4321 DBG2("UST consumer 64 bits err path: %s",
4322 ustconsumer64_data
.err_unix_sock_path
);
4323 DBG2("UST consumer 64 bits cmd path: %s",
4324 ustconsumer64_data
.cmd_unix_sock_path
);
4327 * See if daemon already exist.
4329 if ((ret
= check_existing_daemon()) < 0) {
4330 ERR("Already running daemon.\n");
4332 * We do not goto exit because we must not cleanup()
4333 * because a daemon is already running.
4338 /* After this point, we can safely call cleanup() with "goto exit" */
4341 * These actions must be executed as root. We do that *after* setting up
4342 * the sockets path because we MUST make the check for another daemon using
4343 * those paths *before* trying to set the kernel consumer sockets and init
4347 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4352 /* Setup kernel tracer */
4353 if (!opt_no_kernel
) {
4354 init_kernel_tracer();
4357 /* Set ulimit for open files */
4361 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4366 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4371 if ((ret
= set_signal_handler()) < 0) {
4375 /* Setup the needed unix socket */
4376 if ((ret
= init_daemon_socket()) < 0) {
4380 /* Set credentials to socket */
4381 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4385 /* Get parent pid if -S, --sig-parent is specified. */
4386 if (opt_sig_parent
) {
4390 /* Setup the kernel pipe for waking up the kernel thread */
4391 if ((ret
= create_kernel_poll_pipe()) < 0) {
4395 /* Setup the thread apps communication pipe. */
4396 if ((ret
= create_apps_cmd_pipe()) < 0) {
4400 /* Init UST command queue. */
4401 cds_wfq_init(&ust_cmd_queue
.queue
);
4403 /* Init UST app hash table */
4407 * Get session list pointer. This pointer MUST NOT be free(). This list is
4408 * statically declared in session.c
4410 session_list_ptr
= session_get_list();
4412 /* Set up max poll set size */
4413 lttng_poll_set_max_size();
4415 /* Create thread to manage the client socket */
4416 ret
= pthread_create(&client_thread
, NULL
,
4417 thread_manage_clients
, (void *) NULL
);
4419 perror("pthread_create clients");
4423 /* Create thread to dispatch registration */
4424 ret
= pthread_create(&dispatch_thread
, NULL
,
4425 thread_dispatch_ust_registration
, (void *) NULL
);
4427 perror("pthread_create dispatch");
4431 /* Create thread to manage application registration. */
4432 ret
= pthread_create(®_apps_thread
, NULL
,
4433 thread_registration_apps
, (void *) NULL
);
4435 perror("pthread_create registration");
4439 /* Create thread to manage application socket */
4440 ret
= pthread_create(&apps_thread
, NULL
,
4441 thread_manage_apps
, (void *) NULL
);
4443 perror("pthread_create apps");
4447 /* Create kernel thread to manage kernel event */
4448 ret
= pthread_create(&kernel_thread
, NULL
,
4449 thread_manage_kernel
, (void *) NULL
);
4451 perror("pthread_create kernel");
4455 ret
= pthread_join(kernel_thread
, &status
);
4457 perror("pthread_join");
4458 goto error
; /* join error, exit without cleanup */
4462 ret
= pthread_join(apps_thread
, &status
);
4464 perror("pthread_join");
4465 goto error
; /* join error, exit without cleanup */
4469 ret
= pthread_join(reg_apps_thread
, &status
);
4471 perror("pthread_join");
4472 goto error
; /* join error, exit without cleanup */
4476 ret
= pthread_join(dispatch_thread
, &status
);
4478 perror("pthread_join");
4479 goto error
; /* join error, exit without cleanup */
4483 ret
= pthread_join(client_thread
, &status
);
4485 perror("pthread_join");
4486 goto error
; /* join error, exit without cleanup */
4489 ret
= join_consumer_thread(&kconsumer_data
);
4491 perror("join_consumer");
4492 goto error
; /* join error, exit without cleanup */
4498 * cleanup() is called when no other thread is running.
4500 rcu_thread_online();
4502 rcu_thread_offline();
4503 rcu_unregister_thread();