2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <lttng-consumerd.h>
42 #include <lttng-sessiond-comm.h>
43 #include <lttng/lttng-consumer.h>
48 #include "compat/poll.h"
52 #include "hashtable.h"
54 #include "lttng-sessiond.h"
60 #define CONSUMERD_FILE "lttng-consumerd"
62 struct consumer_data
{
63 enum lttng_consumer_type type
;
65 pthread_t thread
; /* Worker thread interacting with the consumer */
68 /* Mutex to control consumerd pid assignation */
69 pthread_mutex_t pid_mutex
;
75 /* consumer error and command Unix socket path */
76 char err_unix_sock_path
[PATH_MAX
];
77 char cmd_unix_sock_path
[PATH_MAX
];
80 #include "benchmark.h"
83 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
84 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
85 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
86 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
89 int opt_verbose
; /* Not static for lttngerr.h */
90 int opt_verbose_consumer
; /* Not static for lttngerr.h */
91 int opt_quiet
; /* Not static for lttngerr.h */
94 const char *opt_tracing_group
;
95 static int opt_sig_parent
;
96 static int opt_daemon
;
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 */
100 /* Consumer daemon specific control data */
101 static struct consumer_data kconsumer_data
= {
102 .type
= LTTNG_CONSUMER_KERNEL
,
103 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
104 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
106 static struct consumer_data ustconsumer64_data
= {
107 .type
= LTTNG_CONSUMER64_UST
,
108 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
109 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
111 static struct consumer_data ustconsumer32_data
= {
112 .type
= LTTNG_CONSUMER32_UST
,
113 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
114 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
117 static int dispatch_thread_exit
;
119 /* Global application Unix socket path */
120 static char apps_unix_sock_path
[PATH_MAX
];
121 /* Global client Unix socket path */
122 static char client_unix_sock_path
[PATH_MAX
];
123 /* global wait shm path for UST */
124 static char wait_shm_path
[PATH_MAX
];
126 /* Sockets and FDs */
127 static int client_sock
;
128 static int apps_sock
;
129 static int kernel_tracer_fd
;
130 static int kernel_poll_pipe
[2];
133 * Quit pipe for all threads. This permits a single cancellation point
134 * for all threads when receiving an event on the pipe.
136 static int thread_quit_pipe
[2];
139 * This pipe is used to inform the thread managing application communication
140 * that a command is queued and ready to be processed.
142 static int apps_cmd_pipe
[2];
144 /* Pthread, Mutexes and Semaphores */
145 static pthread_t apps_thread
;
146 static pthread_t reg_apps_thread
;
147 static pthread_t client_thread
;
148 static pthread_t kernel_thread
;
149 static pthread_t dispatch_thread
;
153 * UST registration command queue. This queue is tied with a futex and uses a N
154 * wakers / 1 waiter implemented and detailed in futex.c/.h
156 * The thread_manage_apps and thread_dispatch_ust_registration interact with
157 * this queue and the wait/wake scheme.
159 static struct ust_cmd_queue ust_cmd_queue
;
162 * Pointer initialized before thread creation.
164 * This points to the tracing session list containing the session count and a
165 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
166 * MUST NOT be taken if you call a public function in session.c.
168 * The lock is nested inside the structure: session_list_ptr->lock. Please use
169 * session_lock_list and session_unlock_list for lock acquisition.
171 static struct ltt_session_list
*session_list_ptr
;
173 int ust_consumerd64_fd
= -1;
174 int ust_consumerd32_fd
= -1;
176 static const char *consumerd32_bin
=
177 __stringify(CONFIG_CONSUMERD32_BIN
);
178 static const char *consumerd64_bin
=
179 __stringify(CONFIG_CONSUMERD64_BIN
);
180 static const char *consumerd32_libdir
=
181 __stringify(CONFIG_CONSUMERD32_LIBDIR
);
182 static const char *consumerd64_libdir
=
183 __stringify(CONFIG_CONSUMERD64_LIBDIR
);
186 void setup_consumerd_path(void)
188 const char *bin
, *libdir
;
191 * Allow INSTALL_BIN_PATH to be used as a target path for the
192 * native architecture size consumer if CONFIG_CONSUMER*_PATH
193 * has not been defined.
195 #if (CAA_BITS_PER_LONG == 32)
196 if (!consumerd32_bin
[0]) {
197 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
199 if (!consumerd32_libdir
[0]) {
200 consumerd32_libdir
= INSTALL_LIB_PATH
;
202 #elif (CAA_BITS_PER_LONG == 64)
203 if (!consumerd64_bin
[0]) {
204 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
206 if (!consumerd64_libdir
[0]) {
207 consumerd64_libdir
= INSTALL_LIB_PATH
;
210 #error "Unknown bitness"
214 * runtime env. var. overrides the build default.
216 bin
= getenv("LTTNG_CONSUMERD32_BIN");
218 consumerd32_bin
= bin
;
220 bin
= getenv("LTTNG_CONSUMERD64_BIN");
222 consumerd64_bin
= bin
;
224 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
226 consumerd32_libdir
= libdir
;
228 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
230 consumerd64_libdir
= libdir
;
235 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
237 static int create_thread_poll_set(struct lttng_poll_event
*events
,
242 if (events
== NULL
|| size
== 0) {
247 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
253 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
265 * Check if the thread quit pipe was triggered.
267 * Return 1 if it was triggered else 0;
269 static int check_thread_quit_pipe(int fd
, uint32_t events
)
271 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
279 * Remove modules in reverse load order.
281 static int modprobe_remove_kernel_modules(void)
286 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
287 ret
= snprintf(modprobe
, sizeof(modprobe
),
288 "/sbin/modprobe -r -q %s",
289 kernel_modules_list
[i
].name
);
291 perror("snprintf modprobe -r");
294 modprobe
[sizeof(modprobe
) - 1] = '\0';
295 ret
= system(modprobe
);
297 ERR("Unable to launch modprobe -r for module %s",
298 kernel_modules_list
[i
].name
);
299 } else if (kernel_modules_list
[i
].required
300 && WEXITSTATUS(ret
) != 0) {
301 ERR("Unable to remove module %s",
302 kernel_modules_list
[i
].name
);
304 DBG("Modprobe removal successful %s",
305 kernel_modules_list
[i
].name
);
314 * Return group ID of the tracing group or -1 if not found.
316 static gid_t
allowed_group(void)
320 if (opt_tracing_group
) {
321 grp
= getgrnam(opt_tracing_group
);
323 grp
= getgrnam(default_tracing_group
);
333 * Init thread quit pipe.
335 * Return -1 on error or 0 if all pipes are created.
337 static int init_thread_quit_pipe(void)
341 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
343 perror("thread quit pipe");
352 * Complete teardown of a kernel session. This free all data structure related
353 * to a kernel session and update counter.
355 static void teardown_kernel_session(struct ltt_session
*session
)
357 if (!session
->kernel_session
) {
358 DBG3("No kernel session when tearingdown session");
362 DBG("Tearing down kernel session");
365 * If a custom kernel consumer was registered, close the socket before
366 * tearing down the complete kernel session structure
368 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
369 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
372 trace_kernel_destroy_session(session
->kernel_session
);
376 * Complete teardown of all UST sessions. This will free everything on his path
377 * and destroy the core essence of all ust sessions :)
379 static void teardown_ust_session(struct ltt_session
*session
)
383 if (!session
->ust_session
) {
384 DBG3("No UST session when tearingdown session");
388 DBG("Tearing down UST session(s)");
390 ret
= ust_app_destroy_trace_all(session
->ust_session
);
392 ERR("Error in ust_app_destroy_trace_all");
395 trace_ust_destroy_session(session
->ust_session
);
399 * Stop all threads by closing the thread quit pipe.
401 static void stop_threads(void)
405 /* Stopping all threads */
406 DBG("Terminating all threads");
407 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
409 ERR("write error on thread quit pipe");
412 /* Dispatch thread */
413 dispatch_thread_exit
= 1;
414 futex_nto1_wake(&ust_cmd_queue
.futex
);
420 static void cleanup(void)
424 struct ltt_session
*sess
, *stmp
;
429 DBG("Removing %s directory", LTTNG_RUNDIR
);
430 ret
= asprintf(&cmd
, "rm -rf " LTTNG_RUNDIR
);
432 ERR("asprintf failed. Something is really wrong!");
435 /* Remove lttng run directory */
438 ERR("Unable to clean " LTTNG_RUNDIR
);
442 DBG("Cleaning up all session");
444 /* Destroy session list mutex */
445 if (session_list_ptr
!= NULL
) {
446 pthread_mutex_destroy(&session_list_ptr
->lock
);
448 /* Cleanup ALL session */
449 cds_list_for_each_entry_safe(sess
, stmp
,
450 &session_list_ptr
->head
, list
) {
451 teardown_kernel_session(sess
);
452 teardown_ust_session(sess
);
457 DBG("Closing all UST sockets");
458 ust_app_clean_list();
460 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
462 DBG("Closing kernel fd");
463 close(kernel_tracer_fd
);
466 DBG("Unloading kernel modules");
467 modprobe_remove_kernel_modules();
470 close(thread_quit_pipe
[0]);
471 close(thread_quit_pipe
[1]);
473 /* OUTPUT BENCHMARK RESULTS */
476 if (getenv("BENCH_UST_NOTIFY")) {
477 bench_print_ust_notification();
480 if (getenv("BENCH_UST_REGISTER")) {
481 bench_print_ust_register();
482 bench_print_ust_unregister();
485 if (getenv("BENCH_BOOT_PROCESS")) {
486 bench_print_boot_process();
493 MSG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
494 "Matthew, BEET driven development works!%c[%dm",
495 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
500 * Send data on a unix socket using the liblttsessiondcomm API.
502 * Return lttcomm error code.
504 static int send_unix_sock(int sock
, void *buf
, size_t len
)
506 /* Check valid length */
511 return lttcomm_send_unix_sock(sock
, buf
, len
);
515 * Free memory of a command context structure.
517 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
519 DBG("Clean command context structure");
521 if ((*cmd_ctx
)->llm
) {
522 free((*cmd_ctx
)->llm
);
524 if ((*cmd_ctx
)->lsm
) {
525 free((*cmd_ctx
)->lsm
);
533 * Send all stream fds of kernel channel to the consumer.
535 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
536 int sock
, struct ltt_kernel_channel
*channel
)
539 struct ltt_kernel_stream
*stream
;
540 struct lttcomm_consumer_msg lkm
;
542 DBG("Sending streams of channel %s to kernel consumer",
543 channel
->channel
->name
);
546 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
547 lkm
.u
.channel
.channel_key
= channel
->fd
;
548 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
549 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
550 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
551 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
553 perror("send consumer channel");
558 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
562 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
563 lkm
.u
.stream
.channel_key
= channel
->fd
;
564 lkm
.u
.stream
.stream_key
= stream
->fd
;
565 lkm
.u
.stream
.state
= stream
->state
;
566 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
567 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
568 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
569 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
570 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
571 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
573 perror("send consumer stream");
576 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
578 perror("send consumer stream ancillary data");
583 DBG("consumer channel streams sent");
592 * Send all stream fds of the kernel session to the consumer.
594 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
595 struct ltt_kernel_session
*session
)
598 struct ltt_kernel_channel
*chan
;
599 struct lttcomm_consumer_msg lkm
;
600 int sock
= session
->consumer_fd
;
602 DBG("Sending metadata stream fd");
604 /* Extra protection. It's NOT supposed to be set to 0 at this point */
605 if (session
->consumer_fd
== 0) {
606 session
->consumer_fd
= consumer_data
->cmd_sock
;
609 if (session
->metadata_stream_fd
!= 0) {
610 /* Send metadata channel fd */
611 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
612 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
613 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
614 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
615 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
616 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
618 perror("send consumer channel");
622 /* Send metadata stream fd */
623 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
624 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
625 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
626 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
627 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
628 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
629 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
630 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
631 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
632 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
634 perror("send consumer stream");
637 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
639 perror("send consumer stream");
644 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
645 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
);
651 DBG("consumer fds (metadata and channel streams) sent");
660 * Notify UST applications using the shm mmap futex.
662 static int notify_ust_apps(int active
)
666 DBG("Notifying applications of session daemon state: %d", active
);
668 tracepoint(ust_notify_apps_start
);
670 /* See shm.c for this call implying mmap, shm and futex calls */
671 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
672 if (wait_shm_mmap
== NULL
) {
676 /* Wake waiting process */
677 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
679 tracepoint(ust_notify_apps_stop
);
681 /* Apps notified successfully */
689 * Setup the outgoing data buffer for the response (llm) by allocating the
690 * right amount of memory and copying the original information from the lsm
693 * Return total size of the buffer pointed by buf.
695 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
701 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
702 if (cmd_ctx
->llm
== NULL
) {
708 /* Copy common data */
709 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
710 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
712 cmd_ctx
->llm
->data_size
= size
;
713 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
722 * Update the kernel poll set of all channel fd available over all tracing
723 * session. Add the wakeup pipe at the end of the set.
725 static int update_kernel_poll(struct lttng_poll_event
*events
)
728 struct ltt_session
*session
;
729 struct ltt_kernel_channel
*channel
;
731 DBG("Updating kernel poll set");
734 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
735 session_lock(session
);
736 if (session
->kernel_session
== NULL
) {
737 session_unlock(session
);
741 cds_list_for_each_entry(channel
,
742 &session
->kernel_session
->channel_list
.head
, list
) {
743 /* Add channel fd to the kernel poll set */
744 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
746 session_unlock(session
);
749 DBG("Channel fd %d added to kernel set", channel
->fd
);
751 session_unlock(session
);
753 session_unlock_list();
758 session_unlock_list();
763 * Find the channel fd from 'fd' over all tracing session. When found, check
764 * for new channel stream and send those stream fds to the kernel consumer.
766 * Useful for CPU hotplug feature.
768 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
771 struct ltt_session
*session
;
772 struct ltt_kernel_channel
*channel
;
774 DBG("Updating kernel streams for channel fd %d", fd
);
777 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
778 session_lock(session
);
779 if (session
->kernel_session
== NULL
) {
780 session_unlock(session
);
784 /* This is not suppose to be 0 but this is an extra security check */
785 if (session
->kernel_session
->consumer_fd
== 0) {
786 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
789 cds_list_for_each_entry(channel
,
790 &session
->kernel_session
->channel_list
.head
, list
) {
791 if (channel
->fd
== fd
) {
792 DBG("Channel found, updating kernel streams");
793 ret
= kernel_open_channel_stream(channel
);
799 * Have we already sent fds to the consumer? If yes, it means
800 * that tracing is started so it is safe to send our updated
803 if (session
->kernel_session
->consumer_fds_sent
== 1) {
804 ret
= send_kconsumer_channel_streams(consumer_data
,
805 session
->kernel_session
->consumer_fd
, channel
);
813 session_unlock(session
);
815 session_unlock_list();
819 session_unlock(session
);
820 session_unlock_list();
825 * For each tracing session, update newly registered apps.
827 static void update_ust_app(int app_sock
)
829 struct ltt_session
*sess
, *stmp
;
831 /* For all tracing session(s) */
832 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
833 if (sess
->ust_session
) {
834 ust_app_global_update(sess
->ust_session
, app_sock
);
840 * This thread manage event coming from the kernel.
842 * Features supported in this thread:
845 static void *thread_manage_kernel(void *data
)
847 int ret
, i
, pollfd
, update_poll_flag
= 1;
848 uint32_t revents
, nb_fd
;
850 struct lttng_poll_event events
;
852 tracepoint(sessiond_th_kern_start
);
854 DBG("Thread manage kernel started");
856 ret
= create_thread_poll_set(&events
, 2);
861 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
867 if (update_poll_flag
== 1) {
869 * Reset number of fd in the poll set. Always 2 since there is the thread
870 * quit pipe and the kernel pipe.
874 ret
= update_kernel_poll(&events
);
878 update_poll_flag
= 0;
881 nb_fd
= LTTNG_POLL_GETNB(&events
);
883 DBG("Thread kernel polling on %d fds", nb_fd
);
885 /* Zeroed the poll events */
886 lttng_poll_reset(&events
);
888 tracepoint(sessiond_th_kern_poll
);
890 /* Poll infinite value of time */
891 ret
= lttng_poll_wait(&events
, -1);
894 } else if (ret
== 0) {
895 /* Should not happen since timeout is infinite */
896 ERR("Return value of poll is 0 with an infinite timeout.\n"
897 "This should not have happened! Continuing...");
901 for (i
= 0; i
< nb_fd
; i
++) {
902 /* Fetch once the poll data */
903 revents
= LTTNG_POLL_GETEV(&events
, i
);
904 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
906 /* Thread quit pipe has been closed. Killing thread. */
907 ret
= check_thread_quit_pipe(pollfd
, revents
);
912 /* Check for data on kernel pipe */
913 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
914 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
915 update_poll_flag
= 1;
919 * New CPU detected by the kernel. Adding kernel stream to
920 * kernel session and updating the kernel consumer
922 if (revents
& LPOLLIN
) {
923 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
929 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
930 * and unregister kernel stream at this point.
938 DBG("Kernel thread dying");
939 close(kernel_poll_pipe
[0]);
940 close(kernel_poll_pipe
[1]);
942 lttng_poll_clean(&events
);
948 * This thread manage the consumer error sent back to the session daemon.
950 static void *thread_manage_consumer(void *data
)
952 int sock
= 0, i
, ret
, pollfd
;
953 uint32_t revents
, nb_fd
;
954 enum lttcomm_return_code code
;
955 struct lttng_poll_event events
;
956 struct consumer_data
*consumer_data
= data
;
958 tracepoint(sessiond_th_kcon_start
);
960 DBG("[thread] Manage consumer started");
962 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
968 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
969 * Nothing more will be added to this poll set.
971 ret
= create_thread_poll_set(&events
, 2);
976 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
981 nb_fd
= LTTNG_POLL_GETNB(&events
);
983 tracepoint(sessiond_th_kcon_poll
);
985 /* Inifinite blocking call, waiting for transmission */
986 ret
= lttng_poll_wait(&events
, -1);
991 for (i
= 0; i
< nb_fd
; i
++) {
992 /* Fetch once the poll data */
993 revents
= LTTNG_POLL_GETEV(&events
, i
);
994 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
996 /* Thread quit pipe has been closed. Killing thread. */
997 ret
= check_thread_quit_pipe(pollfd
, revents
);
1002 /* Event on the registration socket */
1003 if (pollfd
== consumer_data
->err_sock
) {
1004 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1005 ERR("consumer err socket poll error");
1011 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1016 DBG2("Receiving code from consumer err_sock");
1018 /* Getting status code from kconsumerd */
1019 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1020 sizeof(enum lttcomm_return_code
));
1025 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1026 consumer_data
->cmd_sock
=
1027 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1028 if (consumer_data
->cmd_sock
< 0) {
1029 sem_post(&consumer_data
->sem
);
1030 PERROR("consumer connect");
1033 /* Signal condition to tell that the kconsumerd is ready */
1034 sem_post(&consumer_data
->sem
);
1035 DBG("consumer command socket ready");
1037 ERR("consumer error when waiting for SOCK_READY : %s",
1038 lttcomm_get_readable_code(-code
));
1042 /* Remove the kconsumerd error sock since we've established a connexion */
1043 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1048 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1053 /* Update number of fd */
1054 nb_fd
= LTTNG_POLL_GETNB(&events
);
1056 /* Inifinite blocking call, waiting for transmission */
1057 ret
= lttng_poll_wait(&events
, -1);
1062 for (i
= 0; i
< nb_fd
; i
++) {
1063 /* Fetch once the poll data */
1064 revents
= LTTNG_POLL_GETEV(&events
, i
);
1065 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1067 /* Thread quit pipe has been closed. Killing thread. */
1068 ret
= check_thread_quit_pipe(pollfd
, revents
);
1073 /* Event on the kconsumerd socket */
1074 if (pollfd
== sock
) {
1075 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1076 ERR("consumer err socket second poll error");
1082 /* Wait for any kconsumerd error */
1083 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1084 sizeof(enum lttcomm_return_code
));
1086 ERR("consumer closed the command socket");
1090 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1093 DBG("consumer thread dying");
1094 close(consumer_data
->err_sock
);
1095 close(consumer_data
->cmd_sock
);
1098 unlink(consumer_data
->err_unix_sock_path
);
1099 unlink(consumer_data
->cmd_unix_sock_path
);
1100 consumer_data
->pid
= 0;
1102 lttng_poll_clean(&events
);
1108 * This thread manage application communication.
1110 static void *thread_manage_apps(void *data
)
1113 uint32_t revents
, nb_fd
;
1114 struct ust_command ust_cmd
;
1115 struct lttng_poll_event events
;
1117 tracepoint(sessiond_th_apps_start
);
1119 DBG("[thread] Manage application started");
1121 rcu_register_thread();
1122 rcu_thread_online();
1124 ret
= create_thread_poll_set(&events
, 2);
1129 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1135 /* Zeroed the events structure */
1136 lttng_poll_reset(&events
);
1138 nb_fd
= LTTNG_POLL_GETNB(&events
);
1140 DBG("Apps thread polling on %d fds", nb_fd
);
1142 tracepoint(sessiond_th_apps_poll
);
1144 /* Inifinite blocking call, waiting for transmission */
1145 ret
= lttng_poll_wait(&events
, -1);
1150 for (i
= 0; i
< nb_fd
; i
++) {
1151 /* Fetch once the poll data */
1152 revents
= LTTNG_POLL_GETEV(&events
, i
);
1153 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1155 /* Thread quit pipe has been closed. Killing thread. */
1156 ret
= check_thread_quit_pipe(pollfd
, revents
);
1161 /* Inspect the apps cmd pipe */
1162 if (pollfd
== apps_cmd_pipe
[0]) {
1163 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1164 ERR("Apps command pipe error");
1166 } else if (revents
& LPOLLIN
) {
1167 tracepoint(ust_register_read_start
);
1169 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1170 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1171 perror("read apps cmd pipe");
1174 tracepoint(ust_register_read_stop
);
1176 tracepoint(ust_register_add_start
);
1177 /* Register applicaton to the session daemon */
1178 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1180 if (ret
== -ENOMEM
) {
1182 } else if (ret
< 0) {
1185 tracepoint(ust_register_add_stop
);
1187 tracepoint(ust_register_done_start
);
1189 * Add channel(s) and event(s) to newly registered apps
1190 * from lttng global UST domain.
1192 update_ust_app(ust_cmd
.sock
);
1194 ret
= ustctl_register_done(ust_cmd
.sock
);
1197 * If the registration is not possible, we simply
1198 * unregister the apps and continue
1200 ust_app_unregister(ust_cmd
.sock
);
1203 * We just need here to monitor the close of the UST
1204 * socket and poll set monitor those by default.
1206 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1211 DBG("Apps with sock %d added to poll set",
1214 tracepoint(ust_register_done_stop
);
1219 * At this point, we know that a registered application made
1220 * the event at poll_wait.
1222 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1223 tracepoint(ust_unregister_start
);
1225 /* Removing from the poll set */
1226 ret
= lttng_poll_del(&events
, pollfd
);
1231 /* Socket closed on remote end. */
1232 ust_app_unregister(pollfd
);
1234 tracepoint(ust_unregister_stop
);
1242 DBG("Application communication apps dying");
1243 close(apps_cmd_pipe
[0]);
1244 close(apps_cmd_pipe
[1]);
1246 lttng_poll_clean(&events
);
1248 rcu_thread_offline();
1249 rcu_unregister_thread();
1254 * Dispatch request from the registration threads to the application
1255 * communication thread.
1257 static void *thread_dispatch_ust_registration(void *data
)
1260 struct cds_wfq_node
*node
;
1261 struct ust_command
*ust_cmd
= NULL
;
1263 tracepoint(sessiond_th_dispatch_start
);
1265 DBG("[thread] Dispatch UST command started");
1267 while (!dispatch_thread_exit
) {
1268 /* Atomically prepare the queue futex */
1269 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1272 tracepoint(sessiond_th_dispatch_block
);
1274 /* Dequeue command for registration */
1275 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1277 DBG("Woken up but nothing in the UST command queue");
1278 /* Continue thread execution */
1282 tracepoint(ust_dispatch_register_start
);
1284 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1286 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1287 " gid:%d sock:%d name:%s (version %d.%d)",
1288 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1289 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1290 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1291 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1293 * Inform apps thread of the new application registration. This
1294 * call is blocking so we can be assured that the data will be read
1295 * at some point in time or wait to the end of the world :)
1297 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1298 sizeof(struct ust_command
));
1300 perror("write apps cmd pipe");
1301 if (errno
== EBADF
) {
1303 * We can't inform the application thread to process
1304 * registration. We will exit or else application
1305 * registration will not occur and tracing will never
1312 } while (node
!= NULL
);
1314 tracepoint(ust_dispatch_register_stop
);
1316 /* Futex wait on queue. Blocking call on futex() */
1317 futex_nto1_wait(&ust_cmd_queue
.futex
);
1321 DBG("Dispatch thread dying");
1326 * This thread manage application registration.
1328 static void *thread_registration_apps(void *data
)
1330 int sock
= 0, i
, ret
, pollfd
;
1331 uint32_t revents
, nb_fd
;
1332 struct lttng_poll_event events
;
1334 * Get allocated in this thread, enqueued to a global queue, dequeued and
1335 * freed in the manage apps thread.
1337 struct ust_command
*ust_cmd
= NULL
;
1339 tracepoint(sessiond_th_reg_start
);
1341 DBG("[thread] Manage application registration started");
1343 ret
= lttcomm_listen_unix_sock(apps_sock
);
1349 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1350 * more will be added to this poll set.
1352 ret
= create_thread_poll_set(&events
, 2);
1357 /* Add the application registration socket */
1358 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1363 /* Notify all applications to register */
1364 ret
= notify_ust_apps(1);
1366 ERR("Failed to notify applications or create the wait shared memory.\n"
1367 "Execution continues but there might be problem for already\n"
1368 "running applications that wishes to register.");
1372 DBG("Accepting application registration");
1374 tracepoint(sessiond_th_reg_poll
);
1376 nb_fd
= LTTNG_POLL_GETNB(&events
);
1378 /* Inifinite blocking call, waiting for transmission */
1379 ret
= lttng_poll_wait(&events
, -1);
1384 for (i
= 0; i
< nb_fd
; i
++) {
1385 /* Fetch once the poll data */
1386 revents
= LTTNG_POLL_GETEV(&events
, i
);
1387 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1389 /* Thread quit pipe has been closed. Killing thread. */
1390 ret
= check_thread_quit_pipe(pollfd
, revents
);
1395 /* Event on the registration socket */
1396 if (pollfd
== apps_sock
) {
1397 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1398 ERR("Register apps socket poll error");
1400 } else if (revents
& LPOLLIN
) {
1401 /* Registration starts here. Recording cycles */
1402 tracepoint(ust_register_start
);
1404 sock
= lttcomm_accept_unix_sock(apps_sock
);
1409 /* Create UST registration command for enqueuing */
1410 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1411 if (ust_cmd
== NULL
) {
1412 perror("ust command zmalloc");
1417 * Using message-based transmissions to ensure we don't
1418 * have to deal with partially received messages.
1420 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1421 sizeof(struct ust_register_msg
));
1422 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1424 perror("lttcomm_recv_unix_sock register apps");
1426 ERR("Wrong size received on apps register");
1433 ust_cmd
->sock
= sock
;
1435 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1436 " gid:%d sock:%d name:%s (version %d.%d)",
1437 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1438 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1439 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1440 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1443 * Lock free enqueue the registration request. The red pill
1444 * has been taken! This apps will be part of the *system*.
1446 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1449 * Wake the registration queue futex. Implicit memory
1450 * barrier with the exchange in cds_wfq_enqueue.
1452 futex_nto1_wake(&ust_cmd_queue
.futex
);
1454 tracepoint(ust_register_stop
);
1461 DBG("UST Registration thread dying");
1463 /* Notify that the registration thread is gone */
1468 unlink(apps_unix_sock_path
);
1470 lttng_poll_clean(&events
);
1476 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1477 * exec or it will fails.
1479 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1482 struct timespec timeout
;
1484 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1485 timeout
.tv_nsec
= 0;
1487 /* Setup semaphore */
1488 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1490 PERROR("sem_init consumer semaphore");
1494 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1495 thread_manage_consumer
, consumer_data
);
1497 PERROR("pthread_create consumer");
1502 /* Get time for sem_timedwait absolute timeout */
1503 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1505 PERROR("clock_gettime spawn consumer");
1506 /* Infinite wait for the kconsumerd thread to be ready */
1507 ret
= sem_wait(&consumer_data
->sem
);
1509 /* Normal timeout if the gettime was successful */
1510 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1511 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1515 if (errno
== ETIMEDOUT
) {
1517 * Call has timed out so we kill the kconsumerd_thread and return
1520 ERR("The consumer thread was never ready. Killing it");
1521 ret
= pthread_cancel(consumer_data
->thread
);
1523 PERROR("pthread_cancel consumer thread");
1526 PERROR("semaphore wait failed consumer thread");
1531 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1532 if (consumer_data
->pid
== 0) {
1533 ERR("Kconsumerd did not start");
1534 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1537 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1546 * Join consumer thread
1548 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1553 if (consumer_data
->pid
!= 0) {
1554 ret
= kill(consumer_data
->pid
, SIGTERM
);
1556 ERR("Error killing consumer daemon");
1559 return pthread_join(consumer_data
->thread
, &status
);
1566 * Fork and exec a consumer daemon (consumerd).
1568 * Return pid if successful else -1.
1570 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1574 const char *consumer_to_use
;
1575 const char *verbosity
;
1578 DBG("Spawning consumerd");
1585 if (opt_verbose
> 1 || opt_verbose_consumer
) {
1586 verbosity
= "--verbose";
1588 verbosity
= "--quiet";
1590 switch (consumer_data
->type
) {
1591 case LTTNG_CONSUMER_KERNEL
:
1593 * Find out which consumerd to execute. We will
1594 * first try the 64-bit path, then the
1595 * sessiond's installation directory, and
1596 * fallback on the 32-bit one,
1598 if (stat(consumerd64_bin
, &st
) == 0) {
1599 consumer_to_use
= consumerd64_bin
;
1600 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1601 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1602 } else if (stat(consumerd32_bin
, &st
) == 0) {
1603 consumer_to_use
= consumerd32_bin
;
1607 DBG("Using kernel consumer at: %s", consumer_to_use
);
1608 execl(consumer_to_use
,
1609 "lttng-consumerd", verbosity
, "-k",
1610 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1611 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1614 case LTTNG_CONSUMER64_UST
:
1616 char *tmpnew
= NULL
;
1618 if (consumerd64_libdir
[0] != '\0') {
1622 tmp
= getenv("LD_LIBRARY_PATH");
1626 tmplen
= strlen("LD_LIBRARY_PATH=")
1627 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1628 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1633 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1634 strcat(tmpnew
, consumerd64_libdir
);
1635 if (tmp
[0] != '\0') {
1636 strcat(tmpnew
, ":");
1637 strcat(tmpnew
, tmp
);
1639 ret
= putenv(tmpnew
);
1645 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1646 ret
= execl(consumerd64_bin
, verbosity
, "-u",
1647 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1648 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1650 if (consumerd64_libdir
[0] != '\0') {
1658 case LTTNG_CONSUMER32_UST
:
1660 char *tmpnew
= NULL
;
1662 if (consumerd32_libdir
[0] != '\0') {
1666 tmp
= getenv("LD_LIBRARY_PATH");
1670 tmplen
= strlen("LD_LIBRARY_PATH=")
1671 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1672 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1677 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1678 strcat(tmpnew
, consumerd32_libdir
);
1679 if (tmp
[0] != '\0') {
1680 strcat(tmpnew
, ":");
1681 strcat(tmpnew
, tmp
);
1683 ret
= putenv(tmpnew
);
1689 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1690 ret
= execl(consumerd32_bin
, verbosity
, "-u",
1691 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1692 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1694 if (consumerd32_libdir
[0] != '\0') {
1703 perror("unknown consumer type");
1707 perror("kernel start consumer exec");
1710 } else if (pid
> 0) {
1713 perror("start consumer fork");
1721 * Spawn the consumerd daemon and session daemon thread.
1723 static int start_consumerd(struct consumer_data
*consumer_data
)
1727 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1728 if (consumer_data
->pid
!= 0) {
1729 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1733 ret
= spawn_consumerd(consumer_data
);
1735 ERR("Spawning consumerd failed");
1736 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1740 /* Setting up the consumer_data pid */
1741 consumer_data
->pid
= ret
;
1742 DBG2("Consumer pid %d", consumer_data
->pid
);
1743 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1745 DBG2("Spawning consumer control thread");
1746 ret
= spawn_consumer_thread(consumer_data
);
1748 ERR("Fatal error spawning consumer control thread");
1760 * modprobe_kernel_modules
1762 static int modprobe_kernel_modules(void)
1767 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1768 ret
= snprintf(modprobe
, sizeof(modprobe
),
1769 "/sbin/modprobe %s%s",
1770 kernel_modules_list
[i
].required
? "" : "-q ",
1771 kernel_modules_list
[i
].name
);
1773 perror("snprintf modprobe");
1776 modprobe
[sizeof(modprobe
) - 1] = '\0';
1777 ret
= system(modprobe
);
1779 ERR("Unable to launch modprobe for module %s",
1780 kernel_modules_list
[i
].name
);
1781 } else if (kernel_modules_list
[i
].required
1782 && WEXITSTATUS(ret
) != 0) {
1783 ERR("Unable to load module %s",
1784 kernel_modules_list
[i
].name
);
1786 DBG("Modprobe successfully %s",
1787 kernel_modules_list
[i
].name
);
1798 static int mount_debugfs(char *path
)
1801 char *type
= "debugfs";
1803 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1805 PERROR("Cannot create debugfs path");
1809 ret
= mount(type
, path
, type
, 0, NULL
);
1811 PERROR("Cannot mount debugfs");
1815 DBG("Mounted debugfs successfully at %s", path
);
1822 * Setup necessary data for kernel tracer action.
1824 static void init_kernel_tracer(void)
1827 char *proc_mounts
= "/proc/mounts";
1829 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1832 /* Detect debugfs */
1833 fp
= fopen(proc_mounts
, "r");
1835 ERR("Unable to probe %s", proc_mounts
);
1839 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1840 if (strstr(line
, "debugfs") != NULL
) {
1841 /* Remove first string */
1843 /* Dup string here so we can reuse line later on */
1844 debugfs_path
= strdup(strtok(NULL
, " "));
1845 DBG("Got debugfs path : %s", debugfs_path
);
1852 /* Mount debugfs if needded */
1853 if (debugfs_path
== NULL
) {
1854 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1856 perror("asprintf debugfs path");
1859 ret
= mount_debugfs(debugfs_path
);
1861 perror("Cannot mount debugfs");
1866 /* Modprobe lttng kernel modules */
1867 ret
= modprobe_kernel_modules();
1872 /* Setup lttng kernel path */
1873 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1875 perror("asprintf lttng path");
1879 /* Open debugfs lttng */
1880 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1881 if (kernel_tracer_fd
< 0) {
1882 DBG("Failed to open %s", lttng_path
);
1888 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1898 WARN("No kernel tracer available");
1899 kernel_tracer_fd
= 0;
1904 * Init tracing by creating trace directory and sending fds kernel consumer.
1906 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1910 if (session
->consumer_fds_sent
== 0) {
1912 * Assign default kernel consumer socket if no consumer assigned to the
1913 * kernel session. At this point, it's NOT suppose to be 0 but this is
1914 * an extra security check.
1916 if (session
->consumer_fd
== 0) {
1917 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1920 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1922 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1926 session
->consumer_fds_sent
= 1;
1934 * Create an UST session and add it to the session ust list.
1936 static int create_ust_session(struct ltt_session
*session
,
1937 struct lttng_domain
*domain
)
1941 struct ltt_ust_session
*lus
= NULL
;
1943 switch (domain
->type
) {
1944 case LTTNG_DOMAIN_UST
:
1947 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1951 DBG("Creating UST session");
1954 lus
= trace_ust_create_session(session
->path
, uid
, domain
);
1956 ret
= LTTCOMM_UST_SESS_FAIL
;
1960 ret
= mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1961 geteuid(), allowed_group());
1963 if (ret
!= -EEXIST
) {
1964 ERR("Trace directory creation error");
1965 ret
= LTTCOMM_UST_SESS_FAIL
;
1970 /* The domain type dictate different actions on session creation */
1971 switch (domain
->type
) {
1972 case LTTNG_DOMAIN_UST
:
1973 /* No ustctl for the global UST domain */
1976 ERR("Unknown UST domain on create session %d", domain
->type
);
1979 session
->ust_session
= lus
;
1989 * Create a kernel tracer session then create the default channel.
1991 static int create_kernel_session(struct ltt_session
*session
)
1995 DBG("Creating kernel session");
1997 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1999 ret
= LTTCOMM_KERN_SESS_FAIL
;
2003 /* Set kernel consumer socket fd */
2004 if (kconsumer_data
.cmd_sock
) {
2005 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
2008 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
2009 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
2011 if (ret
!= -EEXIST
) {
2012 ERR("Trace directory creation error");
2022 * Using the session list, filled a lttng_session array to send back to the
2023 * client for session listing.
2025 * The session list lock MUST be acquired before calling this function. Use
2026 * session_lock_list() and session_unlock_list().
2028 static void list_lttng_sessions(struct lttng_session
*sessions
)
2031 struct ltt_session
*session
;
2033 DBG("Getting all available session");
2035 * Iterate over session list and append data after the control struct in
2038 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2039 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2040 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2041 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2042 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2043 sessions
[i
].enabled
= session
->enabled
;
2049 * Fill lttng_channel array of all channels.
2051 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2052 struct lttng_channel
*channels
)
2055 struct ltt_kernel_channel
*kchan
;
2057 DBG("Listing channels for session %s", session
->name
);
2060 case LTTNG_DOMAIN_KERNEL
:
2061 /* Kernel channels */
2062 if (session
->kernel_session
!= NULL
) {
2063 cds_list_for_each_entry(kchan
,
2064 &session
->kernel_session
->channel_list
.head
, list
) {
2065 /* Copy lttng_channel struct to array */
2066 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2067 channels
[i
].enabled
= kchan
->enabled
;
2072 case LTTNG_DOMAIN_UST
:
2074 struct cds_lfht_iter iter
;
2075 struct ltt_ust_channel
*uchan
;
2077 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
2078 &iter
, uchan
, node
) {
2079 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2080 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2081 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2082 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2083 channels
[i
].attr
.switch_timer_interval
=
2084 uchan
->attr
.switch_timer_interval
;
2085 channels
[i
].attr
.read_timer_interval
=
2086 uchan
->attr
.read_timer_interval
;
2087 channels
[i
].enabled
= uchan
->enabled
;
2088 switch (uchan
->attr
.output
) {
2089 case LTTNG_UST_MMAP
:
2091 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2104 * Create a list of ust global domain events.
2106 static int list_lttng_ust_global_events(char *channel_name
,
2107 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2110 unsigned int nb_event
= 0;
2111 struct cds_lfht_iter iter
;
2112 struct cds_lfht_node
*node
;
2113 struct ltt_ust_channel
*uchan
;
2114 struct ltt_ust_event
*uevent
;
2115 struct lttng_event
*tmp
;
2117 DBG("Listing UST global events for channel %s", channel_name
);
2121 node
= hashtable_lookup(ust_global
->channels
, (void *) channel_name
,
2122 strlen(channel_name
), &iter
);
2124 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2128 uchan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
2130 nb_event
+= hashtable_get_count(uchan
->events
);
2132 if (nb_event
== 0) {
2137 DBG3("Listing UST global %d events", nb_event
);
2139 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2141 ret
= -LTTCOMM_FATAL
;
2145 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
2146 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2147 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2148 tmp
[i
].enabled
= uevent
->enabled
;
2149 switch (uevent
->attr
.instrumentation
) {
2150 case LTTNG_UST_TRACEPOINT
:
2151 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2153 case LTTNG_UST_PROBE
:
2154 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2156 case LTTNG_UST_FUNCTION
:
2157 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2159 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2160 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2175 * Fill lttng_event array of all kernel events in the channel.
2177 static int list_lttng_kernel_events(char *channel_name
,
2178 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2181 unsigned int nb_event
;
2182 struct ltt_kernel_event
*event
;
2183 struct ltt_kernel_channel
*kchan
;
2185 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2186 if (kchan
== NULL
) {
2187 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2191 nb_event
= kchan
->event_count
;
2193 DBG("Listing events for channel %s", kchan
->channel
->name
);
2195 if (nb_event
== 0) {
2200 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2201 if (*events
== NULL
) {
2202 ret
= LTTCOMM_FATAL
;
2206 /* Kernel channels */
2207 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2208 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2209 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2210 (*events
)[i
].enabled
= event
->enabled
;
2211 switch (event
->event
->instrumentation
) {
2212 case LTTNG_KERNEL_TRACEPOINT
:
2213 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2215 case LTTNG_KERNEL_KPROBE
:
2216 case LTTNG_KERNEL_KRETPROBE
:
2217 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2218 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2219 sizeof(struct lttng_kernel_kprobe
));
2221 case LTTNG_KERNEL_FUNCTION
:
2222 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2223 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2224 sizeof(struct lttng_kernel_function
));
2226 case LTTNG_KERNEL_NOOP
:
2227 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2229 case LTTNG_KERNEL_SYSCALL
:
2230 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2232 case LTTNG_KERNEL_ALL
:
2246 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2248 static int cmd_disable_channel(struct ltt_session
*session
,
2249 int domain
, char *channel_name
)
2252 struct ltt_ust_session
*usess
;
2254 usess
= session
->ust_session
;
2257 case LTTNG_DOMAIN_KERNEL
:
2259 ret
= channel_kernel_disable(session
->kernel_session
,
2261 if (ret
!= LTTCOMM_OK
) {
2265 kernel_wait_quiescent(kernel_tracer_fd
);
2268 case LTTNG_DOMAIN_UST
:
2270 struct ltt_ust_channel
*uchan
;
2271 struct cds_lfht
*chan_ht
;
2273 chan_ht
= usess
->domain_global
.channels
;
2275 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2276 if (uchan
== NULL
) {
2277 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2281 ret
= channel_ust_disable(usess
, domain
, uchan
);
2282 if (ret
!= LTTCOMM_OK
) {
2287 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2288 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2289 case LTTNG_DOMAIN_UST_PID
:
2290 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2293 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2304 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2306 static int cmd_enable_channel(struct ltt_session
*session
,
2307 int domain
, struct lttng_channel
*attr
)
2310 struct ltt_ust_session
*usess
= session
->ust_session
;
2311 struct cds_lfht
*chan_ht
;
2313 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2316 case LTTNG_DOMAIN_KERNEL
:
2318 struct ltt_kernel_channel
*kchan
;
2320 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2321 session
->kernel_session
);
2322 if (kchan
== NULL
) {
2323 ret
= channel_kernel_create(session
->kernel_session
,
2324 attr
, kernel_poll_pipe
[1]);
2326 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2329 if (ret
!= LTTCOMM_OK
) {
2333 kernel_wait_quiescent(kernel_tracer_fd
);
2336 case LTTNG_DOMAIN_UST
:
2338 struct ltt_ust_channel
*uchan
;
2340 chan_ht
= usess
->domain_global
.channels
;
2342 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2343 if (uchan
== NULL
) {
2344 ret
= channel_ust_create(usess
, domain
, attr
);
2346 ret
= channel_ust_enable(usess
, domain
, uchan
);
2350 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2351 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2352 case LTTNG_DOMAIN_UST_PID
:
2353 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2356 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2365 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2367 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2368 char *channel_name
, char *event_name
)
2373 case LTTNG_DOMAIN_KERNEL
:
2375 struct ltt_kernel_channel
*kchan
;
2376 struct ltt_kernel_session
*ksess
;
2378 ksess
= session
->kernel_session
;
2380 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2381 if (kchan
== NULL
) {
2382 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2386 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2387 if (ret
!= LTTCOMM_OK
) {
2391 kernel_wait_quiescent(kernel_tracer_fd
);
2394 case LTTNG_DOMAIN_UST
:
2396 struct ltt_ust_channel
*uchan
;
2397 struct ltt_ust_session
*usess
;
2399 usess
= session
->ust_session
;
2401 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2403 if (uchan
== NULL
) {
2404 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2408 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2409 if (ret
!= LTTCOMM_OK
) {
2413 DBG3("Disable UST event %s in channel %s completed", event_name
,
2417 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2418 case LTTNG_DOMAIN_UST_PID
:
2419 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2421 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2432 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2434 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2440 case LTTNG_DOMAIN_KERNEL
:
2442 struct ltt_kernel_session
*ksess
;
2443 struct ltt_kernel_channel
*kchan
;
2445 ksess
= session
->kernel_session
;
2447 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2448 if (kchan
== NULL
) {
2449 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2453 ret
= event_kernel_disable_all(ksess
, kchan
);
2454 if (ret
!= LTTCOMM_OK
) {
2458 kernel_wait_quiescent(kernel_tracer_fd
);
2461 case LTTNG_DOMAIN_UST
:
2463 struct ltt_ust_session
*usess
;
2464 struct ltt_ust_channel
*uchan
;
2466 usess
= session
->ust_session
;
2468 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2470 if (uchan
== NULL
) {
2471 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2475 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2480 DBG3("Disable all UST events in channel %s completed", channel_name
);
2484 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2485 case LTTNG_DOMAIN_UST_PID
:
2486 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2488 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2499 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2501 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2502 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2507 case LTTNG_DOMAIN_KERNEL
:
2508 /* Add kernel context to kernel tracer */
2509 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2510 event_name
, channel_name
);
2511 if (ret
!= LTTCOMM_OK
) {
2515 case LTTNG_DOMAIN_UST
:
2517 struct ltt_ust_session
*usess
= session
->ust_session
;
2519 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2520 if (ret
!= LTTCOMM_OK
) {
2525 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2526 case LTTNG_DOMAIN_UST_PID
:
2527 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2529 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2540 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2542 * TODO: currently, both events and loglevels are kept within the same
2543 * namespace for UST global registry/app registery, so if an event
2544 * happen to have the same name as the loglevel (very unlikely though),
2545 * and an attempt is made to enable/disable both in the same session,
2546 * the first to be created will be the only one allowed to exist.
2548 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2549 char *channel_name
, struct lttng_event
*event
)
2552 struct lttng_channel
*attr
;
2553 struct ltt_ust_session
*usess
= session
->ust_session
;
2556 case LTTNG_DOMAIN_KERNEL
:
2558 struct ltt_kernel_channel
*kchan
;
2560 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2561 session
->kernel_session
);
2562 if (kchan
== NULL
) {
2563 attr
= channel_new_default_attr(domain
);
2565 ret
= LTTCOMM_FATAL
;
2568 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2570 /* This call will notify the kernel thread */
2571 ret
= channel_kernel_create(session
->kernel_session
,
2572 attr
, kernel_poll_pipe
[1]);
2573 if (ret
!= LTTCOMM_OK
) {
2580 /* Get the newly created kernel channel pointer */
2581 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2582 session
->kernel_session
);
2583 if (kchan
== NULL
) {
2584 /* This sould not happen... */
2585 ret
= LTTCOMM_FATAL
;
2589 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2591 if (ret
!= LTTCOMM_OK
) {
2595 kernel_wait_quiescent(kernel_tracer_fd
);
2598 case LTTNG_DOMAIN_UST
:
2600 struct lttng_channel
*attr
;
2601 struct ltt_ust_channel
*uchan
;
2603 /* Get channel from global UST domain */
2604 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2606 if (uchan
== NULL
) {
2607 /* Create default channel */
2608 attr
= channel_new_default_attr(domain
);
2610 ret
= LTTCOMM_FATAL
;
2613 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2614 attr
->name
[NAME_MAX
- 1] = '\0';
2616 ret
= channel_ust_create(usess
, domain
, attr
);
2617 if (ret
!= LTTCOMM_OK
) {
2623 /* Get the newly created channel reference back */
2624 uchan
= trace_ust_find_channel_by_name(
2625 usess
->domain_global
.channels
, channel_name
);
2626 if (uchan
== NULL
) {
2627 /* Something is really wrong */
2628 ret
= LTTCOMM_FATAL
;
2633 /* At this point, the session and channel exist on the tracer */
2635 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2636 if (ret
!= LTTCOMM_OK
) {
2641 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2642 case LTTNG_DOMAIN_UST_PID
:
2643 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2645 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2656 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2658 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2659 char *channel_name
, int event_type
)
2662 struct ltt_kernel_channel
*kchan
;
2665 case LTTNG_DOMAIN_KERNEL
:
2666 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2667 session
->kernel_session
);
2668 if (kchan
== NULL
) {
2669 /* This call will notify the kernel thread */
2670 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2671 kernel_poll_pipe
[1]);
2672 if (ret
!= LTTCOMM_OK
) {
2676 /* Get the newly created kernel channel pointer */
2677 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2678 session
->kernel_session
);
2679 if (kchan
== NULL
) {
2680 /* This sould not happen... */
2681 ret
= LTTCOMM_FATAL
;
2687 switch (event_type
) {
2688 case LTTNG_EVENT_SYSCALL
:
2689 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2690 kchan
, kernel_tracer_fd
);
2692 case LTTNG_EVENT_TRACEPOINT
:
2694 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2695 * events already registered to the channel.
2697 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2698 kchan
, kernel_tracer_fd
);
2700 case LTTNG_EVENT_ALL
:
2701 /* Enable syscalls and tracepoints */
2702 ret
= event_kernel_enable_all(session
->kernel_session
,
2703 kchan
, kernel_tracer_fd
);
2706 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2710 /* Manage return value */
2711 if (ret
!= LTTCOMM_OK
) {
2715 kernel_wait_quiescent(kernel_tracer_fd
);
2717 case LTTNG_DOMAIN_UST
:
2719 struct lttng_channel
*attr
;
2720 struct ltt_ust_channel
*uchan
;
2721 struct ltt_ust_session
*usess
= session
->ust_session
;
2723 /* Get channel from global UST domain */
2724 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2726 if (uchan
== NULL
) {
2727 /* Create default channel */
2728 attr
= channel_new_default_attr(domain
);
2730 ret
= LTTCOMM_FATAL
;
2733 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2734 attr
->name
[NAME_MAX
- 1] = '\0';
2736 /* Use the internal command enable channel */
2737 ret
= channel_ust_create(usess
, domain
, attr
);
2738 if (ret
!= LTTCOMM_OK
) {
2744 /* Get the newly created channel reference back */
2745 uchan
= trace_ust_find_channel_by_name(
2746 usess
->domain_global
.channels
, channel_name
);
2747 if (uchan
== NULL
) {
2748 /* Something is really wrong */
2749 ret
= LTTCOMM_FATAL
;
2754 /* At this point, the session and channel exist on the tracer */
2756 switch (event_type
) {
2757 case LTTNG_EVENT_ALL
:
2758 case LTTNG_EVENT_TRACEPOINT
:
2759 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2760 if (ret
!= LTTCOMM_OK
) {
2765 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2769 /* Manage return value */
2770 if (ret
!= LTTCOMM_OK
) {
2776 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2777 case LTTNG_DOMAIN_UST_PID
:
2778 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2780 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2791 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2793 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2796 ssize_t nb_events
= 0;
2799 case LTTNG_DOMAIN_KERNEL
:
2800 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2801 if (nb_events
< 0) {
2802 ret
= LTTCOMM_KERN_LIST_FAIL
;
2806 case LTTNG_DOMAIN_UST
:
2807 nb_events
= ust_app_list_events(events
);
2808 if (nb_events
< 0) {
2809 ret
= LTTCOMM_UST_LIST_FAIL
;
2814 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2821 /* Return negative value to differentiate return code */
2826 * Command LTTNG_START_TRACE processed by the client thread.
2828 static int cmd_start_trace(struct ltt_session
*session
)
2831 struct ltt_kernel_session
*ksession
;
2832 struct ltt_ust_session
*usess
;
2835 ksession
= session
->kernel_session
;
2836 usess
= session
->ust_session
;
2838 if (session
->enabled
)
2839 return LTTCOMM_UST_START_FAIL
;
2840 session
->enabled
= 1;
2842 /* Kernel tracing */
2843 if (ksession
!= NULL
) {
2844 struct ltt_kernel_channel
*kchan
;
2846 /* Open kernel metadata */
2847 if (ksession
->metadata
== NULL
) {
2848 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2850 ret
= LTTCOMM_KERN_META_FAIL
;
2855 /* Open kernel metadata stream */
2856 if (ksession
->metadata_stream_fd
== 0) {
2857 ret
= kernel_open_metadata_stream(ksession
);
2859 ERR("Kernel create metadata stream failed");
2860 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2865 /* For each channel */
2866 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2867 if (kchan
->stream_count
== 0) {
2868 ret
= kernel_open_channel_stream(kchan
);
2870 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2873 /* Update the stream global counter */
2874 ksession
->stream_count_global
+= ret
;
2878 /* Setup kernel consumer socket and send fds to it */
2879 ret
= init_kernel_tracing(ksession
);
2881 ret
= LTTCOMM_KERN_START_FAIL
;
2885 /* This start the kernel tracing */
2886 ret
= kernel_start_session(ksession
);
2888 ret
= LTTCOMM_KERN_START_FAIL
;
2892 /* Quiescent wait after starting trace */
2893 kernel_wait_quiescent(kernel_tracer_fd
);
2896 /* Flag session that trace should start automatically */
2898 usess
->start_trace
= 1;
2900 ret
= ust_app_start_trace_all(usess
);
2902 ret
= LTTCOMM_UST_START_FAIL
;
2914 * Command LTTNG_STOP_TRACE processed by the client thread.
2916 static int cmd_stop_trace(struct ltt_session
*session
)
2919 struct ltt_kernel_channel
*kchan
;
2920 struct ltt_kernel_session
*ksession
;
2921 struct ltt_ust_session
*usess
;
2924 ksession
= session
->kernel_session
;
2925 usess
= session
->ust_session
;
2927 if (!session
->enabled
)
2928 return LTTCOMM_UST_START_FAIL
;
2929 session
->enabled
= 0;
2932 if (ksession
!= NULL
) {
2933 DBG("Stop kernel tracing");
2935 /* Flush all buffers before stopping */
2936 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2938 ERR("Kernel metadata flush failed");
2941 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2942 ret
= kernel_flush_buffer(kchan
);
2944 ERR("Kernel flush buffer error");
2948 ret
= kernel_stop_session(ksession
);
2950 ret
= LTTCOMM_KERN_STOP_FAIL
;
2954 kernel_wait_quiescent(kernel_tracer_fd
);
2958 usess
->start_trace
= 0;
2960 ret
= ust_app_stop_trace_all(usess
);
2962 ret
= LTTCOMM_UST_START_FAIL
;
2974 * Command LTTNG_CREATE_SESSION processed by the client thread.
2976 static int cmd_create_session(char *name
, char *path
)
2980 ret
= session_create(name
, path
);
2981 if (ret
!= LTTCOMM_OK
) {
2992 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2994 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2998 /* Clean kernel session teardown */
2999 teardown_kernel_session(session
);
3000 /* UST session teardown */
3001 teardown_ust_session(session
);
3004 * Must notify the kernel thread here to update it's poll setin order
3005 * to remove the channel(s)' fd just destroyed.
3007 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3009 perror("write kernel poll pipe");
3012 ret
= session_destroy(session
);
3018 * Command LTTNG_CALIBRATE processed by the client thread.
3020 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3025 case LTTNG_DOMAIN_KERNEL
:
3027 struct lttng_kernel_calibrate kcalibrate
;
3029 kcalibrate
.type
= calibrate
->type
;
3030 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3032 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3038 /* TODO: Userspace tracing */
3039 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3050 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3052 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3058 case LTTNG_DOMAIN_KERNEL
:
3059 /* Can't register a consumer if there is already one */
3060 if (session
->kernel_session
->consumer_fd
!= 0) {
3061 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3065 sock
= lttcomm_connect_unix_sock(sock_path
);
3067 ret
= LTTCOMM_CONNECT_FAIL
;
3071 session
->kernel_session
->consumer_fd
= sock
;
3074 /* TODO: Userspace tracing */
3075 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3086 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3088 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3089 struct lttng_domain
**domains
)
3094 if (session
->kernel_session
!= NULL
) {
3095 DBG3("Listing domains found kernel domain");
3099 if (session
->ust_session
!= NULL
) {
3100 DBG3("Listing domains found UST global domain");
3104 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3105 if (*domains
== NULL
) {
3106 ret
= -LTTCOMM_FATAL
;
3110 if (session
->kernel_session
!= NULL
) {
3111 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3115 if (session
->ust_session
!= NULL
) {
3116 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3127 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3129 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3130 struct lttng_channel
**channels
)
3133 ssize_t nb_chan
= 0;
3136 case LTTNG_DOMAIN_KERNEL
:
3137 if (session
->kernel_session
!= NULL
) {
3138 nb_chan
= session
->kernel_session
->channel_count
;
3140 DBG3("Number of kernel channels %zd", nb_chan
);
3142 case LTTNG_DOMAIN_UST
:
3143 if (session
->ust_session
!= NULL
) {
3144 nb_chan
= hashtable_get_count(
3145 session
->ust_session
->domain_global
.channels
);
3147 DBG3("Number of UST global channels %zd", nb_chan
);
3151 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3156 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3157 if (*channels
== NULL
) {
3158 ret
= -LTTCOMM_FATAL
;
3162 list_lttng_channels(domain
, session
, *channels
);
3174 * Command LTTNG_LIST_EVENTS processed by the client thread.
3176 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3177 char *channel_name
, struct lttng_event
**events
)
3180 ssize_t nb_event
= 0;
3183 case LTTNG_DOMAIN_KERNEL
:
3184 if (session
->kernel_session
!= NULL
) {
3185 nb_event
= list_lttng_kernel_events(channel_name
,
3186 session
->kernel_session
, events
);
3189 case LTTNG_DOMAIN_UST
:
3191 if (session
->ust_session
!= NULL
) {
3192 nb_event
= list_lttng_ust_global_events(channel_name
,
3193 &session
->ust_session
->domain_global
, events
);
3198 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3209 * Process the command requested by the lttng client within the command
3210 * context structure. This function make sure that the return structure (llm)
3211 * is set and ready for transmission before returning.
3213 * Return any error encountered or 0 for success.
3215 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3217 int ret
= LTTCOMM_OK
;
3218 int need_tracing_session
= 1;
3220 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
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
);
3361 /* Process by command type */
3362 switch (cmd_ctx
->lsm
->cmd_type
) {
3363 case LTTNG_ADD_CONTEXT
:
3365 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3366 cmd_ctx
->lsm
->u
.context
.channel_name
,
3367 cmd_ctx
->lsm
->u
.context
.event_name
,
3368 &cmd_ctx
->lsm
->u
.context
.ctx
);
3371 case LTTNG_DISABLE_CHANNEL
:
3373 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3374 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3377 case LTTNG_DISABLE_EVENT
:
3379 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3380 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3381 cmd_ctx
->lsm
->u
.disable
.name
);
3385 case LTTNG_DISABLE_ALL_EVENT
:
3387 DBG("Disabling all events");
3389 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3390 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3393 case LTTNG_ENABLE_CHANNEL
:
3395 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3396 &cmd_ctx
->lsm
->u
.channel
.chan
);
3399 case LTTNG_ENABLE_EVENT
:
3401 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3402 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3403 &cmd_ctx
->lsm
->u
.enable
.event
);
3406 case LTTNG_ENABLE_ALL_EVENT
:
3408 DBG("Enabling all events");
3410 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3411 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3412 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3415 case LTTNG_LIST_TRACEPOINTS
:
3417 struct lttng_event
*events
;
3420 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3421 if (nb_events
< 0) {
3427 * Setup lttng message with payload size set to the event list size in
3428 * bytes and then copy list into the llm payload.
3430 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3436 /* Copy event list into message payload */
3437 memcpy(cmd_ctx
->llm
->payload
, events
,
3438 sizeof(struct lttng_event
) * nb_events
);
3445 case LTTNG_START_TRACE
:
3447 ret
= cmd_start_trace(cmd_ctx
->session
);
3450 case LTTNG_STOP_TRACE
:
3452 ret
= cmd_stop_trace(cmd_ctx
->session
);
3455 case LTTNG_CREATE_SESSION
:
3457 tracepoint(create_session_start
);
3458 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3459 cmd_ctx
->lsm
->session
.path
);
3460 tracepoint(create_session_end
);
3463 case LTTNG_DESTROY_SESSION
:
3465 tracepoint(destroy_session_start
);
3466 ret
= cmd_destroy_session(cmd_ctx
->session
,
3467 cmd_ctx
->lsm
->session
.name
);
3468 tracepoint(destroy_session_end
);
3471 case LTTNG_LIST_DOMAINS
:
3474 struct lttng_domain
*domains
;
3476 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3482 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3487 /* Copy event list into message payload */
3488 memcpy(cmd_ctx
->llm
->payload
, domains
,
3489 nb_dom
* sizeof(struct lttng_domain
));
3496 case LTTNG_LIST_CHANNELS
:
3499 struct lttng_channel
*channels
;
3501 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3502 cmd_ctx
->session
, &channels
);
3508 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3513 /* Copy event list into message payload */
3514 memcpy(cmd_ctx
->llm
->payload
, channels
,
3515 nb_chan
* sizeof(struct lttng_channel
));
3522 case LTTNG_LIST_EVENTS
:
3525 struct lttng_event
*events
= NULL
;
3527 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3528 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3534 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3539 /* Copy event list into message payload */
3540 memcpy(cmd_ctx
->llm
->payload
, events
,
3541 nb_event
* sizeof(struct lttng_event
));
3548 case LTTNG_LIST_SESSIONS
:
3550 session_lock_list();
3552 if (session_list_ptr
->count
== 0) {
3553 ret
= LTTCOMM_NO_SESSION
;
3554 session_unlock_list();
3558 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3559 session_list_ptr
->count
);
3561 session_unlock_list();
3565 /* Filled the session array */
3566 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3568 session_unlock_list();
3573 case LTTNG_CALIBRATE
:
3575 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3576 &cmd_ctx
->lsm
->u
.calibrate
);
3579 case LTTNG_REGISTER_CONSUMER
:
3581 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3582 cmd_ctx
->lsm
->u
.reg
.path
);
3591 if (cmd_ctx
->llm
== NULL
) {
3592 DBG("Missing llm structure. Allocating one.");
3593 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3597 /* Set return code */
3598 cmd_ctx
->llm
->ret_code
= ret
;
3600 if (cmd_ctx
->session
) {
3601 session_unlock(cmd_ctx
->session
);
3608 * This thread manage all clients request using the unix client socket for
3611 static void *thread_manage_clients(void *data
)
3613 int sock
= 0, ret
, i
, pollfd
;
3614 uint32_t revents
, nb_fd
;
3615 struct command_ctx
*cmd_ctx
= NULL
;
3616 struct lttng_poll_event events
;
3618 tracepoint(sessiond_th_cli_start
);
3620 DBG("[thread] Manage client started");
3622 rcu_register_thread();
3624 ret
= lttcomm_listen_unix_sock(client_sock
);
3630 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3631 * more will be added to this poll set.
3633 ret
= create_thread_poll_set(&events
, 2);
3638 /* Add the application registration socket */
3639 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3645 * Notify parent pid that we are ready to accept command for client side.
3647 if (opt_sig_parent
) {
3648 kill(ppid
, SIGCHLD
);
3652 DBG("Accepting client command ...");
3654 tracepoint(sessiond_th_cli_poll
);
3656 nb_fd
= LTTNG_POLL_GETNB(&events
);
3658 /* Inifinite blocking call, waiting for transmission */
3659 ret
= lttng_poll_wait(&events
, -1);
3664 for (i
= 0; i
< nb_fd
; i
++) {
3665 /* Fetch once the poll data */
3666 revents
= LTTNG_POLL_GETEV(&events
, i
);
3667 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3669 /* Thread quit pipe has been closed. Killing thread. */
3670 ret
= check_thread_quit_pipe(pollfd
, revents
);
3675 /* Event on the registration socket */
3676 if (pollfd
== client_sock
) {
3677 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3678 ERR("Client socket poll error");
3684 DBG("Wait for client response");
3686 sock
= lttcomm_accept_unix_sock(client_sock
);
3691 /* Allocate context command to process the client request */
3692 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3693 if (cmd_ctx
== NULL
) {
3694 perror("zmalloc cmd_ctx");
3698 /* Allocate data buffer for reception */
3699 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3700 if (cmd_ctx
->lsm
== NULL
) {
3701 perror("zmalloc cmd_ctx->lsm");
3705 cmd_ctx
->llm
= NULL
;
3706 cmd_ctx
->session
= NULL
;
3709 * Data is received from the lttng client. The struct
3710 * lttcomm_session_msg (lsm) contains the command and data request of
3713 DBG("Receiving data from client ...");
3714 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
,
3715 sizeof(struct lttcomm_session_msg
));
3717 DBG("Nothing recv() from client... continuing");
3723 // TODO: Validate cmd_ctx including sanity check for
3724 // security purpose.
3726 rcu_thread_online();
3728 * This function dispatch the work to the kernel or userspace tracer
3729 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3730 * informations for the client. The command context struct contains
3731 * everything this function may needs.
3733 ret
= process_client_msg(cmd_ctx
);
3734 rcu_thread_offline();
3737 * TODO: Inform client somehow of the fatal error. At
3738 * this point, ret < 0 means that a zmalloc failed
3739 * (ENOMEM). Error detected but still accept command.
3741 clean_command_ctx(&cmd_ctx
);
3745 DBG("Sending response (size: %d, retcode: %s)",
3746 cmd_ctx
->lttng_msg_size
,
3747 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3748 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3750 ERR("Failed to send data back to client");
3753 clean_command_ctx(&cmd_ctx
);
3755 /* End of transmission */
3760 DBG("Client thread dying");
3761 unlink(client_unix_sock_path
);
3765 lttng_poll_clean(&events
);
3766 clean_command_ctx(&cmd_ctx
);
3768 rcu_unregister_thread();
3774 * usage function on stderr
3776 static void usage(void)
3778 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3779 fprintf(stderr
, " -h, --help Display this usage.\n");
3780 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3781 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3782 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3783 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3784 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3785 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3786 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3787 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3788 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3789 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3790 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3791 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3792 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3793 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3794 fprintf(stderr
, " -V, --version Show version number.\n");
3795 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3796 fprintf(stderr
, " -q, --quiet No output at all.\n");
3797 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3798 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3802 * daemon argument parsing
3804 static int parse_args(int argc
, char **argv
)
3808 static struct option long_options
[] = {
3809 { "client-sock", 1, 0, 'c' },
3810 { "apps-sock", 1, 0, 'a' },
3811 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3812 { "kconsumerd-err-sock", 1, 0, 'E' },
3813 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3814 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3815 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3816 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3817 { "consumerd32-path", 1, 0, 'u' },
3818 { "consumerd32-libdir", 1, 0, 'U' },
3819 { "consumerd64-path", 1, 0, 't' },
3820 { "consumerd64-libdir", 1, 0, 'T' },
3821 { "daemonize", 0, 0, 'd' },
3822 { "sig-parent", 0, 0, 'S' },
3823 { "help", 0, 0, 'h' },
3824 { "group", 1, 0, 'g' },
3825 { "version", 0, 0, 'V' },
3826 { "quiet", 0, 0, 'q' },
3827 { "verbose", 0, 0, 'v' },
3828 { "verbose-consumer", 0, 0, 'Z' },
3833 int option_index
= 0;
3834 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:C:E:D:F:Z:u:t",
3835 long_options
, &option_index
);
3842 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3844 fprintf(stderr
, " with arg %s\n", optarg
);
3848 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3851 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3857 opt_tracing_group
= optarg
;
3863 fprintf(stdout
, "%s\n", VERSION
);
3869 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3872 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3875 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3878 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3881 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3884 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3890 /* Verbose level can increase using multiple -v */
3894 opt_verbose_consumer
+= 1;
3897 consumerd32_bin
= optarg
;
3900 consumerd32_libdir
= optarg
;
3903 consumerd64_bin
= optarg
;
3906 consumerd64_libdir
= optarg
;
3909 /* Unknown option or other error.
3910 * Error is printed by getopt, just return */
3919 * Creates the two needed socket by the daemon.
3920 * apps_sock - The communication socket for all UST apps.
3921 * client_sock - The communication of the cli tool (lttng).
3923 static int init_daemon_socket(void)
3928 old_umask
= umask(0);
3930 /* Create client tool unix socket */
3931 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3932 if (client_sock
< 0) {
3933 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3938 /* File permission MUST be 660 */
3939 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3941 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3946 /* Create the application unix socket */
3947 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3948 if (apps_sock
< 0) {
3949 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3954 /* File permission MUST be 666 */
3955 ret
= chmod(apps_unix_sock_path
,
3956 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3958 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3969 * Check if the global socket is available, and if a daemon is answering at the
3970 * other side. If yes, error is returned.
3972 static int check_existing_daemon(void)
3974 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3975 access(apps_unix_sock_path
, F_OK
) < 0) {
3979 /* Is there anybody out there ? */
3980 if (lttng_session_daemon_alive()) {
3988 * Set the tracing group gid onto the client socket.
3990 * Race window between mkdir and chown is OK because we are going from more
3991 * permissive (root.root) to les permissive (root.tracing).
3993 static int set_permissions(void)
3998 gid
= allowed_group();
4001 WARN("No tracing group detected");
4004 ERR("Missing tracing group. Aborting execution.");
4010 /* Set lttng run dir */
4011 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
4013 ERR("Unable to set group on " LTTNG_RUNDIR
);
4017 /* lttng client socket path */
4018 ret
= chown(client_unix_sock_path
, 0, gid
);
4020 ERR("Unable to set group on %s", client_unix_sock_path
);
4024 /* kconsumer error socket path */
4025 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4027 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4031 /* 64-bit ustconsumer error socket path */
4032 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4034 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4038 /* 32-bit ustconsumer compat32 error socket path */
4039 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4041 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4045 DBG("All permissions are set");
4052 * Create the pipe used to wake up the kernel thread.
4054 static int create_kernel_poll_pipe(void)
4056 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4060 * Create the application command pipe to wake thread_manage_apps.
4062 static int create_apps_cmd_pipe(void)
4064 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4068 * Create the lttng run directory needed for all global sockets and pipe.
4070 static int create_lttng_rundir(void)
4074 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
4076 if (errno
!= EEXIST
) {
4077 ERR("Unable to create " LTTNG_RUNDIR
);
4089 * Setup sockets and directory needed by the kconsumerd communication with the
4092 static int set_consumer_sockets(struct consumer_data
*consumer_data
)
4097 switch (consumer_data
->type
) {
4098 case LTTNG_CONSUMER_KERNEL
:
4099 path
= KCONSUMERD_PATH
;
4101 case LTTNG_CONSUMER64_UST
:
4102 path
= USTCONSUMERD64_PATH
;
4104 case LTTNG_CONSUMER32_UST
:
4105 path
= USTCONSUMERD32_PATH
;
4108 ERR("Consumer type unknown");
4113 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4115 if (errno
!= EEXIST
) {
4116 ERR("Failed to create %s", path
);
4122 /* Create the kconsumerd error unix socket */
4123 consumer_data
->err_sock
=
4124 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4125 if (consumer_data
->err_sock
< 0) {
4126 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4131 /* File permission MUST be 660 */
4132 ret
= chmod(consumer_data
->err_unix_sock_path
,
4133 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4135 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4145 * Signal handler for the daemon
4147 * Simply stop all worker threads, leaving main() return gracefully after
4148 * joining all threads and calling cleanup().
4150 static void sighandler(int sig
)
4154 DBG("SIGPIPE catched");
4157 DBG("SIGINT catched");
4161 DBG("SIGTERM catched");
4170 * Setup signal handler for :
4171 * SIGINT, SIGTERM, SIGPIPE
4173 static int set_signal_handler(void)
4176 struct sigaction sa
;
4179 if ((ret
= sigemptyset(&sigset
)) < 0) {
4180 perror("sigemptyset");
4184 sa
.sa_handler
= sighandler
;
4185 sa
.sa_mask
= sigset
;
4187 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4188 perror("sigaction");
4192 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4193 perror("sigaction");
4197 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4198 perror("sigaction");
4202 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4208 * Set open files limit to unlimited. This daemon can open a large number of
4209 * file descriptors in order to consumer multiple kernel traces.
4211 static void set_ulimit(void)
4216 /* The kernel does not allowed an infinite limit for open files */
4217 lim
.rlim_cur
= 65535;
4218 lim
.rlim_max
= 65535;
4220 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4222 perror("failed to set open files limit");
4229 int main(int argc
, char **argv
)
4233 const char *home_path
;
4235 tracepoint(sessiond_boot_start
);
4236 rcu_register_thread();
4238 /* Create thread quit pipe */
4239 if ((ret
= init_thread_quit_pipe()) < 0) {
4243 setup_consumerd_path();
4245 /* Parse arguments */
4247 if ((ret
= parse_args(argc
, argv
) < 0)) {
4260 /* Check if daemon is UID = 0 */
4261 is_root
= !getuid();
4264 ret
= create_lttng_rundir();
4269 if (strlen(apps_unix_sock_path
) == 0) {
4270 snprintf(apps_unix_sock_path
, PATH_MAX
,
4271 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4274 if (strlen(client_unix_sock_path
) == 0) {
4275 snprintf(client_unix_sock_path
, PATH_MAX
,
4276 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4279 /* Set global SHM for ust */
4280 if (strlen(wait_shm_path
) == 0) {
4281 snprintf(wait_shm_path
, PATH_MAX
,
4282 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4285 home_path
= get_home_dir();
4286 if (home_path
== NULL
) {
4287 /* TODO: Add --socket PATH option */
4288 ERR("Can't get HOME directory for sockets creation.");
4293 if (strlen(apps_unix_sock_path
) == 0) {
4294 snprintf(apps_unix_sock_path
, PATH_MAX
,
4295 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4298 /* Set the cli tool unix socket path */
4299 if (strlen(client_unix_sock_path
) == 0) {
4300 snprintf(client_unix_sock_path
, PATH_MAX
,
4301 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4304 /* Set global SHM for ust */
4305 if (strlen(wait_shm_path
) == 0) {
4306 snprintf(wait_shm_path
, PATH_MAX
,
4307 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4311 DBG("Client socket path %s", client_unix_sock_path
);
4312 DBG("Application socket path %s", apps_unix_sock_path
);
4315 * See if daemon already exist.
4317 if ((ret
= check_existing_daemon()) < 0) {
4318 ERR("Already running daemon.\n");
4320 * We do not goto exit because we must not cleanup()
4321 * because a daemon is already running.
4326 /* After this point, we can safely call cleanup() with "goto exit" */
4329 * These actions must be executed as root. We do that *after* setting up
4330 * the sockets path because we MUST make the check for another daemon using
4331 * those paths *before* trying to set the kernel consumer sockets and init
4335 ret
= set_consumer_sockets(&kconsumer_data
);
4340 ret
= set_consumer_sockets(&ustconsumer64_data
);
4345 ret
= set_consumer_sockets(&ustconsumer32_data
);
4350 /* Setup kernel tracer */
4351 init_kernel_tracer();
4353 /* Set ulimit for open files */
4357 if ((ret
= set_signal_handler()) < 0) {
4361 /* Setup the needed unix socket */
4362 if ((ret
= init_daemon_socket()) < 0) {
4366 /* Set credentials to socket */
4367 if (is_root
&& ((ret
= set_permissions()) < 0)) {
4371 /* Get parent pid if -S, --sig-parent is specified. */
4372 if (opt_sig_parent
) {
4376 /* Setup the kernel pipe for waking up the kernel thread */
4377 if ((ret
= create_kernel_poll_pipe()) < 0) {
4381 /* Setup the thread apps communication pipe. */
4382 if ((ret
= create_apps_cmd_pipe()) < 0) {
4386 /* Init UST command queue. */
4387 cds_wfq_init(&ust_cmd_queue
.queue
);
4389 /* Init UST app hash table */
4393 * Get session list pointer. This pointer MUST NOT be free(). This list is
4394 * statically declared in session.c
4396 session_list_ptr
= session_get_list();
4398 /* Set up max poll set size */
4399 lttng_poll_set_max_size();
4401 /* Create thread to manage the client socket */
4402 ret
= pthread_create(&client_thread
, NULL
,
4403 thread_manage_clients
, (void *) NULL
);
4405 perror("pthread_create clients");
4409 /* Create thread to dispatch registration */
4410 ret
= pthread_create(&dispatch_thread
, NULL
,
4411 thread_dispatch_ust_registration
, (void *) NULL
);
4413 perror("pthread_create dispatch");
4417 /* Create thread to manage application registration. */
4418 ret
= pthread_create(®_apps_thread
, NULL
,
4419 thread_registration_apps
, (void *) NULL
);
4421 perror("pthread_create registration");
4425 /* Create thread to manage application socket */
4426 ret
= pthread_create(&apps_thread
, NULL
,
4427 thread_manage_apps
, (void *) NULL
);
4429 perror("pthread_create apps");
4433 /* Create kernel thread to manage kernel event */
4434 ret
= pthread_create(&kernel_thread
, NULL
,
4435 thread_manage_kernel
, (void *) NULL
);
4437 perror("pthread_create kernel");
4441 tracepoint(sessiond_boot_end
);
4443 ret
= pthread_join(kernel_thread
, &status
);
4445 perror("pthread_join");
4446 goto error
; /* join error, exit without cleanup */
4450 ret
= pthread_join(apps_thread
, &status
);
4452 perror("pthread_join");
4453 goto error
; /* join error, exit without cleanup */
4457 ret
= pthread_join(reg_apps_thread
, &status
);
4459 perror("pthread_join");
4460 goto error
; /* join error, exit without cleanup */
4464 ret
= pthread_join(dispatch_thread
, &status
);
4466 perror("pthread_join");
4467 goto error
; /* join error, exit without cleanup */
4471 ret
= pthread_join(client_thread
, &status
);
4473 perror("pthread_join");
4474 goto error
; /* join error, exit without cleanup */
4477 ret
= join_consumer_thread(&kconsumer_data
);
4479 perror("join_consumer");
4480 goto error
; /* join error, exit without cleanup */
4486 * cleanup() is called when no other thread is running.
4488 rcu_thread_online();
4490 rcu_thread_offline();
4491 rcu_unregister_thread();