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>
48 #include "compat/poll.h"
52 #include "hashtable.h"
54 #include "lttng-sessiond.h"
60 #define CONSUMERD_FILE "lttng-consumerd"
62 struct consumer_data
{
63 enum lttng_consumer_type type
;
65 pthread_t thread
; /* Worker thread interacting with the consumer */
68 /* Mutex to control consumerd pid assignation */
69 pthread_mutex_t pid_mutex
;
75 /* consumer error and command Unix socket path */
76 char err_unix_sock_path
[PATH_MAX
];
77 char cmd_unix_sock_path
[PATH_MAX
];
81 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
82 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
83 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
84 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
87 int opt_verbose
; /* Not static for lttngerr.h */
88 int opt_verbose_consumer
; /* Not static for lttngerr.h */
89 int opt_quiet
; /* Not static for lttngerr.h */
92 const char *opt_tracing_group
;
93 static int opt_sig_parent
;
94 static int opt_daemon
;
95 static int opt_no_kernel
;
96 static int is_root
; /* Set to 1 if the daemon is running as root */
97 static pid_t ppid
; /* Parent PID for --sig-parent option */
100 /* Consumer daemon specific control data */
101 static struct consumer_data kconsumer_data
= {
102 .type
= LTTNG_CONSUMER_KERNEL
,
103 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
104 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
106 static struct consumer_data ustconsumer64_data
= {
107 .type
= LTTNG_CONSUMER64_UST
,
108 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
109 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
111 static struct consumer_data ustconsumer32_data
= {
112 .type
= LTTNG_CONSUMER32_UST
,
113 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
114 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
117 static int dispatch_thread_exit
;
119 /* Global application Unix socket path */
120 static char apps_unix_sock_path
[PATH_MAX
];
121 /* Global client Unix socket path */
122 static char client_unix_sock_path
[PATH_MAX
];
123 /* global wait shm path for UST */
124 static char wait_shm_path
[PATH_MAX
];
126 /* Sockets and FDs */
127 static int client_sock
;
128 static int apps_sock
;
129 static int kernel_tracer_fd
;
130 static int kernel_poll_pipe
[2];
133 * Quit pipe for all threads. This permits a single cancellation point
134 * for all threads when receiving an event on the pipe.
136 static int thread_quit_pipe
[2];
139 * This pipe is used to inform the thread managing application communication
140 * that a command is queued and ready to be processed.
142 static int apps_cmd_pipe
[2];
144 /* Pthread, Mutexes and Semaphores */
145 static pthread_t apps_thread
;
146 static pthread_t reg_apps_thread
;
147 static pthread_t client_thread
;
148 static pthread_t kernel_thread
;
149 static pthread_t dispatch_thread
;
153 * UST registration command queue. This queue is tied with a futex and uses a N
154 * wakers / 1 waiter implemented and detailed in futex.c/.h
156 * The thread_manage_apps and thread_dispatch_ust_registration interact with
157 * this queue and the wait/wake scheme.
159 static struct ust_cmd_queue ust_cmd_queue
;
162 * Pointer initialized before thread creation.
164 * This points to the tracing session list containing the session count and a
165 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
166 * MUST NOT be taken if you call a public function in session.c.
168 * The lock is nested inside the structure: session_list_ptr->lock. Please use
169 * session_lock_list and session_unlock_list for lock acquisition.
171 static struct ltt_session_list
*session_list_ptr
;
173 int ust_consumerd64_fd
= -1;
174 int ust_consumerd32_fd
= -1;
176 static const char *consumerd32_bin
=
177 __stringify(CONFIG_CONSUMERD32_BIN
);
178 static const char *consumerd64_bin
=
179 __stringify(CONFIG_CONSUMERD64_BIN
);
180 static const char *consumerd32_libdir
=
181 __stringify(CONFIG_CONSUMERD32_LIBDIR
);
182 static const char *consumerd64_libdir
=
183 __stringify(CONFIG_CONSUMERD64_LIBDIR
);
186 void setup_consumerd_path(void)
188 const char *bin
, *libdir
;
191 * Allow INSTALL_BIN_PATH to be used as a target path for the
192 * native architecture size consumer if CONFIG_CONSUMER*_PATH
193 * has not been defined.
195 #if (CAA_BITS_PER_LONG == 32)
196 if (!consumerd32_bin
[0]) {
197 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
199 if (!consumerd32_libdir
[0]) {
200 consumerd32_libdir
= INSTALL_LIB_PATH
;
202 #elif (CAA_BITS_PER_LONG == 64)
203 if (!consumerd64_bin
[0]) {
204 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
206 if (!consumerd64_libdir
[0]) {
207 consumerd64_libdir
= INSTALL_LIB_PATH
;
210 #error "Unknown bitness"
214 * runtime env. var. overrides the build default.
216 bin
= getenv("LTTNG_CONSUMERD32_BIN");
218 consumerd32_bin
= bin
;
220 bin
= getenv("LTTNG_CONSUMERD64_BIN");
222 consumerd64_bin
= bin
;
224 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
226 consumerd32_libdir
= libdir
;
228 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
230 consumerd64_libdir
= libdir
;
235 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
237 static int create_thread_poll_set(struct lttng_poll_event
*events
,
242 if (events
== NULL
|| size
== 0) {
247 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
253 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
265 * Check if the thread quit pipe was triggered.
267 * Return 1 if it was triggered else 0;
269 static int check_thread_quit_pipe(int fd
, uint32_t events
)
271 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
279 * Remove modules in reverse load order.
281 static int modprobe_remove_kernel_modules(void)
286 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
287 ret
= snprintf(modprobe
, sizeof(modprobe
),
288 "/sbin/modprobe -r -q %s",
289 kernel_modules_list
[i
].name
);
291 perror("snprintf modprobe -r");
294 modprobe
[sizeof(modprobe
) - 1] = '\0';
295 ret
= system(modprobe
);
297 ERR("Unable to launch modprobe -r for module %s",
298 kernel_modules_list
[i
].name
);
299 } else if (kernel_modules_list
[i
].required
300 && WEXITSTATUS(ret
) != 0) {
301 ERR("Unable to remove module %s",
302 kernel_modules_list
[i
].name
);
304 DBG("Modprobe removal successful %s",
305 kernel_modules_list
[i
].name
);
314 * Return group ID of the tracing group or -1 if not found.
316 static gid_t
allowed_group(void)
320 if (opt_tracing_group
) {
321 grp
= getgrnam(opt_tracing_group
);
323 grp
= getgrnam(default_tracing_group
);
333 * Init thread quit pipe.
335 * Return -1 on error or 0 if all pipes are created.
337 static int init_thread_quit_pipe(void)
341 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
343 perror("thread quit pipe");
352 * Complete teardown of a kernel session. This free all data structure related
353 * to a kernel session and update counter.
355 static void teardown_kernel_session(struct ltt_session
*session
)
357 if (!session
->kernel_session
) {
358 DBG3("No kernel session when tearingdown session");
362 DBG("Tearing down kernel session");
365 * If a custom kernel consumer was registered, close the socket before
366 * tearing down the complete kernel session structure
368 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
369 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
372 trace_kernel_destroy_session(session
->kernel_session
);
376 * Complete teardown of all UST sessions. This will free everything on his path
377 * and destroy the core essence of all ust sessions :)
379 static void teardown_ust_session(struct ltt_session
*session
)
383 if (!session
->ust_session
) {
384 DBG3("No UST session when tearingdown session");
388 DBG("Tearing down UST session(s)");
390 ret
= ust_app_destroy_trace_all(session
->ust_session
);
392 ERR("Error in ust_app_destroy_trace_all");
395 trace_ust_destroy_session(session
->ust_session
);
399 * Stop all threads by closing the thread quit pipe.
401 static void stop_threads(void)
405 /* Stopping all threads */
406 DBG("Terminating all threads");
407 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
409 ERR("write error on thread quit pipe");
412 /* Dispatch thread */
413 dispatch_thread_exit
= 1;
414 futex_nto1_wake(&ust_cmd_queue
.futex
);
420 static void cleanup(void)
424 struct ltt_session
*sess
, *stmp
;
428 DBG("Removing %s directory", rundir
);
429 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
431 ERR("asprintf failed. Something is really wrong!");
434 /* Remove lttng run directory */
437 ERR("Unable to clean %s", rundir
);
441 DBG("Cleaning up all session");
443 /* Destroy session list mutex */
444 if (session_list_ptr
!= NULL
) {
445 pthread_mutex_destroy(&session_list_ptr
->lock
);
447 /* Cleanup ALL session */
448 cds_list_for_each_entry_safe(sess
, stmp
,
449 &session_list_ptr
->head
, list
) {
450 teardown_kernel_session(sess
);
451 teardown_ust_session(sess
);
456 DBG("Closing all UST sockets");
457 ust_app_clean_list();
459 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
461 if (is_root
&& !opt_no_kernel
) {
462 DBG2("Closing kernel fd");
463 close(kernel_tracer_fd
);
464 DBG("Unloading kernel modules");
465 modprobe_remove_kernel_modules();
468 close(thread_quit_pipe
[0]);
469 close(thread_quit_pipe
[1]);
472 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
473 "Matthew, BEET driven development works!%c[%dm",
474 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
479 * Send data on a unix socket using the liblttsessiondcomm API.
481 * Return lttcomm error code.
483 static int send_unix_sock(int sock
, void *buf
, size_t len
)
485 /* Check valid length */
490 return lttcomm_send_unix_sock(sock
, buf
, len
);
494 * Free memory of a command context structure.
496 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
498 DBG("Clean command context structure");
500 if ((*cmd_ctx
)->llm
) {
501 free((*cmd_ctx
)->llm
);
503 if ((*cmd_ctx
)->lsm
) {
504 free((*cmd_ctx
)->lsm
);
512 * Send all stream fds of kernel channel to the consumer.
514 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
515 int sock
, struct ltt_kernel_channel
*channel
,
516 uid_t uid
, gid_t gid
)
519 struct ltt_kernel_stream
*stream
;
520 struct lttcomm_consumer_msg lkm
;
522 DBG("Sending streams of channel %s to kernel consumer",
523 channel
->channel
->name
);
526 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
527 lkm
.u
.channel
.channel_key
= channel
->fd
;
528 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
529 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
530 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
531 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
533 perror("send consumer channel");
538 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
542 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
543 lkm
.u
.stream
.channel_key
= channel
->fd
;
544 lkm
.u
.stream
.stream_key
= stream
->fd
;
545 lkm
.u
.stream
.state
= stream
->state
;
546 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
547 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
548 lkm
.u
.stream
.uid
= uid
;
549 lkm
.u
.stream
.gid
= gid
;
550 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
551 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
552 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
553 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
555 perror("send consumer stream");
558 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
560 perror("send consumer stream ancillary data");
565 DBG("consumer channel streams sent");
574 * Send all stream fds of the kernel session to the consumer.
576 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
577 struct ltt_kernel_session
*session
)
580 struct ltt_kernel_channel
*chan
;
581 struct lttcomm_consumer_msg lkm
;
582 int sock
= session
->consumer_fd
;
584 DBG("Sending metadata stream fd");
586 /* Extra protection. It's NOT supposed to be set to 0 at this point */
587 if (session
->consumer_fd
== 0) {
588 session
->consumer_fd
= consumer_data
->cmd_sock
;
591 if (session
->metadata_stream_fd
!= 0) {
592 /* Send metadata channel fd */
593 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
594 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
595 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
596 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
597 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
598 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
600 perror("send consumer channel");
604 /* Send metadata stream fd */
605 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
606 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
607 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
608 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
609 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
610 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
611 lkm
.u
.stream
.uid
= session
->uid
;
612 lkm
.u
.stream
.gid
= session
->gid
;
613 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
614 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
615 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
616 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
618 perror("send consumer stream");
621 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
623 perror("send consumer stream");
628 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
629 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
630 session
->uid
, session
->gid
);
636 DBG("consumer fds (metadata and channel streams) sent");
645 * Notify UST applications using the shm mmap futex.
647 static int notify_ust_apps(int active
)
651 DBG("Notifying applications of session daemon state: %d", active
);
653 /* See shm.c for this call implying mmap, shm and futex calls */
654 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
655 if (wait_shm_mmap
== NULL
) {
659 /* Wake waiting process */
660 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
662 /* Apps notified successfully */
670 * Setup the outgoing data buffer for the response (llm) by allocating the
671 * right amount of memory and copying the original information from the lsm
674 * Return total size of the buffer pointed by buf.
676 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
682 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
683 if (cmd_ctx
->llm
== NULL
) {
689 /* Copy common data */
690 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
691 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
693 cmd_ctx
->llm
->data_size
= size
;
694 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
703 * Update the kernel poll set of all channel fd available over all tracing
704 * session. Add the wakeup pipe at the end of the set.
706 static int update_kernel_poll(struct lttng_poll_event
*events
)
709 struct ltt_session
*session
;
710 struct ltt_kernel_channel
*channel
;
712 DBG("Updating kernel poll set");
715 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
716 session_lock(session
);
717 if (session
->kernel_session
== NULL
) {
718 session_unlock(session
);
722 cds_list_for_each_entry(channel
,
723 &session
->kernel_session
->channel_list
.head
, list
) {
724 /* Add channel fd to the kernel poll set */
725 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
727 session_unlock(session
);
730 DBG("Channel fd %d added to kernel set", channel
->fd
);
732 session_unlock(session
);
734 session_unlock_list();
739 session_unlock_list();
744 * Find the channel fd from 'fd' over all tracing session. When found, check
745 * for new channel stream and send those stream fds to the kernel consumer.
747 * Useful for CPU hotplug feature.
749 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
752 struct ltt_session
*session
;
753 struct ltt_kernel_channel
*channel
;
755 DBG("Updating kernel streams for channel fd %d", fd
);
758 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
759 session_lock(session
);
760 if (session
->kernel_session
== NULL
) {
761 session_unlock(session
);
765 /* This is not suppose to be 0 but this is an extra security check */
766 if (session
->kernel_session
->consumer_fd
== 0) {
767 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
770 cds_list_for_each_entry(channel
,
771 &session
->kernel_session
->channel_list
.head
, list
) {
772 if (channel
->fd
== fd
) {
773 DBG("Channel found, updating kernel streams");
774 ret
= kernel_open_channel_stream(channel
);
780 * Have we already sent fds to the consumer? If yes, it means
781 * that tracing is started so it is safe to send our updated
784 if (session
->kernel_session
->consumer_fds_sent
== 1) {
785 ret
= send_kconsumer_channel_streams(consumer_data
,
786 session
->kernel_session
->consumer_fd
, channel
,
787 session
->uid
, session
->gid
);
795 session_unlock(session
);
797 session_unlock_list();
801 session_unlock(session
);
802 session_unlock_list();
807 * For each tracing session, update newly registered apps.
809 static void update_ust_app(int app_sock
)
811 struct ltt_session
*sess
, *stmp
;
813 /* For all tracing session(s) */
814 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
815 if (sess
->ust_session
) {
816 ust_app_global_update(sess
->ust_session
, app_sock
);
822 * This thread manage event coming from the kernel.
824 * Features supported in this thread:
827 static void *thread_manage_kernel(void *data
)
829 int ret
, i
, pollfd
, update_poll_flag
= 1;
830 uint32_t revents
, nb_fd
;
832 struct lttng_poll_event events
;
834 DBG("Thread manage kernel started");
836 ret
= create_thread_poll_set(&events
, 2);
841 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
847 if (update_poll_flag
== 1) {
849 * Reset number of fd in the poll set. Always 2 since there is the thread
850 * quit pipe and the kernel pipe.
854 ret
= update_kernel_poll(&events
);
858 update_poll_flag
= 0;
861 nb_fd
= LTTNG_POLL_GETNB(&events
);
863 DBG("Thread kernel polling on %d fds", nb_fd
);
865 /* Zeroed the poll events */
866 lttng_poll_reset(&events
);
868 /* Poll infinite value of time */
869 ret
= lttng_poll_wait(&events
, -1);
872 } else if (ret
== 0) {
873 /* Should not happen since timeout is infinite */
874 ERR("Return value of poll is 0 with an infinite timeout.\n"
875 "This should not have happened! Continuing...");
879 for (i
= 0; i
< nb_fd
; i
++) {
880 /* Fetch once the poll data */
881 revents
= LTTNG_POLL_GETEV(&events
, i
);
882 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
884 /* Thread quit pipe has been closed. Killing thread. */
885 ret
= check_thread_quit_pipe(pollfd
, revents
);
890 /* Check for data on kernel pipe */
891 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
892 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
893 update_poll_flag
= 1;
897 * New CPU detected by the kernel. Adding kernel stream to
898 * kernel session and updating the kernel consumer
900 if (revents
& LPOLLIN
) {
901 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
907 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
908 * and unregister kernel stream at this point.
916 DBG("Kernel thread dying");
917 close(kernel_poll_pipe
[0]);
918 close(kernel_poll_pipe
[1]);
920 lttng_poll_clean(&events
);
926 * This thread manage the consumer error sent back to the session daemon.
928 static void *thread_manage_consumer(void *data
)
930 int sock
= 0, i
, ret
, pollfd
;
931 uint32_t revents
, nb_fd
;
932 enum lttcomm_return_code code
;
933 struct lttng_poll_event events
;
934 struct consumer_data
*consumer_data
= data
;
936 DBG("[thread] Manage consumer started");
938 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
944 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
945 * Nothing more will be added to this poll set.
947 ret
= create_thread_poll_set(&events
, 2);
952 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
957 nb_fd
= LTTNG_POLL_GETNB(&events
);
959 /* Inifinite blocking call, waiting for transmission */
960 ret
= lttng_poll_wait(&events
, -1);
965 for (i
= 0; i
< nb_fd
; i
++) {
966 /* Fetch once the poll data */
967 revents
= LTTNG_POLL_GETEV(&events
, i
);
968 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
970 /* Thread quit pipe has been closed. Killing thread. */
971 ret
= check_thread_quit_pipe(pollfd
, revents
);
976 /* Event on the registration socket */
977 if (pollfd
== consumer_data
->err_sock
) {
978 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
979 ERR("consumer err socket poll error");
985 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
990 DBG2("Receiving code from consumer err_sock");
992 /* Getting status code from kconsumerd */
993 ret
= lttcomm_recv_unix_sock(sock
, &code
,
994 sizeof(enum lttcomm_return_code
));
999 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1000 consumer_data
->cmd_sock
=
1001 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1002 if (consumer_data
->cmd_sock
< 0) {
1003 sem_post(&consumer_data
->sem
);
1004 PERROR("consumer connect");
1007 /* Signal condition to tell that the kconsumerd is ready */
1008 sem_post(&consumer_data
->sem
);
1009 DBG("consumer command socket ready");
1011 ERR("consumer error when waiting for SOCK_READY : %s",
1012 lttcomm_get_readable_code(-code
));
1016 /* Remove the kconsumerd error sock since we've established a connexion */
1017 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1022 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1027 /* Update number of fd */
1028 nb_fd
= LTTNG_POLL_GETNB(&events
);
1030 /* Inifinite blocking call, waiting for transmission */
1031 ret
= lttng_poll_wait(&events
, -1);
1036 for (i
= 0; i
< nb_fd
; i
++) {
1037 /* Fetch once the poll data */
1038 revents
= LTTNG_POLL_GETEV(&events
, i
);
1039 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1041 /* Thread quit pipe has been closed. Killing thread. */
1042 ret
= check_thread_quit_pipe(pollfd
, revents
);
1047 /* Event on the kconsumerd socket */
1048 if (pollfd
== sock
) {
1049 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1050 ERR("consumer err socket second poll error");
1056 /* Wait for any kconsumerd error */
1057 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1058 sizeof(enum lttcomm_return_code
));
1060 ERR("consumer closed the command socket");
1064 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1067 DBG("consumer thread dying");
1068 close(consumer_data
->err_sock
);
1069 close(consumer_data
->cmd_sock
);
1072 unlink(consumer_data
->err_unix_sock_path
);
1073 unlink(consumer_data
->cmd_unix_sock_path
);
1074 consumer_data
->pid
= 0;
1076 lttng_poll_clean(&events
);
1082 * This thread manage application communication.
1084 static void *thread_manage_apps(void *data
)
1087 uint32_t revents
, nb_fd
;
1088 struct ust_command ust_cmd
;
1089 struct lttng_poll_event events
;
1091 DBG("[thread] Manage application started");
1093 rcu_register_thread();
1094 rcu_thread_online();
1096 ret
= create_thread_poll_set(&events
, 2);
1101 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1107 /* Zeroed the events structure */
1108 lttng_poll_reset(&events
);
1110 nb_fd
= LTTNG_POLL_GETNB(&events
);
1112 DBG("Apps thread polling on %d fds", nb_fd
);
1114 /* Inifinite blocking call, waiting for transmission */
1115 ret
= lttng_poll_wait(&events
, -1);
1120 for (i
= 0; i
< nb_fd
; i
++) {
1121 /* Fetch once the poll data */
1122 revents
= LTTNG_POLL_GETEV(&events
, i
);
1123 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1125 /* Thread quit pipe has been closed. Killing thread. */
1126 ret
= check_thread_quit_pipe(pollfd
, revents
);
1131 /* Inspect the apps cmd pipe */
1132 if (pollfd
== apps_cmd_pipe
[0]) {
1133 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1134 ERR("Apps command pipe error");
1136 } else if (revents
& LPOLLIN
) {
1138 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1139 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1140 perror("read apps cmd pipe");
1144 /* Register applicaton to the session daemon */
1145 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1147 if (ret
== -ENOMEM
) {
1149 } else if (ret
< 0) {
1154 * Add channel(s) and event(s) to newly registered apps
1155 * from lttng global UST domain.
1157 update_ust_app(ust_cmd
.sock
);
1159 ret
= ustctl_register_done(ust_cmd
.sock
);
1162 * If the registration is not possible, we simply
1163 * unregister the apps and continue
1165 ust_app_unregister(ust_cmd
.sock
);
1168 * We just need here to monitor the close of the UST
1169 * socket and poll set monitor those by default.
1171 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1176 DBG("Apps with sock %d added to poll set",
1184 * At this point, we know that a registered application made
1185 * the event at poll_wait.
1187 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1188 /* Removing from the poll set */
1189 ret
= lttng_poll_del(&events
, pollfd
);
1194 /* Socket closed on remote end. */
1195 ust_app_unregister(pollfd
);
1203 DBG("Application communication apps dying");
1204 close(apps_cmd_pipe
[0]);
1205 close(apps_cmd_pipe
[1]);
1207 lttng_poll_clean(&events
);
1209 rcu_thread_offline();
1210 rcu_unregister_thread();
1215 * Dispatch request from the registration threads to the application
1216 * communication thread.
1218 static void *thread_dispatch_ust_registration(void *data
)
1221 struct cds_wfq_node
*node
;
1222 struct ust_command
*ust_cmd
= NULL
;
1224 DBG("[thread] Dispatch UST command started");
1226 while (!dispatch_thread_exit
) {
1227 /* Atomically prepare the queue futex */
1228 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1231 /* Dequeue command for registration */
1232 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1234 DBG("Woken up but nothing in the UST command queue");
1235 /* Continue thread execution */
1239 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1241 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1242 " gid:%d sock:%d name:%s (version %d.%d)",
1243 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1244 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1245 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1246 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1248 * Inform apps thread of the new application registration. This
1249 * call is blocking so we can be assured that the data will be read
1250 * at some point in time or wait to the end of the world :)
1252 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1253 sizeof(struct ust_command
));
1255 perror("write apps cmd pipe");
1256 if (errno
== EBADF
) {
1258 * We can't inform the application thread to process
1259 * registration. We will exit or else application
1260 * registration will not occur and tracing will never
1267 } while (node
!= NULL
);
1269 /* Futex wait on queue. Blocking call on futex() */
1270 futex_nto1_wait(&ust_cmd_queue
.futex
);
1274 DBG("Dispatch thread dying");
1279 * This thread manage application registration.
1281 static void *thread_registration_apps(void *data
)
1283 int sock
= 0, i
, ret
, pollfd
;
1284 uint32_t revents
, nb_fd
;
1285 struct lttng_poll_event events
;
1287 * Get allocated in this thread, enqueued to a global queue, dequeued and
1288 * freed in the manage apps thread.
1290 struct ust_command
*ust_cmd
= NULL
;
1292 DBG("[thread] Manage application registration started");
1294 ret
= lttcomm_listen_unix_sock(apps_sock
);
1300 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1301 * more will be added to this poll set.
1303 ret
= create_thread_poll_set(&events
, 2);
1308 /* Add the application registration socket */
1309 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1314 /* Notify all applications to register */
1315 ret
= notify_ust_apps(1);
1317 ERR("Failed to notify applications or create the wait shared memory.\n"
1318 "Execution continues but there might be problem for already\n"
1319 "running applications that wishes to register.");
1323 DBG("Accepting application registration");
1325 nb_fd
= LTTNG_POLL_GETNB(&events
);
1327 /* Inifinite blocking call, waiting for transmission */
1328 ret
= lttng_poll_wait(&events
, -1);
1333 for (i
= 0; i
< nb_fd
; i
++) {
1334 /* Fetch once the poll data */
1335 revents
= LTTNG_POLL_GETEV(&events
, i
);
1336 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1338 /* Thread quit pipe has been closed. Killing thread. */
1339 ret
= check_thread_quit_pipe(pollfd
, revents
);
1344 /* Event on the registration socket */
1345 if (pollfd
== apps_sock
) {
1346 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1347 ERR("Register apps socket poll error");
1349 } else if (revents
& LPOLLIN
) {
1350 sock
= lttcomm_accept_unix_sock(apps_sock
);
1355 /* Create UST registration command for enqueuing */
1356 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1357 if (ust_cmd
== NULL
) {
1358 perror("ust command zmalloc");
1363 * Using message-based transmissions to ensure we don't
1364 * have to deal with partially received messages.
1366 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1367 sizeof(struct ust_register_msg
));
1368 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1370 perror("lttcomm_recv_unix_sock register apps");
1372 ERR("Wrong size received on apps register");
1379 ust_cmd
->sock
= sock
;
1381 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1382 " gid:%d sock:%d name:%s (version %d.%d)",
1383 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1384 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1385 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1386 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1389 * Lock free enqueue the registration request. The red pill
1390 * has been taken! This apps will be part of the *system*.
1392 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1395 * Wake the registration queue futex. Implicit memory
1396 * barrier with the exchange in cds_wfq_enqueue.
1398 futex_nto1_wake(&ust_cmd_queue
.futex
);
1405 DBG("UST Registration thread dying");
1407 /* Notify that the registration thread is gone */
1412 unlink(apps_unix_sock_path
);
1414 lttng_poll_clean(&events
);
1420 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1421 * exec or it will fails.
1423 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1426 struct timespec timeout
;
1428 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1429 timeout
.tv_nsec
= 0;
1431 /* Setup semaphore */
1432 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1434 PERROR("sem_init consumer semaphore");
1438 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1439 thread_manage_consumer
, consumer_data
);
1441 PERROR("pthread_create consumer");
1446 /* Get time for sem_timedwait absolute timeout */
1447 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1449 PERROR("clock_gettime spawn consumer");
1450 /* Infinite wait for the kconsumerd thread to be ready */
1451 ret
= sem_wait(&consumer_data
->sem
);
1453 /* Normal timeout if the gettime was successful */
1454 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1455 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1459 if (errno
== ETIMEDOUT
) {
1461 * Call has timed out so we kill the kconsumerd_thread and return
1464 ERR("The consumer thread was never ready. Killing it");
1465 ret
= pthread_cancel(consumer_data
->thread
);
1467 PERROR("pthread_cancel consumer thread");
1470 PERROR("semaphore wait failed consumer thread");
1475 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1476 if (consumer_data
->pid
== 0) {
1477 ERR("Kconsumerd did not start");
1478 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1481 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1490 * Join consumer thread
1492 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1497 if (consumer_data
->pid
!= 0) {
1498 ret
= kill(consumer_data
->pid
, SIGTERM
);
1500 ERR("Error killing consumer daemon");
1503 return pthread_join(consumer_data
->thread
, &status
);
1510 * Fork and exec a consumer daemon (consumerd).
1512 * Return pid if successful else -1.
1514 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1518 const char *consumer_to_use
;
1519 const char *verbosity
;
1522 DBG("Spawning consumerd");
1529 if (opt_verbose
> 1 || opt_verbose_consumer
) {
1530 verbosity
= "--verbose";
1532 verbosity
= "--quiet";
1534 switch (consumer_data
->type
) {
1535 case LTTNG_CONSUMER_KERNEL
:
1537 * Find out which consumerd to execute. We will
1538 * first try the 64-bit path, then the
1539 * sessiond's installation directory, and
1540 * fallback on the 32-bit one,
1542 if (stat(consumerd64_bin
, &st
) == 0) {
1543 consumer_to_use
= consumerd64_bin
;
1544 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1545 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1546 } else if (stat(consumerd32_bin
, &st
) == 0) {
1547 consumer_to_use
= consumerd32_bin
;
1551 DBG("Using kernel consumer at: %s", consumer_to_use
);
1552 execl(consumer_to_use
,
1553 "lttng-consumerd", verbosity
, "-k",
1554 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1555 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1558 case LTTNG_CONSUMER64_UST
:
1560 char *tmpnew
= NULL
;
1562 if (consumerd64_libdir
[0] != '\0') {
1566 tmp
= getenv("LD_LIBRARY_PATH");
1570 tmplen
= strlen("LD_LIBRARY_PATH=")
1571 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1572 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1577 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1578 strcat(tmpnew
, consumerd64_libdir
);
1579 if (tmp
[0] != '\0') {
1580 strcat(tmpnew
, ":");
1581 strcat(tmpnew
, tmp
);
1583 ret
= putenv(tmpnew
);
1589 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1590 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1591 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1592 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1594 if (consumerd64_libdir
[0] != '\0') {
1602 case LTTNG_CONSUMER32_UST
:
1604 char *tmpnew
= NULL
;
1606 if (consumerd32_libdir
[0] != '\0') {
1610 tmp
= getenv("LD_LIBRARY_PATH");
1614 tmplen
= strlen("LD_LIBRARY_PATH=")
1615 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1616 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1621 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1622 strcat(tmpnew
, consumerd32_libdir
);
1623 if (tmp
[0] != '\0') {
1624 strcat(tmpnew
, ":");
1625 strcat(tmpnew
, tmp
);
1627 ret
= putenv(tmpnew
);
1633 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1634 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1635 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1636 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1638 if (consumerd32_libdir
[0] != '\0') {
1647 perror("unknown consumer type");
1651 perror("kernel start consumer exec");
1654 } else if (pid
> 0) {
1657 perror("start consumer fork");
1665 * Spawn the consumerd daemon and session daemon thread.
1667 static int start_consumerd(struct consumer_data
*consumer_data
)
1671 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1672 if (consumer_data
->pid
!= 0) {
1673 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1677 ret
= spawn_consumerd(consumer_data
);
1679 ERR("Spawning consumerd failed");
1680 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1684 /* Setting up the consumer_data pid */
1685 consumer_data
->pid
= ret
;
1686 DBG2("Consumer pid %d", consumer_data
->pid
);
1687 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1689 DBG2("Spawning consumer control thread");
1690 ret
= spawn_consumer_thread(consumer_data
);
1692 ERR("Fatal error spawning consumer control thread");
1704 * modprobe_kernel_modules
1706 static int modprobe_kernel_modules(void)
1711 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1712 ret
= snprintf(modprobe
, sizeof(modprobe
),
1713 "/sbin/modprobe %s%s",
1714 kernel_modules_list
[i
].required
? "" : "-q ",
1715 kernel_modules_list
[i
].name
);
1717 perror("snprintf modprobe");
1720 modprobe
[sizeof(modprobe
) - 1] = '\0';
1721 ret
= system(modprobe
);
1723 ERR("Unable to launch modprobe for module %s",
1724 kernel_modules_list
[i
].name
);
1725 } else if (kernel_modules_list
[i
].required
1726 && WEXITSTATUS(ret
) != 0) {
1727 ERR("Unable to load module %s",
1728 kernel_modules_list
[i
].name
);
1730 DBG("Modprobe successfully %s",
1731 kernel_modules_list
[i
].name
);
1742 static int mount_debugfs(char *path
)
1745 char *type
= "debugfs";
1747 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1749 PERROR("Cannot create debugfs path");
1753 ret
= mount(type
, path
, type
, 0, NULL
);
1755 PERROR("Cannot mount debugfs");
1759 DBG("Mounted debugfs successfully at %s", path
);
1766 * Setup necessary data for kernel tracer action.
1768 static void init_kernel_tracer(void)
1771 char *proc_mounts
= "/proc/mounts";
1773 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1776 /* Detect debugfs */
1777 fp
= fopen(proc_mounts
, "r");
1779 ERR("Unable to probe %s", proc_mounts
);
1783 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1784 if (strstr(line
, "debugfs") != NULL
) {
1785 /* Remove first string */
1787 /* Dup string here so we can reuse line later on */
1788 debugfs_path
= strdup(strtok(NULL
, " "));
1789 DBG("Got debugfs path : %s", debugfs_path
);
1796 /* Mount debugfs if needded */
1797 if (debugfs_path
== NULL
) {
1798 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1800 perror("asprintf debugfs path");
1803 ret
= mount_debugfs(debugfs_path
);
1805 perror("Cannot mount debugfs");
1810 /* Modprobe lttng kernel modules */
1811 ret
= modprobe_kernel_modules();
1816 /* Setup lttng kernel path */
1817 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1819 perror("asprintf lttng path");
1823 /* Open debugfs lttng */
1824 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1825 if (kernel_tracer_fd
< 0) {
1826 DBG("Failed to open %s", lttng_path
);
1832 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1842 WARN("No kernel tracer available");
1843 kernel_tracer_fd
= 0;
1848 * Init tracing by creating trace directory and sending fds kernel consumer.
1850 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1854 if (session
->consumer_fds_sent
== 0) {
1856 * Assign default kernel consumer socket if no consumer assigned to the
1857 * kernel session. At this point, it's NOT suppose to be 0 but this is
1858 * an extra security check.
1860 if (session
->consumer_fd
== 0) {
1861 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1864 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1866 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1870 session
->consumer_fds_sent
= 1;
1878 * Create an UST session and add it to the session ust list.
1880 static int create_ust_session(struct ltt_session
*session
,
1881 struct lttng_domain
*domain
)
1883 struct ltt_ust_session
*lus
= NULL
;
1886 switch (domain
->type
) {
1887 case LTTNG_DOMAIN_UST
:
1890 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1894 DBG("Creating UST session");
1896 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1898 ret
= LTTCOMM_UST_SESS_FAIL
;
1902 ret
= mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1903 session
->uid
, session
->gid
);
1905 if (ret
!= -EEXIST
) {
1906 ERR("Trace directory creation error");
1907 ret
= LTTCOMM_UST_SESS_FAIL
;
1912 /* The domain type dictate different actions on session creation */
1913 switch (domain
->type
) {
1914 case LTTNG_DOMAIN_UST
:
1915 /* No ustctl for the global UST domain */
1918 ERR("Unknown UST domain on create session %d", domain
->type
);
1921 lus
->uid
= session
->uid
;
1922 lus
->gid
= session
->gid
;
1923 session
->ust_session
= lus
;
1933 * Create a kernel tracer session then create the default channel.
1935 static int create_kernel_session(struct ltt_session
*session
)
1939 DBG("Creating kernel session");
1941 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1943 ret
= LTTCOMM_KERN_SESS_FAIL
;
1947 /* Set kernel consumer socket fd */
1948 if (kconsumer_data
.cmd_sock
) {
1949 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1952 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1953 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1955 if (ret
!= -EEXIST
) {
1956 ERR("Trace directory creation error");
1960 session
->kernel_session
->uid
= session
->uid
;
1961 session
->kernel_session
->gid
= session
->gid
;
1968 * Using the session list, filled a lttng_session array to send back to the
1969 * client for session listing.
1971 * The session list lock MUST be acquired before calling this function. Use
1972 * session_lock_list() and session_unlock_list().
1974 static void list_lttng_sessions(struct lttng_session
*sessions
)
1977 struct ltt_session
*session
;
1979 DBG("Getting all available session");
1981 * Iterate over session list and append data after the control struct in
1984 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1985 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1986 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1987 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1988 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1989 sessions
[i
].enabled
= session
->enabled
;
1995 * Fill lttng_channel array of all channels.
1997 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1998 struct lttng_channel
*channels
)
2001 struct ltt_kernel_channel
*kchan
;
2003 DBG("Listing channels for session %s", session
->name
);
2006 case LTTNG_DOMAIN_KERNEL
:
2007 /* Kernel channels */
2008 if (session
->kernel_session
!= NULL
) {
2009 cds_list_for_each_entry(kchan
,
2010 &session
->kernel_session
->channel_list
.head
, list
) {
2011 /* Copy lttng_channel struct to array */
2012 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2013 channels
[i
].enabled
= kchan
->enabled
;
2018 case LTTNG_DOMAIN_UST
:
2020 struct cds_lfht_iter iter
;
2021 struct ltt_ust_channel
*uchan
;
2023 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
2024 &iter
, uchan
, node
) {
2025 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2026 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2027 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2028 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2029 channels
[i
].attr
.switch_timer_interval
=
2030 uchan
->attr
.switch_timer_interval
;
2031 channels
[i
].attr
.read_timer_interval
=
2032 uchan
->attr
.read_timer_interval
;
2033 channels
[i
].enabled
= uchan
->enabled
;
2034 switch (uchan
->attr
.output
) {
2035 case LTTNG_UST_MMAP
:
2037 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2050 * Create a list of ust global domain events.
2052 static int list_lttng_ust_global_events(char *channel_name
,
2053 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2056 unsigned int nb_event
= 0;
2057 struct cds_lfht_iter iter
;
2058 struct cds_lfht_node
*node
;
2059 struct ltt_ust_channel
*uchan
;
2060 struct ltt_ust_event
*uevent
;
2061 struct lttng_event
*tmp
;
2063 DBG("Listing UST global events for channel %s", channel_name
);
2067 node
= hashtable_lookup(ust_global
->channels
, (void *) channel_name
,
2068 strlen(channel_name
), &iter
);
2070 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2074 uchan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
2076 nb_event
+= hashtable_get_count(uchan
->events
);
2078 if (nb_event
== 0) {
2083 DBG3("Listing UST global %d events", nb_event
);
2085 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2087 ret
= -LTTCOMM_FATAL
;
2091 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
2092 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2093 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2094 tmp
[i
].enabled
= uevent
->enabled
;
2095 switch (uevent
->attr
.instrumentation
) {
2096 case LTTNG_UST_TRACEPOINT
:
2097 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2099 case LTTNG_UST_PROBE
:
2100 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2102 case LTTNG_UST_FUNCTION
:
2103 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2105 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2106 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2121 * Fill lttng_event array of all kernel events in the channel.
2123 static int list_lttng_kernel_events(char *channel_name
,
2124 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2127 unsigned int nb_event
;
2128 struct ltt_kernel_event
*event
;
2129 struct ltt_kernel_channel
*kchan
;
2131 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2132 if (kchan
== NULL
) {
2133 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2137 nb_event
= kchan
->event_count
;
2139 DBG("Listing events for channel %s", kchan
->channel
->name
);
2141 if (nb_event
== 0) {
2146 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2147 if (*events
== NULL
) {
2148 ret
= LTTCOMM_FATAL
;
2152 /* Kernel channels */
2153 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2154 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2155 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2156 (*events
)[i
].enabled
= event
->enabled
;
2157 switch (event
->event
->instrumentation
) {
2158 case LTTNG_KERNEL_TRACEPOINT
:
2159 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2161 case LTTNG_KERNEL_KPROBE
:
2162 case LTTNG_KERNEL_KRETPROBE
:
2163 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2164 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2165 sizeof(struct lttng_kernel_kprobe
));
2167 case LTTNG_KERNEL_FUNCTION
:
2168 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2169 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2170 sizeof(struct lttng_kernel_function
));
2172 case LTTNG_KERNEL_NOOP
:
2173 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2175 case LTTNG_KERNEL_SYSCALL
:
2176 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2178 case LTTNG_KERNEL_ALL
:
2192 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2194 static int cmd_disable_channel(struct ltt_session
*session
,
2195 int domain
, char *channel_name
)
2198 struct ltt_ust_session
*usess
;
2200 usess
= session
->ust_session
;
2203 case LTTNG_DOMAIN_KERNEL
:
2205 ret
= channel_kernel_disable(session
->kernel_session
,
2207 if (ret
!= LTTCOMM_OK
) {
2211 kernel_wait_quiescent(kernel_tracer_fd
);
2214 case LTTNG_DOMAIN_UST
:
2216 struct ltt_ust_channel
*uchan
;
2217 struct cds_lfht
*chan_ht
;
2219 chan_ht
= usess
->domain_global
.channels
;
2221 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2222 if (uchan
== NULL
) {
2223 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2227 ret
= channel_ust_disable(usess
, domain
, uchan
);
2228 if (ret
!= LTTCOMM_OK
) {
2233 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2234 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2235 case LTTNG_DOMAIN_UST_PID
:
2236 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2239 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2250 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2252 static int cmd_enable_channel(struct ltt_session
*session
,
2253 int domain
, struct lttng_channel
*attr
)
2256 struct ltt_ust_session
*usess
= session
->ust_session
;
2257 struct cds_lfht
*chan_ht
;
2259 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2262 case LTTNG_DOMAIN_KERNEL
:
2264 struct ltt_kernel_channel
*kchan
;
2266 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2267 session
->kernel_session
);
2268 if (kchan
== NULL
) {
2269 ret
= channel_kernel_create(session
->kernel_session
,
2270 attr
, kernel_poll_pipe
[1]);
2272 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2275 if (ret
!= LTTCOMM_OK
) {
2279 kernel_wait_quiescent(kernel_tracer_fd
);
2282 case LTTNG_DOMAIN_UST
:
2284 struct ltt_ust_channel
*uchan
;
2286 chan_ht
= usess
->domain_global
.channels
;
2288 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2289 if (uchan
== NULL
) {
2290 ret
= channel_ust_create(usess
, domain
, attr
);
2292 ret
= channel_ust_enable(usess
, domain
, uchan
);
2296 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2297 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2298 case LTTNG_DOMAIN_UST_PID
:
2299 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2302 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2311 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2313 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2314 char *channel_name
, char *event_name
)
2319 case LTTNG_DOMAIN_KERNEL
:
2321 struct ltt_kernel_channel
*kchan
;
2322 struct ltt_kernel_session
*ksess
;
2324 ksess
= session
->kernel_session
;
2326 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2327 if (kchan
== NULL
) {
2328 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2332 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2333 if (ret
!= LTTCOMM_OK
) {
2337 kernel_wait_quiescent(kernel_tracer_fd
);
2340 case LTTNG_DOMAIN_UST
:
2342 struct ltt_ust_channel
*uchan
;
2343 struct ltt_ust_session
*usess
;
2345 usess
= session
->ust_session
;
2347 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2349 if (uchan
== NULL
) {
2350 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2354 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2355 if (ret
!= LTTCOMM_OK
) {
2359 DBG3("Disable UST event %s in channel %s completed", event_name
,
2363 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2364 case LTTNG_DOMAIN_UST_PID
:
2365 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2367 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2378 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2380 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2386 case LTTNG_DOMAIN_KERNEL
:
2388 struct ltt_kernel_session
*ksess
;
2389 struct ltt_kernel_channel
*kchan
;
2391 ksess
= session
->kernel_session
;
2393 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2394 if (kchan
== NULL
) {
2395 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2399 ret
= event_kernel_disable_all(ksess
, kchan
);
2400 if (ret
!= LTTCOMM_OK
) {
2404 kernel_wait_quiescent(kernel_tracer_fd
);
2407 case LTTNG_DOMAIN_UST
:
2409 struct ltt_ust_session
*usess
;
2410 struct ltt_ust_channel
*uchan
;
2412 usess
= session
->ust_session
;
2414 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2416 if (uchan
== NULL
) {
2417 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2421 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2426 DBG3("Disable all UST events in channel %s completed", channel_name
);
2430 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2431 case LTTNG_DOMAIN_UST_PID
:
2432 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2434 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2445 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2447 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2448 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2453 case LTTNG_DOMAIN_KERNEL
:
2454 /* Add kernel context to kernel tracer */
2455 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2456 event_name
, channel_name
);
2457 if (ret
!= LTTCOMM_OK
) {
2461 case LTTNG_DOMAIN_UST
:
2463 struct ltt_ust_session
*usess
= session
->ust_session
;
2465 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2466 if (ret
!= LTTCOMM_OK
) {
2471 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2472 case LTTNG_DOMAIN_UST_PID
:
2473 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2475 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2486 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2488 * TODO: currently, both events and loglevels are kept within the same
2489 * namespace for UST global registry/app registery, so if an event
2490 * happen to have the same name as the loglevel (very unlikely though),
2491 * and an attempt is made to enable/disable both in the same session,
2492 * the first to be created will be the only one allowed to exist.
2494 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2495 char *channel_name
, struct lttng_event
*event
)
2498 struct lttng_channel
*attr
;
2499 struct ltt_ust_session
*usess
= session
->ust_session
;
2502 case LTTNG_DOMAIN_KERNEL
:
2504 struct ltt_kernel_channel
*kchan
;
2506 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2507 session
->kernel_session
);
2508 if (kchan
== NULL
) {
2509 attr
= channel_new_default_attr(domain
);
2511 ret
= LTTCOMM_FATAL
;
2514 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2516 /* This call will notify the kernel thread */
2517 ret
= channel_kernel_create(session
->kernel_session
,
2518 attr
, kernel_poll_pipe
[1]);
2519 if (ret
!= LTTCOMM_OK
) {
2526 /* Get the newly created kernel channel pointer */
2527 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2528 session
->kernel_session
);
2529 if (kchan
== NULL
) {
2530 /* This sould not happen... */
2531 ret
= LTTCOMM_FATAL
;
2535 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2537 if (ret
!= LTTCOMM_OK
) {
2541 kernel_wait_quiescent(kernel_tracer_fd
);
2544 case LTTNG_DOMAIN_UST
:
2546 struct lttng_channel
*attr
;
2547 struct ltt_ust_channel
*uchan
;
2549 /* Get channel from global UST domain */
2550 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2552 if (uchan
== NULL
) {
2553 /* Create default channel */
2554 attr
= channel_new_default_attr(domain
);
2556 ret
= LTTCOMM_FATAL
;
2559 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2560 attr
->name
[NAME_MAX
- 1] = '\0';
2562 ret
= channel_ust_create(usess
, domain
, attr
);
2563 if (ret
!= LTTCOMM_OK
) {
2569 /* Get the newly created channel reference back */
2570 uchan
= trace_ust_find_channel_by_name(
2571 usess
->domain_global
.channels
, channel_name
);
2572 if (uchan
== NULL
) {
2573 /* Something is really wrong */
2574 ret
= LTTCOMM_FATAL
;
2579 /* At this point, the session and channel exist on the tracer */
2581 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2582 if (ret
!= LTTCOMM_OK
) {
2587 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2588 case LTTNG_DOMAIN_UST_PID
:
2589 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2591 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2602 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2604 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2605 char *channel_name
, int event_type
)
2608 struct ltt_kernel_channel
*kchan
;
2611 case LTTNG_DOMAIN_KERNEL
:
2612 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2613 session
->kernel_session
);
2614 if (kchan
== NULL
) {
2615 /* This call will notify the kernel thread */
2616 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2617 kernel_poll_pipe
[1]);
2618 if (ret
!= LTTCOMM_OK
) {
2622 /* Get the newly created kernel channel pointer */
2623 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2624 session
->kernel_session
);
2625 if (kchan
== NULL
) {
2626 /* This sould not happen... */
2627 ret
= LTTCOMM_FATAL
;
2633 switch (event_type
) {
2634 case LTTNG_EVENT_SYSCALL
:
2635 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2636 kchan
, kernel_tracer_fd
);
2638 case LTTNG_EVENT_TRACEPOINT
:
2640 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2641 * events already registered to the channel.
2643 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2644 kchan
, kernel_tracer_fd
);
2646 case LTTNG_EVENT_ALL
:
2647 /* Enable syscalls and tracepoints */
2648 ret
= event_kernel_enable_all(session
->kernel_session
,
2649 kchan
, kernel_tracer_fd
);
2652 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2656 /* Manage return value */
2657 if (ret
!= LTTCOMM_OK
) {
2661 kernel_wait_quiescent(kernel_tracer_fd
);
2663 case LTTNG_DOMAIN_UST
:
2665 struct lttng_channel
*attr
;
2666 struct ltt_ust_channel
*uchan
;
2667 struct ltt_ust_session
*usess
= session
->ust_session
;
2669 /* Get channel from global UST domain */
2670 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2672 if (uchan
== NULL
) {
2673 /* Create default channel */
2674 attr
= channel_new_default_attr(domain
);
2676 ret
= LTTCOMM_FATAL
;
2679 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2680 attr
->name
[NAME_MAX
- 1] = '\0';
2682 /* Use the internal command enable channel */
2683 ret
= channel_ust_create(usess
, domain
, attr
);
2684 if (ret
!= LTTCOMM_OK
) {
2690 /* Get the newly created channel reference back */
2691 uchan
= trace_ust_find_channel_by_name(
2692 usess
->domain_global
.channels
, channel_name
);
2693 if (uchan
== NULL
) {
2694 /* Something is really wrong */
2695 ret
= LTTCOMM_FATAL
;
2700 /* At this point, the session and channel exist on the tracer */
2702 switch (event_type
) {
2703 case LTTNG_EVENT_ALL
:
2704 case LTTNG_EVENT_TRACEPOINT
:
2705 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2706 if (ret
!= LTTCOMM_OK
) {
2711 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2715 /* Manage return value */
2716 if (ret
!= LTTCOMM_OK
) {
2722 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2723 case LTTNG_DOMAIN_UST_PID
:
2724 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2726 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2737 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2739 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2742 ssize_t nb_events
= 0;
2745 case LTTNG_DOMAIN_KERNEL
:
2746 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2747 if (nb_events
< 0) {
2748 ret
= LTTCOMM_KERN_LIST_FAIL
;
2752 case LTTNG_DOMAIN_UST
:
2753 nb_events
= ust_app_list_events(events
);
2754 if (nb_events
< 0) {
2755 ret
= LTTCOMM_UST_LIST_FAIL
;
2760 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2767 /* Return negative value to differentiate return code */
2772 * Command LTTNG_START_TRACE processed by the client thread.
2774 static int cmd_start_trace(struct ltt_session
*session
)
2777 struct ltt_kernel_session
*ksession
;
2778 struct ltt_ust_session
*usess
;
2781 ksession
= session
->kernel_session
;
2782 usess
= session
->ust_session
;
2784 if (session
->enabled
) {
2785 ret
= LTTCOMM_UST_START_FAIL
;
2789 session
->enabled
= 1;
2791 /* Kernel tracing */
2792 if (ksession
!= NULL
) {
2793 struct ltt_kernel_channel
*kchan
;
2795 /* Open kernel metadata */
2796 if (ksession
->metadata
== NULL
) {
2797 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2799 ret
= LTTCOMM_KERN_META_FAIL
;
2804 /* Open kernel metadata stream */
2805 if (ksession
->metadata_stream_fd
== 0) {
2806 ret
= kernel_open_metadata_stream(ksession
);
2808 ERR("Kernel create metadata stream failed");
2809 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2814 /* For each channel */
2815 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2816 if (kchan
->stream_count
== 0) {
2817 ret
= kernel_open_channel_stream(kchan
);
2819 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2822 /* Update the stream global counter */
2823 ksession
->stream_count_global
+= ret
;
2827 /* Setup kernel consumer socket and send fds to it */
2828 ret
= init_kernel_tracing(ksession
);
2830 ret
= LTTCOMM_KERN_START_FAIL
;
2834 /* This start the kernel tracing */
2835 ret
= kernel_start_session(ksession
);
2837 ret
= LTTCOMM_KERN_START_FAIL
;
2841 /* Quiescent wait after starting trace */
2842 kernel_wait_quiescent(kernel_tracer_fd
);
2845 /* Flag session that trace should start automatically */
2847 usess
->start_trace
= 1;
2849 ret
= ust_app_start_trace_all(usess
);
2851 ret
= LTTCOMM_UST_START_FAIL
;
2863 * Command LTTNG_STOP_TRACE processed by the client thread.
2865 static int cmd_stop_trace(struct ltt_session
*session
)
2868 struct ltt_kernel_channel
*kchan
;
2869 struct ltt_kernel_session
*ksession
;
2870 struct ltt_ust_session
*usess
;
2873 ksession
= session
->kernel_session
;
2874 usess
= session
->ust_session
;
2876 if (!session
->enabled
) {
2877 ret
= LTTCOMM_UST_START_FAIL
;
2881 session
->enabled
= 0;
2884 if (ksession
!= NULL
) {
2885 DBG("Stop kernel tracing");
2887 /* Flush all buffers before stopping */
2888 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2890 ERR("Kernel metadata flush failed");
2893 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2894 ret
= kernel_flush_buffer(kchan
);
2896 ERR("Kernel flush buffer error");
2900 ret
= kernel_stop_session(ksession
);
2902 ret
= LTTCOMM_KERN_STOP_FAIL
;
2906 kernel_wait_quiescent(kernel_tracer_fd
);
2910 usess
->start_trace
= 0;
2912 ret
= ust_app_stop_trace_all(usess
);
2914 ret
= LTTCOMM_UST_START_FAIL
;
2926 * Command LTTNG_CREATE_SESSION processed by the client thread.
2928 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2932 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2933 if (ret
!= LTTCOMM_OK
) {
2944 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2946 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2950 /* Clean kernel session teardown */
2951 teardown_kernel_session(session
);
2952 /* UST session teardown */
2953 teardown_ust_session(session
);
2956 * Must notify the kernel thread here to update it's poll setin order
2957 * to remove the channel(s)' fd just destroyed.
2959 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2961 perror("write kernel poll pipe");
2964 ret
= session_destroy(session
);
2970 * Command LTTNG_CALIBRATE processed by the client thread.
2972 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2977 case LTTNG_DOMAIN_KERNEL
:
2979 struct lttng_kernel_calibrate kcalibrate
;
2981 kcalibrate
.type
= calibrate
->type
;
2982 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2984 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2990 /* TODO: Userspace tracing */
2991 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3002 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3004 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3010 case LTTNG_DOMAIN_KERNEL
:
3011 /* Can't register a consumer if there is already one */
3012 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3013 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3017 sock
= lttcomm_connect_unix_sock(sock_path
);
3019 ret
= LTTCOMM_CONNECT_FAIL
;
3023 session
->kernel_session
->consumer_fd
= sock
;
3026 /* TODO: Userspace tracing */
3027 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3038 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3040 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3041 struct lttng_domain
**domains
)
3046 if (session
->kernel_session
!= NULL
) {
3047 DBG3("Listing domains found kernel domain");
3051 if (session
->ust_session
!= NULL
) {
3052 DBG3("Listing domains found UST global domain");
3056 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3057 if (*domains
== NULL
) {
3058 ret
= -LTTCOMM_FATAL
;
3062 if (session
->kernel_session
!= NULL
) {
3063 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3067 if (session
->ust_session
!= NULL
) {
3068 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3079 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3081 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3082 struct lttng_channel
**channels
)
3085 ssize_t nb_chan
= 0;
3088 case LTTNG_DOMAIN_KERNEL
:
3089 if (session
->kernel_session
!= NULL
) {
3090 nb_chan
= session
->kernel_session
->channel_count
;
3092 DBG3("Number of kernel channels %zd", nb_chan
);
3094 case LTTNG_DOMAIN_UST
:
3095 if (session
->ust_session
!= NULL
) {
3096 nb_chan
= hashtable_get_count(
3097 session
->ust_session
->domain_global
.channels
);
3099 DBG3("Number of UST global channels %zd", nb_chan
);
3103 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3108 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3109 if (*channels
== NULL
) {
3110 ret
= -LTTCOMM_FATAL
;
3114 list_lttng_channels(domain
, session
, *channels
);
3126 * Command LTTNG_LIST_EVENTS processed by the client thread.
3128 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3129 char *channel_name
, struct lttng_event
**events
)
3132 ssize_t nb_event
= 0;
3135 case LTTNG_DOMAIN_KERNEL
:
3136 if (session
->kernel_session
!= NULL
) {
3137 nb_event
= list_lttng_kernel_events(channel_name
,
3138 session
->kernel_session
, events
);
3141 case LTTNG_DOMAIN_UST
:
3143 if (session
->ust_session
!= NULL
) {
3144 nb_event
= list_lttng_ust_global_events(channel_name
,
3145 &session
->ust_session
->domain_global
, events
);
3150 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3161 * Process the command requested by the lttng client within the command
3162 * context structure. This function make sure that the return structure (llm)
3163 * is set and ready for transmission before returning.
3165 * Return any error encountered or 0 for success.
3167 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3169 int ret
= LTTCOMM_OK
;
3170 int need_tracing_session
= 1;
3172 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3174 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3175 ret
= LTTCOMM_KERN_NA
;
3180 * Check for command that don't needs to allocate a returned payload. We do
3181 * this here so we don't have to make the call for no payload at each
3184 switch(cmd_ctx
->lsm
->cmd_type
) {
3185 case LTTNG_LIST_SESSIONS
:
3186 case LTTNG_LIST_TRACEPOINTS
:
3187 case LTTNG_LIST_DOMAINS
:
3188 case LTTNG_LIST_CHANNELS
:
3189 case LTTNG_LIST_EVENTS
:
3192 /* Setup lttng message with no payload */
3193 ret
= setup_lttng_msg(cmd_ctx
, 0);
3195 /* This label does not try to unlock the session */
3196 goto init_setup_error
;
3200 /* Commands that DO NOT need a session. */
3201 switch (cmd_ctx
->lsm
->cmd_type
) {
3202 case LTTNG_CALIBRATE
:
3203 case LTTNG_CREATE_SESSION
:
3204 case LTTNG_LIST_SESSIONS
:
3205 case LTTNG_LIST_TRACEPOINTS
:
3206 need_tracing_session
= 0;
3209 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3210 session_lock_list();
3211 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3212 session_unlock_list();
3213 if (cmd_ctx
->session
== NULL
) {
3214 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3215 ret
= LTTCOMM_SESS_NOT_FOUND
;
3217 /* If no session name specified */
3218 ret
= LTTCOMM_SELECT_SESS
;
3222 /* Acquire lock for the session */
3223 session_lock(cmd_ctx
->session
);
3229 * Check domain type for specific "pre-action".
3231 switch (cmd_ctx
->lsm
->domain
.type
) {
3232 case LTTNG_DOMAIN_KERNEL
:
3233 /* Kernel tracer check */
3234 if (kernel_tracer_fd
== 0) {
3235 /* Basically, load kernel tracer modules */
3236 init_kernel_tracer();
3237 if (kernel_tracer_fd
== 0) {
3238 ret
= LTTCOMM_KERN_NA
;
3243 /* Need a session for kernel command */
3244 if (need_tracing_session
) {
3245 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3246 ret
= create_kernel_session(cmd_ctx
->session
);
3248 ret
= LTTCOMM_KERN_SESS_FAIL
;
3253 /* Start the kernel consumer daemon */
3254 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3255 if (kconsumer_data
.pid
== 0 &&
3256 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3257 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3258 ret
= start_consumerd(&kconsumer_data
);
3260 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3264 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3268 case LTTNG_DOMAIN_UST
:
3270 if (need_tracing_session
) {
3271 if (cmd_ctx
->session
->ust_session
== NULL
) {
3272 ret
= create_ust_session(cmd_ctx
->session
,
3273 &cmd_ctx
->lsm
->domain
);
3274 if (ret
!= LTTCOMM_OK
) {
3278 /* Start the UST consumer daemons */
3280 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3281 if (consumerd64_bin
[0] != '\0' &&
3282 ustconsumer64_data
.pid
== 0 &&
3283 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3284 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3285 ret
= start_consumerd(&ustconsumer64_data
);
3287 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3288 ust_consumerd64_fd
= -EINVAL
;
3292 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3294 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3297 if (consumerd32_bin
[0] != '\0' &&
3298 ustconsumer32_data
.pid
== 0 &&
3299 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3300 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3301 ret
= start_consumerd(&ustconsumer32_data
);
3303 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3304 ust_consumerd32_fd
= -EINVAL
;
3307 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3309 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3318 /* Process by command type */
3319 switch (cmd_ctx
->lsm
->cmd_type
) {
3320 case LTTNG_ADD_CONTEXT
:
3322 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3323 cmd_ctx
->lsm
->u
.context
.channel_name
,
3324 cmd_ctx
->lsm
->u
.context
.event_name
,
3325 &cmd_ctx
->lsm
->u
.context
.ctx
);
3328 case LTTNG_DISABLE_CHANNEL
:
3330 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3331 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3334 case LTTNG_DISABLE_EVENT
:
3336 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3337 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3338 cmd_ctx
->lsm
->u
.disable
.name
);
3342 case LTTNG_DISABLE_ALL_EVENT
:
3344 DBG("Disabling all events");
3346 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3347 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3350 case LTTNG_ENABLE_CHANNEL
:
3352 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3353 &cmd_ctx
->lsm
->u
.channel
.chan
);
3356 case LTTNG_ENABLE_EVENT
:
3358 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3359 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3360 &cmd_ctx
->lsm
->u
.enable
.event
);
3363 case LTTNG_ENABLE_ALL_EVENT
:
3365 DBG("Enabling all events");
3367 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3368 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3369 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3372 case LTTNG_LIST_TRACEPOINTS
:
3374 struct lttng_event
*events
;
3377 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3378 if (nb_events
< 0) {
3384 * Setup lttng message with payload size set to the event list size in
3385 * bytes and then copy list into the llm payload.
3387 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3393 /* Copy event list into message payload */
3394 memcpy(cmd_ctx
->llm
->payload
, events
,
3395 sizeof(struct lttng_event
) * nb_events
);
3402 case LTTNG_START_TRACE
:
3404 ret
= cmd_start_trace(cmd_ctx
->session
);
3407 case LTTNG_STOP_TRACE
:
3409 ret
= cmd_stop_trace(cmd_ctx
->session
);
3412 case LTTNG_CREATE_SESSION
:
3414 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3415 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3418 case LTTNG_DESTROY_SESSION
:
3420 ret
= cmd_destroy_session(cmd_ctx
->session
,
3421 cmd_ctx
->lsm
->session
.name
);
3424 case LTTNG_LIST_DOMAINS
:
3427 struct lttng_domain
*domains
;
3429 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3435 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3440 /* Copy event list into message payload */
3441 memcpy(cmd_ctx
->llm
->payload
, domains
,
3442 nb_dom
* sizeof(struct lttng_domain
));
3449 case LTTNG_LIST_CHANNELS
:
3452 struct lttng_channel
*channels
;
3454 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3455 cmd_ctx
->session
, &channels
);
3461 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3466 /* Copy event list into message payload */
3467 memcpy(cmd_ctx
->llm
->payload
, channels
,
3468 nb_chan
* sizeof(struct lttng_channel
));
3475 case LTTNG_LIST_EVENTS
:
3478 struct lttng_event
*events
= NULL
;
3480 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3481 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3487 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3492 /* Copy event list into message payload */
3493 memcpy(cmd_ctx
->llm
->payload
, events
,
3494 nb_event
* sizeof(struct lttng_event
));
3501 case LTTNG_LIST_SESSIONS
:
3503 session_lock_list();
3505 if (session_list_ptr
->count
== 0) {
3506 ret
= LTTCOMM_NO_SESSION
;
3507 session_unlock_list();
3511 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3512 session_list_ptr
->count
);
3514 session_unlock_list();
3518 /* Filled the session array */
3519 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3521 session_unlock_list();
3526 case LTTNG_CALIBRATE
:
3528 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3529 &cmd_ctx
->lsm
->u
.calibrate
);
3532 case LTTNG_REGISTER_CONSUMER
:
3534 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3535 cmd_ctx
->lsm
->u
.reg
.path
);
3544 if (cmd_ctx
->llm
== NULL
) {
3545 DBG("Missing llm structure. Allocating one.");
3546 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3550 /* Set return code */
3551 cmd_ctx
->llm
->ret_code
= ret
;
3553 if (cmd_ctx
->session
) {
3554 session_unlock(cmd_ctx
->session
);
3561 * This thread manage all clients request using the unix client socket for
3564 static void *thread_manage_clients(void *data
)
3566 int sock
= 0, ret
, i
, pollfd
;
3567 uint32_t revents
, nb_fd
;
3568 struct command_ctx
*cmd_ctx
= NULL
;
3569 struct lttng_poll_event events
;
3571 DBG("[thread] Manage client started");
3573 rcu_register_thread();
3575 ret
= lttcomm_listen_unix_sock(client_sock
);
3581 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3582 * more will be added to this poll set.
3584 ret
= create_thread_poll_set(&events
, 2);
3589 /* Add the application registration socket */
3590 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3596 * Notify parent pid that we are ready to accept command for client side.
3598 if (opt_sig_parent
) {
3599 kill(ppid
, SIGCHLD
);
3603 DBG("Accepting client command ...");
3605 nb_fd
= LTTNG_POLL_GETNB(&events
);
3607 /* Inifinite blocking call, waiting for transmission */
3608 ret
= lttng_poll_wait(&events
, -1);
3613 for (i
= 0; i
< nb_fd
; i
++) {
3614 /* Fetch once the poll data */
3615 revents
= LTTNG_POLL_GETEV(&events
, i
);
3616 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3618 /* Thread quit pipe has been closed. Killing thread. */
3619 ret
= check_thread_quit_pipe(pollfd
, revents
);
3624 /* Event on the registration socket */
3625 if (pollfd
== client_sock
) {
3626 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3627 ERR("Client socket poll error");
3633 DBG("Wait for client response");
3635 sock
= lttcomm_accept_unix_sock(client_sock
);
3640 /* Set socket option for credentials retrieval */
3641 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3646 /* Allocate context command to process the client request */
3647 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3648 if (cmd_ctx
== NULL
) {
3649 perror("zmalloc cmd_ctx");
3653 /* Allocate data buffer for reception */
3654 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3655 if (cmd_ctx
->lsm
== NULL
) {
3656 perror("zmalloc cmd_ctx->lsm");
3660 cmd_ctx
->llm
= NULL
;
3661 cmd_ctx
->session
= NULL
;
3664 * Data is received from the lttng client. The struct
3665 * lttcomm_session_msg (lsm) contains the command and data request of
3668 DBG("Receiving data from client ...");
3669 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3670 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3672 DBG("Nothing recv() from client... continuing");
3678 // TODO: Validate cmd_ctx including sanity check for
3679 // security purpose.
3681 rcu_thread_online();
3683 * This function dispatch the work to the kernel or userspace tracer
3684 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3685 * informations for the client. The command context struct contains
3686 * everything this function may needs.
3688 ret
= process_client_msg(cmd_ctx
);
3689 rcu_thread_offline();
3692 * TODO: Inform client somehow of the fatal error. At
3693 * this point, ret < 0 means that a zmalloc failed
3694 * (ENOMEM). Error detected but still accept command.
3696 clean_command_ctx(&cmd_ctx
);
3700 DBG("Sending response (size: %d, retcode: %s)",
3701 cmd_ctx
->lttng_msg_size
,
3702 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3703 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3705 ERR("Failed to send data back to client");
3708 /* End of transmission */
3711 clean_command_ctx(&cmd_ctx
);
3715 DBG("Client thread dying");
3716 unlink(client_unix_sock_path
);
3720 lttng_poll_clean(&events
);
3721 clean_command_ctx(&cmd_ctx
);
3723 rcu_unregister_thread();
3729 * usage function on stderr
3731 static void usage(void)
3733 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3734 fprintf(stderr
, " -h, --help Display this usage.\n");
3735 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3736 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3737 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3738 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3739 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3740 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3741 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3742 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3743 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3744 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3745 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3746 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3747 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3748 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3749 fprintf(stderr
, " -V, --version Show version number.\n");
3750 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3751 fprintf(stderr
, " -q, --quiet No output at all.\n");
3752 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3753 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3754 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3758 * daemon argument parsing
3760 static int parse_args(int argc
, char **argv
)
3764 static struct option long_options
[] = {
3765 { "client-sock", 1, 0, 'c' },
3766 { "apps-sock", 1, 0, 'a' },
3767 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3768 { "kconsumerd-err-sock", 1, 0, 'E' },
3769 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3770 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3771 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3772 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3773 { "consumerd32-path", 1, 0, 'u' },
3774 { "consumerd32-libdir", 1, 0, 'U' },
3775 { "consumerd64-path", 1, 0, 't' },
3776 { "consumerd64-libdir", 1, 0, 'T' },
3777 { "daemonize", 0, 0, 'd' },
3778 { "sig-parent", 0, 0, 'S' },
3779 { "help", 0, 0, 'h' },
3780 { "group", 1, 0, 'g' },
3781 { "version", 0, 0, 'V' },
3782 { "quiet", 0, 0, 'q' },
3783 { "verbose", 0, 0, 'v' },
3784 { "verbose-consumer", 0, 0, 'Z' },
3785 { "no-kernel", 0, 0, 'N' },
3790 int option_index
= 0;
3791 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3792 long_options
, &option_index
);
3799 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3801 fprintf(stderr
, " with arg %s\n", optarg
);
3805 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3808 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3814 opt_tracing_group
= optarg
;
3820 fprintf(stdout
, "%s\n", VERSION
);
3826 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3829 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3832 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3835 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3838 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3841 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3850 /* Verbose level can increase using multiple -v */
3854 opt_verbose_consumer
+= 1;
3857 consumerd32_bin
= optarg
;
3860 consumerd32_libdir
= optarg
;
3863 consumerd64_bin
= optarg
;
3866 consumerd64_libdir
= optarg
;
3869 /* Unknown option or other error.
3870 * Error is printed by getopt, just return */
3879 * Creates the two needed socket by the daemon.
3880 * apps_sock - The communication socket for all UST apps.
3881 * client_sock - The communication of the cli tool (lttng).
3883 static int init_daemon_socket(void)
3888 old_umask
= umask(0);
3890 /* Create client tool unix socket */
3891 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3892 if (client_sock
< 0) {
3893 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3898 /* File permission MUST be 660 */
3899 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3901 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3906 /* Create the application unix socket */
3907 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3908 if (apps_sock
< 0) {
3909 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3914 /* File permission MUST be 666 */
3915 ret
= chmod(apps_unix_sock_path
,
3916 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3918 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3929 * Check if the global socket is available, and if a daemon is answering at the
3930 * other side. If yes, error is returned.
3932 static int check_existing_daemon(void)
3934 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3935 access(apps_unix_sock_path
, F_OK
) < 0) {
3939 /* Is there anybody out there ? */
3940 if (lttng_session_daemon_alive()) {
3948 * Set the tracing group gid onto the client socket.
3950 * Race window between mkdir and chown is OK because we are going from more
3951 * permissive (root.root) to les permissive (root.tracing).
3953 static int set_permissions(char *rundir
)
3958 gid
= allowed_group();
3960 WARN("No tracing group detected");
3965 /* Set lttng run dir */
3966 ret
= chown(rundir
, 0, gid
);
3968 ERR("Unable to set group on %s", rundir
);
3972 /* lttng client socket path */
3973 ret
= chown(client_unix_sock_path
, 0, gid
);
3975 ERR("Unable to set group on %s", client_unix_sock_path
);
3979 /* kconsumer error socket path */
3980 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3982 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3986 /* 64-bit ustconsumer error socket path */
3987 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3989 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3993 /* 32-bit ustconsumer compat32 error socket path */
3994 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3996 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4000 DBG("All permissions are set");
4007 * Create the pipe used to wake up the kernel thread.
4009 static int create_kernel_poll_pipe(void)
4011 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4015 * Create the application command pipe to wake thread_manage_apps.
4017 static int create_apps_cmd_pipe(void)
4019 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4023 * Create the lttng run directory needed for all global sockets and pipe.
4025 static int create_lttng_rundir(const char *rundir
)
4029 DBG3("Creating LTTng run directory: %s", rundir
);
4031 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4033 if (errno
!= EEXIST
) {
4034 ERR("Unable to create %s", rundir
);
4046 * Setup sockets and directory needed by the kconsumerd communication with the
4049 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4053 char path
[PATH_MAX
];
4055 switch (consumer_data
->type
) {
4056 case LTTNG_CONSUMER_KERNEL
:
4057 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4059 case LTTNG_CONSUMER64_UST
:
4060 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4062 case LTTNG_CONSUMER32_UST
:
4063 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4066 ERR("Consumer type unknown");
4071 DBG2("Creating consumer directory: %s", path
);
4073 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4075 if (errno
!= EEXIST
) {
4076 ERR("Failed to create %s", path
);
4082 /* Create the kconsumerd error unix socket */
4083 consumer_data
->err_sock
=
4084 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4085 if (consumer_data
->err_sock
< 0) {
4086 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4091 /* File permission MUST be 660 */
4092 ret
= chmod(consumer_data
->err_unix_sock_path
,
4093 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4095 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4105 * Signal handler for the daemon
4107 * Simply stop all worker threads, leaving main() return gracefully after
4108 * joining all threads and calling cleanup().
4110 static void sighandler(int sig
)
4114 DBG("SIGPIPE catched");
4117 DBG("SIGINT catched");
4121 DBG("SIGTERM catched");
4130 * Setup signal handler for :
4131 * SIGINT, SIGTERM, SIGPIPE
4133 static int set_signal_handler(void)
4136 struct sigaction sa
;
4139 if ((ret
= sigemptyset(&sigset
)) < 0) {
4140 perror("sigemptyset");
4144 sa
.sa_handler
= sighandler
;
4145 sa
.sa_mask
= sigset
;
4147 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4148 perror("sigaction");
4152 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4153 perror("sigaction");
4157 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4158 perror("sigaction");
4162 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4168 * Set open files limit to unlimited. This daemon can open a large number of
4169 * file descriptors in order to consumer multiple kernel traces.
4171 static void set_ulimit(void)
4176 /* The kernel does not allowed an infinite limit for open files */
4177 lim
.rlim_cur
= 65535;
4178 lim
.rlim_max
= 65535;
4180 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4182 perror("failed to set open files limit");
4189 int main(int argc
, char **argv
)
4193 const char *home_path
;
4195 rcu_register_thread();
4197 /* Create thread quit pipe */
4198 if ((ret
= init_thread_quit_pipe()) < 0) {
4202 setup_consumerd_path();
4204 /* Parse arguments */
4206 if ((ret
= parse_args(argc
, argv
) < 0)) {
4219 /* Check if daemon is UID = 0 */
4220 is_root
= !getuid();
4223 rundir
= strdup(LTTNG_RUNDIR
);
4225 /* Create global run dir with root access */
4226 ret
= create_lttng_rundir(rundir
);
4231 if (strlen(apps_unix_sock_path
) == 0) {
4232 snprintf(apps_unix_sock_path
, PATH_MAX
,
4233 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4236 if (strlen(client_unix_sock_path
) == 0) {
4237 snprintf(client_unix_sock_path
, PATH_MAX
,
4238 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4241 /* Set global SHM for ust */
4242 if (strlen(wait_shm_path
) == 0) {
4243 snprintf(wait_shm_path
, PATH_MAX
,
4244 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4247 /* Setup kernel consumerd path */
4248 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4249 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4250 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4251 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4253 DBG2("Kernel consumer err path: %s",
4254 kconsumer_data
.err_unix_sock_path
);
4255 DBG2("Kernel consumer cmd path: %s",
4256 kconsumer_data
.cmd_unix_sock_path
);
4258 home_path
= get_home_dir();
4259 if (home_path
== NULL
) {
4260 /* TODO: Add --socket PATH option */
4261 ERR("Can't get HOME directory for sockets creation.");
4267 * Create rundir from home path. This will create something like
4270 ret
= asprintf(&rundir
, LTTNG_HOME_RUNDIR
, home_path
);
4276 ret
= create_lttng_rundir(rundir
);
4281 if (strlen(apps_unix_sock_path
) == 0) {
4282 snprintf(apps_unix_sock_path
, PATH_MAX
,
4283 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4286 /* Set the cli tool unix socket path */
4287 if (strlen(client_unix_sock_path
) == 0) {
4288 snprintf(client_unix_sock_path
, PATH_MAX
,
4289 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4292 /* Set global SHM for ust */
4293 if (strlen(wait_shm_path
) == 0) {
4294 snprintf(wait_shm_path
, PATH_MAX
,
4295 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4299 DBG("Client socket path %s", client_unix_sock_path
);
4300 DBG("Application socket path %s", apps_unix_sock_path
);
4301 DBG("LTTng run directory path: %s", rundir
);
4303 /* 32 bits consumerd path setup */
4304 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4305 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4306 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4307 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4309 DBG2("UST consumer 32 bits err path: %s",
4310 ustconsumer32_data
.err_unix_sock_path
);
4311 DBG2("UST consumer 32 bits cmd path: %s",
4312 ustconsumer32_data
.cmd_unix_sock_path
);
4314 /* 64 bits consumerd path setup */
4315 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4316 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4317 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4318 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4320 DBG2("UST consumer 64 bits err path: %s",
4321 ustconsumer64_data
.err_unix_sock_path
);
4322 DBG2("UST consumer 64 bits cmd path: %s",
4323 ustconsumer64_data
.cmd_unix_sock_path
);
4326 * See if daemon already exist.
4328 if ((ret
= check_existing_daemon()) < 0) {
4329 ERR("Already running daemon.\n");
4331 * We do not goto exit because we must not cleanup()
4332 * because a daemon is already running.
4337 /* After this point, we can safely call cleanup() with "goto exit" */
4340 * These actions must be executed as root. We do that *after* setting up
4341 * the sockets path because we MUST make the check for another daemon using
4342 * those paths *before* trying to set the kernel consumer sockets and init
4346 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4351 /* Setup kernel tracer */
4352 if (!opt_no_kernel
) {
4353 init_kernel_tracer();
4356 /* Set ulimit for open files */
4360 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4365 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4370 if ((ret
= set_signal_handler()) < 0) {
4374 /* Setup the needed unix socket */
4375 if ((ret
= init_daemon_socket()) < 0) {
4379 /* Set credentials to socket */
4380 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4384 /* Get parent pid if -S, --sig-parent is specified. */
4385 if (opt_sig_parent
) {
4389 /* Setup the kernel pipe for waking up the kernel thread */
4390 if ((ret
= create_kernel_poll_pipe()) < 0) {
4394 /* Setup the thread apps communication pipe. */
4395 if ((ret
= create_apps_cmd_pipe()) < 0) {
4399 /* Init UST command queue. */
4400 cds_wfq_init(&ust_cmd_queue
.queue
);
4402 /* Init UST app hash table */
4406 * Get session list pointer. This pointer MUST NOT be free(). This list is
4407 * statically declared in session.c
4409 session_list_ptr
= session_get_list();
4411 /* Set up max poll set size */
4412 lttng_poll_set_max_size();
4414 /* Create thread to manage the client socket */
4415 ret
= pthread_create(&client_thread
, NULL
,
4416 thread_manage_clients
, (void *) NULL
);
4418 perror("pthread_create clients");
4422 /* Create thread to dispatch registration */
4423 ret
= pthread_create(&dispatch_thread
, NULL
,
4424 thread_dispatch_ust_registration
, (void *) NULL
);
4426 perror("pthread_create dispatch");
4430 /* Create thread to manage application registration. */
4431 ret
= pthread_create(®_apps_thread
, NULL
,
4432 thread_registration_apps
, (void *) NULL
);
4434 perror("pthread_create registration");
4438 /* Create thread to manage application socket */
4439 ret
= pthread_create(&apps_thread
, NULL
,
4440 thread_manage_apps
, (void *) NULL
);
4442 perror("pthread_create apps");
4446 /* Create kernel thread to manage kernel event */
4447 ret
= pthread_create(&kernel_thread
, NULL
,
4448 thread_manage_kernel
, (void *) NULL
);
4450 perror("pthread_create kernel");
4454 ret
= pthread_join(kernel_thread
, &status
);
4456 perror("pthread_join");
4457 goto error
; /* join error, exit without cleanup */
4461 ret
= pthread_join(apps_thread
, &status
);
4463 perror("pthread_join");
4464 goto error
; /* join error, exit without cleanup */
4468 ret
= pthread_join(reg_apps_thread
, &status
);
4470 perror("pthread_join");
4471 goto error
; /* join error, exit without cleanup */
4475 ret
= pthread_join(dispatch_thread
, &status
);
4477 perror("pthread_join");
4478 goto error
; /* join error, exit without cleanup */
4482 ret
= pthread_join(client_thread
, &status
);
4484 perror("pthread_join");
4485 goto error
; /* join error, exit without cleanup */
4488 ret
= join_consumer_thread(&kconsumer_data
);
4490 perror("join_consumer");
4491 goto error
; /* join error, exit without cleanup */
4497 * cleanup() is called when no other thread is running.
4499 rcu_thread_online();
4501 rcu_thread_offline();
4502 rcu_unregister_thread();