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 is_root
; /* Set to 1 if the daemon is running as root */
96 static pid_t ppid
; /* Parent PID for --sig-parent option */
98 /* Consumer daemon specific control data */
99 static struct consumer_data kconsumer_data
= {
100 .type
= LTTNG_CONSUMER_KERNEL
,
101 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
102 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
104 static struct consumer_data ustconsumer64_data
= {
105 .type
= LTTNG_CONSUMER64_UST
,
106 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
107 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
109 static struct consumer_data ustconsumer32_data
= {
110 .type
= LTTNG_CONSUMER32_UST
,
111 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
112 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
115 static int dispatch_thread_exit
;
117 /* Global application Unix socket path */
118 static char apps_unix_sock_path
[PATH_MAX
];
119 /* Global client Unix socket path */
120 static char client_unix_sock_path
[PATH_MAX
];
121 /* global wait shm path for UST */
122 static char wait_shm_path
[PATH_MAX
];
124 /* Sockets and FDs */
125 static int client_sock
;
126 static int apps_sock
;
127 static int kernel_tracer_fd
;
128 static int kernel_poll_pipe
[2];
131 * Quit pipe for all threads. This permits a single cancellation point
132 * for all threads when receiving an event on the pipe.
134 static int thread_quit_pipe
[2];
137 * This pipe is used to inform the thread managing application communication
138 * that a command is queued and ready to be processed.
140 static int apps_cmd_pipe
[2];
142 /* Pthread, Mutexes and Semaphores */
143 static pthread_t apps_thread
;
144 static pthread_t reg_apps_thread
;
145 static pthread_t client_thread
;
146 static pthread_t kernel_thread
;
147 static pthread_t dispatch_thread
;
151 * UST registration command queue. This queue is tied with a futex and uses a N
152 * wakers / 1 waiter implemented and detailed in futex.c/.h
154 * The thread_manage_apps and thread_dispatch_ust_registration interact with
155 * this queue and the wait/wake scheme.
157 static struct ust_cmd_queue ust_cmd_queue
;
160 * Pointer initialized before thread creation.
162 * This points to the tracing session list containing the session count and a
163 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
164 * MUST NOT be taken if you call a public function in session.c.
166 * The lock is nested inside the structure: session_list_ptr->lock. Please use
167 * session_lock_list and session_unlock_list for lock acquisition.
169 static struct ltt_session_list
*session_list_ptr
;
171 int ust_consumerd64_fd
= -1;
172 int ust_consumerd32_fd
= -1;
174 static const char *consumerd32_bin
=
175 __stringify(CONFIG_CONSUMERD32_BIN
);
176 static const char *consumerd64_bin
=
177 __stringify(CONFIG_CONSUMERD64_BIN
);
178 static const char *consumerd32_libdir
=
179 __stringify(CONFIG_CONSUMERD32_LIBDIR
);
180 static const char *consumerd64_libdir
=
181 __stringify(CONFIG_CONSUMERD64_LIBDIR
);
184 void setup_consumerd_path(void)
186 const char *bin
, *libdir
;
189 * Allow INSTALL_BIN_PATH to be used as a target path for the
190 * native architecture size consumer if CONFIG_CONSUMER*_PATH
191 * has not been defined.
193 #if (CAA_BITS_PER_LONG == 32)
194 if (!consumerd32_bin
[0]) {
195 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
197 if (!consumerd32_libdir
[0]) {
198 consumerd32_libdir
= INSTALL_LIB_PATH
;
200 #elif (CAA_BITS_PER_LONG == 64)
201 if (!consumerd64_bin
[0]) {
202 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
204 if (!consumerd64_libdir
[0]) {
205 consumerd64_libdir
= INSTALL_LIB_PATH
;
208 #error "Unknown bitness"
212 * runtime env. var. overrides the build default.
214 bin
= getenv("LTTNG_CONSUMERD32_BIN");
216 consumerd32_bin
= bin
;
218 bin
= getenv("LTTNG_CONSUMERD64_BIN");
220 consumerd64_bin
= bin
;
222 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
224 consumerd32_libdir
= libdir
;
226 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
228 consumerd64_libdir
= libdir
;
233 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
235 static int create_thread_poll_set(struct lttng_poll_event
*events
,
240 if (events
== NULL
|| size
== 0) {
245 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
251 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
263 * Check if the thread quit pipe was triggered.
265 * Return 1 if it was triggered else 0;
267 static int check_thread_quit_pipe(int fd
, uint32_t events
)
269 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
277 * Remove modules in reverse load order.
279 static int modprobe_remove_kernel_modules(void)
284 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
285 ret
= snprintf(modprobe
, sizeof(modprobe
),
286 "/sbin/modprobe -r -q %s",
287 kernel_modules_list
[i
].name
);
289 perror("snprintf modprobe -r");
292 modprobe
[sizeof(modprobe
) - 1] = '\0';
293 ret
= system(modprobe
);
295 ERR("Unable to launch modprobe -r for module %s",
296 kernel_modules_list
[i
].name
);
297 } else if (kernel_modules_list
[i
].required
298 && WEXITSTATUS(ret
) != 0) {
299 ERR("Unable to remove module %s",
300 kernel_modules_list
[i
].name
);
302 DBG("Modprobe removal successful %s",
303 kernel_modules_list
[i
].name
);
312 * Return group ID of the tracing group or -1 if not found.
314 static gid_t
allowed_group(void)
318 if (opt_tracing_group
) {
319 grp
= getgrnam(opt_tracing_group
);
321 grp
= getgrnam(default_tracing_group
);
331 * Init thread quit pipe.
333 * Return -1 on error or 0 if all pipes are created.
335 static int init_thread_quit_pipe(void)
339 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
341 perror("thread quit pipe");
350 * Complete teardown of a kernel session. This free all data structure related
351 * to a kernel session and update counter.
353 static void teardown_kernel_session(struct ltt_session
*session
)
355 if (!session
->kernel_session
) {
356 DBG3("No kernel session when tearingdown session");
360 DBG("Tearing down kernel session");
363 * If a custom kernel consumer was registered, close the socket before
364 * tearing down the complete kernel session structure
366 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
367 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
370 trace_kernel_destroy_session(session
->kernel_session
);
374 * Complete teardown of all UST sessions. This will free everything on his path
375 * and destroy the core essence of all ust sessions :)
377 static void teardown_ust_session(struct ltt_session
*session
)
381 if (!session
->ust_session
) {
382 DBG3("No UST session when tearingdown session");
386 DBG("Tearing down UST session(s)");
388 ret
= ust_app_destroy_trace_all(session
->ust_session
);
390 ERR("Error in ust_app_destroy_trace_all");
393 trace_ust_destroy_session(session
->ust_session
);
397 * Stop all threads by closing the thread quit pipe.
399 static void stop_threads(void)
403 /* Stopping all threads */
404 DBG("Terminating all threads");
405 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
407 ERR("write error on thread quit pipe");
410 /* Dispatch thread */
411 dispatch_thread_exit
= 1;
412 futex_nto1_wake(&ust_cmd_queue
.futex
);
418 static void cleanup(void)
422 struct ltt_session
*sess
, *stmp
;
427 DBG("Removing %s directory", LTTNG_RUNDIR
);
428 ret
= asprintf(&cmd
, "rm -rf " LTTNG_RUNDIR
);
430 ERR("asprintf failed. Something is really wrong!");
433 /* Remove lttng run directory */
436 ERR("Unable to clean " LTTNG_RUNDIR
);
440 DBG("Cleaning up all session");
442 /* Destroy session list mutex */
443 if (session_list_ptr
!= NULL
) {
444 pthread_mutex_destroy(&session_list_ptr
->lock
);
446 /* Cleanup ALL session */
447 cds_list_for_each_entry_safe(sess
, stmp
,
448 &session_list_ptr
->head
, list
) {
449 teardown_kernel_session(sess
);
450 teardown_ust_session(sess
);
455 DBG("Closing all UST sockets");
456 ust_app_clean_list();
458 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
460 DBG("Closing kernel fd");
461 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 MSG("%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
)
518 struct ltt_kernel_stream
*stream
;
519 struct lttcomm_consumer_msg lkm
;
521 DBG("Sending streams of channel %s to kernel consumer",
522 channel
->channel
->name
);
525 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
526 lkm
.u
.channel
.channel_key
= channel
->fd
;
527 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
528 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
529 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
530 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
532 perror("send consumer channel");
537 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
541 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
542 lkm
.u
.stream
.channel_key
= channel
->fd
;
543 lkm
.u
.stream
.stream_key
= stream
->fd
;
544 lkm
.u
.stream
.state
= stream
->state
;
545 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
546 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
547 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
548 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
549 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
550 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
552 perror("send consumer stream");
555 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
557 perror("send consumer stream ancillary data");
562 DBG("consumer channel streams sent");
571 * Send all stream fds of the kernel session to the consumer.
573 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
574 struct ltt_kernel_session
*session
)
577 struct ltt_kernel_channel
*chan
;
578 struct lttcomm_consumer_msg lkm
;
579 int sock
= session
->consumer_fd
;
581 DBG("Sending metadata stream fd");
583 /* Extra protection. It's NOT supposed to be set to 0 at this point */
584 if (session
->consumer_fd
== 0) {
585 session
->consumer_fd
= consumer_data
->cmd_sock
;
588 if (session
->metadata_stream_fd
!= 0) {
589 /* Send metadata channel fd */
590 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
591 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
592 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
593 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
594 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
595 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
597 perror("send consumer channel");
601 /* Send metadata stream fd */
602 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
603 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
604 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
605 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
606 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
607 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
608 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
609 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
610 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
611 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
613 perror("send consumer stream");
616 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
618 perror("send consumer stream");
623 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
624 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
);
630 DBG("consumer fds (metadata and channel streams) sent");
639 * Notify UST applications using the shm mmap futex.
641 static int notify_ust_apps(int active
)
645 DBG("Notifying applications of session daemon state: %d", active
);
647 /* See shm.c for this call implying mmap, shm and futex calls */
648 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
649 if (wait_shm_mmap
== NULL
) {
653 /* Wake waiting process */
654 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
656 /* Apps notified successfully */
664 * Setup the outgoing data buffer for the response (llm) by allocating the
665 * right amount of memory and copying the original information from the lsm
668 * Return total size of the buffer pointed by buf.
670 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
676 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
677 if (cmd_ctx
->llm
== NULL
) {
683 /* Copy common data */
684 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
685 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
687 cmd_ctx
->llm
->data_size
= size
;
688 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
697 * Update the kernel poll set of all channel fd available over all tracing
698 * session. Add the wakeup pipe at the end of the set.
700 static int update_kernel_poll(struct lttng_poll_event
*events
)
703 struct ltt_session
*session
;
704 struct ltt_kernel_channel
*channel
;
706 DBG("Updating kernel poll set");
709 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
710 session_lock(session
);
711 if (session
->kernel_session
== NULL
) {
712 session_unlock(session
);
716 cds_list_for_each_entry(channel
,
717 &session
->kernel_session
->channel_list
.head
, list
) {
718 /* Add channel fd to the kernel poll set */
719 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
721 session_unlock(session
);
724 DBG("Channel fd %d added to kernel set", channel
->fd
);
726 session_unlock(session
);
728 session_unlock_list();
733 session_unlock_list();
738 * Find the channel fd from 'fd' over all tracing session. When found, check
739 * for new channel stream and send those stream fds to the kernel consumer.
741 * Useful for CPU hotplug feature.
743 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
746 struct ltt_session
*session
;
747 struct ltt_kernel_channel
*channel
;
749 DBG("Updating kernel streams for channel fd %d", fd
);
752 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
753 session_lock(session
);
754 if (session
->kernel_session
== NULL
) {
755 session_unlock(session
);
759 /* This is not suppose to be 0 but this is an extra security check */
760 if (session
->kernel_session
->consumer_fd
== 0) {
761 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
764 cds_list_for_each_entry(channel
,
765 &session
->kernel_session
->channel_list
.head
, list
) {
766 if (channel
->fd
== fd
) {
767 DBG("Channel found, updating kernel streams");
768 ret
= kernel_open_channel_stream(channel
);
774 * Have we already sent fds to the consumer? If yes, it means
775 * that tracing is started so it is safe to send our updated
778 if (session
->kernel_session
->consumer_fds_sent
== 1) {
779 ret
= send_kconsumer_channel_streams(consumer_data
,
780 session
->kernel_session
->consumer_fd
, channel
);
788 session_unlock(session
);
790 session_unlock_list();
794 session_unlock(session
);
795 session_unlock_list();
800 * For each tracing session, update newly registered apps.
802 static void update_ust_app(int app_sock
)
804 struct ltt_session
*sess
, *stmp
;
806 /* For all tracing session(s) */
807 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
808 if (sess
->ust_session
) {
809 ust_app_global_update(sess
->ust_session
, app_sock
);
815 * This thread manage event coming from the kernel.
817 * Features supported in this thread:
820 static void *thread_manage_kernel(void *data
)
822 int ret
, i
, pollfd
, update_poll_flag
= 1;
823 uint32_t revents
, nb_fd
;
825 struct lttng_poll_event events
;
827 DBG("Thread manage kernel started");
829 ret
= create_thread_poll_set(&events
, 2);
834 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
840 if (update_poll_flag
== 1) {
842 * Reset number of fd in the poll set. Always 2 since there is the thread
843 * quit pipe and the kernel pipe.
847 ret
= update_kernel_poll(&events
);
851 update_poll_flag
= 0;
854 nb_fd
= LTTNG_POLL_GETNB(&events
);
856 DBG("Thread kernel polling on %d fds", nb_fd
);
858 /* Zeroed the poll events */
859 lttng_poll_reset(&events
);
861 /* Poll infinite value of time */
862 ret
= lttng_poll_wait(&events
, -1);
865 } else if (ret
== 0) {
866 /* Should not happen since timeout is infinite */
867 ERR("Return value of poll is 0 with an infinite timeout.\n"
868 "This should not have happened! Continuing...");
872 for (i
= 0; i
< nb_fd
; i
++) {
873 /* Fetch once the poll data */
874 revents
= LTTNG_POLL_GETEV(&events
, i
);
875 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
877 /* Thread quit pipe has been closed. Killing thread. */
878 ret
= check_thread_quit_pipe(pollfd
, revents
);
883 /* Check for data on kernel pipe */
884 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
885 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
886 update_poll_flag
= 1;
890 * New CPU detected by the kernel. Adding kernel stream to
891 * kernel session and updating the kernel consumer
893 if (revents
& LPOLLIN
) {
894 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
900 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
901 * and unregister kernel stream at this point.
909 DBG("Kernel thread dying");
910 close(kernel_poll_pipe
[0]);
911 close(kernel_poll_pipe
[1]);
913 lttng_poll_clean(&events
);
919 * This thread manage the consumer error sent back to the session daemon.
921 static void *thread_manage_consumer(void *data
)
923 int sock
= 0, i
, ret
, pollfd
;
924 uint32_t revents
, nb_fd
;
925 enum lttcomm_return_code code
;
926 struct lttng_poll_event events
;
927 struct consumer_data
*consumer_data
= data
;
929 DBG("[thread] Manage consumer started");
931 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
937 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
938 * Nothing more will be added to this poll set.
940 ret
= create_thread_poll_set(&events
, 2);
945 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
950 nb_fd
= LTTNG_POLL_GETNB(&events
);
952 /* Inifinite blocking call, waiting for transmission */
953 ret
= lttng_poll_wait(&events
, -1);
958 for (i
= 0; i
< nb_fd
; i
++) {
959 /* Fetch once the poll data */
960 revents
= LTTNG_POLL_GETEV(&events
, i
);
961 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
963 /* Thread quit pipe has been closed. Killing thread. */
964 ret
= check_thread_quit_pipe(pollfd
, revents
);
969 /* Event on the registration socket */
970 if (pollfd
== consumer_data
->err_sock
) {
971 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
972 ERR("consumer err socket poll error");
978 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
983 DBG2("Receiving code from consumer err_sock");
985 /* Getting status code from kconsumerd */
986 ret
= lttcomm_recv_unix_sock(sock
, &code
,
987 sizeof(enum lttcomm_return_code
));
992 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
993 consumer_data
->cmd_sock
=
994 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
995 if (consumer_data
->cmd_sock
< 0) {
996 sem_post(&consumer_data
->sem
);
997 PERROR("consumer connect");
1000 /* Signal condition to tell that the kconsumerd is ready */
1001 sem_post(&consumer_data
->sem
);
1002 DBG("consumer command socket ready");
1004 ERR("consumer error when waiting for SOCK_READY : %s",
1005 lttcomm_get_readable_code(-code
));
1009 /* Remove the kconsumerd error sock since we've established a connexion */
1010 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1015 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1020 /* Update number of fd */
1021 nb_fd
= LTTNG_POLL_GETNB(&events
);
1023 /* Inifinite blocking call, waiting for transmission */
1024 ret
= lttng_poll_wait(&events
, -1);
1029 for (i
= 0; i
< nb_fd
; i
++) {
1030 /* Fetch once the poll data */
1031 revents
= LTTNG_POLL_GETEV(&events
, i
);
1032 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1034 /* Thread quit pipe has been closed. Killing thread. */
1035 ret
= check_thread_quit_pipe(pollfd
, revents
);
1040 /* Event on the kconsumerd socket */
1041 if (pollfd
== sock
) {
1042 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1043 ERR("consumer err socket second poll error");
1049 /* Wait for any kconsumerd error */
1050 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1051 sizeof(enum lttcomm_return_code
));
1053 ERR("consumer closed the command socket");
1057 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1060 DBG("consumer thread dying");
1061 close(consumer_data
->err_sock
);
1062 close(consumer_data
->cmd_sock
);
1065 unlink(consumer_data
->err_unix_sock_path
);
1066 unlink(consumer_data
->cmd_unix_sock_path
);
1067 consumer_data
->pid
= 0;
1069 lttng_poll_clean(&events
);
1075 * This thread manage application communication.
1077 static void *thread_manage_apps(void *data
)
1080 uint32_t revents
, nb_fd
;
1081 struct ust_command ust_cmd
;
1082 struct lttng_poll_event events
;
1084 DBG("[thread] Manage application started");
1086 rcu_register_thread();
1087 rcu_thread_online();
1089 ret
= create_thread_poll_set(&events
, 2);
1094 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1100 /* Zeroed the events structure */
1101 lttng_poll_reset(&events
);
1103 nb_fd
= LTTNG_POLL_GETNB(&events
);
1105 DBG("Apps thread polling on %d fds", nb_fd
);
1107 /* Inifinite blocking call, waiting for transmission */
1108 ret
= lttng_poll_wait(&events
, -1);
1113 for (i
= 0; i
< nb_fd
; i
++) {
1114 /* Fetch once the poll data */
1115 revents
= LTTNG_POLL_GETEV(&events
, i
);
1116 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1118 /* Thread quit pipe has been closed. Killing thread. */
1119 ret
= check_thread_quit_pipe(pollfd
, revents
);
1124 /* Inspect the apps cmd pipe */
1125 if (pollfd
== apps_cmd_pipe
[0]) {
1126 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1127 ERR("Apps command pipe error");
1129 } else if (revents
& LPOLLIN
) {
1131 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1132 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1133 perror("read apps cmd pipe");
1137 /* Register applicaton to the session daemon */
1138 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1140 if (ret
== -ENOMEM
) {
1142 } else if (ret
< 0) {
1147 * Add channel(s) and event(s) to newly registered apps
1148 * from lttng global UST domain.
1150 update_ust_app(ust_cmd
.sock
);
1152 ret
= ustctl_register_done(ust_cmd
.sock
);
1155 * If the registration is not possible, we simply
1156 * unregister the apps and continue
1158 ust_app_unregister(ust_cmd
.sock
);
1161 * We just need here to monitor the close of the UST
1162 * socket and poll set monitor those by default.
1164 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1169 DBG("Apps with sock %d added to poll set",
1177 * At this point, we know that a registered application made
1178 * the event at poll_wait.
1180 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1181 /* Removing from the poll set */
1182 ret
= lttng_poll_del(&events
, pollfd
);
1187 /* Socket closed on remote end. */
1188 ust_app_unregister(pollfd
);
1196 DBG("Application communication apps dying");
1197 close(apps_cmd_pipe
[0]);
1198 close(apps_cmd_pipe
[1]);
1200 lttng_poll_clean(&events
);
1202 rcu_thread_offline();
1203 rcu_unregister_thread();
1208 * Dispatch request from the registration threads to the application
1209 * communication thread.
1211 static void *thread_dispatch_ust_registration(void *data
)
1214 struct cds_wfq_node
*node
;
1215 struct ust_command
*ust_cmd
= NULL
;
1217 DBG("[thread] Dispatch UST command started");
1219 while (!dispatch_thread_exit
) {
1220 /* Atomically prepare the queue futex */
1221 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1224 /* Dequeue command for registration */
1225 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1227 DBG("Woken up but nothing in the UST command queue");
1228 /* Continue thread execution */
1232 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1234 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1235 " gid:%d sock:%d name:%s (version %d.%d)",
1236 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1237 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1238 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1239 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1241 * Inform apps thread of the new application registration. This
1242 * call is blocking so we can be assured that the data will be read
1243 * at some point in time or wait to the end of the world :)
1245 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1246 sizeof(struct ust_command
));
1248 perror("write apps cmd pipe");
1249 if (errno
== EBADF
) {
1251 * We can't inform the application thread to process
1252 * registration. We will exit or else application
1253 * registration will not occur and tracing will never
1260 } while (node
!= NULL
);
1262 /* Futex wait on queue. Blocking call on futex() */
1263 futex_nto1_wait(&ust_cmd_queue
.futex
);
1267 DBG("Dispatch thread dying");
1272 * This thread manage application registration.
1274 static void *thread_registration_apps(void *data
)
1276 int sock
= 0, i
, ret
, pollfd
;
1277 uint32_t revents
, nb_fd
;
1278 struct lttng_poll_event events
;
1280 * Get allocated in this thread, enqueued to a global queue, dequeued and
1281 * freed in the manage apps thread.
1283 struct ust_command
*ust_cmd
= NULL
;
1285 DBG("[thread] Manage application registration started");
1287 ret
= lttcomm_listen_unix_sock(apps_sock
);
1293 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1294 * more will be added to this poll set.
1296 ret
= create_thread_poll_set(&events
, 2);
1301 /* Add the application registration socket */
1302 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1307 /* Notify all applications to register */
1308 ret
= notify_ust_apps(1);
1310 ERR("Failed to notify applications or create the wait shared memory.\n"
1311 "Execution continues but there might be problem for already\n"
1312 "running applications that wishes to register.");
1316 DBG("Accepting application registration");
1318 nb_fd
= LTTNG_POLL_GETNB(&events
);
1320 /* Inifinite blocking call, waiting for transmission */
1321 ret
= lttng_poll_wait(&events
, -1);
1326 for (i
= 0; i
< nb_fd
; i
++) {
1327 /* Fetch once the poll data */
1328 revents
= LTTNG_POLL_GETEV(&events
, i
);
1329 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1331 /* Thread quit pipe has been closed. Killing thread. */
1332 ret
= check_thread_quit_pipe(pollfd
, revents
);
1337 /* Event on the registration socket */
1338 if (pollfd
== apps_sock
) {
1339 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1340 ERR("Register apps socket poll error");
1342 } else if (revents
& LPOLLIN
) {
1343 sock
= lttcomm_accept_unix_sock(apps_sock
);
1348 /* Create UST registration command for enqueuing */
1349 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1350 if (ust_cmd
== NULL
) {
1351 perror("ust command zmalloc");
1356 * Using message-based transmissions to ensure we don't
1357 * have to deal with partially received messages.
1359 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1360 sizeof(struct ust_register_msg
));
1361 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1363 perror("lttcomm_recv_unix_sock register apps");
1365 ERR("Wrong size received on apps register");
1372 ust_cmd
->sock
= sock
;
1374 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1375 " gid:%d sock:%d name:%s (version %d.%d)",
1376 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1377 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1378 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1379 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1382 * Lock free enqueue the registration request. The red pill
1383 * has been taken! This apps will be part of the *system*.
1385 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1388 * Wake the registration queue futex. Implicit memory
1389 * barrier with the exchange in cds_wfq_enqueue.
1391 futex_nto1_wake(&ust_cmd_queue
.futex
);
1398 DBG("UST Registration thread dying");
1400 /* Notify that the registration thread is gone */
1405 unlink(apps_unix_sock_path
);
1407 lttng_poll_clean(&events
);
1413 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1414 * exec or it will fails.
1416 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1419 struct timespec timeout
;
1421 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1422 timeout
.tv_nsec
= 0;
1424 /* Setup semaphore */
1425 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1427 PERROR("sem_init consumer semaphore");
1431 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1432 thread_manage_consumer
, consumer_data
);
1434 PERROR("pthread_create consumer");
1439 /* Get time for sem_timedwait absolute timeout */
1440 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1442 PERROR("clock_gettime spawn consumer");
1443 /* Infinite wait for the kconsumerd thread to be ready */
1444 ret
= sem_wait(&consumer_data
->sem
);
1446 /* Normal timeout if the gettime was successful */
1447 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1448 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1452 if (errno
== ETIMEDOUT
) {
1454 * Call has timed out so we kill the kconsumerd_thread and return
1457 ERR("The consumer thread was never ready. Killing it");
1458 ret
= pthread_cancel(consumer_data
->thread
);
1460 PERROR("pthread_cancel consumer thread");
1463 PERROR("semaphore wait failed consumer thread");
1468 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1469 if (consumer_data
->pid
== 0) {
1470 ERR("Kconsumerd did not start");
1471 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1474 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1483 * Join consumer thread
1485 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1490 if (consumer_data
->pid
!= 0) {
1491 ret
= kill(consumer_data
->pid
, SIGTERM
);
1493 ERR("Error killing consumer daemon");
1496 return pthread_join(consumer_data
->thread
, &status
);
1503 * Fork and exec a consumer daemon (consumerd).
1505 * Return pid if successful else -1.
1507 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1511 const char *consumer_to_use
;
1512 const char *verbosity
;
1515 DBG("Spawning consumerd");
1522 if (opt_verbose
> 1 || opt_verbose_consumer
) {
1523 verbosity
= "--verbose";
1525 verbosity
= "--quiet";
1527 switch (consumer_data
->type
) {
1528 case LTTNG_CONSUMER_KERNEL
:
1530 * Find out which consumerd to execute. We will
1531 * first try the 64-bit path, then the
1532 * sessiond's installation directory, and
1533 * fallback on the 32-bit one,
1535 if (stat(consumerd64_bin
, &st
) == 0) {
1536 consumer_to_use
= consumerd64_bin
;
1537 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1538 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1539 } else if (stat(consumerd32_bin
, &st
) == 0) {
1540 consumer_to_use
= consumerd32_bin
;
1544 DBG("Using kernel consumer at: %s", consumer_to_use
);
1545 execl(consumer_to_use
,
1546 "lttng-consumerd", verbosity
, "-k",
1547 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1548 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1551 case LTTNG_CONSUMER64_UST
:
1553 char *tmpnew
= NULL
;
1555 if (consumerd64_libdir
[0] != '\0') {
1559 tmp
= getenv("LD_LIBRARY_PATH");
1563 tmplen
= strlen("LD_LIBRARY_PATH=")
1564 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1565 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1570 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1571 strcat(tmpnew
, consumerd64_libdir
);
1572 if (tmp
[0] != '\0') {
1573 strcat(tmpnew
, ":");
1574 strcat(tmpnew
, tmp
);
1576 ret
= putenv(tmpnew
);
1582 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1583 ret
= execl(consumerd64_bin
, verbosity
, "-u",
1584 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1585 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1587 if (consumerd64_libdir
[0] != '\0') {
1595 case LTTNG_CONSUMER32_UST
:
1597 char *tmpnew
= NULL
;
1599 if (consumerd32_libdir
[0] != '\0') {
1603 tmp
= getenv("LD_LIBRARY_PATH");
1607 tmplen
= strlen("LD_LIBRARY_PATH=")
1608 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1609 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1614 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1615 strcat(tmpnew
, consumerd32_libdir
);
1616 if (tmp
[0] != '\0') {
1617 strcat(tmpnew
, ":");
1618 strcat(tmpnew
, tmp
);
1620 ret
= putenv(tmpnew
);
1626 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1627 ret
= execl(consumerd32_bin
, verbosity
, "-u",
1628 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1629 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1631 if (consumerd32_libdir
[0] != '\0') {
1640 perror("unknown consumer type");
1644 perror("kernel start consumer exec");
1647 } else if (pid
> 0) {
1650 perror("start consumer fork");
1658 * Spawn the consumerd daemon and session daemon thread.
1660 static int start_consumerd(struct consumer_data
*consumer_data
)
1664 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1665 if (consumer_data
->pid
!= 0) {
1666 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1670 ret
= spawn_consumerd(consumer_data
);
1672 ERR("Spawning consumerd failed");
1673 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1677 /* Setting up the consumer_data pid */
1678 consumer_data
->pid
= ret
;
1679 DBG2("Consumer pid %d", consumer_data
->pid
);
1680 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1682 DBG2("Spawning consumer control thread");
1683 ret
= spawn_consumer_thread(consumer_data
);
1685 ERR("Fatal error spawning consumer control thread");
1697 * modprobe_kernel_modules
1699 static int modprobe_kernel_modules(void)
1704 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1705 ret
= snprintf(modprobe
, sizeof(modprobe
),
1706 "/sbin/modprobe %s%s",
1707 kernel_modules_list
[i
].required
? "" : "-q ",
1708 kernel_modules_list
[i
].name
);
1710 perror("snprintf modprobe");
1713 modprobe
[sizeof(modprobe
) - 1] = '\0';
1714 ret
= system(modprobe
);
1716 ERR("Unable to launch modprobe for module %s",
1717 kernel_modules_list
[i
].name
);
1718 } else if (kernel_modules_list
[i
].required
1719 && WEXITSTATUS(ret
) != 0) {
1720 ERR("Unable to load module %s",
1721 kernel_modules_list
[i
].name
);
1723 DBG("Modprobe successfully %s",
1724 kernel_modules_list
[i
].name
);
1735 static int mount_debugfs(char *path
)
1738 char *type
= "debugfs";
1740 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1742 PERROR("Cannot create debugfs path");
1746 ret
= mount(type
, path
, type
, 0, NULL
);
1748 PERROR("Cannot mount debugfs");
1752 DBG("Mounted debugfs successfully at %s", path
);
1759 * Setup necessary data for kernel tracer action.
1761 static void init_kernel_tracer(void)
1764 char *proc_mounts
= "/proc/mounts";
1766 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1769 /* Detect debugfs */
1770 fp
= fopen(proc_mounts
, "r");
1772 ERR("Unable to probe %s", proc_mounts
);
1776 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1777 if (strstr(line
, "debugfs") != NULL
) {
1778 /* Remove first string */
1780 /* Dup string here so we can reuse line later on */
1781 debugfs_path
= strdup(strtok(NULL
, " "));
1782 DBG("Got debugfs path : %s", debugfs_path
);
1789 /* Mount debugfs if needded */
1790 if (debugfs_path
== NULL
) {
1791 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1793 perror("asprintf debugfs path");
1796 ret
= mount_debugfs(debugfs_path
);
1798 perror("Cannot mount debugfs");
1803 /* Modprobe lttng kernel modules */
1804 ret
= modprobe_kernel_modules();
1809 /* Setup lttng kernel path */
1810 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1812 perror("asprintf lttng path");
1816 /* Open debugfs lttng */
1817 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1818 if (kernel_tracer_fd
< 0) {
1819 DBG("Failed to open %s", lttng_path
);
1825 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1835 WARN("No kernel tracer available");
1836 kernel_tracer_fd
= 0;
1841 * Init tracing by creating trace directory and sending fds kernel consumer.
1843 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1847 if (session
->consumer_fds_sent
== 0) {
1849 * Assign default kernel consumer socket if no consumer assigned to the
1850 * kernel session. At this point, it's NOT suppose to be 0 but this is
1851 * an extra security check.
1853 if (session
->consumer_fd
== 0) {
1854 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1857 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1859 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1863 session
->consumer_fds_sent
= 1;
1871 * Create an UST session and add it to the session ust list.
1873 static int create_ust_session(struct ltt_session
*session
,
1874 struct lttng_domain
*domain
)
1878 struct ltt_ust_session
*lus
= NULL
;
1880 switch (domain
->type
) {
1881 case LTTNG_DOMAIN_UST
:
1884 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1888 DBG("Creating UST session");
1891 lus
= trace_ust_create_session(session
->path
, uid
, domain
);
1893 ret
= LTTCOMM_UST_SESS_FAIL
;
1897 ret
= mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1898 geteuid(), allowed_group());
1900 if (ret
!= -EEXIST
) {
1901 ERR("Trace directory creation error");
1902 ret
= LTTCOMM_UST_SESS_FAIL
;
1907 /* The domain type dictate different actions on session creation */
1908 switch (domain
->type
) {
1909 case LTTNG_DOMAIN_UST
:
1910 /* No ustctl for the global UST domain */
1913 ERR("Unknown UST domain on create session %d", domain
->type
);
1916 session
->ust_session
= lus
;
1926 * Create a kernel tracer session then create the default channel.
1928 static int create_kernel_session(struct ltt_session
*session
)
1932 DBG("Creating kernel session");
1934 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1936 ret
= LTTCOMM_KERN_SESS_FAIL
;
1940 /* Set kernel consumer socket fd */
1941 if (kconsumer_data
.cmd_sock
) {
1942 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1945 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1946 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1948 if (ret
!= -EEXIST
) {
1949 ERR("Trace directory creation error");
1959 * Using the session list, filled a lttng_session array to send back to the
1960 * client for session listing.
1962 * The session list lock MUST be acquired before calling this function. Use
1963 * session_lock_list() and session_unlock_list().
1965 static void list_lttng_sessions(struct lttng_session
*sessions
)
1968 struct ltt_session
*session
;
1970 DBG("Getting all available session");
1972 * Iterate over session list and append data after the control struct in
1975 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1976 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1977 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1978 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1979 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1980 sessions
[i
].enabled
= session
->enabled
;
1986 * Fill lttng_channel array of all channels.
1988 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1989 struct lttng_channel
*channels
)
1992 struct ltt_kernel_channel
*kchan
;
1994 DBG("Listing channels for session %s", session
->name
);
1997 case LTTNG_DOMAIN_KERNEL
:
1998 /* Kernel channels */
1999 if (session
->kernel_session
!= NULL
) {
2000 cds_list_for_each_entry(kchan
,
2001 &session
->kernel_session
->channel_list
.head
, list
) {
2002 /* Copy lttng_channel struct to array */
2003 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2004 channels
[i
].enabled
= kchan
->enabled
;
2009 case LTTNG_DOMAIN_UST
:
2011 struct cds_lfht_iter iter
;
2012 struct ltt_ust_channel
*uchan
;
2014 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
2015 &iter
, uchan
, node
) {
2016 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2017 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2018 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2019 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2020 channels
[i
].attr
.switch_timer_interval
=
2021 uchan
->attr
.switch_timer_interval
;
2022 channels
[i
].attr
.read_timer_interval
=
2023 uchan
->attr
.read_timer_interval
;
2024 channels
[i
].enabled
= uchan
->enabled
;
2025 switch (uchan
->attr
.output
) {
2026 case LTTNG_UST_MMAP
:
2028 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2041 * Create a list of ust global domain events.
2043 static int list_lttng_ust_global_events(char *channel_name
,
2044 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2047 unsigned int nb_event
= 0;
2048 struct cds_lfht_iter iter
;
2049 struct cds_lfht_node
*node
;
2050 struct ltt_ust_channel
*uchan
;
2051 struct ltt_ust_event
*uevent
;
2052 struct lttng_event
*tmp
;
2054 DBG("Listing UST global events for channel %s", channel_name
);
2058 node
= hashtable_lookup(ust_global
->channels
, (void *) channel_name
,
2059 strlen(channel_name
), &iter
);
2061 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2065 uchan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
2067 nb_event
+= hashtable_get_count(uchan
->events
);
2069 if (nb_event
== 0) {
2074 DBG3("Listing UST global %d events", nb_event
);
2076 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2078 ret
= -LTTCOMM_FATAL
;
2082 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
2083 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2084 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2085 tmp
[i
].enabled
= uevent
->enabled
;
2086 switch (uevent
->attr
.instrumentation
) {
2087 case LTTNG_UST_TRACEPOINT
:
2088 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2090 case LTTNG_UST_PROBE
:
2091 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2093 case LTTNG_UST_FUNCTION
:
2094 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2096 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2097 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2112 * Fill lttng_event array of all kernel events in the channel.
2114 static int list_lttng_kernel_events(char *channel_name
,
2115 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2118 unsigned int nb_event
;
2119 struct ltt_kernel_event
*event
;
2120 struct ltt_kernel_channel
*kchan
;
2122 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2123 if (kchan
== NULL
) {
2124 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2128 nb_event
= kchan
->event_count
;
2130 DBG("Listing events for channel %s", kchan
->channel
->name
);
2132 if (nb_event
== 0) {
2137 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2138 if (*events
== NULL
) {
2139 ret
= LTTCOMM_FATAL
;
2143 /* Kernel channels */
2144 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2145 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2146 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2147 (*events
)[i
].enabled
= event
->enabled
;
2148 switch (event
->event
->instrumentation
) {
2149 case LTTNG_KERNEL_TRACEPOINT
:
2150 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2152 case LTTNG_KERNEL_KPROBE
:
2153 case LTTNG_KERNEL_KRETPROBE
:
2154 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2155 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2156 sizeof(struct lttng_kernel_kprobe
));
2158 case LTTNG_KERNEL_FUNCTION
:
2159 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2160 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2161 sizeof(struct lttng_kernel_function
));
2163 case LTTNG_KERNEL_NOOP
:
2164 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2166 case LTTNG_KERNEL_SYSCALL
:
2167 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2169 case LTTNG_KERNEL_ALL
:
2183 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2185 static int cmd_disable_channel(struct ltt_session
*session
,
2186 int domain
, char *channel_name
)
2189 struct ltt_ust_session
*usess
;
2191 usess
= session
->ust_session
;
2194 case LTTNG_DOMAIN_KERNEL
:
2196 ret
= channel_kernel_disable(session
->kernel_session
,
2198 if (ret
!= LTTCOMM_OK
) {
2202 kernel_wait_quiescent(kernel_tracer_fd
);
2205 case LTTNG_DOMAIN_UST
:
2207 struct ltt_ust_channel
*uchan
;
2208 struct cds_lfht
*chan_ht
;
2210 chan_ht
= usess
->domain_global
.channels
;
2212 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2213 if (uchan
== NULL
) {
2214 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2218 ret
= channel_ust_disable(usess
, domain
, uchan
);
2219 if (ret
!= LTTCOMM_OK
) {
2224 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2225 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2226 case LTTNG_DOMAIN_UST_PID
:
2227 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2230 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2241 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2243 static int cmd_enable_channel(struct ltt_session
*session
,
2244 int domain
, struct lttng_channel
*attr
)
2247 struct ltt_ust_session
*usess
= session
->ust_session
;
2248 struct cds_lfht
*chan_ht
;
2250 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2253 case LTTNG_DOMAIN_KERNEL
:
2255 struct ltt_kernel_channel
*kchan
;
2257 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2258 session
->kernel_session
);
2259 if (kchan
== NULL
) {
2260 ret
= channel_kernel_create(session
->kernel_session
,
2261 attr
, kernel_poll_pipe
[1]);
2263 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2266 if (ret
!= LTTCOMM_OK
) {
2270 kernel_wait_quiescent(kernel_tracer_fd
);
2273 case LTTNG_DOMAIN_UST
:
2275 struct ltt_ust_channel
*uchan
;
2277 chan_ht
= usess
->domain_global
.channels
;
2279 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2280 if (uchan
== NULL
) {
2281 ret
= channel_ust_create(usess
, domain
, attr
);
2283 ret
= channel_ust_enable(usess
, domain
, uchan
);
2287 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2288 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2289 case LTTNG_DOMAIN_UST_PID
:
2290 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2293 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2302 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2304 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2305 char *channel_name
, char *event_name
)
2310 case LTTNG_DOMAIN_KERNEL
:
2312 struct ltt_kernel_channel
*kchan
;
2313 struct ltt_kernel_session
*ksess
;
2315 ksess
= session
->kernel_session
;
2317 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2318 if (kchan
== NULL
) {
2319 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2323 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2324 if (ret
!= LTTCOMM_OK
) {
2328 kernel_wait_quiescent(kernel_tracer_fd
);
2331 case LTTNG_DOMAIN_UST
:
2333 struct ltt_ust_channel
*uchan
;
2334 struct ltt_ust_session
*usess
;
2336 usess
= session
->ust_session
;
2338 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2340 if (uchan
== NULL
) {
2341 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2345 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2346 if (ret
!= LTTCOMM_OK
) {
2350 DBG3("Disable UST event %s in channel %s completed", event_name
,
2354 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2355 case LTTNG_DOMAIN_UST_PID
:
2356 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2358 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2369 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2371 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2377 case LTTNG_DOMAIN_KERNEL
:
2379 struct ltt_kernel_session
*ksess
;
2380 struct ltt_kernel_channel
*kchan
;
2382 ksess
= session
->kernel_session
;
2384 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2385 if (kchan
== NULL
) {
2386 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2390 ret
= event_kernel_disable_all(ksess
, kchan
);
2391 if (ret
!= LTTCOMM_OK
) {
2395 kernel_wait_quiescent(kernel_tracer_fd
);
2398 case LTTNG_DOMAIN_UST
:
2400 struct ltt_ust_session
*usess
;
2401 struct ltt_ust_channel
*uchan
;
2403 usess
= session
->ust_session
;
2405 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2407 if (uchan
== NULL
) {
2408 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2412 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2417 DBG3("Disable all UST events in channel %s completed", channel_name
);
2421 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2422 case LTTNG_DOMAIN_UST_PID
:
2423 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2425 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2436 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2438 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2439 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2444 case LTTNG_DOMAIN_KERNEL
:
2445 /* Add kernel context to kernel tracer */
2446 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2447 event_name
, channel_name
);
2448 if (ret
!= LTTCOMM_OK
) {
2452 case LTTNG_DOMAIN_UST
:
2454 struct ltt_ust_session
*usess
= session
->ust_session
;
2456 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2457 if (ret
!= LTTCOMM_OK
) {
2462 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2463 case LTTNG_DOMAIN_UST_PID
:
2464 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2466 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2477 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2479 * TODO: currently, both events and loglevels are kept within the same
2480 * namespace for UST global registry/app registery, so if an event
2481 * happen to have the same name as the loglevel (very unlikely though),
2482 * and an attempt is made to enable/disable both in the same session,
2483 * the first to be created will be the only one allowed to exist.
2485 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2486 char *channel_name
, struct lttng_event
*event
)
2489 struct lttng_channel
*attr
;
2490 struct ltt_ust_session
*usess
= session
->ust_session
;
2493 case LTTNG_DOMAIN_KERNEL
:
2495 struct ltt_kernel_channel
*kchan
;
2497 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2498 session
->kernel_session
);
2499 if (kchan
== NULL
) {
2500 attr
= channel_new_default_attr(domain
);
2502 ret
= LTTCOMM_FATAL
;
2505 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2507 /* This call will notify the kernel thread */
2508 ret
= channel_kernel_create(session
->kernel_session
,
2509 attr
, kernel_poll_pipe
[1]);
2510 if (ret
!= LTTCOMM_OK
) {
2517 /* Get the newly created kernel channel pointer */
2518 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2519 session
->kernel_session
);
2520 if (kchan
== NULL
) {
2521 /* This sould not happen... */
2522 ret
= LTTCOMM_FATAL
;
2526 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2528 if (ret
!= LTTCOMM_OK
) {
2532 kernel_wait_quiescent(kernel_tracer_fd
);
2535 case LTTNG_DOMAIN_UST
:
2537 struct lttng_channel
*attr
;
2538 struct ltt_ust_channel
*uchan
;
2540 /* Get channel from global UST domain */
2541 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2543 if (uchan
== NULL
) {
2544 /* Create default channel */
2545 attr
= channel_new_default_attr(domain
);
2547 ret
= LTTCOMM_FATAL
;
2550 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2551 attr
->name
[NAME_MAX
- 1] = '\0';
2553 ret
= channel_ust_create(usess
, domain
, attr
);
2554 if (ret
!= LTTCOMM_OK
) {
2560 /* Get the newly created channel reference back */
2561 uchan
= trace_ust_find_channel_by_name(
2562 usess
->domain_global
.channels
, channel_name
);
2563 if (uchan
== NULL
) {
2564 /* Something is really wrong */
2565 ret
= LTTCOMM_FATAL
;
2570 /* At this point, the session and channel exist on the tracer */
2572 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2573 if (ret
!= LTTCOMM_OK
) {
2578 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2579 case LTTNG_DOMAIN_UST_PID
:
2580 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2582 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2593 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2595 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2596 char *channel_name
, int event_type
)
2599 struct ltt_kernel_channel
*kchan
;
2602 case LTTNG_DOMAIN_KERNEL
:
2603 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2604 session
->kernel_session
);
2605 if (kchan
== NULL
) {
2606 /* This call will notify the kernel thread */
2607 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2608 kernel_poll_pipe
[1]);
2609 if (ret
!= LTTCOMM_OK
) {
2613 /* Get the newly created kernel channel pointer */
2614 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2615 session
->kernel_session
);
2616 if (kchan
== NULL
) {
2617 /* This sould not happen... */
2618 ret
= LTTCOMM_FATAL
;
2624 switch (event_type
) {
2625 case LTTNG_EVENT_SYSCALL
:
2626 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2627 kchan
, kernel_tracer_fd
);
2629 case LTTNG_EVENT_TRACEPOINT
:
2631 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2632 * events already registered to the channel.
2634 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2635 kchan
, kernel_tracer_fd
);
2637 case LTTNG_EVENT_ALL
:
2638 /* Enable syscalls and tracepoints */
2639 ret
= event_kernel_enable_all(session
->kernel_session
,
2640 kchan
, kernel_tracer_fd
);
2643 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2647 /* Manage return value */
2648 if (ret
!= LTTCOMM_OK
) {
2652 kernel_wait_quiescent(kernel_tracer_fd
);
2654 case LTTNG_DOMAIN_UST
:
2656 struct lttng_channel
*attr
;
2657 struct ltt_ust_channel
*uchan
;
2658 struct ltt_ust_session
*usess
= session
->ust_session
;
2660 /* Get channel from global UST domain */
2661 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2663 if (uchan
== NULL
) {
2664 /* Create default channel */
2665 attr
= channel_new_default_attr(domain
);
2667 ret
= LTTCOMM_FATAL
;
2670 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2671 attr
->name
[NAME_MAX
- 1] = '\0';
2673 /* Use the internal command enable channel */
2674 ret
= channel_ust_create(usess
, domain
, attr
);
2675 if (ret
!= LTTCOMM_OK
) {
2681 /* Get the newly created channel reference back */
2682 uchan
= trace_ust_find_channel_by_name(
2683 usess
->domain_global
.channels
, channel_name
);
2684 if (uchan
== NULL
) {
2685 /* Something is really wrong */
2686 ret
= LTTCOMM_FATAL
;
2691 /* At this point, the session and channel exist on the tracer */
2693 switch (event_type
) {
2694 case LTTNG_EVENT_ALL
:
2695 case LTTNG_EVENT_TRACEPOINT
:
2696 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2697 if (ret
!= LTTCOMM_OK
) {
2702 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2706 /* Manage return value */
2707 if (ret
!= LTTCOMM_OK
) {
2713 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2714 case LTTNG_DOMAIN_UST_PID
:
2715 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2717 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2728 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2730 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2733 ssize_t nb_events
= 0;
2736 case LTTNG_DOMAIN_KERNEL
:
2737 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2738 if (nb_events
< 0) {
2739 ret
= LTTCOMM_KERN_LIST_FAIL
;
2743 case LTTNG_DOMAIN_UST
:
2744 nb_events
= ust_app_list_events(events
);
2745 if (nb_events
< 0) {
2746 ret
= LTTCOMM_UST_LIST_FAIL
;
2751 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2758 /* Return negative value to differentiate return code */
2763 * Command LTTNG_START_TRACE processed by the client thread.
2765 static int cmd_start_trace(struct ltt_session
*session
)
2768 struct ltt_kernel_session
*ksession
;
2769 struct ltt_ust_session
*usess
;
2772 ksession
= session
->kernel_session
;
2773 usess
= session
->ust_session
;
2775 if (session
->enabled
)
2776 return LTTCOMM_UST_START_FAIL
;
2777 session
->enabled
= 1;
2779 /* Kernel tracing */
2780 if (ksession
!= NULL
) {
2781 struct ltt_kernel_channel
*kchan
;
2783 /* Open kernel metadata */
2784 if (ksession
->metadata
== NULL
) {
2785 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2787 ret
= LTTCOMM_KERN_META_FAIL
;
2792 /* Open kernel metadata stream */
2793 if (ksession
->metadata_stream_fd
== 0) {
2794 ret
= kernel_open_metadata_stream(ksession
);
2796 ERR("Kernel create metadata stream failed");
2797 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2802 /* For each channel */
2803 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2804 if (kchan
->stream_count
== 0) {
2805 ret
= kernel_open_channel_stream(kchan
);
2807 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2810 /* Update the stream global counter */
2811 ksession
->stream_count_global
+= ret
;
2815 /* Setup kernel consumer socket and send fds to it */
2816 ret
= init_kernel_tracing(ksession
);
2818 ret
= LTTCOMM_KERN_START_FAIL
;
2822 /* This start the kernel tracing */
2823 ret
= kernel_start_session(ksession
);
2825 ret
= LTTCOMM_KERN_START_FAIL
;
2829 /* Quiescent wait after starting trace */
2830 kernel_wait_quiescent(kernel_tracer_fd
);
2833 /* Flag session that trace should start automatically */
2835 usess
->start_trace
= 1;
2837 ret
= ust_app_start_trace_all(usess
);
2839 ret
= LTTCOMM_UST_START_FAIL
;
2851 * Command LTTNG_STOP_TRACE processed by the client thread.
2853 static int cmd_stop_trace(struct ltt_session
*session
)
2856 struct ltt_kernel_channel
*kchan
;
2857 struct ltt_kernel_session
*ksession
;
2858 struct ltt_ust_session
*usess
;
2861 ksession
= session
->kernel_session
;
2862 usess
= session
->ust_session
;
2864 if (!session
->enabled
)
2865 return LTTCOMM_UST_START_FAIL
;
2866 session
->enabled
= 0;
2869 if (ksession
!= NULL
) {
2870 DBG("Stop kernel tracing");
2872 /* Flush all buffers before stopping */
2873 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2875 ERR("Kernel metadata flush failed");
2878 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2879 ret
= kernel_flush_buffer(kchan
);
2881 ERR("Kernel flush buffer error");
2885 ret
= kernel_stop_session(ksession
);
2887 ret
= LTTCOMM_KERN_STOP_FAIL
;
2891 kernel_wait_quiescent(kernel_tracer_fd
);
2895 usess
->start_trace
= 0;
2897 ret
= ust_app_stop_trace_all(usess
);
2899 ret
= LTTCOMM_UST_START_FAIL
;
2911 * Command LTTNG_CREATE_SESSION processed by the client thread.
2913 static int cmd_create_session(char *name
, char *path
)
2917 ret
= session_create(name
, path
);
2918 if (ret
!= LTTCOMM_OK
) {
2929 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2931 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2935 /* Clean kernel session teardown */
2936 teardown_kernel_session(session
);
2937 /* UST session teardown */
2938 teardown_ust_session(session
);
2941 * Must notify the kernel thread here to update it's poll setin order
2942 * to remove the channel(s)' fd just destroyed.
2944 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2946 perror("write kernel poll pipe");
2949 ret
= session_destroy(session
);
2955 * Command LTTNG_CALIBRATE processed by the client thread.
2957 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2962 case LTTNG_DOMAIN_KERNEL
:
2964 struct lttng_kernel_calibrate kcalibrate
;
2966 kcalibrate
.type
= calibrate
->type
;
2967 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2969 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2975 /* TODO: Userspace tracing */
2976 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2987 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2989 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2995 case LTTNG_DOMAIN_KERNEL
:
2996 /* Can't register a consumer if there is already one */
2997 if (session
->kernel_session
->consumer_fd
!= 0) {
2998 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3002 sock
= lttcomm_connect_unix_sock(sock_path
);
3004 ret
= LTTCOMM_CONNECT_FAIL
;
3008 session
->kernel_session
->consumer_fd
= sock
;
3011 /* TODO: Userspace tracing */
3012 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3023 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3025 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3026 struct lttng_domain
**domains
)
3031 if (session
->kernel_session
!= NULL
) {
3032 DBG3("Listing domains found kernel domain");
3036 if (session
->ust_session
!= NULL
) {
3037 DBG3("Listing domains found UST global domain");
3041 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3042 if (*domains
== NULL
) {
3043 ret
= -LTTCOMM_FATAL
;
3047 if (session
->kernel_session
!= NULL
) {
3048 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3052 if (session
->ust_session
!= NULL
) {
3053 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3064 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3066 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3067 struct lttng_channel
**channels
)
3070 ssize_t nb_chan
= 0;
3073 case LTTNG_DOMAIN_KERNEL
:
3074 if (session
->kernel_session
!= NULL
) {
3075 nb_chan
= session
->kernel_session
->channel_count
;
3077 DBG3("Number of kernel channels %zd", nb_chan
);
3079 case LTTNG_DOMAIN_UST
:
3080 if (session
->ust_session
!= NULL
) {
3081 nb_chan
= hashtable_get_count(
3082 session
->ust_session
->domain_global
.channels
);
3084 DBG3("Number of UST global channels %zd", nb_chan
);
3088 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3093 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3094 if (*channels
== NULL
) {
3095 ret
= -LTTCOMM_FATAL
;
3099 list_lttng_channels(domain
, session
, *channels
);
3111 * Command LTTNG_LIST_EVENTS processed by the client thread.
3113 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3114 char *channel_name
, struct lttng_event
**events
)
3117 ssize_t nb_event
= 0;
3120 case LTTNG_DOMAIN_KERNEL
:
3121 if (session
->kernel_session
!= NULL
) {
3122 nb_event
= list_lttng_kernel_events(channel_name
,
3123 session
->kernel_session
, events
);
3126 case LTTNG_DOMAIN_UST
:
3128 if (session
->ust_session
!= NULL
) {
3129 nb_event
= list_lttng_ust_global_events(channel_name
,
3130 &session
->ust_session
->domain_global
, events
);
3135 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3146 * Process the command requested by the lttng client within the command
3147 * context structure. This function make sure that the return structure (llm)
3148 * is set and ready for transmission before returning.
3150 * Return any error encountered or 0 for success.
3152 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3154 int ret
= LTTCOMM_OK
;
3155 int need_tracing_session
= 1;
3157 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3160 * Check for command that don't needs to allocate a returned payload. We do
3161 * this here so we don't have to make the call for no payload at each
3164 switch(cmd_ctx
->lsm
->cmd_type
) {
3165 case LTTNG_LIST_SESSIONS
:
3166 case LTTNG_LIST_TRACEPOINTS
:
3167 case LTTNG_LIST_DOMAINS
:
3168 case LTTNG_LIST_CHANNELS
:
3169 case LTTNG_LIST_EVENTS
:
3172 /* Setup lttng message with no payload */
3173 ret
= setup_lttng_msg(cmd_ctx
, 0);
3175 /* This label does not try to unlock the session */
3176 goto init_setup_error
;
3180 /* Commands that DO NOT need a session. */
3181 switch (cmd_ctx
->lsm
->cmd_type
) {
3182 case LTTNG_CALIBRATE
:
3183 case LTTNG_CREATE_SESSION
:
3184 case LTTNG_LIST_SESSIONS
:
3185 case LTTNG_LIST_TRACEPOINTS
:
3186 need_tracing_session
= 0;
3189 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3190 session_lock_list();
3191 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3192 session_unlock_list();
3193 if (cmd_ctx
->session
== NULL
) {
3194 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3195 ret
= LTTCOMM_SESS_NOT_FOUND
;
3197 /* If no session name specified */
3198 ret
= LTTCOMM_SELECT_SESS
;
3202 /* Acquire lock for the session */
3203 session_lock(cmd_ctx
->session
);
3209 * Check domain type for specific "pre-action".
3211 switch (cmd_ctx
->lsm
->domain
.type
) {
3212 case LTTNG_DOMAIN_KERNEL
:
3213 /* Kernel tracer check */
3214 if (kernel_tracer_fd
== 0) {
3215 /* Basically, load kernel tracer modules */
3216 init_kernel_tracer();
3217 if (kernel_tracer_fd
== 0) {
3218 ret
= LTTCOMM_KERN_NA
;
3223 /* Need a session for kernel command */
3224 if (need_tracing_session
) {
3225 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3226 ret
= create_kernel_session(cmd_ctx
->session
);
3228 ret
= LTTCOMM_KERN_SESS_FAIL
;
3233 /* Start the kernel consumer daemon */
3234 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3235 if (kconsumer_data
.pid
== 0 &&
3236 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3237 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3238 ret
= start_consumerd(&kconsumer_data
);
3240 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3244 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3248 case LTTNG_DOMAIN_UST
:
3250 if (need_tracing_session
) {
3251 if (cmd_ctx
->session
->ust_session
== NULL
) {
3252 ret
= create_ust_session(cmd_ctx
->session
,
3253 &cmd_ctx
->lsm
->domain
);
3254 if (ret
!= LTTCOMM_OK
) {
3258 /* Start the UST consumer daemons */
3260 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3261 if (consumerd64_bin
[0] != '\0' &&
3262 ustconsumer64_data
.pid
== 0 &&
3263 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3264 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3265 ret
= start_consumerd(&ustconsumer64_data
);
3267 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3268 ust_consumerd64_fd
= -EINVAL
;
3272 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3274 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3277 if (consumerd32_bin
[0] != '\0' &&
3278 ustconsumer32_data
.pid
== 0 &&
3279 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3280 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3281 ret
= start_consumerd(&ustconsumer32_data
);
3283 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3284 ust_consumerd32_fd
= -EINVAL
;
3287 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3289 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3298 /* Process by command type */
3299 switch (cmd_ctx
->lsm
->cmd_type
) {
3300 case LTTNG_ADD_CONTEXT
:
3302 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3303 cmd_ctx
->lsm
->u
.context
.channel_name
,
3304 cmd_ctx
->lsm
->u
.context
.event_name
,
3305 &cmd_ctx
->lsm
->u
.context
.ctx
);
3308 case LTTNG_DISABLE_CHANNEL
:
3310 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3311 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3314 case LTTNG_DISABLE_EVENT
:
3316 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3317 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3318 cmd_ctx
->lsm
->u
.disable
.name
);
3322 case LTTNG_DISABLE_ALL_EVENT
:
3324 DBG("Disabling all events");
3326 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3327 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3330 case LTTNG_ENABLE_CHANNEL
:
3332 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3333 &cmd_ctx
->lsm
->u
.channel
.chan
);
3336 case LTTNG_ENABLE_EVENT
:
3338 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3339 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3340 &cmd_ctx
->lsm
->u
.enable
.event
);
3343 case LTTNG_ENABLE_ALL_EVENT
:
3345 DBG("Enabling all events");
3347 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3348 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3349 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3352 case LTTNG_LIST_TRACEPOINTS
:
3354 struct lttng_event
*events
;
3357 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3358 if (nb_events
< 0) {
3364 * Setup lttng message with payload size set to the event list size in
3365 * bytes and then copy list into the llm payload.
3367 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3373 /* Copy event list into message payload */
3374 memcpy(cmd_ctx
->llm
->payload
, events
,
3375 sizeof(struct lttng_event
) * nb_events
);
3382 case LTTNG_START_TRACE
:
3384 ret
= cmd_start_trace(cmd_ctx
->session
);
3387 case LTTNG_STOP_TRACE
:
3389 ret
= cmd_stop_trace(cmd_ctx
->session
);
3392 case LTTNG_CREATE_SESSION
:
3394 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3395 cmd_ctx
->lsm
->session
.path
);
3398 case LTTNG_DESTROY_SESSION
:
3400 ret
= cmd_destroy_session(cmd_ctx
->session
,
3401 cmd_ctx
->lsm
->session
.name
);
3404 case LTTNG_LIST_DOMAINS
:
3407 struct lttng_domain
*domains
;
3409 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3415 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3420 /* Copy event list into message payload */
3421 memcpy(cmd_ctx
->llm
->payload
, domains
,
3422 nb_dom
* sizeof(struct lttng_domain
));
3429 case LTTNG_LIST_CHANNELS
:
3432 struct lttng_channel
*channels
;
3434 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3435 cmd_ctx
->session
, &channels
);
3441 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3446 /* Copy event list into message payload */
3447 memcpy(cmd_ctx
->llm
->payload
, channels
,
3448 nb_chan
* sizeof(struct lttng_channel
));
3455 case LTTNG_LIST_EVENTS
:
3458 struct lttng_event
*events
= NULL
;
3460 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3461 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3467 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3472 /* Copy event list into message payload */
3473 memcpy(cmd_ctx
->llm
->payload
, events
,
3474 nb_event
* sizeof(struct lttng_event
));
3481 case LTTNG_LIST_SESSIONS
:
3483 session_lock_list();
3485 if (session_list_ptr
->count
== 0) {
3486 ret
= LTTCOMM_NO_SESSION
;
3487 session_unlock_list();
3491 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3492 session_list_ptr
->count
);
3494 session_unlock_list();
3498 /* Filled the session array */
3499 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3501 session_unlock_list();
3506 case LTTNG_CALIBRATE
:
3508 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3509 &cmd_ctx
->lsm
->u
.calibrate
);
3512 case LTTNG_REGISTER_CONSUMER
:
3514 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3515 cmd_ctx
->lsm
->u
.reg
.path
);
3524 if (cmd_ctx
->llm
== NULL
) {
3525 DBG("Missing llm structure. Allocating one.");
3526 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3530 /* Set return code */
3531 cmd_ctx
->llm
->ret_code
= ret
;
3533 if (cmd_ctx
->session
) {
3534 session_unlock(cmd_ctx
->session
);
3541 * This thread manage all clients request using the unix client socket for
3544 static void *thread_manage_clients(void *data
)
3546 int sock
= 0, ret
, i
, pollfd
;
3547 uint32_t revents
, nb_fd
;
3548 struct command_ctx
*cmd_ctx
= NULL
;
3549 struct lttng_poll_event events
;
3551 DBG("[thread] Manage client started");
3553 rcu_register_thread();
3555 ret
= lttcomm_listen_unix_sock(client_sock
);
3561 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3562 * more will be added to this poll set.
3564 ret
= create_thread_poll_set(&events
, 2);
3569 /* Add the application registration socket */
3570 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3576 * Notify parent pid that we are ready to accept command for client side.
3578 if (opt_sig_parent
) {
3579 kill(ppid
, SIGCHLD
);
3583 DBG("Accepting client command ...");
3585 nb_fd
= LTTNG_POLL_GETNB(&events
);
3587 /* Inifinite blocking call, waiting for transmission */
3588 ret
= lttng_poll_wait(&events
, -1);
3593 for (i
= 0; i
< nb_fd
; i
++) {
3594 /* Fetch once the poll data */
3595 revents
= LTTNG_POLL_GETEV(&events
, i
);
3596 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3598 /* Thread quit pipe has been closed. Killing thread. */
3599 ret
= check_thread_quit_pipe(pollfd
, revents
);
3604 /* Event on the registration socket */
3605 if (pollfd
== client_sock
) {
3606 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3607 ERR("Client socket poll error");
3613 DBG("Wait for client response");
3615 sock
= lttcomm_accept_unix_sock(client_sock
);
3620 /* Allocate context command to process the client request */
3621 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3622 if (cmd_ctx
== NULL
) {
3623 perror("zmalloc cmd_ctx");
3627 /* Allocate data buffer for reception */
3628 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3629 if (cmd_ctx
->lsm
== NULL
) {
3630 perror("zmalloc cmd_ctx->lsm");
3634 cmd_ctx
->llm
= NULL
;
3635 cmd_ctx
->session
= NULL
;
3638 * Data is received from the lttng client. The struct
3639 * lttcomm_session_msg (lsm) contains the command and data request of
3642 DBG("Receiving data from client ...");
3643 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
,
3644 sizeof(struct lttcomm_session_msg
));
3646 DBG("Nothing recv() from client... continuing");
3652 // TODO: Validate cmd_ctx including sanity check for
3653 // security purpose.
3655 rcu_thread_online();
3657 * This function dispatch the work to the kernel or userspace tracer
3658 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3659 * informations for the client. The command context struct contains
3660 * everything this function may needs.
3662 ret
= process_client_msg(cmd_ctx
);
3663 rcu_thread_offline();
3666 * TODO: Inform client somehow of the fatal error. At
3667 * this point, ret < 0 means that a zmalloc failed
3668 * (ENOMEM). Error detected but still accept command.
3670 clean_command_ctx(&cmd_ctx
);
3674 DBG("Sending response (size: %d, retcode: %s)",
3675 cmd_ctx
->lttng_msg_size
,
3676 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3677 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3679 ERR("Failed to send data back to client");
3682 clean_command_ctx(&cmd_ctx
);
3684 /* End of transmission */
3689 DBG("Client thread dying");
3690 unlink(client_unix_sock_path
);
3694 lttng_poll_clean(&events
);
3695 clean_command_ctx(&cmd_ctx
);
3697 rcu_unregister_thread();
3703 * usage function on stderr
3705 static void usage(void)
3707 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3708 fprintf(stderr
, " -h, --help Display this usage.\n");
3709 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3710 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3711 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3712 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3713 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3714 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3715 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3716 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3717 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3718 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3719 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3720 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3721 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3722 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3723 fprintf(stderr
, " -V, --version Show version number.\n");
3724 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3725 fprintf(stderr
, " -q, --quiet No output at all.\n");
3726 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3727 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3731 * daemon argument parsing
3733 static int parse_args(int argc
, char **argv
)
3737 static struct option long_options
[] = {
3738 { "client-sock", 1, 0, 'c' },
3739 { "apps-sock", 1, 0, 'a' },
3740 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3741 { "kconsumerd-err-sock", 1, 0, 'E' },
3742 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3743 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3744 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3745 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3746 { "consumerd32-path", 1, 0, 'u' },
3747 { "consumerd32-libdir", 1, 0, 'U' },
3748 { "consumerd64-path", 1, 0, 't' },
3749 { "consumerd64-libdir", 1, 0, 'T' },
3750 { "daemonize", 0, 0, 'd' },
3751 { "sig-parent", 0, 0, 'S' },
3752 { "help", 0, 0, 'h' },
3753 { "group", 1, 0, 'g' },
3754 { "version", 0, 0, 'V' },
3755 { "quiet", 0, 0, 'q' },
3756 { "verbose", 0, 0, 'v' },
3757 { "verbose-consumer", 0, 0, 'Z' },
3762 int option_index
= 0;
3763 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:C:E:D:F:Z:u:t",
3764 long_options
, &option_index
);
3771 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3773 fprintf(stderr
, " with arg %s\n", optarg
);
3777 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3780 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3786 opt_tracing_group
= optarg
;
3792 fprintf(stdout
, "%s\n", VERSION
);
3798 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3801 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3804 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3807 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3810 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3813 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3819 /* Verbose level can increase using multiple -v */
3823 opt_verbose_consumer
+= 1;
3826 consumerd32_bin
= optarg
;
3829 consumerd32_libdir
= optarg
;
3832 consumerd64_bin
= optarg
;
3835 consumerd64_libdir
= optarg
;
3838 /* Unknown option or other error.
3839 * Error is printed by getopt, just return */
3848 * Creates the two needed socket by the daemon.
3849 * apps_sock - The communication socket for all UST apps.
3850 * client_sock - The communication of the cli tool (lttng).
3852 static int init_daemon_socket(void)
3857 old_umask
= umask(0);
3859 /* Create client tool unix socket */
3860 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3861 if (client_sock
< 0) {
3862 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3867 /* File permission MUST be 660 */
3868 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3870 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3875 /* Create the application unix socket */
3876 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3877 if (apps_sock
< 0) {
3878 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3883 /* File permission MUST be 666 */
3884 ret
= chmod(apps_unix_sock_path
,
3885 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3887 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3898 * Check if the global socket is available, and if a daemon is answering at the
3899 * other side. If yes, error is returned.
3901 static int check_existing_daemon(void)
3903 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3904 access(apps_unix_sock_path
, F_OK
) < 0) {
3908 /* Is there anybody out there ? */
3909 if (lttng_session_daemon_alive()) {
3917 * Set the tracing group gid onto the client socket.
3919 * Race window between mkdir and chown is OK because we are going from more
3920 * permissive (root.root) to les permissive (root.tracing).
3922 static int set_permissions(void)
3927 gid
= allowed_group();
3930 WARN("No tracing group detected");
3933 ERR("Missing tracing group. Aborting execution.");
3939 /* Set lttng run dir */
3940 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
3942 ERR("Unable to set group on " LTTNG_RUNDIR
);
3946 /* lttng client socket path */
3947 ret
= chown(client_unix_sock_path
, 0, gid
);
3949 ERR("Unable to set group on %s", client_unix_sock_path
);
3953 /* kconsumer error socket path */
3954 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3956 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3960 /* 64-bit ustconsumer error socket path */
3961 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3963 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3967 /* 32-bit ustconsumer compat32 error socket path */
3968 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3970 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
3974 DBG("All permissions are set");
3981 * Create the pipe used to wake up the kernel thread.
3983 static int create_kernel_poll_pipe(void)
3985 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
3989 * Create the application command pipe to wake thread_manage_apps.
3991 static int create_apps_cmd_pipe(void)
3993 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
3997 * Create the lttng run directory needed for all global sockets and pipe.
3999 static int create_lttng_rundir(void)
4003 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
4005 if (errno
!= EEXIST
) {
4006 ERR("Unable to create " LTTNG_RUNDIR
);
4018 * Setup sockets and directory needed by the kconsumerd communication with the
4021 static int set_consumer_sockets(struct consumer_data
*consumer_data
)
4026 switch (consumer_data
->type
) {
4027 case LTTNG_CONSUMER_KERNEL
:
4028 path
= KCONSUMERD_PATH
;
4030 case LTTNG_CONSUMER64_UST
:
4031 path
= USTCONSUMERD64_PATH
;
4033 case LTTNG_CONSUMER32_UST
:
4034 path
= USTCONSUMERD32_PATH
;
4037 ERR("Consumer type unknown");
4042 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4044 if (errno
!= EEXIST
) {
4045 ERR("Failed to create %s", path
);
4051 /* Create the kconsumerd error unix socket */
4052 consumer_data
->err_sock
=
4053 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4054 if (consumer_data
->err_sock
< 0) {
4055 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4060 /* File permission MUST be 660 */
4061 ret
= chmod(consumer_data
->err_unix_sock_path
,
4062 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4064 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4074 * Signal handler for the daemon
4076 * Simply stop all worker threads, leaving main() return gracefully after
4077 * joining all threads and calling cleanup().
4079 static void sighandler(int sig
)
4083 DBG("SIGPIPE catched");
4086 DBG("SIGINT catched");
4090 DBG("SIGTERM catched");
4099 * Setup signal handler for :
4100 * SIGINT, SIGTERM, SIGPIPE
4102 static int set_signal_handler(void)
4105 struct sigaction sa
;
4108 if ((ret
= sigemptyset(&sigset
)) < 0) {
4109 perror("sigemptyset");
4113 sa
.sa_handler
= sighandler
;
4114 sa
.sa_mask
= sigset
;
4116 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4117 perror("sigaction");
4121 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4122 perror("sigaction");
4126 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4127 perror("sigaction");
4131 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4137 * Set open files limit to unlimited. This daemon can open a large number of
4138 * file descriptors in order to consumer multiple kernel traces.
4140 static void set_ulimit(void)
4145 /* The kernel does not allowed an infinite limit for open files */
4146 lim
.rlim_cur
= 65535;
4147 lim
.rlim_max
= 65535;
4149 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4151 perror("failed to set open files limit");
4158 int main(int argc
, char **argv
)
4162 const char *home_path
;
4164 rcu_register_thread();
4166 /* Create thread quit pipe */
4167 if ((ret
= init_thread_quit_pipe()) < 0) {
4171 setup_consumerd_path();
4173 /* Parse arguments */
4175 if ((ret
= parse_args(argc
, argv
) < 0)) {
4188 /* Check if daemon is UID = 0 */
4189 is_root
= !getuid();
4192 ret
= create_lttng_rundir();
4197 if (strlen(apps_unix_sock_path
) == 0) {
4198 snprintf(apps_unix_sock_path
, PATH_MAX
,
4199 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4202 if (strlen(client_unix_sock_path
) == 0) {
4203 snprintf(client_unix_sock_path
, PATH_MAX
,
4204 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4207 /* Set global SHM for ust */
4208 if (strlen(wait_shm_path
) == 0) {
4209 snprintf(wait_shm_path
, PATH_MAX
,
4210 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4213 home_path
= get_home_dir();
4214 if (home_path
== NULL
) {
4215 /* TODO: Add --socket PATH option */
4216 ERR("Can't get HOME directory for sockets creation.");
4221 if (strlen(apps_unix_sock_path
) == 0) {
4222 snprintf(apps_unix_sock_path
, PATH_MAX
,
4223 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4226 /* Set the cli tool unix socket path */
4227 if (strlen(client_unix_sock_path
) == 0) {
4228 snprintf(client_unix_sock_path
, PATH_MAX
,
4229 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4232 /* Set global SHM for ust */
4233 if (strlen(wait_shm_path
) == 0) {
4234 snprintf(wait_shm_path
, PATH_MAX
,
4235 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4239 DBG("Client socket path %s", client_unix_sock_path
);
4240 DBG("Application socket path %s", apps_unix_sock_path
);
4243 * See if daemon already exist.
4245 if ((ret
= check_existing_daemon()) < 0) {
4246 ERR("Already running daemon.\n");
4248 * We do not goto exit because we must not cleanup()
4249 * because a daemon is already running.
4254 /* After this point, we can safely call cleanup() with "goto exit" */
4257 * These actions must be executed as root. We do that *after* setting up
4258 * the sockets path because we MUST make the check for another daemon using
4259 * those paths *before* trying to set the kernel consumer sockets and init
4263 ret
= set_consumer_sockets(&kconsumer_data
);
4268 ret
= set_consumer_sockets(&ustconsumer64_data
);
4273 ret
= set_consumer_sockets(&ustconsumer32_data
);
4278 /* Setup kernel tracer */
4279 init_kernel_tracer();
4281 /* Set ulimit for open files */
4285 if ((ret
= set_signal_handler()) < 0) {
4289 /* Setup the needed unix socket */
4290 if ((ret
= init_daemon_socket()) < 0) {
4294 /* Set credentials to socket */
4295 if (is_root
&& ((ret
= set_permissions()) < 0)) {
4299 /* Get parent pid if -S, --sig-parent is specified. */
4300 if (opt_sig_parent
) {
4304 /* Setup the kernel pipe for waking up the kernel thread */
4305 if ((ret
= create_kernel_poll_pipe()) < 0) {
4309 /* Setup the thread apps communication pipe. */
4310 if ((ret
= create_apps_cmd_pipe()) < 0) {
4314 /* Init UST command queue. */
4315 cds_wfq_init(&ust_cmd_queue
.queue
);
4317 /* Init UST app hash table */
4321 * Get session list pointer. This pointer MUST NOT be free(). This list is
4322 * statically declared in session.c
4324 session_list_ptr
= session_get_list();
4326 /* Set up max poll set size */
4327 lttng_poll_set_max_size();
4329 /* Create thread to manage the client socket */
4330 ret
= pthread_create(&client_thread
, NULL
,
4331 thread_manage_clients
, (void *) NULL
);
4333 perror("pthread_create clients");
4337 /* Create thread to dispatch registration */
4338 ret
= pthread_create(&dispatch_thread
, NULL
,
4339 thread_dispatch_ust_registration
, (void *) NULL
);
4341 perror("pthread_create dispatch");
4345 /* Create thread to manage application registration. */
4346 ret
= pthread_create(®_apps_thread
, NULL
,
4347 thread_registration_apps
, (void *) NULL
);
4349 perror("pthread_create registration");
4353 /* Create thread to manage application socket */
4354 ret
= pthread_create(&apps_thread
, NULL
,
4355 thread_manage_apps
, (void *) NULL
);
4357 perror("pthread_create apps");
4361 /* Create kernel thread to manage kernel event */
4362 ret
= pthread_create(&kernel_thread
, NULL
,
4363 thread_manage_kernel
, (void *) NULL
);
4365 perror("pthread_create kernel");
4369 ret
= pthread_join(kernel_thread
, &status
);
4371 perror("pthread_join");
4372 goto error
; /* join error, exit without cleanup */
4376 ret
= pthread_join(apps_thread
, &status
);
4378 perror("pthread_join");
4379 goto error
; /* join error, exit without cleanup */
4383 ret
= pthread_join(reg_apps_thread
, &status
);
4385 perror("pthread_join");
4386 goto error
; /* join error, exit without cleanup */
4390 ret
= pthread_join(dispatch_thread
, &status
);
4392 perror("pthread_join");
4393 goto error
; /* join error, exit without cleanup */
4397 ret
= pthread_join(client_thread
, &status
);
4399 perror("pthread_join");
4400 goto error
; /* join error, exit without cleanup */
4403 ret
= join_consumer_thread(&kconsumer_data
);
4405 perror("join_consumer");
4406 goto error
; /* join error, exit without cleanup */
4412 * cleanup() is called when no other thread is running.
4414 rcu_thread_online();
4416 rcu_thread_offline();
4417 rcu_unregister_thread();