2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <lttng-consumerd.h>
43 #include <lttng-sessiond-comm.h>
44 #include <lttng/lttng-consumer.h>
47 #include "common/runas.h"
50 #include "compat/poll.h"
55 #include "lttng-sessiond.h"
61 #define CONSUMERD_FILE "lttng-consumerd"
63 struct consumer_data
{
64 enum lttng_consumer_type type
;
66 pthread_t thread
; /* Worker thread interacting with the consumer */
69 /* Mutex to control consumerd pid assignation */
70 pthread_mutex_t pid_mutex
;
76 /* consumer error and command Unix socket path */
77 char err_unix_sock_path
[PATH_MAX
];
78 char cmd_unix_sock_path
[PATH_MAX
];
82 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
83 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
84 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
85 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
88 int opt_verbose
; /* Not static for lttngerr.h */
89 int opt_verbose_consumer
; /* Not static for lttngerr.h */
90 int opt_quiet
; /* Not static for lttngerr.h */
93 const char *opt_tracing_group
;
94 static int opt_sig_parent
;
95 static int opt_daemon
;
96 static int opt_no_kernel
;
97 static int is_root
; /* Set to 1 if the daemon is running as root */
98 static pid_t ppid
; /* Parent PID for --sig-parent option */
101 /* Consumer daemon specific control data */
102 static struct consumer_data kconsumer_data
= {
103 .type
= LTTNG_CONSUMER_KERNEL
,
104 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
105 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
107 static struct consumer_data ustconsumer64_data
= {
108 .type
= LTTNG_CONSUMER64_UST
,
109 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
110 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
112 static struct consumer_data ustconsumer32_data
= {
113 .type
= LTTNG_CONSUMER32_UST
,
114 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
115 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
118 static int dispatch_thread_exit
;
120 /* Global application Unix socket path */
121 static char apps_unix_sock_path
[PATH_MAX
];
122 /* Global client Unix socket path */
123 static char client_unix_sock_path
[PATH_MAX
];
124 /* global wait shm path for UST */
125 static char wait_shm_path
[PATH_MAX
];
127 /* Sockets and FDs */
128 static int client_sock
;
129 static int apps_sock
;
130 static int kernel_tracer_fd
;
131 static int kernel_poll_pipe
[2];
134 * Quit pipe for all threads. This permits a single cancellation point
135 * for all threads when receiving an event on the pipe.
137 static int thread_quit_pipe
[2];
140 * This pipe is used to inform the thread managing application communication
141 * that a command is queued and ready to be processed.
143 static int apps_cmd_pipe
[2];
145 /* Pthread, Mutexes and Semaphores */
146 static pthread_t apps_thread
;
147 static pthread_t reg_apps_thread
;
148 static pthread_t client_thread
;
149 static pthread_t kernel_thread
;
150 static pthread_t dispatch_thread
;
154 * UST registration command queue. This queue is tied with a futex and uses a N
155 * wakers / 1 waiter implemented and detailed in futex.c/.h
157 * The thread_manage_apps and thread_dispatch_ust_registration interact with
158 * this queue and the wait/wake scheme.
160 static struct ust_cmd_queue ust_cmd_queue
;
163 * Pointer initialized before thread creation.
165 * This points to the tracing session list containing the session count and a
166 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
167 * MUST NOT be taken if you call a public function in session.c.
169 * The lock is nested inside the structure: session_list_ptr->lock. Please use
170 * session_lock_list and session_unlock_list for lock acquisition.
172 static struct ltt_session_list
*session_list_ptr
;
174 int ust_consumerd64_fd
= -1;
175 int ust_consumerd32_fd
= -1;
177 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
178 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
179 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
180 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
183 void setup_consumerd_path(void)
185 const char *bin
, *libdir
;
188 * Allow INSTALL_BIN_PATH to be used as a target path for the
189 * native architecture size consumer if CONFIG_CONSUMER*_PATH
190 * has not been defined.
192 #if (CAA_BITS_PER_LONG == 32)
193 if (!consumerd32_bin
[0]) {
194 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
196 if (!consumerd32_libdir
[0]) {
197 consumerd32_libdir
= INSTALL_LIB_PATH
;
199 #elif (CAA_BITS_PER_LONG == 64)
200 if (!consumerd64_bin
[0]) {
201 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
203 if (!consumerd64_libdir
[0]) {
204 consumerd64_libdir
= INSTALL_LIB_PATH
;
207 #error "Unknown bitness"
211 * runtime env. var. overrides the build default.
213 bin
= getenv("LTTNG_CONSUMERD32_BIN");
215 consumerd32_bin
= bin
;
217 bin
= getenv("LTTNG_CONSUMERD64_BIN");
219 consumerd64_bin
= bin
;
221 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
223 consumerd32_libdir
= libdir
;
225 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
227 consumerd64_libdir
= libdir
;
232 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
234 static int create_thread_poll_set(struct lttng_poll_event
*events
,
239 if (events
== NULL
|| size
== 0) {
244 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
250 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
262 * Check if the thread quit pipe was triggered.
264 * Return 1 if it was triggered else 0;
266 static int check_thread_quit_pipe(int fd
, uint32_t events
)
268 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
276 * Remove modules in reverse load order.
278 static int modprobe_remove_kernel_modules(void)
283 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
284 ret
= snprintf(modprobe
, sizeof(modprobe
),
285 "/sbin/modprobe -r -q %s",
286 kernel_modules_list
[i
].name
);
288 perror("snprintf modprobe -r");
291 modprobe
[sizeof(modprobe
) - 1] = '\0';
292 ret
= system(modprobe
);
294 ERR("Unable to launch modprobe -r for module %s",
295 kernel_modules_list
[i
].name
);
296 } else if (kernel_modules_list
[i
].required
297 && WEXITSTATUS(ret
) != 0) {
298 ERR("Unable to remove module %s",
299 kernel_modules_list
[i
].name
);
301 DBG("Modprobe removal successful %s",
302 kernel_modules_list
[i
].name
);
311 * Return group ID of the tracing group or -1 if not found.
313 static gid_t
allowed_group(void)
317 if (opt_tracing_group
) {
318 grp
= getgrnam(opt_tracing_group
);
320 grp
= getgrnam(default_tracing_group
);
330 * Init thread quit pipe.
332 * Return -1 on error or 0 if all pipes are created.
334 static int init_thread_quit_pipe(void)
338 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
340 perror("thread quit pipe");
349 * Complete teardown of a kernel session. This free all data structure related
350 * to a kernel session and update counter.
352 static void teardown_kernel_session(struct ltt_session
*session
)
354 if (!session
->kernel_session
) {
355 DBG3("No kernel session when tearingdown session");
359 DBG("Tearing down kernel session");
362 * If a custom kernel consumer was registered, close the socket before
363 * tearing down the complete kernel session structure
365 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
366 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
369 trace_kernel_destroy_session(session
->kernel_session
);
373 * Complete teardown of all UST sessions. This will free everything on his path
374 * and destroy the core essence of all ust sessions :)
376 static void teardown_ust_session(struct ltt_session
*session
)
380 if (!session
->ust_session
) {
381 DBG3("No UST session when tearingdown session");
385 DBG("Tearing down UST session(s)");
387 ret
= ust_app_destroy_trace_all(session
->ust_session
);
389 ERR("Error in ust_app_destroy_trace_all");
392 trace_ust_destroy_session(session
->ust_session
);
396 * Stop all threads by closing the thread quit pipe.
398 static void stop_threads(void)
402 /* Stopping all threads */
403 DBG("Terminating all threads");
404 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
406 ERR("write error on thread quit pipe");
409 /* Dispatch thread */
410 dispatch_thread_exit
= 1;
411 futex_nto1_wake(&ust_cmd_queue
.futex
);
417 static void cleanup(void)
421 struct ltt_session
*sess
, *stmp
;
425 DBG("Removing %s directory", rundir
);
426 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
428 ERR("asprintf failed. Something is really wrong!");
431 /* Remove lttng run directory */
434 ERR("Unable to clean %s", rundir
);
438 DBG("Cleaning up all session");
440 /* Destroy session list mutex */
441 if (session_list_ptr
!= NULL
) {
442 pthread_mutex_destroy(&session_list_ptr
->lock
);
444 /* Cleanup ALL session */
445 cds_list_for_each_entry_safe(sess
, stmp
,
446 &session_list_ptr
->head
, list
) {
447 teardown_kernel_session(sess
);
448 teardown_ust_session(sess
);
453 DBG("Closing all UST sockets");
454 ust_app_clean_list();
456 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
458 if (is_root
&& !opt_no_kernel
) {
459 DBG2("Closing kernel fd");
460 close(kernel_tracer_fd
);
461 DBG("Unloading kernel modules");
462 modprobe_remove_kernel_modules();
465 close(thread_quit_pipe
[0]);
466 close(thread_quit_pipe
[1]);
469 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
470 "Matthew, BEET driven development works!%c[%dm",
471 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
476 * Send data on a unix socket using the liblttsessiondcomm API.
478 * Return lttcomm error code.
480 static int send_unix_sock(int sock
, void *buf
, size_t len
)
482 /* Check valid length */
487 return lttcomm_send_unix_sock(sock
, buf
, len
);
491 * Free memory of a command context structure.
493 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
495 DBG("Clean command context structure");
497 if ((*cmd_ctx
)->llm
) {
498 free((*cmd_ctx
)->llm
);
500 if ((*cmd_ctx
)->lsm
) {
501 free((*cmd_ctx
)->lsm
);
509 * Send all stream fds of kernel channel to the consumer.
511 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
512 int sock
, struct ltt_kernel_channel
*channel
,
513 uid_t uid
, gid_t gid
)
516 struct ltt_kernel_stream
*stream
;
517 struct lttcomm_consumer_msg lkm
;
519 DBG("Sending streams of channel %s to kernel consumer",
520 channel
->channel
->name
);
523 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
524 lkm
.u
.channel
.channel_key
= channel
->fd
;
525 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
526 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
527 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
528 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
530 perror("send consumer channel");
535 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
539 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
540 lkm
.u
.stream
.channel_key
= channel
->fd
;
541 lkm
.u
.stream
.stream_key
= stream
->fd
;
542 lkm
.u
.stream
.state
= stream
->state
;
543 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
544 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
545 lkm
.u
.stream
.uid
= uid
;
546 lkm
.u
.stream
.gid
= gid
;
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 lkm
.u
.stream
.uid
= session
->uid
;
609 lkm
.u
.stream
.gid
= session
->gid
;
610 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
611 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
612 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
613 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
615 perror("send consumer stream");
618 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
620 perror("send consumer stream");
625 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
626 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
627 session
->uid
, session
->gid
);
633 DBG("consumer fds (metadata and channel streams) sent");
642 * Notify UST applications using the shm mmap futex.
644 static int notify_ust_apps(int active
)
648 DBG("Notifying applications of session daemon state: %d", active
);
650 /* See shm.c for this call implying mmap, shm and futex calls */
651 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
652 if (wait_shm_mmap
== NULL
) {
656 /* Wake waiting process */
657 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
659 /* Apps notified successfully */
667 * Setup the outgoing data buffer for the response (llm) by allocating the
668 * right amount of memory and copying the original information from the lsm
671 * Return total size of the buffer pointed by buf.
673 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
679 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
680 if (cmd_ctx
->llm
== NULL
) {
686 /* Copy common data */
687 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
688 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
690 cmd_ctx
->llm
->data_size
= size
;
691 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
700 * Update the kernel poll set of all channel fd available over all tracing
701 * session. Add the wakeup pipe at the end of the set.
703 static int update_kernel_poll(struct lttng_poll_event
*events
)
706 struct ltt_session
*session
;
707 struct ltt_kernel_channel
*channel
;
709 DBG("Updating kernel poll set");
712 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
713 session_lock(session
);
714 if (session
->kernel_session
== NULL
) {
715 session_unlock(session
);
719 cds_list_for_each_entry(channel
,
720 &session
->kernel_session
->channel_list
.head
, list
) {
721 /* Add channel fd to the kernel poll set */
722 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
724 session_unlock(session
);
727 DBG("Channel fd %d added to kernel set", channel
->fd
);
729 session_unlock(session
);
731 session_unlock_list();
736 session_unlock_list();
741 * Find the channel fd from 'fd' over all tracing session. When found, check
742 * for new channel stream and send those stream fds to the kernel consumer.
744 * Useful for CPU hotplug feature.
746 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
749 struct ltt_session
*session
;
750 struct ltt_kernel_channel
*channel
;
752 DBG("Updating kernel streams for channel fd %d", fd
);
755 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
756 session_lock(session
);
757 if (session
->kernel_session
== NULL
) {
758 session_unlock(session
);
762 /* This is not suppose to be 0 but this is an extra security check */
763 if (session
->kernel_session
->consumer_fd
== 0) {
764 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
767 cds_list_for_each_entry(channel
,
768 &session
->kernel_session
->channel_list
.head
, list
) {
769 if (channel
->fd
== fd
) {
770 DBG("Channel found, updating kernel streams");
771 ret
= kernel_open_channel_stream(channel
);
777 * Have we already sent fds to the consumer? If yes, it means
778 * that tracing is started so it is safe to send our updated
781 if (session
->kernel_session
->consumer_fds_sent
== 1) {
782 ret
= send_kconsumer_channel_streams(consumer_data
,
783 session
->kernel_session
->consumer_fd
, channel
,
784 session
->uid
, session
->gid
);
792 session_unlock(session
);
794 session_unlock_list();
798 session_unlock(session
);
799 session_unlock_list();
804 * For each tracing session, update newly registered apps.
806 static void update_ust_app(int app_sock
)
808 struct ltt_session
*sess
, *stmp
;
810 /* For all tracing session(s) */
811 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
812 if (sess
->ust_session
) {
813 ust_app_global_update(sess
->ust_session
, app_sock
);
819 * This thread manage event coming from the kernel.
821 * Features supported in this thread:
824 static void *thread_manage_kernel(void *data
)
826 int ret
, i
, pollfd
, update_poll_flag
= 1;
827 uint32_t revents
, nb_fd
;
829 struct lttng_poll_event events
;
831 DBG("Thread manage kernel started");
833 ret
= create_thread_poll_set(&events
, 2);
838 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
844 if (update_poll_flag
== 1) {
846 * Reset number of fd in the poll set. Always 2 since there is the thread
847 * quit pipe and the kernel pipe.
851 ret
= update_kernel_poll(&events
);
855 update_poll_flag
= 0;
858 nb_fd
= LTTNG_POLL_GETNB(&events
);
860 DBG("Thread kernel polling on %d fds", nb_fd
);
862 /* Zeroed the poll events */
863 lttng_poll_reset(&events
);
865 /* Poll infinite value of time */
866 ret
= lttng_poll_wait(&events
, -1);
869 } else if (ret
== 0) {
870 /* Should not happen since timeout is infinite */
871 ERR("Return value of poll is 0 with an infinite timeout.\n"
872 "This should not have happened! Continuing...");
876 for (i
= 0; i
< nb_fd
; i
++) {
877 /* Fetch once the poll data */
878 revents
= LTTNG_POLL_GETEV(&events
, i
);
879 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
881 /* Thread quit pipe has been closed. Killing thread. */
882 ret
= check_thread_quit_pipe(pollfd
, revents
);
887 /* Check for data on kernel pipe */
888 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
889 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
890 update_poll_flag
= 1;
894 * New CPU detected by the kernel. Adding kernel stream to
895 * kernel session and updating the kernel consumer
897 if (revents
& LPOLLIN
) {
898 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
904 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
905 * and unregister kernel stream at this point.
913 DBG("Kernel thread dying");
914 close(kernel_poll_pipe
[0]);
915 close(kernel_poll_pipe
[1]);
917 lttng_poll_clean(&events
);
923 * This thread manage the consumer error sent back to the session daemon.
925 static void *thread_manage_consumer(void *data
)
927 int sock
= 0, i
, ret
, pollfd
;
928 uint32_t revents
, nb_fd
;
929 enum lttcomm_return_code code
;
930 struct lttng_poll_event events
;
931 struct consumer_data
*consumer_data
= data
;
933 DBG("[thread] Manage consumer started");
935 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
941 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
942 * Nothing more will be added to this poll set.
944 ret
= create_thread_poll_set(&events
, 2);
949 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
954 nb_fd
= LTTNG_POLL_GETNB(&events
);
956 /* Inifinite blocking call, waiting for transmission */
957 ret
= lttng_poll_wait(&events
, -1);
962 for (i
= 0; i
< nb_fd
; i
++) {
963 /* Fetch once the poll data */
964 revents
= LTTNG_POLL_GETEV(&events
, i
);
965 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
967 /* Thread quit pipe has been closed. Killing thread. */
968 ret
= check_thread_quit_pipe(pollfd
, revents
);
973 /* Event on the registration socket */
974 if (pollfd
== consumer_data
->err_sock
) {
975 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
976 ERR("consumer err socket poll error");
982 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
987 DBG2("Receiving code from consumer err_sock");
989 /* Getting status code from kconsumerd */
990 ret
= lttcomm_recv_unix_sock(sock
, &code
,
991 sizeof(enum lttcomm_return_code
));
996 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
997 consumer_data
->cmd_sock
=
998 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
999 if (consumer_data
->cmd_sock
< 0) {
1000 sem_post(&consumer_data
->sem
);
1001 PERROR("consumer connect");
1004 /* Signal condition to tell that the kconsumerd is ready */
1005 sem_post(&consumer_data
->sem
);
1006 DBG("consumer command socket ready");
1008 ERR("consumer error when waiting for SOCK_READY : %s",
1009 lttcomm_get_readable_code(-code
));
1013 /* Remove the kconsumerd error sock since we've established a connexion */
1014 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1019 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1024 /* Update number of fd */
1025 nb_fd
= LTTNG_POLL_GETNB(&events
);
1027 /* Inifinite blocking call, waiting for transmission */
1028 ret
= lttng_poll_wait(&events
, -1);
1033 for (i
= 0; i
< nb_fd
; i
++) {
1034 /* Fetch once the poll data */
1035 revents
= LTTNG_POLL_GETEV(&events
, i
);
1036 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1038 /* Thread quit pipe has been closed. Killing thread. */
1039 ret
= check_thread_quit_pipe(pollfd
, revents
);
1044 /* Event on the kconsumerd socket */
1045 if (pollfd
== sock
) {
1046 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1047 ERR("consumer err socket second poll error");
1053 /* Wait for any kconsumerd error */
1054 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1055 sizeof(enum lttcomm_return_code
));
1057 ERR("consumer closed the command socket");
1061 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1064 DBG("consumer thread dying");
1065 close(consumer_data
->err_sock
);
1066 close(consumer_data
->cmd_sock
);
1069 unlink(consumer_data
->err_unix_sock_path
);
1070 unlink(consumer_data
->cmd_unix_sock_path
);
1071 consumer_data
->pid
= 0;
1073 lttng_poll_clean(&events
);
1079 * This thread manage application communication.
1081 static void *thread_manage_apps(void *data
)
1084 uint32_t revents
, nb_fd
;
1085 struct ust_command ust_cmd
;
1086 struct lttng_poll_event events
;
1088 DBG("[thread] Manage application started");
1090 rcu_register_thread();
1091 rcu_thread_online();
1093 ret
= create_thread_poll_set(&events
, 2);
1098 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1104 /* Zeroed the events structure */
1105 lttng_poll_reset(&events
);
1107 nb_fd
= LTTNG_POLL_GETNB(&events
);
1109 DBG("Apps thread polling on %d fds", nb_fd
);
1111 /* Inifinite blocking call, waiting for transmission */
1112 ret
= lttng_poll_wait(&events
, -1);
1117 for (i
= 0; i
< nb_fd
; i
++) {
1118 /* Fetch once the poll data */
1119 revents
= LTTNG_POLL_GETEV(&events
, i
);
1120 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1122 /* Thread quit pipe has been closed. Killing thread. */
1123 ret
= check_thread_quit_pipe(pollfd
, revents
);
1128 /* Inspect the apps cmd pipe */
1129 if (pollfd
== apps_cmd_pipe
[0]) {
1130 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1131 ERR("Apps command pipe error");
1133 } else if (revents
& LPOLLIN
) {
1135 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1136 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1137 perror("read apps cmd pipe");
1141 /* Register applicaton to the session daemon */
1142 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1144 if (ret
== -ENOMEM
) {
1146 } else if (ret
< 0) {
1151 * Add channel(s) and event(s) to newly registered apps
1152 * from lttng global UST domain.
1154 update_ust_app(ust_cmd
.sock
);
1156 ret
= ust_app_register_done(ust_cmd
.sock
);
1159 * If the registration is not possible, we simply
1160 * unregister the apps and continue
1162 ust_app_unregister(ust_cmd
.sock
);
1165 * We just need here to monitor the close of the UST
1166 * socket and poll set monitor those by default.
1168 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1173 DBG("Apps with sock %d added to poll set",
1181 * At this point, we know that a registered application made
1182 * the event at poll_wait.
1184 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1185 /* Removing from the poll set */
1186 ret
= lttng_poll_del(&events
, pollfd
);
1191 /* Socket closed on remote end. */
1192 ust_app_unregister(pollfd
);
1200 DBG("Application communication apps dying");
1201 close(apps_cmd_pipe
[0]);
1202 close(apps_cmd_pipe
[1]);
1204 lttng_poll_clean(&events
);
1206 rcu_thread_offline();
1207 rcu_unregister_thread();
1212 * Dispatch request from the registration threads to the application
1213 * communication thread.
1215 static void *thread_dispatch_ust_registration(void *data
)
1218 struct cds_wfq_node
*node
;
1219 struct ust_command
*ust_cmd
= NULL
;
1221 DBG("[thread] Dispatch UST command started");
1223 while (!dispatch_thread_exit
) {
1224 /* Atomically prepare the queue futex */
1225 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1228 /* Dequeue command for registration */
1229 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1231 DBG("Woken up but nothing in the UST command queue");
1232 /* Continue thread execution */
1236 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1238 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1239 " gid:%d sock:%d name:%s (version %d.%d)",
1240 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1241 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1242 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1243 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1245 * Inform apps thread of the new application registration. This
1246 * call is blocking so we can be assured that the data will be read
1247 * at some point in time or wait to the end of the world :)
1249 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1250 sizeof(struct ust_command
));
1252 perror("write apps cmd pipe");
1253 if (errno
== EBADF
) {
1255 * We can't inform the application thread to process
1256 * registration. We will exit or else application
1257 * registration will not occur and tracing will never
1264 } while (node
!= NULL
);
1266 /* Futex wait on queue. Blocking call on futex() */
1267 futex_nto1_wait(&ust_cmd_queue
.futex
);
1271 DBG("Dispatch thread dying");
1276 * This thread manage application registration.
1278 static void *thread_registration_apps(void *data
)
1280 int sock
= 0, i
, ret
, pollfd
;
1281 uint32_t revents
, nb_fd
;
1282 struct lttng_poll_event events
;
1284 * Get allocated in this thread, enqueued to a global queue, dequeued and
1285 * freed in the manage apps thread.
1287 struct ust_command
*ust_cmd
= NULL
;
1289 DBG("[thread] Manage application registration started");
1291 ret
= lttcomm_listen_unix_sock(apps_sock
);
1297 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1298 * more will be added to this poll set.
1300 ret
= create_thread_poll_set(&events
, 2);
1305 /* Add the application registration socket */
1306 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1311 /* Notify all applications to register */
1312 ret
= notify_ust_apps(1);
1314 ERR("Failed to notify applications or create the wait shared memory.\n"
1315 "Execution continues but there might be problem for already\n"
1316 "running applications that wishes to register.");
1320 DBG("Accepting application registration");
1322 nb_fd
= LTTNG_POLL_GETNB(&events
);
1324 /* Inifinite blocking call, waiting for transmission */
1325 ret
= lttng_poll_wait(&events
, -1);
1330 for (i
= 0; i
< nb_fd
; i
++) {
1331 /* Fetch once the poll data */
1332 revents
= LTTNG_POLL_GETEV(&events
, i
);
1333 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1335 /* Thread quit pipe has been closed. Killing thread. */
1336 ret
= check_thread_quit_pipe(pollfd
, revents
);
1341 /* Event on the registration socket */
1342 if (pollfd
== apps_sock
) {
1343 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1344 ERR("Register apps socket poll error");
1346 } else if (revents
& LPOLLIN
) {
1347 sock
= lttcomm_accept_unix_sock(apps_sock
);
1352 /* Create UST registration command for enqueuing */
1353 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1354 if (ust_cmd
== NULL
) {
1355 perror("ust command zmalloc");
1360 * Using message-based transmissions to ensure we don't
1361 * have to deal with partially received messages.
1363 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1364 sizeof(struct ust_register_msg
));
1365 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1367 perror("lttcomm_recv_unix_sock register apps");
1369 ERR("Wrong size received on apps register");
1376 ust_cmd
->sock
= sock
;
1378 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1379 " gid:%d sock:%d name:%s (version %d.%d)",
1380 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1381 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1382 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1383 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1386 * Lock free enqueue the registration request. The red pill
1387 * has been taken! This apps will be part of the *system*.
1389 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1392 * Wake the registration queue futex. Implicit memory
1393 * barrier with the exchange in cds_wfq_enqueue.
1395 futex_nto1_wake(&ust_cmd_queue
.futex
);
1402 DBG("UST Registration thread dying");
1404 /* Notify that the registration thread is gone */
1409 unlink(apps_unix_sock_path
);
1411 lttng_poll_clean(&events
);
1417 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1418 * exec or it will fails.
1420 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1423 struct timespec timeout
;
1425 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1426 timeout
.tv_nsec
= 0;
1428 /* Setup semaphore */
1429 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1431 PERROR("sem_init consumer semaphore");
1435 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1436 thread_manage_consumer
, consumer_data
);
1438 PERROR("pthread_create consumer");
1443 /* Get time for sem_timedwait absolute timeout */
1444 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1446 PERROR("clock_gettime spawn consumer");
1447 /* Infinite wait for the kconsumerd thread to be ready */
1448 ret
= sem_wait(&consumer_data
->sem
);
1450 /* Normal timeout if the gettime was successful */
1451 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1452 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1456 if (errno
== ETIMEDOUT
) {
1458 * Call has timed out so we kill the kconsumerd_thread and return
1461 ERR("The consumer thread was never ready. Killing it");
1462 ret
= pthread_cancel(consumer_data
->thread
);
1464 PERROR("pthread_cancel consumer thread");
1467 PERROR("semaphore wait failed consumer thread");
1472 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1473 if (consumer_data
->pid
== 0) {
1474 ERR("Kconsumerd did not start");
1475 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1478 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1487 * Join consumer thread
1489 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1494 if (consumer_data
->pid
!= 0) {
1495 ret
= kill(consumer_data
->pid
, SIGTERM
);
1497 ERR("Error killing consumer daemon");
1500 return pthread_join(consumer_data
->thread
, &status
);
1507 * Fork and exec a consumer daemon (consumerd).
1509 * Return pid if successful else -1.
1511 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1515 const char *consumer_to_use
;
1516 const char *verbosity
;
1519 DBG("Spawning consumerd");
1526 if (opt_verbose_consumer
) {
1527 verbosity
= "--verbose";
1529 verbosity
= "--quiet";
1531 switch (consumer_data
->type
) {
1532 case LTTNG_CONSUMER_KERNEL
:
1534 * Find out which consumerd to execute. We will first try the
1535 * 64-bit path, then the sessiond's installation directory, and
1536 * fallback on the 32-bit one,
1538 DBG3("Looking for a kernel consumer at these locations:");
1539 DBG3(" 1) %s", consumerd64_bin
);
1540 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1541 DBG3(" 3) %s", consumerd32_bin
);
1542 if (stat(consumerd64_bin
, &st
) == 0) {
1543 DBG3("Found location #1");
1544 consumer_to_use
= consumerd64_bin
;
1545 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1546 DBG3("Found location #2");
1547 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1548 } else if (stat(consumerd32_bin
, &st
) == 0) {
1549 DBG3("Found location #3");
1550 consumer_to_use
= consumerd32_bin
;
1552 DBG("Could not find any valid consumerd executable");
1555 DBG("Using kernel consumer at: %s", consumer_to_use
);
1556 execl(consumer_to_use
,
1557 "lttng-consumerd", verbosity
, "-k",
1558 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1559 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1562 case LTTNG_CONSUMER64_UST
:
1564 char *tmpnew
= NULL
;
1566 if (consumerd64_libdir
[0] != '\0') {
1570 tmp
= getenv("LD_LIBRARY_PATH");
1574 tmplen
= strlen("LD_LIBRARY_PATH=")
1575 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1576 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1581 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1582 strcat(tmpnew
, consumerd64_libdir
);
1583 if (tmp
[0] != '\0') {
1584 strcat(tmpnew
, ":");
1585 strcat(tmpnew
, tmp
);
1587 ret
= putenv(tmpnew
);
1593 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1594 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1595 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1596 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1598 if (consumerd64_libdir
[0] != '\0') {
1606 case LTTNG_CONSUMER32_UST
:
1608 char *tmpnew
= NULL
;
1610 if (consumerd32_libdir
[0] != '\0') {
1614 tmp
= getenv("LD_LIBRARY_PATH");
1618 tmplen
= strlen("LD_LIBRARY_PATH=")
1619 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1620 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1625 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1626 strcat(tmpnew
, consumerd32_libdir
);
1627 if (tmp
[0] != '\0') {
1628 strcat(tmpnew
, ":");
1629 strcat(tmpnew
, tmp
);
1631 ret
= putenv(tmpnew
);
1637 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1638 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1639 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1640 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1642 if (consumerd32_libdir
[0] != '\0') {
1651 perror("unknown consumer type");
1655 perror("kernel start consumer exec");
1658 } else if (pid
> 0) {
1661 perror("start consumer fork");
1669 * Spawn the consumerd daemon and session daemon thread.
1671 static int start_consumerd(struct consumer_data
*consumer_data
)
1675 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1676 if (consumer_data
->pid
!= 0) {
1677 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1681 ret
= spawn_consumerd(consumer_data
);
1683 ERR("Spawning consumerd failed");
1684 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1688 /* Setting up the consumer_data pid */
1689 consumer_data
->pid
= ret
;
1690 DBG2("Consumer pid %d", consumer_data
->pid
);
1691 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1693 DBG2("Spawning consumer control thread");
1694 ret
= spawn_consumer_thread(consumer_data
);
1696 ERR("Fatal error spawning consumer control thread");
1708 * modprobe_kernel_modules
1710 static int modprobe_kernel_modules(void)
1715 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1716 ret
= snprintf(modprobe
, sizeof(modprobe
),
1717 "/sbin/modprobe %s%s",
1718 kernel_modules_list
[i
].required
? "" : "-q ",
1719 kernel_modules_list
[i
].name
);
1721 perror("snprintf modprobe");
1724 modprobe
[sizeof(modprobe
) - 1] = '\0';
1725 ret
= system(modprobe
);
1727 ERR("Unable to launch modprobe for module %s",
1728 kernel_modules_list
[i
].name
);
1729 } else if (kernel_modules_list
[i
].required
1730 && WEXITSTATUS(ret
) != 0) {
1731 ERR("Unable to load module %s",
1732 kernel_modules_list
[i
].name
);
1734 DBG("Modprobe successfully %s",
1735 kernel_modules_list
[i
].name
);
1746 static int mount_debugfs(char *path
)
1749 char *type
= "debugfs";
1751 ret
= run_as_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1753 PERROR("Cannot create debugfs path");
1757 ret
= mount(type
, path
, type
, 0, NULL
);
1759 PERROR("Cannot mount debugfs");
1763 DBG("Mounted debugfs successfully at %s", path
);
1770 * Setup necessary data for kernel tracer action.
1772 static void init_kernel_tracer(void)
1775 char *proc_mounts
= "/proc/mounts";
1777 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1780 /* Detect debugfs */
1781 fp
= fopen(proc_mounts
, "r");
1783 ERR("Unable to probe %s", proc_mounts
);
1787 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1788 if (strstr(line
, "debugfs") != NULL
) {
1789 /* Remove first string */
1791 /* Dup string here so we can reuse line later on */
1792 debugfs_path
= strdup(strtok(NULL
, " "));
1793 DBG("Got debugfs path : %s", debugfs_path
);
1800 /* Mount debugfs if needded */
1801 if (debugfs_path
== NULL
) {
1802 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1804 perror("asprintf debugfs path");
1807 ret
= mount_debugfs(debugfs_path
);
1809 perror("Cannot mount debugfs");
1814 /* Modprobe lttng kernel modules */
1815 ret
= modprobe_kernel_modules();
1820 /* Setup lttng kernel path */
1821 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1823 perror("asprintf lttng path");
1827 /* Open debugfs lttng */
1828 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1829 if (kernel_tracer_fd
< 0) {
1830 DBG("Failed to open %s", lttng_path
);
1836 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1846 WARN("No kernel tracer available");
1847 kernel_tracer_fd
= 0;
1852 * Init tracing by creating trace directory and sending fds kernel consumer.
1854 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1858 if (session
->consumer_fds_sent
== 0) {
1860 * Assign default kernel consumer socket if no consumer assigned to the
1861 * kernel session. At this point, it's NOT suppose to be 0 but this is
1862 * an extra security check.
1864 if (session
->consumer_fd
== 0) {
1865 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1868 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1870 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1874 session
->consumer_fds_sent
= 1;
1882 * Create an UST session and add it to the session ust list.
1884 static int create_ust_session(struct ltt_session
*session
,
1885 struct lttng_domain
*domain
)
1887 struct ltt_ust_session
*lus
= NULL
;
1890 switch (domain
->type
) {
1891 case LTTNG_DOMAIN_UST
:
1894 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1898 DBG("Creating UST session");
1900 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1902 ret
= LTTCOMM_UST_SESS_FAIL
;
1906 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1907 session
->uid
, session
->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 lus
->uid
= session
->uid
;
1926 lus
->gid
= session
->gid
;
1927 session
->ust_session
= lus
;
1937 * Create a kernel tracer session then create the default channel.
1939 static int create_kernel_session(struct ltt_session
*session
)
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 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1957 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1959 if (ret
!= -EEXIST
) {
1960 ERR("Trace directory creation error");
1964 session
->kernel_session
->uid
= session
->uid
;
1965 session
->kernel_session
->gid
= session
->gid
;
1972 * Check if the UID or GID match the session. Root user has access to all
1975 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1977 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1984 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1987 struct ltt_session
*session
;
1989 DBG("Counting number of available session for UID %d GID %d",
1991 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1993 * Only list the sessions the user can control.
1995 if (!session_access_ok(session
, uid
, gid
)) {
2004 * Using the session list, filled a lttng_session array to send back to the
2005 * client for session listing.
2007 * The session list lock MUST be acquired before calling this function. Use
2008 * session_lock_list() and session_unlock_list().
2010 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2014 struct ltt_session
*session
;
2016 DBG("Getting all available session for UID %d GID %d",
2019 * Iterate over session list and append data after the control struct in
2022 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2024 * Only list the sessions the user can control.
2026 if (!session_access_ok(session
, uid
, gid
)) {
2029 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2030 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2031 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2032 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2033 sessions
[i
].enabled
= session
->enabled
;
2039 * Fill lttng_channel array of all channels.
2041 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2042 struct lttng_channel
*channels
)
2045 struct ltt_kernel_channel
*kchan
;
2047 DBG("Listing channels for session %s", session
->name
);
2050 case LTTNG_DOMAIN_KERNEL
:
2051 /* Kernel channels */
2052 if (session
->kernel_session
!= NULL
) {
2053 cds_list_for_each_entry(kchan
,
2054 &session
->kernel_session
->channel_list
.head
, list
) {
2055 /* Copy lttng_channel struct to array */
2056 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2057 channels
[i
].enabled
= kchan
->enabled
;
2062 case LTTNG_DOMAIN_UST
:
2064 struct lttng_ht_iter iter
;
2065 struct ltt_ust_channel
*uchan
;
2067 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2068 &iter
.iter
, uchan
, node
.node
) {
2069 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2070 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2071 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2072 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2073 channels
[i
].attr
.switch_timer_interval
=
2074 uchan
->attr
.switch_timer_interval
;
2075 channels
[i
].attr
.read_timer_interval
=
2076 uchan
->attr
.read_timer_interval
;
2077 channels
[i
].enabled
= uchan
->enabled
;
2078 switch (uchan
->attr
.output
) {
2079 case LTTNG_UST_MMAP
:
2081 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2094 * Create a list of ust global domain events.
2096 static int list_lttng_ust_global_events(char *channel_name
,
2097 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2100 unsigned int nb_event
= 0;
2101 struct lttng_ht_iter iter
;
2102 struct lttng_ht_node_str
*node
;
2103 struct ltt_ust_channel
*uchan
;
2104 struct ltt_ust_event
*uevent
;
2105 struct lttng_event
*tmp
;
2107 DBG("Listing UST global events for channel %s", channel_name
);
2111 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2112 node
= lttng_ht_iter_get_node_str(&iter
);
2114 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2118 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2120 nb_event
+= lttng_ht_get_count(uchan
->events
);
2122 if (nb_event
== 0) {
2127 DBG3("Listing UST global %d events", nb_event
);
2129 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2131 ret
= -LTTCOMM_FATAL
;
2135 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2136 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2137 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2138 tmp
[i
].enabled
= uevent
->enabled
;
2139 switch (uevent
->attr
.instrumentation
) {
2140 case LTTNG_UST_TRACEPOINT
:
2141 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2143 case LTTNG_UST_PROBE
:
2144 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2146 case LTTNG_UST_FUNCTION
:
2147 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2149 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2150 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2165 * Fill lttng_event array of all kernel events in the channel.
2167 static int list_lttng_kernel_events(char *channel_name
,
2168 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2171 unsigned int nb_event
;
2172 struct ltt_kernel_event
*event
;
2173 struct ltt_kernel_channel
*kchan
;
2175 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2176 if (kchan
== NULL
) {
2177 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2181 nb_event
= kchan
->event_count
;
2183 DBG("Listing events for channel %s", kchan
->channel
->name
);
2185 if (nb_event
== 0) {
2190 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2191 if (*events
== NULL
) {
2192 ret
= LTTCOMM_FATAL
;
2196 /* Kernel channels */
2197 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2198 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2199 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2200 (*events
)[i
].enabled
= event
->enabled
;
2201 switch (event
->event
->instrumentation
) {
2202 case LTTNG_KERNEL_TRACEPOINT
:
2203 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2205 case LTTNG_KERNEL_KPROBE
:
2206 case LTTNG_KERNEL_KRETPROBE
:
2207 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2208 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2209 sizeof(struct lttng_kernel_kprobe
));
2211 case LTTNG_KERNEL_FUNCTION
:
2212 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2213 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2214 sizeof(struct lttng_kernel_function
));
2216 case LTTNG_KERNEL_NOOP
:
2217 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2219 case LTTNG_KERNEL_SYSCALL
:
2220 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2222 case LTTNG_KERNEL_ALL
:
2236 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2238 static int cmd_disable_channel(struct ltt_session
*session
,
2239 int domain
, char *channel_name
)
2242 struct ltt_ust_session
*usess
;
2244 usess
= session
->ust_session
;
2247 case LTTNG_DOMAIN_KERNEL
:
2249 ret
= channel_kernel_disable(session
->kernel_session
,
2251 if (ret
!= LTTCOMM_OK
) {
2255 kernel_wait_quiescent(kernel_tracer_fd
);
2258 case LTTNG_DOMAIN_UST
:
2260 struct ltt_ust_channel
*uchan
;
2261 struct lttng_ht
*chan_ht
;
2263 chan_ht
= usess
->domain_global
.channels
;
2265 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2266 if (uchan
== NULL
) {
2267 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2271 ret
= channel_ust_disable(usess
, domain
, uchan
);
2272 if (ret
!= LTTCOMM_OK
) {
2277 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2278 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2279 case LTTNG_DOMAIN_UST_PID
:
2280 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2283 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2294 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2296 static int cmd_enable_channel(struct ltt_session
*session
,
2297 int domain
, struct lttng_channel
*attr
)
2300 struct ltt_ust_session
*usess
= session
->ust_session
;
2301 struct lttng_ht
*chan_ht
;
2303 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2306 case LTTNG_DOMAIN_KERNEL
:
2308 struct ltt_kernel_channel
*kchan
;
2310 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2311 session
->kernel_session
);
2312 if (kchan
== NULL
) {
2313 ret
= channel_kernel_create(session
->kernel_session
,
2314 attr
, kernel_poll_pipe
[1]);
2316 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2319 if (ret
!= LTTCOMM_OK
) {
2323 kernel_wait_quiescent(kernel_tracer_fd
);
2326 case LTTNG_DOMAIN_UST
:
2328 struct ltt_ust_channel
*uchan
;
2330 chan_ht
= usess
->domain_global
.channels
;
2332 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2333 if (uchan
== NULL
) {
2334 ret
= channel_ust_create(usess
, domain
, attr
);
2336 ret
= channel_ust_enable(usess
, domain
, uchan
);
2340 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2341 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2342 case LTTNG_DOMAIN_UST_PID
:
2343 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2346 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2355 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2357 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2358 char *channel_name
, char *event_name
)
2363 case LTTNG_DOMAIN_KERNEL
:
2365 struct ltt_kernel_channel
*kchan
;
2366 struct ltt_kernel_session
*ksess
;
2368 ksess
= session
->kernel_session
;
2370 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2371 if (kchan
== NULL
) {
2372 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2376 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2377 if (ret
!= LTTCOMM_OK
) {
2381 kernel_wait_quiescent(kernel_tracer_fd
);
2384 case LTTNG_DOMAIN_UST
:
2386 struct ltt_ust_channel
*uchan
;
2387 struct ltt_ust_session
*usess
;
2389 usess
= session
->ust_session
;
2391 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2393 if (uchan
== NULL
) {
2394 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2398 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2399 if (ret
!= LTTCOMM_OK
) {
2403 DBG3("Disable UST event %s in channel %s completed", event_name
,
2407 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2408 case LTTNG_DOMAIN_UST_PID
:
2409 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2411 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2422 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2424 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2430 case LTTNG_DOMAIN_KERNEL
:
2432 struct ltt_kernel_session
*ksess
;
2433 struct ltt_kernel_channel
*kchan
;
2435 ksess
= session
->kernel_session
;
2437 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2438 if (kchan
== NULL
) {
2439 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2443 ret
= event_kernel_disable_all(ksess
, kchan
);
2444 if (ret
!= LTTCOMM_OK
) {
2448 kernel_wait_quiescent(kernel_tracer_fd
);
2451 case LTTNG_DOMAIN_UST
:
2453 struct ltt_ust_session
*usess
;
2454 struct ltt_ust_channel
*uchan
;
2456 usess
= session
->ust_session
;
2458 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2460 if (uchan
== NULL
) {
2461 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2465 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2470 DBG3("Disable all UST events in channel %s completed", channel_name
);
2474 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2475 case LTTNG_DOMAIN_UST_PID
:
2476 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2478 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2489 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2491 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2492 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2497 case LTTNG_DOMAIN_KERNEL
:
2498 /* Add kernel context to kernel tracer */
2499 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2500 event_name
, channel_name
);
2501 if (ret
!= LTTCOMM_OK
) {
2505 case LTTNG_DOMAIN_UST
:
2507 struct ltt_ust_session
*usess
= session
->ust_session
;
2509 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2510 if (ret
!= LTTCOMM_OK
) {
2515 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2516 case LTTNG_DOMAIN_UST_PID
:
2517 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2519 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2530 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2532 * TODO: currently, both events and loglevels are kept within the same
2533 * namespace for UST global registry/app registery, so if an event
2534 * happen to have the same name as the loglevel (very unlikely though),
2535 * and an attempt is made to enable/disable both in the same session,
2536 * the first to be created will be the only one allowed to exist.
2538 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2539 char *channel_name
, struct lttng_event
*event
)
2542 struct lttng_channel
*attr
;
2543 struct ltt_ust_session
*usess
= session
->ust_session
;
2546 case LTTNG_DOMAIN_KERNEL
:
2548 struct ltt_kernel_channel
*kchan
;
2550 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2551 session
->kernel_session
);
2552 if (kchan
== NULL
) {
2553 attr
= channel_new_default_attr(domain
);
2555 ret
= LTTCOMM_FATAL
;
2558 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2560 /* This call will notify the kernel thread */
2561 ret
= channel_kernel_create(session
->kernel_session
,
2562 attr
, kernel_poll_pipe
[1]);
2563 if (ret
!= LTTCOMM_OK
) {
2570 /* Get the newly created kernel channel pointer */
2571 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2572 session
->kernel_session
);
2573 if (kchan
== NULL
) {
2574 /* This sould not happen... */
2575 ret
= LTTCOMM_FATAL
;
2579 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2581 if (ret
!= LTTCOMM_OK
) {
2585 kernel_wait_quiescent(kernel_tracer_fd
);
2588 case LTTNG_DOMAIN_UST
:
2590 struct lttng_channel
*attr
;
2591 struct ltt_ust_channel
*uchan
;
2593 /* Get channel from global UST domain */
2594 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2596 if (uchan
== NULL
) {
2597 /* Create default channel */
2598 attr
= channel_new_default_attr(domain
);
2600 ret
= LTTCOMM_FATAL
;
2603 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2604 attr
->name
[NAME_MAX
- 1] = '\0';
2606 ret
= channel_ust_create(usess
, domain
, attr
);
2607 if (ret
!= LTTCOMM_OK
) {
2613 /* Get the newly created channel reference back */
2614 uchan
= trace_ust_find_channel_by_name(
2615 usess
->domain_global
.channels
, channel_name
);
2616 if (uchan
== NULL
) {
2617 /* Something is really wrong */
2618 ret
= LTTCOMM_FATAL
;
2623 /* At this point, the session and channel exist on the tracer */
2624 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2625 if (ret
!= LTTCOMM_OK
) {
2630 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2631 case LTTNG_DOMAIN_UST_PID
:
2632 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2634 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2645 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2647 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2648 char *channel_name
, int event_type
)
2651 struct ltt_kernel_channel
*kchan
;
2654 case LTTNG_DOMAIN_KERNEL
:
2655 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2656 session
->kernel_session
);
2657 if (kchan
== NULL
) {
2658 /* This call will notify the kernel thread */
2659 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2660 kernel_poll_pipe
[1]);
2661 if (ret
!= LTTCOMM_OK
) {
2665 /* Get the newly created kernel channel pointer */
2666 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2667 session
->kernel_session
);
2668 if (kchan
== NULL
) {
2669 /* This sould not happen... */
2670 ret
= LTTCOMM_FATAL
;
2676 switch (event_type
) {
2677 case LTTNG_EVENT_SYSCALL
:
2678 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2679 kchan
, kernel_tracer_fd
);
2681 case LTTNG_EVENT_TRACEPOINT
:
2683 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2684 * events already registered to the channel.
2686 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2687 kchan
, kernel_tracer_fd
);
2689 case LTTNG_EVENT_ALL
:
2690 /* Enable syscalls and tracepoints */
2691 ret
= event_kernel_enable_all(session
->kernel_session
,
2692 kchan
, kernel_tracer_fd
);
2695 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2699 /* Manage return value */
2700 if (ret
!= LTTCOMM_OK
) {
2704 kernel_wait_quiescent(kernel_tracer_fd
);
2706 case LTTNG_DOMAIN_UST
:
2708 struct lttng_channel
*attr
;
2709 struct ltt_ust_channel
*uchan
;
2710 struct ltt_ust_session
*usess
= session
->ust_session
;
2712 /* Get channel from global UST domain */
2713 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2715 if (uchan
== NULL
) {
2716 /* Create default channel */
2717 attr
= channel_new_default_attr(domain
);
2719 ret
= LTTCOMM_FATAL
;
2722 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2723 attr
->name
[NAME_MAX
- 1] = '\0';
2725 /* Use the internal command enable channel */
2726 ret
= channel_ust_create(usess
, domain
, attr
);
2727 if (ret
!= LTTCOMM_OK
) {
2733 /* Get the newly created channel reference back */
2734 uchan
= trace_ust_find_channel_by_name(
2735 usess
->domain_global
.channels
, channel_name
);
2736 if (uchan
== NULL
) {
2737 /* Something is really wrong */
2738 ret
= LTTCOMM_FATAL
;
2743 /* At this point, the session and channel exist on the tracer */
2745 switch (event_type
) {
2746 case LTTNG_EVENT_ALL
:
2747 case LTTNG_EVENT_TRACEPOINT
:
2748 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2749 if (ret
!= LTTCOMM_OK
) {
2754 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2758 /* Manage return value */
2759 if (ret
!= LTTCOMM_OK
) {
2765 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2766 case LTTNG_DOMAIN_UST_PID
:
2767 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2769 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2780 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2782 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2785 ssize_t nb_events
= 0;
2788 case LTTNG_DOMAIN_KERNEL
:
2789 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2790 if (nb_events
< 0) {
2791 ret
= LTTCOMM_KERN_LIST_FAIL
;
2795 case LTTNG_DOMAIN_UST
:
2796 nb_events
= ust_app_list_events(events
);
2797 if (nb_events
< 0) {
2798 ret
= LTTCOMM_UST_LIST_FAIL
;
2803 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2810 /* Return negative value to differentiate return code */
2815 * Command LTTNG_START_TRACE processed by the client thread.
2817 static int cmd_start_trace(struct ltt_session
*session
)
2820 struct ltt_kernel_session
*ksession
;
2821 struct ltt_ust_session
*usess
;
2824 ksession
= session
->kernel_session
;
2825 usess
= session
->ust_session
;
2827 if (session
->enabled
) {
2828 ret
= LTTCOMM_UST_START_FAIL
;
2832 session
->enabled
= 1;
2834 /* Kernel tracing */
2835 if (ksession
!= NULL
) {
2836 struct ltt_kernel_channel
*kchan
;
2838 /* Open kernel metadata */
2839 if (ksession
->metadata
== NULL
) {
2840 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2842 ret
= LTTCOMM_KERN_META_FAIL
;
2847 /* Open kernel metadata stream */
2848 if (ksession
->metadata_stream_fd
== 0) {
2849 ret
= kernel_open_metadata_stream(ksession
);
2851 ERR("Kernel create metadata stream failed");
2852 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2857 /* For each channel */
2858 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2859 if (kchan
->stream_count
== 0) {
2860 ret
= kernel_open_channel_stream(kchan
);
2862 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2865 /* Update the stream global counter */
2866 ksession
->stream_count_global
+= ret
;
2870 /* Setup kernel consumer socket and send fds to it */
2871 ret
= init_kernel_tracing(ksession
);
2873 ret
= LTTCOMM_KERN_START_FAIL
;
2877 /* This start the kernel tracing */
2878 ret
= kernel_start_session(ksession
);
2880 ret
= LTTCOMM_KERN_START_FAIL
;
2884 /* Quiescent wait after starting trace */
2885 kernel_wait_quiescent(kernel_tracer_fd
);
2888 /* Flag session that trace should start automatically */
2890 usess
->start_trace
= 1;
2892 ret
= ust_app_start_trace_all(usess
);
2894 ret
= LTTCOMM_UST_START_FAIL
;
2906 * Command LTTNG_STOP_TRACE processed by the client thread.
2908 static int cmd_stop_trace(struct ltt_session
*session
)
2911 struct ltt_kernel_channel
*kchan
;
2912 struct ltt_kernel_session
*ksession
;
2913 struct ltt_ust_session
*usess
;
2916 ksession
= session
->kernel_session
;
2917 usess
= session
->ust_session
;
2919 if (!session
->enabled
) {
2920 ret
= LTTCOMM_UST_STOP_FAIL
;
2924 session
->enabled
= 0;
2927 if (ksession
!= NULL
) {
2928 DBG("Stop kernel tracing");
2930 /* Flush all buffers before stopping */
2931 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2933 ERR("Kernel metadata flush failed");
2936 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2937 ret
= kernel_flush_buffer(kchan
);
2939 ERR("Kernel flush buffer error");
2943 ret
= kernel_stop_session(ksession
);
2945 ret
= LTTCOMM_KERN_STOP_FAIL
;
2949 kernel_wait_quiescent(kernel_tracer_fd
);
2953 usess
->start_trace
= 0;
2955 ret
= ust_app_stop_trace_all(usess
);
2957 ret
= LTTCOMM_UST_STOP_FAIL
;
2969 * Command LTTNG_CREATE_SESSION processed by the client thread.
2971 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2975 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2976 if (ret
!= LTTCOMM_OK
) {
2987 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2989 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2993 /* Clean kernel session teardown */
2994 teardown_kernel_session(session
);
2995 /* UST session teardown */
2996 teardown_ust_session(session
);
2999 * Must notify the kernel thread here to update it's poll setin order
3000 * to remove the channel(s)' fd just destroyed.
3002 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3004 perror("write kernel poll pipe");
3007 ret
= session_destroy(session
);
3013 * Command LTTNG_CALIBRATE processed by the client thread.
3015 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3020 case LTTNG_DOMAIN_KERNEL
:
3022 struct lttng_kernel_calibrate kcalibrate
;
3024 kcalibrate
.type
= calibrate
->type
;
3025 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3027 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3033 /* TODO: Userspace tracing */
3034 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3045 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3047 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3053 case LTTNG_DOMAIN_KERNEL
:
3054 /* Can't register a consumer if there is already one */
3055 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3056 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3060 sock
= lttcomm_connect_unix_sock(sock_path
);
3062 ret
= LTTCOMM_CONNECT_FAIL
;
3066 session
->kernel_session
->consumer_fd
= sock
;
3069 /* TODO: Userspace tracing */
3070 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3081 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3083 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3084 struct lttng_domain
**domains
)
3089 if (session
->kernel_session
!= NULL
) {
3090 DBG3("Listing domains found kernel domain");
3094 if (session
->ust_session
!= NULL
) {
3095 DBG3("Listing domains found UST global domain");
3099 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3100 if (*domains
== NULL
) {
3101 ret
= -LTTCOMM_FATAL
;
3105 if (session
->kernel_session
!= NULL
) {
3106 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3110 if (session
->ust_session
!= NULL
) {
3111 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3122 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3124 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3125 struct lttng_channel
**channels
)
3128 ssize_t nb_chan
= 0;
3131 case LTTNG_DOMAIN_KERNEL
:
3132 if (session
->kernel_session
!= NULL
) {
3133 nb_chan
= session
->kernel_session
->channel_count
;
3135 DBG3("Number of kernel channels %zd", nb_chan
);
3137 case LTTNG_DOMAIN_UST
:
3138 if (session
->ust_session
!= NULL
) {
3139 nb_chan
= lttng_ht_get_count(
3140 session
->ust_session
->domain_global
.channels
);
3142 DBG3("Number of UST global channels %zd", nb_chan
);
3146 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3151 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3152 if (*channels
== NULL
) {
3153 ret
= -LTTCOMM_FATAL
;
3157 list_lttng_channels(domain
, session
, *channels
);
3169 * Command LTTNG_LIST_EVENTS processed by the client thread.
3171 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3172 char *channel_name
, struct lttng_event
**events
)
3175 ssize_t nb_event
= 0;
3178 case LTTNG_DOMAIN_KERNEL
:
3179 if (session
->kernel_session
!= NULL
) {
3180 nb_event
= list_lttng_kernel_events(channel_name
,
3181 session
->kernel_session
, events
);
3184 case LTTNG_DOMAIN_UST
:
3186 if (session
->ust_session
!= NULL
) {
3187 nb_event
= list_lttng_ust_global_events(channel_name
,
3188 &session
->ust_session
->domain_global
, events
);
3193 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3204 * Process the command requested by the lttng client within the command
3205 * context structure. This function make sure that the return structure (llm)
3206 * is set and ready for transmission before returning.
3208 * Return any error encountered or 0 for success.
3210 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3212 int ret
= LTTCOMM_OK
;
3213 int need_tracing_session
= 1;
3215 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3217 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3218 ret
= LTTCOMM_KERN_NA
;
3223 * Check for command that don't needs to allocate a returned payload. We do
3224 * this here so we don't have to make the call for no payload at each
3227 switch(cmd_ctx
->lsm
->cmd_type
) {
3228 case LTTNG_LIST_SESSIONS
:
3229 case LTTNG_LIST_TRACEPOINTS
:
3230 case LTTNG_LIST_DOMAINS
:
3231 case LTTNG_LIST_CHANNELS
:
3232 case LTTNG_LIST_EVENTS
:
3235 /* Setup lttng message with no payload */
3236 ret
= setup_lttng_msg(cmd_ctx
, 0);
3238 /* This label does not try to unlock the session */
3239 goto init_setup_error
;
3243 /* Commands that DO NOT need a session. */
3244 switch (cmd_ctx
->lsm
->cmd_type
) {
3245 case LTTNG_CALIBRATE
:
3246 case LTTNG_CREATE_SESSION
:
3247 case LTTNG_LIST_SESSIONS
:
3248 case LTTNG_LIST_TRACEPOINTS
:
3249 need_tracing_session
= 0;
3252 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3253 session_lock_list();
3254 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3255 session_unlock_list();
3256 if (cmd_ctx
->session
== NULL
) {
3257 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3258 ret
= LTTCOMM_SESS_NOT_FOUND
;
3260 /* If no session name specified */
3261 ret
= LTTCOMM_SELECT_SESS
;
3265 /* Acquire lock for the session */
3266 session_lock(cmd_ctx
->session
);
3272 * Check domain type for specific "pre-action".
3274 switch (cmd_ctx
->lsm
->domain
.type
) {
3275 case LTTNG_DOMAIN_KERNEL
:
3276 /* Kernel tracer check */
3277 if (kernel_tracer_fd
== 0) {
3278 /* Basically, load kernel tracer modules */
3279 init_kernel_tracer();
3280 if (kernel_tracer_fd
== 0) {
3281 ret
= LTTCOMM_KERN_NA
;
3286 /* Need a session for kernel command */
3287 if (need_tracing_session
) {
3288 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3289 ret
= create_kernel_session(cmd_ctx
->session
);
3291 ret
= LTTCOMM_KERN_SESS_FAIL
;
3296 /* Start the kernel consumer daemon */
3297 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3298 if (kconsumer_data
.pid
== 0 &&
3299 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3300 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3301 ret
= start_consumerd(&kconsumer_data
);
3303 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3307 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3311 case LTTNG_DOMAIN_UST
:
3313 if (need_tracing_session
) {
3314 if (cmd_ctx
->session
->ust_session
== NULL
) {
3315 ret
= create_ust_session(cmd_ctx
->session
,
3316 &cmd_ctx
->lsm
->domain
);
3317 if (ret
!= LTTCOMM_OK
) {
3321 /* Start the UST consumer daemons */
3323 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3324 if (consumerd64_bin
[0] != '\0' &&
3325 ustconsumer64_data
.pid
== 0 &&
3326 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3327 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3328 ret
= start_consumerd(&ustconsumer64_data
);
3330 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3331 ust_consumerd64_fd
= -EINVAL
;
3335 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3337 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3340 if (consumerd32_bin
[0] != '\0' &&
3341 ustconsumer32_data
.pid
== 0 &&
3342 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3343 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3344 ret
= start_consumerd(&ustconsumer32_data
);
3346 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3347 ust_consumerd32_fd
= -EINVAL
;
3350 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3352 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3362 * Check that the UID or GID match that of the tracing session.
3363 * The root user can interact with all sessions.
3365 if (need_tracing_session
) {
3366 if (!session_access_ok(cmd_ctx
->session
,
3367 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3368 ret
= LTTCOMM_EPERM
;
3373 /* Process by command type */
3374 switch (cmd_ctx
->lsm
->cmd_type
) {
3375 case LTTNG_ADD_CONTEXT
:
3377 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3378 cmd_ctx
->lsm
->u
.context
.channel_name
,
3379 cmd_ctx
->lsm
->u
.context
.event_name
,
3380 &cmd_ctx
->lsm
->u
.context
.ctx
);
3383 case LTTNG_DISABLE_CHANNEL
:
3385 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3386 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3389 case LTTNG_DISABLE_EVENT
:
3391 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3392 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3393 cmd_ctx
->lsm
->u
.disable
.name
);
3397 case LTTNG_DISABLE_ALL_EVENT
:
3399 DBG("Disabling all events");
3401 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3402 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3405 case LTTNG_ENABLE_CHANNEL
:
3407 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3408 &cmd_ctx
->lsm
->u
.channel
.chan
);
3411 case LTTNG_ENABLE_EVENT
:
3413 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3414 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3415 &cmd_ctx
->lsm
->u
.enable
.event
);
3418 case LTTNG_ENABLE_ALL_EVENT
:
3420 DBG("Enabling all events");
3422 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3423 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3424 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3427 case LTTNG_LIST_TRACEPOINTS
:
3429 struct lttng_event
*events
;
3432 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3433 if (nb_events
< 0) {
3439 * Setup lttng message with payload size set to the event list size in
3440 * bytes and then copy list into the llm payload.
3442 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3448 /* Copy event list into message payload */
3449 memcpy(cmd_ctx
->llm
->payload
, events
,
3450 sizeof(struct lttng_event
) * nb_events
);
3457 case LTTNG_START_TRACE
:
3459 ret
= cmd_start_trace(cmd_ctx
->session
);
3462 case LTTNG_STOP_TRACE
:
3464 ret
= cmd_stop_trace(cmd_ctx
->session
);
3467 case LTTNG_CREATE_SESSION
:
3469 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3470 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3473 case LTTNG_DESTROY_SESSION
:
3475 ret
= cmd_destroy_session(cmd_ctx
->session
,
3476 cmd_ctx
->lsm
->session
.name
);
3479 case LTTNG_LIST_DOMAINS
:
3482 struct lttng_domain
*domains
;
3484 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3490 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3495 /* Copy event list into message payload */
3496 memcpy(cmd_ctx
->llm
->payload
, domains
,
3497 nb_dom
* sizeof(struct lttng_domain
));
3504 case LTTNG_LIST_CHANNELS
:
3507 struct lttng_channel
*channels
;
3509 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3510 cmd_ctx
->session
, &channels
);
3516 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3521 /* Copy event list into message payload */
3522 memcpy(cmd_ctx
->llm
->payload
, channels
,
3523 nb_chan
* sizeof(struct lttng_channel
));
3530 case LTTNG_LIST_EVENTS
:
3533 struct lttng_event
*events
= NULL
;
3535 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3536 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3542 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3547 /* Copy event list into message payload */
3548 memcpy(cmd_ctx
->llm
->payload
, events
,
3549 nb_event
* sizeof(struct lttng_event
));
3556 case LTTNG_LIST_SESSIONS
:
3558 unsigned int nr_sessions
;
3560 session_lock_list();
3561 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3562 if (nr_sessions
== 0) {
3563 ret
= LTTCOMM_NO_SESSION
;
3564 session_unlock_list();
3567 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3569 session_unlock_list();
3573 /* Filled the session array */
3574 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3575 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3577 session_unlock_list();
3582 case LTTNG_CALIBRATE
:
3584 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3585 &cmd_ctx
->lsm
->u
.calibrate
);
3588 case LTTNG_REGISTER_CONSUMER
:
3590 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3591 cmd_ctx
->lsm
->u
.reg
.path
);
3600 if (cmd_ctx
->llm
== NULL
) {
3601 DBG("Missing llm structure. Allocating one.");
3602 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3606 /* Set return code */
3607 cmd_ctx
->llm
->ret_code
= ret
;
3609 if (cmd_ctx
->session
) {
3610 session_unlock(cmd_ctx
->session
);
3617 * This thread manage all clients request using the unix client socket for
3620 static void *thread_manage_clients(void *data
)
3622 int sock
= 0, ret
, i
, pollfd
;
3623 uint32_t revents
, nb_fd
;
3624 struct command_ctx
*cmd_ctx
= NULL
;
3625 struct lttng_poll_event events
;
3627 DBG("[thread] Manage client started");
3629 rcu_register_thread();
3631 ret
= lttcomm_listen_unix_sock(client_sock
);
3637 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3638 * more will be added to this poll set.
3640 ret
= create_thread_poll_set(&events
, 2);
3645 /* Add the application registration socket */
3646 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3652 * Notify parent pid that we are ready to accept command for client side.
3654 if (opt_sig_parent
) {
3655 kill(ppid
, SIGCHLD
);
3659 DBG("Accepting client command ...");
3661 nb_fd
= LTTNG_POLL_GETNB(&events
);
3663 /* Inifinite blocking call, waiting for transmission */
3664 ret
= lttng_poll_wait(&events
, -1);
3669 for (i
= 0; i
< nb_fd
; i
++) {
3670 /* Fetch once the poll data */
3671 revents
= LTTNG_POLL_GETEV(&events
, i
);
3672 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3674 /* Thread quit pipe has been closed. Killing thread. */
3675 ret
= check_thread_quit_pipe(pollfd
, revents
);
3680 /* Event on the registration socket */
3681 if (pollfd
== client_sock
) {
3682 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3683 ERR("Client socket poll error");
3689 DBG("Wait for client response");
3691 sock
= lttcomm_accept_unix_sock(client_sock
);
3696 /* Set socket option for credentials retrieval */
3697 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3702 /* Allocate context command to process the client request */
3703 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3704 if (cmd_ctx
== NULL
) {
3705 perror("zmalloc cmd_ctx");
3709 /* Allocate data buffer for reception */
3710 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3711 if (cmd_ctx
->lsm
== NULL
) {
3712 perror("zmalloc cmd_ctx->lsm");
3716 cmd_ctx
->llm
= NULL
;
3717 cmd_ctx
->session
= NULL
;
3720 * Data is received from the lttng client. The struct
3721 * lttcomm_session_msg (lsm) contains the command and data request of
3724 DBG("Receiving data from client ...");
3725 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3726 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3728 DBG("Nothing recv() from client... continuing");
3734 // TODO: Validate cmd_ctx including sanity check for
3735 // security purpose.
3737 rcu_thread_online();
3739 * This function dispatch the work to the kernel or userspace tracer
3740 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3741 * informations for the client. The command context struct contains
3742 * everything this function may needs.
3744 ret
= process_client_msg(cmd_ctx
);
3745 rcu_thread_offline();
3748 * TODO: Inform client somehow of the fatal error. At
3749 * this point, ret < 0 means that a zmalloc failed
3750 * (ENOMEM). Error detected but still accept command.
3752 clean_command_ctx(&cmd_ctx
);
3756 DBG("Sending response (size: %d, retcode: %s)",
3757 cmd_ctx
->lttng_msg_size
,
3758 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3759 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3761 ERR("Failed to send data back to client");
3764 /* End of transmission */
3767 clean_command_ctx(&cmd_ctx
);
3771 DBG("Client thread dying");
3772 unlink(client_unix_sock_path
);
3776 lttng_poll_clean(&events
);
3777 clean_command_ctx(&cmd_ctx
);
3779 rcu_unregister_thread();
3785 * usage function on stderr
3787 static void usage(void)
3789 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3790 fprintf(stderr
, " -h, --help Display this usage.\n");
3791 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3792 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3793 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3794 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3795 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3796 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3797 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3798 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3799 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3800 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3801 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3802 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3803 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3804 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3805 fprintf(stderr
, " -V, --version Show version number.\n");
3806 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3807 fprintf(stderr
, " -q, --quiet No output at all.\n");
3808 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3809 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3810 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3814 * daemon argument parsing
3816 static int parse_args(int argc
, char **argv
)
3820 static struct option long_options
[] = {
3821 { "client-sock", 1, 0, 'c' },
3822 { "apps-sock", 1, 0, 'a' },
3823 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3824 { "kconsumerd-err-sock", 1, 0, 'E' },
3825 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3826 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3827 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3828 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3829 { "consumerd32-path", 1, 0, 'u' },
3830 { "consumerd32-libdir", 1, 0, 'U' },
3831 { "consumerd64-path", 1, 0, 't' },
3832 { "consumerd64-libdir", 1, 0, 'T' },
3833 { "daemonize", 0, 0, 'd' },
3834 { "sig-parent", 0, 0, 'S' },
3835 { "help", 0, 0, 'h' },
3836 { "group", 1, 0, 'g' },
3837 { "version", 0, 0, 'V' },
3838 { "quiet", 0, 0, 'q' },
3839 { "verbose", 0, 0, 'v' },
3840 { "verbose-consumer", 0, 0, 'Z' },
3841 { "no-kernel", 0, 0, 'N' },
3846 int option_index
= 0;
3847 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3848 long_options
, &option_index
);
3855 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3857 fprintf(stderr
, " with arg %s\n", optarg
);
3861 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3864 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3870 opt_tracing_group
= optarg
;
3876 fprintf(stdout
, "%s\n", VERSION
);
3882 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3885 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3888 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3891 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3894 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3897 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3906 /* Verbose level can increase using multiple -v */
3910 opt_verbose_consumer
+= 1;
3913 consumerd32_bin
= optarg
;
3916 consumerd32_libdir
= optarg
;
3919 consumerd64_bin
= optarg
;
3922 consumerd64_libdir
= optarg
;
3925 /* Unknown option or other error.
3926 * Error is printed by getopt, just return */
3935 * Creates the two needed socket by the daemon.
3936 * apps_sock - The communication socket for all UST apps.
3937 * client_sock - The communication of the cli tool (lttng).
3939 static int init_daemon_socket(void)
3944 old_umask
= umask(0);
3946 /* Create client tool unix socket */
3947 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3948 if (client_sock
< 0) {
3949 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3954 /* File permission MUST be 660 */
3955 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3957 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3962 /* Create the application unix socket */
3963 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3964 if (apps_sock
< 0) {
3965 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3970 /* File permission MUST be 666 */
3971 ret
= chmod(apps_unix_sock_path
,
3972 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3974 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3985 * Check if the global socket is available, and if a daemon is answering at the
3986 * other side. If yes, error is returned.
3988 static int check_existing_daemon(void)
3990 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3991 access(apps_unix_sock_path
, F_OK
) < 0) {
3995 /* Is there anybody out there ? */
3996 if (lttng_session_daemon_alive()) {
4004 * Set the tracing group gid onto the client socket.
4006 * Race window between mkdir and chown is OK because we are going from more
4007 * permissive (root.root) to les permissive (root.tracing).
4009 static int set_permissions(char *rundir
)
4014 gid
= allowed_group();
4016 WARN("No tracing group detected");
4021 /* Set lttng run dir */
4022 ret
= chown(rundir
, 0, gid
);
4024 ERR("Unable to set group on %s", rundir
);
4028 /* lttng client socket path */
4029 ret
= chown(client_unix_sock_path
, 0, gid
);
4031 ERR("Unable to set group on %s", client_unix_sock_path
);
4035 /* kconsumer error socket path */
4036 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4038 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4042 /* 64-bit ustconsumer error socket path */
4043 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4045 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4049 /* 32-bit ustconsumer compat32 error socket path */
4050 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4052 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4056 DBG("All permissions are set");
4063 * Create the pipe used to wake up the kernel thread.
4065 static int create_kernel_poll_pipe(void)
4067 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4071 * Create the application command pipe to wake thread_manage_apps.
4073 static int create_apps_cmd_pipe(void)
4075 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4079 * Create the lttng run directory needed for all global sockets and pipe.
4081 static int create_lttng_rundir(const char *rundir
)
4085 DBG3("Creating LTTng run directory: %s", rundir
);
4087 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4089 if (errno
!= EEXIST
) {
4090 ERR("Unable to create %s", rundir
);
4102 * Setup sockets and directory needed by the kconsumerd communication with the
4105 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4109 char path
[PATH_MAX
];
4111 switch (consumer_data
->type
) {
4112 case LTTNG_CONSUMER_KERNEL
:
4113 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4115 case LTTNG_CONSUMER64_UST
:
4116 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4118 case LTTNG_CONSUMER32_UST
:
4119 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4122 ERR("Consumer type unknown");
4127 DBG2("Creating consumer directory: %s", path
);
4129 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4131 if (errno
!= EEXIST
) {
4132 ERR("Failed to create %s", path
);
4138 /* Create the kconsumerd error unix socket */
4139 consumer_data
->err_sock
=
4140 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4141 if (consumer_data
->err_sock
< 0) {
4142 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4147 /* File permission MUST be 660 */
4148 ret
= chmod(consumer_data
->err_unix_sock_path
,
4149 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4151 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4161 * Signal handler for the daemon
4163 * Simply stop all worker threads, leaving main() return gracefully after
4164 * joining all threads and calling cleanup().
4166 static void sighandler(int sig
)
4170 DBG("SIGPIPE catched");
4173 DBG("SIGINT catched");
4177 DBG("SIGTERM catched");
4186 * Setup signal handler for :
4187 * SIGINT, SIGTERM, SIGPIPE
4189 static int set_signal_handler(void)
4192 struct sigaction sa
;
4195 if ((ret
= sigemptyset(&sigset
)) < 0) {
4196 perror("sigemptyset");
4200 sa
.sa_handler
= sighandler
;
4201 sa
.sa_mask
= sigset
;
4203 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4204 perror("sigaction");
4208 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4209 perror("sigaction");
4213 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4214 perror("sigaction");
4218 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4224 * Set open files limit to unlimited. This daemon can open a large number of
4225 * file descriptors in order to consumer multiple kernel traces.
4227 static void set_ulimit(void)
4232 /* The kernel does not allowed an infinite limit for open files */
4233 lim
.rlim_cur
= 65535;
4234 lim
.rlim_max
= 65535;
4236 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4238 perror("failed to set open files limit");
4245 int main(int argc
, char **argv
)
4249 const char *home_path
;
4251 rcu_register_thread();
4253 /* Create thread quit pipe */
4254 if ((ret
= init_thread_quit_pipe()) < 0) {
4258 setup_consumerd_path();
4260 /* Parse arguments */
4262 if ((ret
= parse_args(argc
, argv
) < 0)) {
4275 /* Check if daemon is UID = 0 */
4276 is_root
= !getuid();
4279 rundir
= strdup(LTTNG_RUNDIR
);
4281 /* Create global run dir with root access */
4282 ret
= create_lttng_rundir(rundir
);
4287 if (strlen(apps_unix_sock_path
) == 0) {
4288 snprintf(apps_unix_sock_path
, PATH_MAX
,
4289 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4292 if (strlen(client_unix_sock_path
) == 0) {
4293 snprintf(client_unix_sock_path
, PATH_MAX
,
4294 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4297 /* Set global SHM for ust */
4298 if (strlen(wait_shm_path
) == 0) {
4299 snprintf(wait_shm_path
, PATH_MAX
,
4300 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4303 /* Setup kernel consumerd path */
4304 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4305 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4306 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4307 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4309 DBG2("Kernel consumer err path: %s",
4310 kconsumer_data
.err_unix_sock_path
);
4311 DBG2("Kernel consumer cmd path: %s",
4312 kconsumer_data
.cmd_unix_sock_path
);
4314 home_path
= get_home_dir();
4315 if (home_path
== NULL
) {
4316 /* TODO: Add --socket PATH option */
4317 ERR("Can't get HOME directory for sockets creation.");
4323 * Create rundir from home path. This will create something like
4326 ret
= asprintf(&rundir
, LTTNG_HOME_RUNDIR
, home_path
);
4332 ret
= create_lttng_rundir(rundir
);
4337 if (strlen(apps_unix_sock_path
) == 0) {
4338 snprintf(apps_unix_sock_path
, PATH_MAX
,
4339 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4342 /* Set the cli tool unix socket path */
4343 if (strlen(client_unix_sock_path
) == 0) {
4344 snprintf(client_unix_sock_path
, PATH_MAX
,
4345 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4348 /* Set global SHM for ust */
4349 if (strlen(wait_shm_path
) == 0) {
4350 snprintf(wait_shm_path
, PATH_MAX
,
4351 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4355 DBG("Client socket path %s", client_unix_sock_path
);
4356 DBG("Application socket path %s", apps_unix_sock_path
);
4357 DBG("LTTng run directory path: %s", rundir
);
4359 /* 32 bits consumerd path setup */
4360 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4361 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4362 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4363 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4365 DBG2("UST consumer 32 bits err path: %s",
4366 ustconsumer32_data
.err_unix_sock_path
);
4367 DBG2("UST consumer 32 bits cmd path: %s",
4368 ustconsumer32_data
.cmd_unix_sock_path
);
4370 /* 64 bits consumerd path setup */
4371 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4372 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4373 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4374 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4376 DBG2("UST consumer 64 bits err path: %s",
4377 ustconsumer64_data
.err_unix_sock_path
);
4378 DBG2("UST consumer 64 bits cmd path: %s",
4379 ustconsumer64_data
.cmd_unix_sock_path
);
4382 * See if daemon already exist.
4384 if ((ret
= check_existing_daemon()) < 0) {
4385 ERR("Already running daemon.\n");
4387 * We do not goto exit because we must not cleanup()
4388 * because a daemon is already running.
4393 /* After this point, we can safely call cleanup() with "goto exit" */
4396 * These actions must be executed as root. We do that *after* setting up
4397 * the sockets path because we MUST make the check for another daemon using
4398 * those paths *before* trying to set the kernel consumer sockets and init
4402 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4407 /* Setup kernel tracer */
4408 if (!opt_no_kernel
) {
4409 init_kernel_tracer();
4412 /* Set ulimit for open files */
4416 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4421 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4426 if ((ret
= set_signal_handler()) < 0) {
4430 /* Setup the needed unix socket */
4431 if ((ret
= init_daemon_socket()) < 0) {
4435 /* Set credentials to socket */
4436 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4440 /* Get parent pid if -S, --sig-parent is specified. */
4441 if (opt_sig_parent
) {
4445 /* Setup the kernel pipe for waking up the kernel thread */
4446 if ((ret
= create_kernel_poll_pipe()) < 0) {
4450 /* Setup the thread apps communication pipe. */
4451 if ((ret
= create_apps_cmd_pipe()) < 0) {
4455 /* Init UST command queue. */
4456 cds_wfq_init(&ust_cmd_queue
.queue
);
4458 /* Init UST app hash table */
4462 * Get session list pointer. This pointer MUST NOT be free(). This list is
4463 * statically declared in session.c
4465 session_list_ptr
= session_get_list();
4467 /* Set up max poll set size */
4468 lttng_poll_set_max_size();
4470 /* Create thread to manage the client socket */
4471 ret
= pthread_create(&client_thread
, NULL
,
4472 thread_manage_clients
, (void *) NULL
);
4474 perror("pthread_create clients");
4478 /* Create thread to dispatch registration */
4479 ret
= pthread_create(&dispatch_thread
, NULL
,
4480 thread_dispatch_ust_registration
, (void *) NULL
);
4482 perror("pthread_create dispatch");
4486 /* Create thread to manage application registration. */
4487 ret
= pthread_create(®_apps_thread
, NULL
,
4488 thread_registration_apps
, (void *) NULL
);
4490 perror("pthread_create registration");
4494 /* Create thread to manage application socket */
4495 ret
= pthread_create(&apps_thread
, NULL
,
4496 thread_manage_apps
, (void *) NULL
);
4498 perror("pthread_create apps");
4502 /* Create kernel thread to manage kernel event */
4503 ret
= pthread_create(&kernel_thread
, NULL
,
4504 thread_manage_kernel
, (void *) NULL
);
4506 perror("pthread_create kernel");
4510 ret
= pthread_join(kernel_thread
, &status
);
4512 perror("pthread_join");
4513 goto error
; /* join error, exit without cleanup */
4517 ret
= pthread_join(apps_thread
, &status
);
4519 perror("pthread_join");
4520 goto error
; /* join error, exit without cleanup */
4524 ret
= pthread_join(reg_apps_thread
, &status
);
4526 perror("pthread_join");
4527 goto error
; /* join error, exit without cleanup */
4531 ret
= pthread_join(dispatch_thread
, &status
);
4533 perror("pthread_join");
4534 goto error
; /* join error, exit without cleanup */
4538 ret
= pthread_join(client_thread
, &status
);
4540 perror("pthread_join");
4541 goto error
; /* join error, exit without cleanup */
4544 ret
= join_consumer_thread(&kconsumer_data
);
4546 perror("join_consumer");
4547 goto error
; /* join error, exit without cleanup */
4553 * cleanup() is called when no other thread is running.
4555 rcu_thread_online();
4557 rcu_thread_offline();
4558 rcu_unregister_thread();