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 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
, "lttng-consumerd", 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
, "lttng-consumerd", 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
, struct ucred
*creds
)
1877 unsigned int sess_uid
;
1879 struct ltt_ust_session
*lus
= NULL
;
1881 switch (domain
->type
) {
1882 case LTTNG_DOMAIN_UST
:
1885 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1889 DBG("Creating UST session");
1891 sess_uid
= session
->uid
;
1892 lus
= trace_ust_create_session(session
->path
, sess_uid
, domain
);
1894 ret
= LTTCOMM_UST_SESS_FAIL
;
1899 * Get the right group ID. To use the tracing group, the daemon must be
1900 * running with root credentials or else it's the user GID used.
1902 gid
= allowed_group();
1903 if (gid
< 0 || !is_root
) {
1907 ret
= mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
, creds
->uid
, gid
);
1909 if (ret
!= -EEXIST
) {
1910 ERR("Trace directory creation error");
1911 ret
= LTTCOMM_UST_SESS_FAIL
;
1916 /* The domain type dictate different actions on session creation */
1917 switch (domain
->type
) {
1918 case LTTNG_DOMAIN_UST
:
1919 /* No ustctl for the global UST domain */
1922 ERR("Unknown UST domain on create session %d", domain
->type
);
1925 session
->ust_session
= lus
;
1935 * Create a kernel tracer session then create the default channel.
1937 static int create_kernel_session(struct ltt_session
*session
,
1938 struct ucred
*creds
)
1943 DBG("Creating kernel session");
1945 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1947 ret
= LTTCOMM_KERN_SESS_FAIL
;
1951 /* Set kernel consumer socket fd */
1952 if (kconsumer_data
.cmd_sock
) {
1953 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1956 gid
= allowed_group();
1959 * Use GID 0 has a fallback since kernel session is only allowed under
1960 * root or the gid of the calling user
1962 is_root
? (gid
= 0) : (gid
= creds
->gid
);
1965 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1966 S_IRWXU
| S_IRWXG
, creds
->uid
, gid
);
1968 if (ret
!= -EEXIST
) {
1969 ERR("Trace directory creation error");
1979 * Using the session list, filled a lttng_session array to send back to the
1980 * client for session listing.
1982 * The session list lock MUST be acquired before calling this function. Use
1983 * session_lock_list() and session_unlock_list().
1985 static void list_lttng_sessions(struct lttng_session
*sessions
)
1988 struct ltt_session
*session
;
1990 DBG("Getting all available session");
1992 * Iterate over session list and append data after the control struct in
1995 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1996 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1997 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1998 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1999 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2000 sessions
[i
].enabled
= session
->enabled
;
2006 * Fill lttng_channel array of all channels.
2008 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2009 struct lttng_channel
*channels
)
2012 struct ltt_kernel_channel
*kchan
;
2014 DBG("Listing channels for session %s", session
->name
);
2017 case LTTNG_DOMAIN_KERNEL
:
2018 /* Kernel channels */
2019 if (session
->kernel_session
!= NULL
) {
2020 cds_list_for_each_entry(kchan
,
2021 &session
->kernel_session
->channel_list
.head
, list
) {
2022 /* Copy lttng_channel struct to array */
2023 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2024 channels
[i
].enabled
= kchan
->enabled
;
2029 case LTTNG_DOMAIN_UST
:
2031 struct cds_lfht_iter iter
;
2032 struct ltt_ust_channel
*uchan
;
2034 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
2035 &iter
, uchan
, node
) {
2036 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2037 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2038 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2039 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2040 channels
[i
].attr
.switch_timer_interval
=
2041 uchan
->attr
.switch_timer_interval
;
2042 channels
[i
].attr
.read_timer_interval
=
2043 uchan
->attr
.read_timer_interval
;
2044 channels
[i
].enabled
= uchan
->enabled
;
2045 switch (uchan
->attr
.output
) {
2046 case LTTNG_UST_MMAP
:
2048 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2061 * Create a list of ust global domain events.
2063 static int list_lttng_ust_global_events(char *channel_name
,
2064 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2067 unsigned int nb_event
= 0;
2068 struct cds_lfht_iter iter
;
2069 struct cds_lfht_node
*node
;
2070 struct ltt_ust_channel
*uchan
;
2071 struct ltt_ust_event
*uevent
;
2072 struct lttng_event
*tmp
;
2074 DBG("Listing UST global events for channel %s", channel_name
);
2078 node
= hashtable_lookup(ust_global
->channels
, (void *) channel_name
,
2079 strlen(channel_name
), &iter
);
2081 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2085 uchan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
2087 nb_event
+= hashtable_get_count(uchan
->events
);
2089 if (nb_event
== 0) {
2094 DBG3("Listing UST global %d events", nb_event
);
2096 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2098 ret
= -LTTCOMM_FATAL
;
2102 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
2103 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2104 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2105 tmp
[i
].enabled
= uevent
->enabled
;
2106 switch (uevent
->attr
.instrumentation
) {
2107 case LTTNG_UST_TRACEPOINT
:
2108 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2110 case LTTNG_UST_PROBE
:
2111 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2113 case LTTNG_UST_FUNCTION
:
2114 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2116 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2117 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2132 * Fill lttng_event array of all kernel events in the channel.
2134 static int list_lttng_kernel_events(char *channel_name
,
2135 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2138 unsigned int nb_event
;
2139 struct ltt_kernel_event
*event
;
2140 struct ltt_kernel_channel
*kchan
;
2142 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2143 if (kchan
== NULL
) {
2144 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2148 nb_event
= kchan
->event_count
;
2150 DBG("Listing events for channel %s", kchan
->channel
->name
);
2152 if (nb_event
== 0) {
2157 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2158 if (*events
== NULL
) {
2159 ret
= LTTCOMM_FATAL
;
2163 /* Kernel channels */
2164 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2165 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2166 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2167 (*events
)[i
].enabled
= event
->enabled
;
2168 switch (event
->event
->instrumentation
) {
2169 case LTTNG_KERNEL_TRACEPOINT
:
2170 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2172 case LTTNG_KERNEL_KPROBE
:
2173 case LTTNG_KERNEL_KRETPROBE
:
2174 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2175 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2176 sizeof(struct lttng_kernel_kprobe
));
2178 case LTTNG_KERNEL_FUNCTION
:
2179 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2180 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2181 sizeof(struct lttng_kernel_function
));
2183 case LTTNG_KERNEL_NOOP
:
2184 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2186 case LTTNG_KERNEL_SYSCALL
:
2187 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2189 case LTTNG_KERNEL_ALL
:
2203 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2205 static int cmd_disable_channel(struct ltt_session
*session
,
2206 int domain
, char *channel_name
)
2209 struct ltt_ust_session
*usess
;
2211 usess
= session
->ust_session
;
2214 case LTTNG_DOMAIN_KERNEL
:
2216 ret
= channel_kernel_disable(session
->kernel_session
,
2218 if (ret
!= LTTCOMM_OK
) {
2222 kernel_wait_quiescent(kernel_tracer_fd
);
2225 case LTTNG_DOMAIN_UST
:
2227 struct ltt_ust_channel
*uchan
;
2228 struct cds_lfht
*chan_ht
;
2230 chan_ht
= usess
->domain_global
.channels
;
2232 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2233 if (uchan
== NULL
) {
2234 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2238 ret
= channel_ust_disable(usess
, domain
, uchan
);
2239 if (ret
!= LTTCOMM_OK
) {
2244 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2245 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2246 case LTTNG_DOMAIN_UST_PID
:
2247 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2250 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2261 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2263 static int cmd_enable_channel(struct ltt_session
*session
,
2264 int domain
, struct lttng_channel
*attr
)
2267 struct ltt_ust_session
*usess
= session
->ust_session
;
2268 struct cds_lfht
*chan_ht
;
2270 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2273 case LTTNG_DOMAIN_KERNEL
:
2275 struct ltt_kernel_channel
*kchan
;
2277 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2278 session
->kernel_session
);
2279 if (kchan
== NULL
) {
2280 ret
= channel_kernel_create(session
->kernel_session
,
2281 attr
, kernel_poll_pipe
[1]);
2283 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2286 if (ret
!= LTTCOMM_OK
) {
2290 kernel_wait_quiescent(kernel_tracer_fd
);
2293 case LTTNG_DOMAIN_UST
:
2295 struct ltt_ust_channel
*uchan
;
2297 chan_ht
= usess
->domain_global
.channels
;
2299 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2300 if (uchan
== NULL
) {
2301 ret
= channel_ust_create(usess
, domain
, attr
);
2303 ret
= channel_ust_enable(usess
, domain
, uchan
);
2307 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2308 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2309 case LTTNG_DOMAIN_UST_PID
:
2310 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2313 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2322 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2324 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2325 char *channel_name
, char *event_name
)
2330 case LTTNG_DOMAIN_KERNEL
:
2332 struct ltt_kernel_channel
*kchan
;
2333 struct ltt_kernel_session
*ksess
;
2335 ksess
= session
->kernel_session
;
2337 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2338 if (kchan
== NULL
) {
2339 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2343 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2344 if (ret
!= LTTCOMM_OK
) {
2348 kernel_wait_quiescent(kernel_tracer_fd
);
2351 case LTTNG_DOMAIN_UST
:
2353 struct ltt_ust_channel
*uchan
;
2354 struct ltt_ust_session
*usess
;
2356 usess
= session
->ust_session
;
2358 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2360 if (uchan
== NULL
) {
2361 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2365 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2366 if (ret
!= LTTCOMM_OK
) {
2370 DBG3("Disable UST event %s in channel %s completed", event_name
,
2374 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2375 case LTTNG_DOMAIN_UST_PID
:
2376 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2378 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2389 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2391 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2397 case LTTNG_DOMAIN_KERNEL
:
2399 struct ltt_kernel_session
*ksess
;
2400 struct ltt_kernel_channel
*kchan
;
2402 ksess
= session
->kernel_session
;
2404 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2405 if (kchan
== NULL
) {
2406 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2410 ret
= event_kernel_disable_all(ksess
, kchan
);
2411 if (ret
!= LTTCOMM_OK
) {
2415 kernel_wait_quiescent(kernel_tracer_fd
);
2418 case LTTNG_DOMAIN_UST
:
2420 struct ltt_ust_session
*usess
;
2421 struct ltt_ust_channel
*uchan
;
2423 usess
= session
->ust_session
;
2425 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2427 if (uchan
== NULL
) {
2428 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2432 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2437 DBG3("Disable all UST events in channel %s completed", channel_name
);
2441 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2442 case LTTNG_DOMAIN_UST_PID
:
2443 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2445 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2456 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2458 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2459 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2464 case LTTNG_DOMAIN_KERNEL
:
2465 /* Add kernel context to kernel tracer */
2466 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2467 event_name
, channel_name
);
2468 if (ret
!= LTTCOMM_OK
) {
2472 case LTTNG_DOMAIN_UST
:
2474 struct ltt_ust_session
*usess
= session
->ust_session
;
2476 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2477 if (ret
!= LTTCOMM_OK
) {
2482 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2483 case LTTNG_DOMAIN_UST_PID
:
2484 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2486 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2497 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2499 * TODO: currently, both events and loglevels are kept within the same
2500 * namespace for UST global registry/app registery, so if an event
2501 * happen to have the same name as the loglevel (very unlikely though),
2502 * and an attempt is made to enable/disable both in the same session,
2503 * the first to be created will be the only one allowed to exist.
2505 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2506 char *channel_name
, struct lttng_event
*event
)
2509 struct lttng_channel
*attr
;
2510 struct ltt_ust_session
*usess
= session
->ust_session
;
2513 case LTTNG_DOMAIN_KERNEL
:
2515 struct ltt_kernel_channel
*kchan
;
2517 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2518 session
->kernel_session
);
2519 if (kchan
== NULL
) {
2520 attr
= channel_new_default_attr(domain
);
2522 ret
= LTTCOMM_FATAL
;
2525 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2527 /* This call will notify the kernel thread */
2528 ret
= channel_kernel_create(session
->kernel_session
,
2529 attr
, kernel_poll_pipe
[1]);
2530 if (ret
!= LTTCOMM_OK
) {
2537 /* Get the newly created kernel channel pointer */
2538 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2539 session
->kernel_session
);
2540 if (kchan
== NULL
) {
2541 /* This sould not happen... */
2542 ret
= LTTCOMM_FATAL
;
2546 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2548 if (ret
!= LTTCOMM_OK
) {
2552 kernel_wait_quiescent(kernel_tracer_fd
);
2555 case LTTNG_DOMAIN_UST
:
2557 struct lttng_channel
*attr
;
2558 struct ltt_ust_channel
*uchan
;
2560 /* Get channel from global UST domain */
2561 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2563 if (uchan
== NULL
) {
2564 /* Create default channel */
2565 attr
= channel_new_default_attr(domain
);
2567 ret
= LTTCOMM_FATAL
;
2570 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2571 attr
->name
[NAME_MAX
- 1] = '\0';
2573 ret
= channel_ust_create(usess
, domain
, attr
);
2574 if (ret
!= LTTCOMM_OK
) {
2580 /* Get the newly created channel reference back */
2581 uchan
= trace_ust_find_channel_by_name(
2582 usess
->domain_global
.channels
, channel_name
);
2583 if (uchan
== NULL
) {
2584 /* Something is really wrong */
2585 ret
= LTTCOMM_FATAL
;
2590 /* At this point, the session and channel exist on the tracer */
2592 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2593 if (ret
!= LTTCOMM_OK
) {
2598 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2599 case LTTNG_DOMAIN_UST_PID
:
2600 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2602 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2613 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2615 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2616 char *channel_name
, int event_type
)
2619 struct ltt_kernel_channel
*kchan
;
2622 case LTTNG_DOMAIN_KERNEL
:
2623 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2624 session
->kernel_session
);
2625 if (kchan
== NULL
) {
2626 /* This call will notify the kernel thread */
2627 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2628 kernel_poll_pipe
[1]);
2629 if (ret
!= LTTCOMM_OK
) {
2633 /* Get the newly created kernel channel pointer */
2634 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2635 session
->kernel_session
);
2636 if (kchan
== NULL
) {
2637 /* This sould not happen... */
2638 ret
= LTTCOMM_FATAL
;
2644 switch (event_type
) {
2645 case LTTNG_EVENT_SYSCALL
:
2646 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2647 kchan
, kernel_tracer_fd
);
2649 case LTTNG_EVENT_TRACEPOINT
:
2651 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2652 * events already registered to the channel.
2654 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2655 kchan
, kernel_tracer_fd
);
2657 case LTTNG_EVENT_ALL
:
2658 /* Enable syscalls and tracepoints */
2659 ret
= event_kernel_enable_all(session
->kernel_session
,
2660 kchan
, kernel_tracer_fd
);
2663 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2667 /* Manage return value */
2668 if (ret
!= LTTCOMM_OK
) {
2672 kernel_wait_quiescent(kernel_tracer_fd
);
2674 case LTTNG_DOMAIN_UST
:
2676 struct lttng_channel
*attr
;
2677 struct ltt_ust_channel
*uchan
;
2678 struct ltt_ust_session
*usess
= session
->ust_session
;
2680 /* Get channel from global UST domain */
2681 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2683 if (uchan
== NULL
) {
2684 /* Create default channel */
2685 attr
= channel_new_default_attr(domain
);
2687 ret
= LTTCOMM_FATAL
;
2690 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2691 attr
->name
[NAME_MAX
- 1] = '\0';
2693 /* Use the internal command enable channel */
2694 ret
= channel_ust_create(usess
, domain
, attr
);
2695 if (ret
!= LTTCOMM_OK
) {
2701 /* Get the newly created channel reference back */
2702 uchan
= trace_ust_find_channel_by_name(
2703 usess
->domain_global
.channels
, channel_name
);
2704 if (uchan
== NULL
) {
2705 /* Something is really wrong */
2706 ret
= LTTCOMM_FATAL
;
2711 /* At this point, the session and channel exist on the tracer */
2713 switch (event_type
) {
2714 case LTTNG_EVENT_ALL
:
2715 case LTTNG_EVENT_TRACEPOINT
:
2716 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2717 if (ret
!= LTTCOMM_OK
) {
2722 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2726 /* Manage return value */
2727 if (ret
!= LTTCOMM_OK
) {
2733 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2734 case LTTNG_DOMAIN_UST_PID
:
2735 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2737 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2748 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2750 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2753 ssize_t nb_events
= 0;
2756 case LTTNG_DOMAIN_KERNEL
:
2757 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2758 if (nb_events
< 0) {
2759 ret
= LTTCOMM_KERN_LIST_FAIL
;
2763 case LTTNG_DOMAIN_UST
:
2764 nb_events
= ust_app_list_events(events
);
2765 if (nb_events
< 0) {
2766 ret
= LTTCOMM_UST_LIST_FAIL
;
2771 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2778 /* Return negative value to differentiate return code */
2783 * Command LTTNG_START_TRACE processed by the client thread.
2785 static int cmd_start_trace(struct ltt_session
*session
)
2788 struct ltt_kernel_session
*ksession
;
2789 struct ltt_ust_session
*usess
;
2792 ksession
= session
->kernel_session
;
2793 usess
= session
->ust_session
;
2795 if (session
->enabled
) {
2796 ret
= LTTCOMM_UST_START_FAIL
;
2800 session
->enabled
= 1;
2802 /* Kernel tracing */
2803 if (ksession
!= NULL
) {
2804 struct ltt_kernel_channel
*kchan
;
2806 /* Open kernel metadata */
2807 if (ksession
->metadata
== NULL
) {
2808 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2810 ret
= LTTCOMM_KERN_META_FAIL
;
2815 /* Open kernel metadata stream */
2816 if (ksession
->metadata_stream_fd
== 0) {
2817 ret
= kernel_open_metadata_stream(ksession
);
2819 ERR("Kernel create metadata stream failed");
2820 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2825 /* For each channel */
2826 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2827 if (kchan
->stream_count
== 0) {
2828 ret
= kernel_open_channel_stream(kchan
);
2830 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2833 /* Update the stream global counter */
2834 ksession
->stream_count_global
+= ret
;
2838 /* Setup kernel consumer socket and send fds to it */
2839 ret
= init_kernel_tracing(ksession
);
2841 ret
= LTTCOMM_KERN_START_FAIL
;
2845 /* This start the kernel tracing */
2846 ret
= kernel_start_session(ksession
);
2848 ret
= LTTCOMM_KERN_START_FAIL
;
2852 /* Quiescent wait after starting trace */
2853 kernel_wait_quiescent(kernel_tracer_fd
);
2856 /* Flag session that trace should start automatically */
2858 usess
->start_trace
= 1;
2860 ret
= ust_app_start_trace_all(usess
);
2862 ret
= LTTCOMM_UST_START_FAIL
;
2874 * Command LTTNG_STOP_TRACE processed by the client thread.
2876 static int cmd_stop_trace(struct ltt_session
*session
)
2879 struct ltt_kernel_channel
*kchan
;
2880 struct ltt_kernel_session
*ksession
;
2881 struct ltt_ust_session
*usess
;
2884 ksession
= session
->kernel_session
;
2885 usess
= session
->ust_session
;
2887 if (!session
->enabled
) {
2888 ret
= LTTCOMM_UST_START_FAIL
;
2892 session
->enabled
= 0;
2895 if (ksession
!= NULL
) {
2896 DBG("Stop kernel tracing");
2898 /* Flush all buffers before stopping */
2899 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2901 ERR("Kernel metadata flush failed");
2904 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2905 ret
= kernel_flush_buffer(kchan
);
2907 ERR("Kernel flush buffer error");
2911 ret
= kernel_stop_session(ksession
);
2913 ret
= LTTCOMM_KERN_STOP_FAIL
;
2917 kernel_wait_quiescent(kernel_tracer_fd
);
2921 usess
->start_trace
= 0;
2923 ret
= ust_app_stop_trace_all(usess
);
2925 ret
= LTTCOMM_UST_START_FAIL
;
2937 * Command LTTNG_CREATE_SESSION processed by the client thread.
2939 static int cmd_create_session(char *name
, char *path
)
2943 ret
= session_create(name
, path
);
2944 if (ret
!= LTTCOMM_OK
) {
2955 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2957 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2961 /* Clean kernel session teardown */
2962 teardown_kernel_session(session
);
2963 /* UST session teardown */
2964 teardown_ust_session(session
);
2967 * Must notify the kernel thread here to update it's poll setin order
2968 * to remove the channel(s)' fd just destroyed.
2970 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2972 perror("write kernel poll pipe");
2975 ret
= session_destroy(session
);
2981 * Command LTTNG_CALIBRATE processed by the client thread.
2983 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2988 case LTTNG_DOMAIN_KERNEL
:
2990 struct lttng_kernel_calibrate kcalibrate
;
2992 kcalibrate
.type
= calibrate
->type
;
2993 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2995 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3001 /* TODO: Userspace tracing */
3002 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3013 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3015 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3021 case LTTNG_DOMAIN_KERNEL
:
3022 /* Can't register a consumer if there is already one */
3023 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3024 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3028 sock
= lttcomm_connect_unix_sock(sock_path
);
3030 ret
= LTTCOMM_CONNECT_FAIL
;
3034 session
->kernel_session
->consumer_fd
= sock
;
3037 /* TODO: Userspace tracing */
3038 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3049 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3051 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3052 struct lttng_domain
**domains
)
3057 if (session
->kernel_session
!= NULL
) {
3058 DBG3("Listing domains found kernel domain");
3062 if (session
->ust_session
!= NULL
) {
3063 DBG3("Listing domains found UST global domain");
3067 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3068 if (*domains
== NULL
) {
3069 ret
= -LTTCOMM_FATAL
;
3073 if (session
->kernel_session
!= NULL
) {
3074 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3078 if (session
->ust_session
!= NULL
) {
3079 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3090 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3092 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3093 struct lttng_channel
**channels
)
3096 ssize_t nb_chan
= 0;
3099 case LTTNG_DOMAIN_KERNEL
:
3100 if (session
->kernel_session
!= NULL
) {
3101 nb_chan
= session
->kernel_session
->channel_count
;
3103 DBG3("Number of kernel channels %zd", nb_chan
);
3105 case LTTNG_DOMAIN_UST
:
3106 if (session
->ust_session
!= NULL
) {
3107 nb_chan
= hashtable_get_count(
3108 session
->ust_session
->domain_global
.channels
);
3110 DBG3("Number of UST global channels %zd", nb_chan
);
3114 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3119 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3120 if (*channels
== NULL
) {
3121 ret
= -LTTCOMM_FATAL
;
3125 list_lttng_channels(domain
, session
, *channels
);
3137 * Command LTTNG_LIST_EVENTS processed by the client thread.
3139 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3140 char *channel_name
, struct lttng_event
**events
)
3143 ssize_t nb_event
= 0;
3146 case LTTNG_DOMAIN_KERNEL
:
3147 if (session
->kernel_session
!= NULL
) {
3148 nb_event
= list_lttng_kernel_events(channel_name
,
3149 session
->kernel_session
, events
);
3152 case LTTNG_DOMAIN_UST
:
3154 if (session
->ust_session
!= NULL
) {
3155 nb_event
= list_lttng_ust_global_events(channel_name
,
3156 &session
->ust_session
->domain_global
, events
);
3161 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3172 * Process the command requested by the lttng client within the command
3173 * context structure. This function make sure that the return structure (llm)
3174 * is set and ready for transmission before returning.
3176 * Return any error encountered or 0 for success.
3178 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3180 int ret
= LTTCOMM_OK
;
3181 int need_tracing_session
= 1;
3183 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3185 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3186 ret
= LTTCOMM_KERN_NA
;
3191 * Check for command that don't needs to allocate a returned payload. We do
3192 * this here so we don't have to make the call for no payload at each
3195 switch(cmd_ctx
->lsm
->cmd_type
) {
3196 case LTTNG_LIST_SESSIONS
:
3197 case LTTNG_LIST_TRACEPOINTS
:
3198 case LTTNG_LIST_DOMAINS
:
3199 case LTTNG_LIST_CHANNELS
:
3200 case LTTNG_LIST_EVENTS
:
3203 /* Setup lttng message with no payload */
3204 ret
= setup_lttng_msg(cmd_ctx
, 0);
3206 /* This label does not try to unlock the session */
3207 goto init_setup_error
;
3211 /* Commands that DO NOT need a session. */
3212 switch (cmd_ctx
->lsm
->cmd_type
) {
3213 case LTTNG_CALIBRATE
:
3214 case LTTNG_CREATE_SESSION
:
3215 case LTTNG_LIST_SESSIONS
:
3216 case LTTNG_LIST_TRACEPOINTS
:
3217 need_tracing_session
= 0;
3220 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3221 session_lock_list();
3222 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3223 session_unlock_list();
3224 if (cmd_ctx
->session
== NULL
) {
3225 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3226 ret
= LTTCOMM_SESS_NOT_FOUND
;
3228 /* If no session name specified */
3229 ret
= LTTCOMM_SELECT_SESS
;
3233 /* Acquire lock for the session */
3234 session_lock(cmd_ctx
->session
);
3240 * Check domain type for specific "pre-action".
3242 switch (cmd_ctx
->lsm
->domain
.type
) {
3243 case LTTNG_DOMAIN_KERNEL
:
3244 /* Kernel tracer check */
3245 if (kernel_tracer_fd
== 0) {
3246 /* Basically, load kernel tracer modules */
3247 init_kernel_tracer();
3248 if (kernel_tracer_fd
== 0) {
3249 ret
= LTTCOMM_KERN_NA
;
3254 /* Need a session for kernel command */
3255 if (need_tracing_session
) {
3256 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3257 ret
= create_kernel_session(cmd_ctx
->session
, &cmd_ctx
->creds
);
3259 ret
= LTTCOMM_KERN_SESS_FAIL
;
3264 /* Start the kernel consumer daemon */
3265 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3266 if (kconsumer_data
.pid
== 0 &&
3267 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3268 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3269 ret
= start_consumerd(&kconsumer_data
);
3271 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3275 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3279 case LTTNG_DOMAIN_UST
:
3281 if (need_tracing_session
) {
3282 if (cmd_ctx
->session
->ust_session
== NULL
) {
3283 ret
= create_ust_session(cmd_ctx
->session
,
3284 &cmd_ctx
->lsm
->domain
, &cmd_ctx
->creds
);
3285 if (ret
!= LTTCOMM_OK
) {
3289 /* Start the UST consumer daemons */
3291 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3292 if (consumerd64_bin
[0] != '\0' &&
3293 ustconsumer64_data
.pid
== 0 &&
3294 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3295 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3296 ret
= start_consumerd(&ustconsumer64_data
);
3298 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3299 ust_consumerd64_fd
= -EINVAL
;
3303 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3305 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3308 if (consumerd32_bin
[0] != '\0' &&
3309 ustconsumer32_data
.pid
== 0 &&
3310 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3311 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3312 ret
= start_consumerd(&ustconsumer32_data
);
3314 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3315 ust_consumerd32_fd
= -EINVAL
;
3318 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3320 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3329 /* Process by command type */
3330 switch (cmd_ctx
->lsm
->cmd_type
) {
3331 case LTTNG_ADD_CONTEXT
:
3333 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3334 cmd_ctx
->lsm
->u
.context
.channel_name
,
3335 cmd_ctx
->lsm
->u
.context
.event_name
,
3336 &cmd_ctx
->lsm
->u
.context
.ctx
);
3339 case LTTNG_DISABLE_CHANNEL
:
3341 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3342 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3345 case LTTNG_DISABLE_EVENT
:
3347 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3348 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3349 cmd_ctx
->lsm
->u
.disable
.name
);
3353 case LTTNG_DISABLE_ALL_EVENT
:
3355 DBG("Disabling all events");
3357 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3358 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3361 case LTTNG_ENABLE_CHANNEL
:
3363 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3364 &cmd_ctx
->lsm
->u
.channel
.chan
);
3367 case LTTNG_ENABLE_EVENT
:
3369 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3370 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3371 &cmd_ctx
->lsm
->u
.enable
.event
);
3374 case LTTNG_ENABLE_ALL_EVENT
:
3376 DBG("Enabling all events");
3378 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3379 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3380 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3383 case LTTNG_LIST_TRACEPOINTS
:
3385 struct lttng_event
*events
;
3388 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3389 if (nb_events
< 0) {
3395 * Setup lttng message with payload size set to the event list size in
3396 * bytes and then copy list into the llm payload.
3398 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3404 /* Copy event list into message payload */
3405 memcpy(cmd_ctx
->llm
->payload
, events
,
3406 sizeof(struct lttng_event
) * nb_events
);
3413 case LTTNG_START_TRACE
:
3415 ret
= cmd_start_trace(cmd_ctx
->session
);
3418 case LTTNG_STOP_TRACE
:
3420 ret
= cmd_stop_trace(cmd_ctx
->session
);
3423 case LTTNG_CREATE_SESSION
:
3425 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3426 cmd_ctx
->lsm
->session
.path
);
3429 case LTTNG_DESTROY_SESSION
:
3431 ret
= cmd_destroy_session(cmd_ctx
->session
,
3432 cmd_ctx
->lsm
->session
.name
);
3435 case LTTNG_LIST_DOMAINS
:
3438 struct lttng_domain
*domains
;
3440 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3446 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3451 /* Copy event list into message payload */
3452 memcpy(cmd_ctx
->llm
->payload
, domains
,
3453 nb_dom
* sizeof(struct lttng_domain
));
3460 case LTTNG_LIST_CHANNELS
:
3463 struct lttng_channel
*channels
;
3465 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3466 cmd_ctx
->session
, &channels
);
3472 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3477 /* Copy event list into message payload */
3478 memcpy(cmd_ctx
->llm
->payload
, channels
,
3479 nb_chan
* sizeof(struct lttng_channel
));
3486 case LTTNG_LIST_EVENTS
:
3489 struct lttng_event
*events
= NULL
;
3491 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3492 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3498 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3503 /* Copy event list into message payload */
3504 memcpy(cmd_ctx
->llm
->payload
, events
,
3505 nb_event
* sizeof(struct lttng_event
));
3512 case LTTNG_LIST_SESSIONS
:
3514 session_lock_list();
3516 if (session_list_ptr
->count
== 0) {
3517 ret
= LTTCOMM_NO_SESSION
;
3518 session_unlock_list();
3522 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3523 session_list_ptr
->count
);
3525 session_unlock_list();
3529 /* Filled the session array */
3530 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3532 session_unlock_list();
3537 case LTTNG_CALIBRATE
:
3539 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3540 &cmd_ctx
->lsm
->u
.calibrate
);
3543 case LTTNG_REGISTER_CONSUMER
:
3545 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3546 cmd_ctx
->lsm
->u
.reg
.path
);
3555 if (cmd_ctx
->llm
== NULL
) {
3556 DBG("Missing llm structure. Allocating one.");
3557 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3561 /* Set return code */
3562 cmd_ctx
->llm
->ret_code
= ret
;
3564 if (cmd_ctx
->session
) {
3565 session_unlock(cmd_ctx
->session
);
3572 * This thread manage all clients request using the unix client socket for
3575 static void *thread_manage_clients(void *data
)
3577 int sock
= 0, ret
, i
, pollfd
;
3578 uint32_t revents
, nb_fd
;
3579 struct command_ctx
*cmd_ctx
= NULL
;
3580 struct lttng_poll_event events
;
3582 DBG("[thread] Manage client started");
3584 rcu_register_thread();
3586 ret
= lttcomm_listen_unix_sock(client_sock
);
3592 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3593 * more will be added to this poll set.
3595 ret
= create_thread_poll_set(&events
, 2);
3600 /* Add the application registration socket */
3601 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3607 * Notify parent pid that we are ready to accept command for client side.
3609 if (opt_sig_parent
) {
3610 kill(ppid
, SIGCHLD
);
3614 DBG("Accepting client command ...");
3616 nb_fd
= LTTNG_POLL_GETNB(&events
);
3618 /* Inifinite blocking call, waiting for transmission */
3619 ret
= lttng_poll_wait(&events
, -1);
3624 for (i
= 0; i
< nb_fd
; i
++) {
3625 /* Fetch once the poll data */
3626 revents
= LTTNG_POLL_GETEV(&events
, i
);
3627 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3629 /* Thread quit pipe has been closed. Killing thread. */
3630 ret
= check_thread_quit_pipe(pollfd
, revents
);
3635 /* Event on the registration socket */
3636 if (pollfd
== client_sock
) {
3637 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3638 ERR("Client socket poll error");
3644 DBG("Wait for client response");
3646 sock
= lttcomm_accept_unix_sock(client_sock
);
3651 /* Set socket option for credentials retrieval */
3652 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3657 /* Allocate context command to process the client request */
3658 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3659 if (cmd_ctx
== NULL
) {
3660 perror("zmalloc cmd_ctx");
3664 /* Allocate data buffer for reception */
3665 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3666 if (cmd_ctx
->lsm
== NULL
) {
3667 perror("zmalloc cmd_ctx->lsm");
3671 cmd_ctx
->llm
= NULL
;
3672 cmd_ctx
->session
= NULL
;
3675 * Data is received from the lttng client. The struct
3676 * lttcomm_session_msg (lsm) contains the command and data request of
3679 DBG("Receiving data from client ...");
3680 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3681 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3683 DBG("Nothing recv() from client... continuing");
3689 // TODO: Validate cmd_ctx including sanity check for
3690 // security purpose.
3692 rcu_thread_online();
3694 * This function dispatch the work to the kernel or userspace tracer
3695 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3696 * informations for the client. The command context struct contains
3697 * everything this function may needs.
3699 ret
= process_client_msg(cmd_ctx
);
3700 rcu_thread_offline();
3703 * TODO: Inform client somehow of the fatal error. At
3704 * this point, ret < 0 means that a zmalloc failed
3705 * (ENOMEM). Error detected but still accept command.
3707 clean_command_ctx(&cmd_ctx
);
3711 DBG("Sending response (size: %d, retcode: %s)",
3712 cmd_ctx
->lttng_msg_size
,
3713 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3714 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3716 ERR("Failed to send data back to client");
3719 /* End of transmission */
3722 clean_command_ctx(&cmd_ctx
);
3726 DBG("Client thread dying");
3727 unlink(client_unix_sock_path
);
3731 lttng_poll_clean(&events
);
3732 clean_command_ctx(&cmd_ctx
);
3734 rcu_unregister_thread();
3740 * usage function on stderr
3742 static void usage(void)
3744 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3745 fprintf(stderr
, " -h, --help Display this usage.\n");
3746 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3747 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3748 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3749 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3750 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3751 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3752 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3753 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3754 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3755 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3756 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3757 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3758 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3759 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3760 fprintf(stderr
, " -V, --version Show version number.\n");
3761 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3762 fprintf(stderr
, " -q, --quiet No output at all.\n");
3763 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3764 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3765 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3769 * daemon argument parsing
3771 static int parse_args(int argc
, char **argv
)
3775 static struct option long_options
[] = {
3776 { "client-sock", 1, 0, 'c' },
3777 { "apps-sock", 1, 0, 'a' },
3778 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3779 { "kconsumerd-err-sock", 1, 0, 'E' },
3780 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3781 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3782 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3783 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3784 { "consumerd32-path", 1, 0, 'u' },
3785 { "consumerd32-libdir", 1, 0, 'U' },
3786 { "consumerd64-path", 1, 0, 't' },
3787 { "consumerd64-libdir", 1, 0, 'T' },
3788 { "daemonize", 0, 0, 'd' },
3789 { "sig-parent", 0, 0, 'S' },
3790 { "help", 0, 0, 'h' },
3791 { "group", 1, 0, 'g' },
3792 { "version", 0, 0, 'V' },
3793 { "quiet", 0, 0, 'q' },
3794 { "verbose", 0, 0, 'v' },
3795 { "verbose-consumer", 0, 0, 'Z' },
3796 { "no-kernel", 0, 0, 'N' },
3801 int option_index
= 0;
3802 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3803 long_options
, &option_index
);
3810 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3812 fprintf(stderr
, " with arg %s\n", optarg
);
3816 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3819 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3825 opt_tracing_group
= optarg
;
3831 fprintf(stdout
, "%s\n", VERSION
);
3837 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3840 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3843 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3846 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3849 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3852 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3861 /* Verbose level can increase using multiple -v */
3865 opt_verbose_consumer
+= 1;
3868 consumerd32_bin
= optarg
;
3871 consumerd32_libdir
= optarg
;
3874 consumerd64_bin
= optarg
;
3877 consumerd64_libdir
= optarg
;
3880 /* Unknown option or other error.
3881 * Error is printed by getopt, just return */
3890 * Creates the two needed socket by the daemon.
3891 * apps_sock - The communication socket for all UST apps.
3892 * client_sock - The communication of the cli tool (lttng).
3894 static int init_daemon_socket(void)
3899 old_umask
= umask(0);
3901 /* Create client tool unix socket */
3902 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3903 if (client_sock
< 0) {
3904 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3909 /* File permission MUST be 660 */
3910 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3912 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3917 /* Create the application unix socket */
3918 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3919 if (apps_sock
< 0) {
3920 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3925 /* File permission MUST be 666 */
3926 ret
= chmod(apps_unix_sock_path
,
3927 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3929 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3940 * Check if the global socket is available, and if a daemon is answering at the
3941 * other side. If yes, error is returned.
3943 static int check_existing_daemon(void)
3945 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3946 access(apps_unix_sock_path
, F_OK
) < 0) {
3950 /* Is there anybody out there ? */
3951 if (lttng_session_daemon_alive()) {
3959 * Set the tracing group gid onto the client socket.
3961 * Race window between mkdir and chown is OK because we are going from more
3962 * permissive (root.root) to les permissive (root.tracing).
3964 static int set_permissions(char *rundir
)
3969 gid
= allowed_group();
3971 WARN("No tracing group detected");
3976 /* Set lttng run dir */
3977 ret
= chown(rundir
, 0, gid
);
3979 ERR("Unable to set group on %s", rundir
);
3983 /* lttng client socket path */
3984 ret
= chown(client_unix_sock_path
, 0, gid
);
3986 ERR("Unable to set group on %s", client_unix_sock_path
);
3990 /* kconsumer error socket path */
3991 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3993 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3997 /* 64-bit ustconsumer error socket path */
3998 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4000 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4004 /* 32-bit ustconsumer compat32 error socket path */
4005 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4007 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4011 DBG("All permissions are set");
4018 * Create the pipe used to wake up the kernel thread.
4020 static int create_kernel_poll_pipe(void)
4022 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4026 * Create the application command pipe to wake thread_manage_apps.
4028 static int create_apps_cmd_pipe(void)
4030 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4034 * Create the lttng run directory needed for all global sockets and pipe.
4036 static int create_lttng_rundir(const char *rundir
)
4040 DBG3("Creating LTTng run directory: %s", rundir
);
4042 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4044 if (errno
!= EEXIST
) {
4045 ERR("Unable to create %s", rundir
);
4057 * Setup sockets and directory needed by the kconsumerd communication with the
4060 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4064 char path
[PATH_MAX
];
4066 switch (consumer_data
->type
) {
4067 case LTTNG_CONSUMER_KERNEL
:
4068 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4070 case LTTNG_CONSUMER64_UST
:
4071 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4073 case LTTNG_CONSUMER32_UST
:
4074 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4077 ERR("Consumer type unknown");
4082 DBG2("Creating consumer directory: %s", path
);
4084 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4086 if (errno
!= EEXIST
) {
4087 ERR("Failed to create %s", path
);
4093 /* Create the kconsumerd error unix socket */
4094 consumer_data
->err_sock
=
4095 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4096 if (consumer_data
->err_sock
< 0) {
4097 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4102 /* File permission MUST be 660 */
4103 ret
= chmod(consumer_data
->err_unix_sock_path
,
4104 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4106 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4116 * Signal handler for the daemon
4118 * Simply stop all worker threads, leaving main() return gracefully after
4119 * joining all threads and calling cleanup().
4121 static void sighandler(int sig
)
4125 DBG("SIGPIPE catched");
4128 DBG("SIGINT catched");
4132 DBG("SIGTERM catched");
4141 * Setup signal handler for :
4142 * SIGINT, SIGTERM, SIGPIPE
4144 static int set_signal_handler(void)
4147 struct sigaction sa
;
4150 if ((ret
= sigemptyset(&sigset
)) < 0) {
4151 perror("sigemptyset");
4155 sa
.sa_handler
= sighandler
;
4156 sa
.sa_mask
= sigset
;
4158 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4159 perror("sigaction");
4163 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4164 perror("sigaction");
4168 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4169 perror("sigaction");
4173 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4179 * Set open files limit to unlimited. This daemon can open a large number of
4180 * file descriptors in order to consumer multiple kernel traces.
4182 static void set_ulimit(void)
4187 /* The kernel does not allowed an infinite limit for open files */
4188 lim
.rlim_cur
= 65535;
4189 lim
.rlim_max
= 65535;
4191 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4193 perror("failed to set open files limit");
4200 int main(int argc
, char **argv
)
4204 const char *home_path
;
4206 rcu_register_thread();
4208 /* Create thread quit pipe */
4209 if ((ret
= init_thread_quit_pipe()) < 0) {
4213 setup_consumerd_path();
4215 /* Parse arguments */
4217 if ((ret
= parse_args(argc
, argv
) < 0)) {
4230 /* Check if daemon is UID = 0 */
4231 is_root
= !getuid();
4234 rundir
= strdup(LTTNG_RUNDIR
);
4236 /* Create global run dir with root access */
4237 ret
= create_lttng_rundir(rundir
);
4242 if (strlen(apps_unix_sock_path
) == 0) {
4243 snprintf(apps_unix_sock_path
, PATH_MAX
,
4244 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4247 if (strlen(client_unix_sock_path
) == 0) {
4248 snprintf(client_unix_sock_path
, PATH_MAX
,
4249 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4252 /* Set global SHM for ust */
4253 if (strlen(wait_shm_path
) == 0) {
4254 snprintf(wait_shm_path
, PATH_MAX
,
4255 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4258 /* Setup kernel consumerd path */
4259 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4260 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4261 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4262 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4264 DBG2("Kernel consumer err path: %s",
4265 kconsumer_data
.err_unix_sock_path
);
4266 DBG2("Kernel consumer cmd path: %s",
4267 kconsumer_data
.cmd_unix_sock_path
);
4269 home_path
= get_home_dir();
4270 if (home_path
== NULL
) {
4271 /* TODO: Add --socket PATH option */
4272 ERR("Can't get HOME directory for sockets creation.");
4278 * Create rundir from home path. This will create something like
4281 ret
= asprintf(&rundir
, LTTNG_HOME_RUNDIR
, home_path
);
4287 ret
= create_lttng_rundir(rundir
);
4292 if (strlen(apps_unix_sock_path
) == 0) {
4293 snprintf(apps_unix_sock_path
, PATH_MAX
,
4294 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4297 /* Set the cli tool unix socket path */
4298 if (strlen(client_unix_sock_path
) == 0) {
4299 snprintf(client_unix_sock_path
, PATH_MAX
,
4300 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4303 /* Set global SHM for ust */
4304 if (strlen(wait_shm_path
) == 0) {
4305 snprintf(wait_shm_path
, PATH_MAX
,
4306 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4310 DBG("Client socket path %s", client_unix_sock_path
);
4311 DBG("Application socket path %s", apps_unix_sock_path
);
4312 DBG("LTTng run directory path: %s", rundir
);
4314 /* 32 bits consumerd path setup */
4315 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4316 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4317 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4318 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4320 DBG2("UST consumer 32 bits err path: %s",
4321 ustconsumer32_data
.err_unix_sock_path
);
4322 DBG2("UST consumer 32 bits cmd path: %s",
4323 ustconsumer32_data
.cmd_unix_sock_path
);
4325 /* 64 bits consumerd path setup */
4326 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4327 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4328 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4329 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4331 DBG2("UST consumer 64 bits err path: %s",
4332 ustconsumer64_data
.err_unix_sock_path
);
4333 DBG2("UST consumer 64 bits cmd path: %s",
4334 ustconsumer64_data
.cmd_unix_sock_path
);
4337 * See if daemon already exist.
4339 if ((ret
= check_existing_daemon()) < 0) {
4340 ERR("Already running daemon.\n");
4342 * We do not goto exit because we must not cleanup()
4343 * because a daemon is already running.
4348 /* After this point, we can safely call cleanup() with "goto exit" */
4351 * These actions must be executed as root. We do that *after* setting up
4352 * the sockets path because we MUST make the check for another daemon using
4353 * those paths *before* trying to set the kernel consumer sockets and init
4357 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4362 /* Setup kernel tracer */
4363 if (!opt_no_kernel
) {
4364 init_kernel_tracer();
4367 /* Set ulimit for open files */
4371 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4376 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4381 if ((ret
= set_signal_handler()) < 0) {
4385 /* Setup the needed unix socket */
4386 if ((ret
= init_daemon_socket()) < 0) {
4390 /* Set credentials to socket */
4391 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4395 /* Get parent pid if -S, --sig-parent is specified. */
4396 if (opt_sig_parent
) {
4400 /* Setup the kernel pipe for waking up the kernel thread */
4401 if ((ret
= create_kernel_poll_pipe()) < 0) {
4405 /* Setup the thread apps communication pipe. */
4406 if ((ret
= create_apps_cmd_pipe()) < 0) {
4410 /* Init UST command queue. */
4411 cds_wfq_init(&ust_cmd_queue
.queue
);
4413 /* Init UST app hash table */
4417 * Get session list pointer. This pointer MUST NOT be free(). This list is
4418 * statically declared in session.c
4420 session_list_ptr
= session_get_list();
4422 /* Set up max poll set size */
4423 lttng_poll_set_max_size();
4425 /* Create thread to manage the client socket */
4426 ret
= pthread_create(&client_thread
, NULL
,
4427 thread_manage_clients
, (void *) NULL
);
4429 perror("pthread_create clients");
4433 /* Create thread to dispatch registration */
4434 ret
= pthread_create(&dispatch_thread
, NULL
,
4435 thread_dispatch_ust_registration
, (void *) NULL
);
4437 perror("pthread_create dispatch");
4441 /* Create thread to manage application registration. */
4442 ret
= pthread_create(®_apps_thread
, NULL
,
4443 thread_registration_apps
, (void *) NULL
);
4445 perror("pthread_create registration");
4449 /* Create thread to manage application socket */
4450 ret
= pthread_create(&apps_thread
, NULL
,
4451 thread_manage_apps
, (void *) NULL
);
4453 perror("pthread_create apps");
4457 /* Create kernel thread to manage kernel event */
4458 ret
= pthread_create(&kernel_thread
, NULL
,
4459 thread_manage_kernel
, (void *) NULL
);
4461 perror("pthread_create kernel");
4465 ret
= pthread_join(kernel_thread
, &status
);
4467 perror("pthread_join");
4468 goto error
; /* join error, exit without cleanup */
4472 ret
= pthread_join(apps_thread
, &status
);
4474 perror("pthread_join");
4475 goto error
; /* join error, exit without cleanup */
4479 ret
= pthread_join(reg_apps_thread
, &status
);
4481 perror("pthread_join");
4482 goto error
; /* join error, exit without cleanup */
4486 ret
= pthread_join(dispatch_thread
, &status
);
4488 perror("pthread_join");
4489 goto error
; /* join error, exit without cleanup */
4493 ret
= pthread_join(client_thread
, &status
);
4495 perror("pthread_join");
4496 goto error
; /* join error, exit without cleanup */
4499 ret
= join_consumer_thread(&kconsumer_data
);
4501 perror("join_consumer");
4502 goto error
; /* join error, exit without cleanup */
4508 * cleanup() is called when no other thread is running.
4510 rcu_thread_online();
4512 rcu_thread_offline();
4513 rcu_unregister_thread();