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_path
=
177 __stringify(CONFIG_CONSUMERD32_PATH
);
178 static const char *consumerd64_path
=
179 __stringify(CONFIG_CONSUMERD64_PATH
);
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 *path
, *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_path
[0]) {
197 consumerd32_path
= 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_path
[0]) {
204 consumerd64_path
= 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 path
= getenv("LTTNG_CONSUMERD32_PATH");
218 consumerd32_path
= path
;
220 path
= getenv("LTTNG_CONSUMERD64_PATH");
222 consumerd64_path
= path
;
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 /* Removing from the poll set */
1224 ret
= lttng_poll_del(&events
, pollfd
);
1229 /* Socket closed on remote end. */
1230 ust_app_unregister(pollfd
);
1238 DBG("Application communication apps dying");
1239 close(apps_cmd_pipe
[0]);
1240 close(apps_cmd_pipe
[1]);
1242 lttng_poll_clean(&events
);
1244 rcu_thread_offline();
1245 rcu_unregister_thread();
1250 * Dispatch request from the registration threads to the application
1251 * communication thread.
1253 static void *thread_dispatch_ust_registration(void *data
)
1256 struct cds_wfq_node
*node
;
1257 struct ust_command
*ust_cmd
= NULL
;
1259 tracepoint(sessiond_th_dispatch_start
);
1261 DBG("[thread] Dispatch UST command started");
1263 while (!dispatch_thread_exit
) {
1264 /* Atomically prepare the queue futex */
1265 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1268 tracepoint(sessiond_th_dispatch_block
);
1270 /* Dequeue command for registration */
1271 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1273 DBG("Woken up but nothing in the UST command queue");
1274 /* Continue thread execution */
1278 tracepoint(ust_dispatch_register_start
);
1280 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1282 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1283 " gid:%d sock:%d name:%s (version %d.%d)",
1284 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1285 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1286 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1287 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1289 * Inform apps thread of the new application registration. This
1290 * call is blocking so we can be assured that the data will be read
1291 * at some point in time or wait to the end of the world :)
1293 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1294 sizeof(struct ust_command
));
1296 perror("write apps cmd pipe");
1297 if (errno
== EBADF
) {
1299 * We can't inform the application thread to process
1300 * registration. We will exit or else application
1301 * registration will not occur and tracing will never
1308 } while (node
!= NULL
);
1310 tracepoint(ust_dispatch_register_stop
);
1312 /* Futex wait on queue. Blocking call on futex() */
1313 futex_nto1_wait(&ust_cmd_queue
.futex
);
1317 DBG("Dispatch thread dying");
1322 * This thread manage application registration.
1324 static void *thread_registration_apps(void *data
)
1326 int sock
= 0, i
, ret
, pollfd
;
1327 uint32_t revents
, nb_fd
;
1328 struct lttng_poll_event events
;
1330 * Get allocated in this thread, enqueued to a global queue, dequeued and
1331 * freed in the manage apps thread.
1333 struct ust_command
*ust_cmd
= NULL
;
1335 tracepoint(sessiond_th_reg_start
);
1337 DBG("[thread] Manage application registration started");
1339 ret
= lttcomm_listen_unix_sock(apps_sock
);
1345 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1346 * more will be added to this poll set.
1348 ret
= create_thread_poll_set(&events
, 2);
1353 /* Add the application registration socket */
1354 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1359 /* Notify all applications to register */
1360 ret
= notify_ust_apps(1);
1362 ERR("Failed to notify applications or create the wait shared memory.\n"
1363 "Execution continues but there might be problem for already\n"
1364 "running applications that wishes to register.");
1368 DBG("Accepting application registration");
1370 tracepoint(sessiond_th_reg_poll
);
1372 nb_fd
= LTTNG_POLL_GETNB(&events
);
1374 /* Inifinite blocking call, waiting for transmission */
1375 ret
= lttng_poll_wait(&events
, -1);
1380 for (i
= 0; i
< nb_fd
; i
++) {
1381 /* Fetch once the poll data */
1382 revents
= LTTNG_POLL_GETEV(&events
, i
);
1383 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1385 /* Thread quit pipe has been closed. Killing thread. */
1386 ret
= check_thread_quit_pipe(pollfd
, revents
);
1391 /* Event on the registration socket */
1392 if (pollfd
== apps_sock
) {
1393 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1394 ERR("Register apps socket poll error");
1396 } else if (revents
& LPOLLIN
) {
1397 /* Registration starts here. Recording cycles */
1398 tracepoint(ust_register_start
);
1400 sock
= lttcomm_accept_unix_sock(apps_sock
);
1405 /* Create UST registration command for enqueuing */
1406 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1407 if (ust_cmd
== NULL
) {
1408 perror("ust command zmalloc");
1413 * Using message-based transmissions to ensure we don't
1414 * have to deal with partially received messages.
1416 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1417 sizeof(struct ust_register_msg
));
1418 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1420 perror("lttcomm_recv_unix_sock register apps");
1422 ERR("Wrong size received on apps register");
1429 ust_cmd
->sock
= sock
;
1431 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1432 " gid:%d sock:%d name:%s (version %d.%d)",
1433 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1434 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1435 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1436 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1439 * Lock free enqueue the registration request. The red pill
1440 * has been taken! This apps will be part of the *system*.
1442 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1445 * Wake the registration queue futex. Implicit memory
1446 * barrier with the exchange in cds_wfq_enqueue.
1448 futex_nto1_wake(&ust_cmd_queue
.futex
);
1450 tracepoint(ust_register_stop
);
1457 DBG("UST Registration thread dying");
1459 /* Notify that the registration thread is gone */
1464 unlink(apps_unix_sock_path
);
1466 lttng_poll_clean(&events
);
1472 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1473 * exec or it will fails.
1475 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1478 struct timespec timeout
;
1480 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1481 timeout
.tv_nsec
= 0;
1483 /* Setup semaphore */
1484 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1486 PERROR("sem_init consumer semaphore");
1490 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1491 thread_manage_consumer
, consumer_data
);
1493 PERROR("pthread_create consumer");
1498 /* Get time for sem_timedwait absolute timeout */
1499 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1501 PERROR("clock_gettime spawn consumer");
1502 /* Infinite wait for the kconsumerd thread to be ready */
1503 ret
= sem_wait(&consumer_data
->sem
);
1505 /* Normal timeout if the gettime was successful */
1506 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1507 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1511 if (errno
== ETIMEDOUT
) {
1513 * Call has timed out so we kill the kconsumerd_thread and return
1516 ERR("The consumer thread was never ready. Killing it");
1517 ret
= pthread_cancel(consumer_data
->thread
);
1519 PERROR("pthread_cancel consumer thread");
1522 PERROR("semaphore wait failed consumer thread");
1527 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1528 if (consumer_data
->pid
== 0) {
1529 ERR("Kconsumerd did not start");
1530 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1533 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1542 * Join consumer thread
1544 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1549 if (consumer_data
->pid
!= 0) {
1550 ret
= kill(consumer_data
->pid
, SIGTERM
);
1552 ERR("Error killing consumer daemon");
1555 return pthread_join(consumer_data
->thread
, &status
);
1562 * Fork and exec a consumer daemon (consumerd).
1564 * Return pid if successful else -1.
1566 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1570 const char *verbosity
;
1572 DBG("Spawning consumerd");
1579 if (opt_verbose
> 1 || opt_verbose_consumer
) {
1580 verbosity
= "--verbose";
1582 verbosity
= "--quiet";
1584 switch (consumer_data
->type
) {
1585 case LTTNG_CONSUMER_KERNEL
:
1586 execl(INSTALL_BIN_PATH
"/lttng-consumerd",
1587 "lttng-consumerd", verbosity
, "-k",
1588 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1589 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1592 case LTTNG_CONSUMER64_UST
:
1594 char *tmpnew
= NULL
;
1596 if (consumerd64_libdir
[0] != '\0') {
1600 tmp
= getenv("LD_LIBRARY_PATH");
1604 tmplen
= strlen("LD_LIBRARY_PATH=")
1605 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1606 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1611 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1612 strcat(tmpnew
, consumerd64_libdir
);
1613 if (tmp
[0] != '\0') {
1614 strcat(tmpnew
, ":");
1615 strcat(tmpnew
, tmp
);
1617 ret
= putenv(tmpnew
);
1623 ret
= execl(consumerd64_path
, verbosity
, "-u",
1624 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1625 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1627 if (consumerd64_libdir
[0] != '\0') {
1635 case LTTNG_CONSUMER32_UST
:
1637 char *tmpnew
= NULL
;
1639 if (consumerd32_libdir
[0] != '\0') {
1643 tmp
= getenv("LD_LIBRARY_PATH");
1647 tmplen
= strlen("LD_LIBRARY_PATH=")
1648 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1649 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1654 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1655 strcat(tmpnew
, consumerd32_libdir
);
1656 if (tmp
[0] != '\0') {
1657 strcat(tmpnew
, ":");
1658 strcat(tmpnew
, tmp
);
1660 ret
= putenv(tmpnew
);
1666 ret
= execl(consumerd32_path
, verbosity
, "-u",
1667 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1668 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1670 if (consumerd32_libdir
[0] != '\0') {
1679 perror("unknown consumer type");
1683 perror("kernel start consumer exec");
1686 } else if (pid
> 0) {
1689 perror("start consumer fork");
1697 * Spawn the consumerd daemon and session daemon thread.
1699 static int start_consumerd(struct consumer_data
*consumer_data
)
1703 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1704 if (consumer_data
->pid
!= 0) {
1705 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1709 ret
= spawn_consumerd(consumer_data
);
1711 ERR("Spawning consumerd failed");
1712 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1716 /* Setting up the consumer_data pid */
1717 consumer_data
->pid
= ret
;
1718 DBG2("Consumer pid %d", consumer_data
->pid
);
1719 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1721 DBG2("Spawning consumer control thread");
1722 ret
= spawn_consumer_thread(consumer_data
);
1724 ERR("Fatal error spawning consumer control thread");
1736 * modprobe_kernel_modules
1738 static int modprobe_kernel_modules(void)
1743 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1744 ret
= snprintf(modprobe
, sizeof(modprobe
),
1745 "/sbin/modprobe %s%s",
1746 kernel_modules_list
[i
].required
? "" : "-q ",
1747 kernel_modules_list
[i
].name
);
1749 perror("snprintf modprobe");
1752 modprobe
[sizeof(modprobe
) - 1] = '\0';
1753 ret
= system(modprobe
);
1755 ERR("Unable to launch modprobe for module %s",
1756 kernel_modules_list
[i
].name
);
1757 } else if (kernel_modules_list
[i
].required
1758 && WEXITSTATUS(ret
) != 0) {
1759 ERR("Unable to load module %s",
1760 kernel_modules_list
[i
].name
);
1762 DBG("Modprobe successfully %s",
1763 kernel_modules_list
[i
].name
);
1774 static int mount_debugfs(char *path
)
1777 char *type
= "debugfs";
1779 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1781 PERROR("Cannot create debugfs path");
1785 ret
= mount(type
, path
, type
, 0, NULL
);
1787 PERROR("Cannot mount debugfs");
1791 DBG("Mounted debugfs successfully at %s", path
);
1798 * Setup necessary data for kernel tracer action.
1800 static void init_kernel_tracer(void)
1803 char *proc_mounts
= "/proc/mounts";
1805 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1808 /* Detect debugfs */
1809 fp
= fopen(proc_mounts
, "r");
1811 ERR("Unable to probe %s", proc_mounts
);
1815 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1816 if (strstr(line
, "debugfs") != NULL
) {
1817 /* Remove first string */
1819 /* Dup string here so we can reuse line later on */
1820 debugfs_path
= strdup(strtok(NULL
, " "));
1821 DBG("Got debugfs path : %s", debugfs_path
);
1828 /* Mount debugfs if needded */
1829 if (debugfs_path
== NULL
) {
1830 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1832 perror("asprintf debugfs path");
1835 ret
= mount_debugfs(debugfs_path
);
1837 perror("Cannot mount debugfs");
1842 /* Modprobe lttng kernel modules */
1843 ret
= modprobe_kernel_modules();
1848 /* Setup lttng kernel path */
1849 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1851 perror("asprintf lttng path");
1855 /* Open debugfs lttng */
1856 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1857 if (kernel_tracer_fd
< 0) {
1858 DBG("Failed to open %s", lttng_path
);
1864 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1874 WARN("No kernel tracer available");
1875 kernel_tracer_fd
= 0;
1880 * Init tracing by creating trace directory and sending fds kernel consumer.
1882 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1886 if (session
->consumer_fds_sent
== 0) {
1888 * Assign default kernel consumer socket if no consumer assigned to the
1889 * kernel session. At this point, it's NOT suppose to be 0 but this is
1890 * an extra security check.
1892 if (session
->consumer_fd
== 0) {
1893 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1896 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1898 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1902 session
->consumer_fds_sent
= 1;
1910 * Create an UST session and add it to the session ust list.
1912 static int create_ust_session(struct ltt_session
*session
,
1913 struct lttng_domain
*domain
)
1917 struct ltt_ust_session
*lus
= NULL
;
1919 switch (domain
->type
) {
1920 case LTTNG_DOMAIN_UST
:
1923 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1927 DBG("Creating UST session");
1930 lus
= trace_ust_create_session(session
->path
, uid
, domain
);
1932 ret
= LTTCOMM_UST_SESS_FAIL
;
1936 ret
= mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1937 geteuid(), allowed_group());
1939 if (ret
!= -EEXIST
) {
1940 ERR("Trace directory creation error");
1941 ret
= LTTCOMM_UST_SESS_FAIL
;
1946 /* The domain type dictate different actions on session creation */
1947 switch (domain
->type
) {
1948 case LTTNG_DOMAIN_UST
:
1949 /* No ustctl for the global UST domain */
1952 ERR("Unknown UST domain on create session %d", domain
->type
);
1955 session
->ust_session
= lus
;
1965 * Create a kernel tracer session then create the default channel.
1967 static int create_kernel_session(struct ltt_session
*session
)
1971 DBG("Creating kernel session");
1973 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1975 ret
= LTTCOMM_KERN_SESS_FAIL
;
1979 /* Set kernel consumer socket fd */
1980 if (kconsumer_data
.cmd_sock
) {
1981 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1984 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1985 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1987 if (ret
!= -EEXIST
) {
1988 ERR("Trace directory creation error");
1998 * Using the session list, filled a lttng_session array to send back to the
1999 * client for session listing.
2001 * The session list lock MUST be acquired before calling this function. Use
2002 * session_lock_list() and session_unlock_list().
2004 static void list_lttng_sessions(struct lttng_session
*sessions
)
2007 struct ltt_session
*session
;
2009 DBG("Getting all available session");
2011 * Iterate over session list and append data after the control struct in
2014 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2015 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2016 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2017 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2018 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2019 sessions
[i
].enabled
= session
->enabled
;
2025 * Fill lttng_channel array of all channels.
2027 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2028 struct lttng_channel
*channels
)
2031 struct ltt_kernel_channel
*kchan
;
2033 DBG("Listing channels for session %s", session
->name
);
2036 case LTTNG_DOMAIN_KERNEL
:
2037 /* Kernel channels */
2038 if (session
->kernel_session
!= NULL
) {
2039 cds_list_for_each_entry(kchan
,
2040 &session
->kernel_session
->channel_list
.head
, list
) {
2041 /* Copy lttng_channel struct to array */
2042 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2043 channels
[i
].enabled
= kchan
->enabled
;
2048 case LTTNG_DOMAIN_UST
:
2050 struct cds_lfht_iter iter
;
2051 struct ltt_ust_channel
*uchan
;
2053 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
2054 &iter
, uchan
, node
) {
2055 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2056 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2057 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2058 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2059 channels
[i
].attr
.switch_timer_interval
=
2060 uchan
->attr
.switch_timer_interval
;
2061 channels
[i
].attr
.read_timer_interval
=
2062 uchan
->attr
.read_timer_interval
;
2063 channels
[i
].enabled
= uchan
->enabled
;
2064 switch (uchan
->attr
.output
) {
2065 case LTTNG_UST_MMAP
:
2067 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2080 * Create a list of ust global domain events.
2082 static int list_lttng_ust_global_events(char *channel_name
,
2083 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2086 unsigned int nb_event
= 0;
2087 struct cds_lfht_iter iter
;
2088 struct cds_lfht_node
*node
;
2089 struct ltt_ust_channel
*uchan
;
2090 struct ltt_ust_event
*uevent
;
2091 struct lttng_event
*tmp
;
2093 DBG("Listing UST global events for channel %s", channel_name
);
2097 node
= hashtable_lookup(ust_global
->channels
, (void *) channel_name
,
2098 strlen(channel_name
), &iter
);
2100 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2104 uchan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
2106 nb_event
+= hashtable_get_count(uchan
->events
);
2108 if (nb_event
== 0) {
2113 DBG3("Listing UST global %d events", nb_event
);
2115 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2117 ret
= -LTTCOMM_FATAL
;
2121 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
2122 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2123 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2124 tmp
[i
].enabled
= uevent
->enabled
;
2125 switch (uevent
->attr
.instrumentation
) {
2126 case LTTNG_UST_TRACEPOINT
:
2127 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2129 case LTTNG_UST_PROBE
:
2130 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2132 case LTTNG_UST_FUNCTION
:
2133 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2135 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2137 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
2153 * Fill lttng_event array of all kernel events in the channel.
2155 static int list_lttng_kernel_events(char *channel_name
,
2156 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2159 unsigned int nb_event
;
2160 struct ltt_kernel_event
*event
;
2161 struct ltt_kernel_channel
*kchan
;
2163 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2164 if (kchan
== NULL
) {
2165 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2169 nb_event
= kchan
->event_count
;
2171 DBG("Listing events for channel %s", kchan
->channel
->name
);
2173 if (nb_event
== 0) {
2178 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2179 if (*events
== NULL
) {
2180 ret
= LTTCOMM_FATAL
;
2184 /* Kernel channels */
2185 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2186 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2187 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2188 (*events
)[i
].enabled
= event
->enabled
;
2189 switch (event
->event
->instrumentation
) {
2190 case LTTNG_KERNEL_TRACEPOINT
:
2191 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2193 case LTTNG_KERNEL_KPROBE
:
2194 case LTTNG_KERNEL_KRETPROBE
:
2195 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2196 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2197 sizeof(struct lttng_kernel_kprobe
));
2199 case LTTNG_KERNEL_FUNCTION
:
2200 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2201 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2202 sizeof(struct lttng_kernel_function
));
2204 case LTTNG_KERNEL_NOOP
:
2205 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2207 case LTTNG_KERNEL_SYSCALL
:
2208 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2210 case LTTNG_KERNEL_ALL
:
2224 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2226 static int cmd_disable_channel(struct ltt_session
*session
,
2227 int domain
, char *channel_name
)
2230 struct ltt_ust_session
*usess
;
2232 usess
= session
->ust_session
;
2235 case LTTNG_DOMAIN_KERNEL
:
2237 ret
= channel_kernel_disable(session
->kernel_session
,
2239 if (ret
!= LTTCOMM_OK
) {
2243 kernel_wait_quiescent(kernel_tracer_fd
);
2246 case LTTNG_DOMAIN_UST
:
2248 struct ltt_ust_channel
*uchan
;
2250 /* Get channel in global UST domain HT */
2251 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2253 if (uchan
== NULL
) {
2254 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2258 /* Already disabled */
2259 if (!uchan
->enabled
) {
2260 DBG2("UST channel %s already disabled", channel_name
);
2264 ret
= ust_app_disable_channel_glb(usess
, uchan
);
2266 ret
= LTTCOMM_UST_DISABLE_FAIL
;
2274 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2275 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2276 case LTTNG_DOMAIN_UST_PID
:
2277 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2280 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2291 * Copy channel from attributes and set it in the application channel list.
2294 static int copy_ust_channel_to_app(struct ltt_ust_session *usess,
2295 struct lttng_channel *attr, struct ust_app *app)
2298 struct ltt_ust_channel *uchan, *new_chan;
2300 uchan = trace_ust_get_channel_by_key(usess->channels, attr->name);
2301 if (uchan == NULL) {
2302 ret = LTTCOMM_FATAL;
2306 new_chan = trace_ust_create_channel(attr, usess->path);
2307 if (new_chan == NULL) {
2308 PERROR("malloc ltt_ust_channel");
2309 ret = LTTCOMM_FATAL;
2313 ret = channel_ust_copy(new_chan, uchan);
2315 ret = LTTCOMM_FATAL;
2325 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2327 static int cmd_enable_channel(struct ltt_session
*session
,
2328 int domain
, struct lttng_channel
*attr
)
2331 struct ltt_ust_session
*usess
= session
->ust_session
;
2333 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2336 case LTTNG_DOMAIN_KERNEL
:
2338 struct ltt_kernel_channel
*kchan
;
2340 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2341 session
->kernel_session
);
2342 if (kchan
== NULL
) {
2343 ret
= channel_kernel_create(session
->kernel_session
,
2344 attr
, kernel_poll_pipe
[1]);
2346 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2349 if (ret
!= LTTCOMM_OK
) {
2353 kernel_wait_quiescent(kernel_tracer_fd
);
2356 case LTTNG_DOMAIN_UST
:
2358 struct ltt_ust_channel
*uchan
;
2360 DBG2("Enabling channel for LTTNG_DOMAIN_UST");
2362 /* Get channel in global UST domain HT */
2363 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2365 if (uchan
== NULL
) {
2366 uchan
= trace_ust_create_channel(attr
, usess
->pathname
);
2367 if (uchan
== NULL
) {
2368 ret
= LTTCOMM_UST_CHAN_FAIL
;
2372 /* Add channel to all registered applications */
2373 ret
= ust_app_create_channel_glb(usess
, uchan
);
2375 ret
= LTTCOMM_UST_CHAN_FAIL
;
2380 hashtable_add_unique(usess
->domain_global
.channels
, &uchan
->node
);
2383 DBG2("UST channel %s added to global domain HT", attr
->name
);
2385 /* If already enabled, everything is OK */
2386 if (uchan
->enabled
) {
2390 ret
= ust_app_enable_channel_glb(usess
, uchan
);
2392 if (ret
!= -EEXIST
) {
2393 ret
= LTTCOMM_UST_CHAN_ENABLE_FAIL
;
2405 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2406 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2407 case LTTNG_DOMAIN_UST_PID
:
2408 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2411 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2422 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2424 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2425 char *channel_name
, char *event_name
)
2430 case LTTNG_DOMAIN_KERNEL
:
2432 struct ltt_kernel_channel
*kchan
;
2433 struct ltt_kernel_session
*ksess
;
2435 ksess
= session
->kernel_session
;
2437 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2438 if (kchan
== NULL
) {
2439 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2443 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2444 if (ret
!= LTTCOMM_OK
) {
2448 kernel_wait_quiescent(kernel_tracer_fd
);
2451 case LTTNG_DOMAIN_UST
:
2453 struct ltt_ust_session
*usess
;
2454 struct ltt_ust_channel
*uchan
;
2455 struct ltt_ust_event
*uevent
;
2457 usess
= session
->ust_session
;
2459 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2461 if (uchan
== NULL
) {
2462 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2466 uevent
= trace_ust_find_event_by_name(uchan
->events
, event_name
);
2467 if (uevent
== NULL
) {
2468 ret
= LTTCOMM_UST_EVENT_NOT_FOUND
;
2472 ret
= ust_app_disable_event_glb(usess
, uchan
, uevent
);
2474 ret
= LTTCOMM_UST_DISABLE_FAIL
;
2478 uevent
->enabled
= 0;
2480 DBG2("Disable UST event %s in channel %s completed", event_name
,
2485 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2486 case LTTNG_DOMAIN_UST_PID
:
2487 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2489 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2500 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2502 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2508 case LTTNG_DOMAIN_KERNEL
:
2510 struct ltt_kernel_session
*ksess
;
2511 struct ltt_kernel_channel
*kchan
;
2513 ksess
= session
->kernel_session
;
2515 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2516 if (kchan
== NULL
) {
2517 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2521 ret
= event_kernel_disable_all(ksess
, kchan
);
2522 if (ret
!= LTTCOMM_OK
) {
2526 kernel_wait_quiescent(kernel_tracer_fd
);
2529 case LTTNG_DOMAIN_UST
:
2531 struct ltt_ust_session
*usess
;
2532 struct ltt_ust_channel
*uchan
;
2534 usess
= session
->ust_session
;
2536 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2538 if (uchan
== NULL
) {
2539 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2543 ret
= ust_app_disable_all_event_glb(usess
, uchan
);
2545 ret
= LTTCOMM_UST_DISABLE_FAIL
;
2549 DBG2("Disable all UST event in channel %s completed", channel_name
);
2553 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2554 case LTTNG_DOMAIN_UST_PID
:
2555 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2557 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2568 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2570 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2571 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2576 case LTTNG_DOMAIN_KERNEL
:
2577 /* Add kernel context to kernel tracer */
2578 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2579 event_name
, channel_name
);
2580 if (ret
!= LTTCOMM_OK
) {
2584 case LTTNG_DOMAIN_UST
:
2586 struct ltt_ust_session
*usess
= session
->ust_session
;
2588 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2589 if (ret
!= LTTCOMM_OK
) {
2594 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2595 case LTTNG_DOMAIN_UST_PID
:
2596 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2598 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2609 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2611 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2612 char *channel_name
, struct lttng_event
*event
)
2615 struct lttng_channel
*attr
;
2616 struct ltt_ust_session
*usess
= session
->ust_session
;
2619 case LTTNG_DOMAIN_KERNEL
:
2621 struct ltt_kernel_channel
*kchan
;
2623 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2624 session
->kernel_session
);
2625 if (kchan
== NULL
) {
2626 attr
= channel_new_default_attr(domain
);
2628 ret
= LTTCOMM_FATAL
;
2631 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2633 /* This call will notify the kernel thread */
2634 ret
= channel_kernel_create(session
->kernel_session
,
2635 attr
, kernel_poll_pipe
[1]);
2636 if (ret
!= LTTCOMM_OK
) {
2643 /* Get the newly created kernel channel pointer */
2644 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2645 session
->kernel_session
);
2646 if (kchan
== NULL
) {
2647 /* This sould not happen... */
2648 ret
= LTTCOMM_FATAL
;
2652 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2654 if (ret
!= LTTCOMM_OK
) {
2658 kernel_wait_quiescent(kernel_tracer_fd
);
2661 case LTTNG_DOMAIN_UST
:
2663 struct lttng_channel
*attr
;
2664 struct ltt_ust_channel
*uchan
;
2666 /* Get channel from global UST domain */
2667 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2669 if (uchan
== NULL
) {
2670 /* Create default channel */
2671 attr
= channel_new_default_attr(domain
);
2673 ret
= LTTCOMM_FATAL
;
2676 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2677 attr
->name
[NAME_MAX
- 1] = '\0';
2679 /* Use the internal command enable channel */
2680 ret
= cmd_enable_channel(session
, domain
, attr
);
2681 if (ret
!= LTTCOMM_OK
) {
2687 /* Get the newly created channel reference back */
2688 uchan
= trace_ust_find_channel_by_name(
2689 usess
->domain_global
.channels
, channel_name
);
2690 if (uchan
== NULL
) {
2691 /* Something is really wrong */
2692 ret
= LTTCOMM_FATAL
;
2697 /* At this point, the session and channel exist on the tracer */
2699 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2700 if (ret
!= LTTCOMM_OK
) {
2705 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2706 case LTTNG_DOMAIN_UST_PID
:
2707 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2709 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2720 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2722 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2723 char *channel_name
, int event_type
)
2726 struct ltt_kernel_channel
*kchan
;
2729 case LTTNG_DOMAIN_KERNEL
:
2730 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2731 session
->kernel_session
);
2732 if (kchan
== NULL
) {
2733 /* This call will notify the kernel thread */
2734 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2735 kernel_poll_pipe
[1]);
2736 if (ret
!= LTTCOMM_OK
) {
2740 /* Get the newly created kernel channel pointer */
2741 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2742 session
->kernel_session
);
2743 if (kchan
== NULL
) {
2744 /* This sould not happen... */
2745 ret
= LTTCOMM_FATAL
;
2751 switch (event_type
) {
2752 case LTTNG_KERNEL_SYSCALL
:
2753 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2754 kchan
, kernel_tracer_fd
);
2756 case LTTNG_KERNEL_TRACEPOINT
:
2758 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2759 * events already registered to the channel.
2761 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2762 kchan
, kernel_tracer_fd
);
2764 case LTTNG_KERNEL_ALL
:
2765 /* Enable syscalls and tracepoints */
2766 ret
= event_kernel_enable_all(session
->kernel_session
,
2767 kchan
, kernel_tracer_fd
);
2770 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2774 /* Manage return value */
2775 if (ret
!= LTTCOMM_OK
) {
2779 kernel_wait_quiescent(kernel_tracer_fd
);
2782 /* TODO: Userspace tracing */
2783 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2794 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2796 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2799 ssize_t nb_events
= 0;
2802 case LTTNG_DOMAIN_KERNEL
:
2803 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2804 if (nb_events
< 0) {
2805 ret
= LTTCOMM_KERN_LIST_FAIL
;
2809 case LTTNG_DOMAIN_UST
:
2810 nb_events
= ust_app_list_events(events
);
2811 if (nb_events
< 0) {
2812 ret
= LTTCOMM_UST_LIST_FAIL
;
2817 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2824 /* Return negative value to differentiate return code */
2829 * Command LTTNG_START_TRACE processed by the client thread.
2831 static int cmd_start_trace(struct ltt_session
*session
)
2834 struct ltt_kernel_session
*ksession
;
2835 struct ltt_ust_session
*usess
;
2838 ksession
= session
->kernel_session
;
2839 usess
= session
->ust_session
;
2841 if (session
->enabled
)
2842 return LTTCOMM_UST_START_FAIL
;
2843 session
->enabled
= 1;
2845 /* Kernel tracing */
2846 if (ksession
!= NULL
) {
2847 struct ltt_kernel_channel
*kchan
;
2849 /* Open kernel metadata */
2850 if (ksession
->metadata
== NULL
) {
2851 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2853 ret
= LTTCOMM_KERN_META_FAIL
;
2858 /* Open kernel metadata stream */
2859 if (ksession
->metadata_stream_fd
== 0) {
2860 ret
= kernel_open_metadata_stream(ksession
);
2862 ERR("Kernel create metadata stream failed");
2863 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2868 /* For each channel */
2869 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2870 if (kchan
->stream_count
== 0) {
2871 ret
= kernel_open_channel_stream(kchan
);
2873 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2876 /* Update the stream global counter */
2877 ksession
->stream_count_global
+= ret
;
2881 /* Setup kernel consumer socket and send fds to it */
2882 ret
= init_kernel_tracing(ksession
);
2884 ret
= LTTCOMM_KERN_START_FAIL
;
2888 /* This start the kernel tracing */
2889 ret
= kernel_start_session(ksession
);
2891 ret
= LTTCOMM_KERN_START_FAIL
;
2895 /* Quiescent wait after starting trace */
2896 kernel_wait_quiescent(kernel_tracer_fd
);
2899 /* Flag session that trace should start automatically */
2901 usess
->start_trace
= 1;
2903 ret
= ust_app_start_trace_all(usess
);
2905 ret
= LTTCOMM_UST_START_FAIL
;
2917 * Command LTTNG_STOP_TRACE processed by the client thread.
2919 static int cmd_stop_trace(struct ltt_session
*session
)
2922 struct ltt_kernel_channel
*kchan
;
2923 struct ltt_kernel_session
*ksession
;
2924 struct ltt_ust_session
*usess
;
2927 ksession
= session
->kernel_session
;
2928 usess
= session
->ust_session
;
2930 if (!session
->enabled
)
2931 return LTTCOMM_UST_START_FAIL
;
2932 session
->enabled
= 0;
2935 if (ksession
!= NULL
) {
2936 DBG("Stop kernel tracing");
2938 /* Flush all buffers before stopping */
2939 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2941 ERR("Kernel metadata flush failed");
2944 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2945 ret
= kernel_flush_buffer(kchan
);
2947 ERR("Kernel flush buffer error");
2951 ret
= kernel_stop_session(ksession
);
2953 ret
= LTTCOMM_KERN_STOP_FAIL
;
2957 kernel_wait_quiescent(kernel_tracer_fd
);
2961 usess
->start_trace
= 0;
2963 ret
= ust_app_stop_trace_all(usess
);
2965 ret
= LTTCOMM_UST_START_FAIL
;
2977 * Command LTTNG_CREATE_SESSION processed by the client thread.
2979 static int cmd_create_session(char *name
, char *path
)
2983 ret
= session_create(name
, path
);
2984 if (ret
!= LTTCOMM_OK
) {
2995 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2997 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3001 /* Clean kernel session teardown */
3002 teardown_kernel_session(session
);
3003 /* UST session teardown */
3004 teardown_ust_session(session
);
3007 * Must notify the kernel thread here to update it's poll setin order
3008 * to remove the channel(s)' fd just destroyed.
3010 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3012 perror("write kernel poll pipe");
3015 ret
= session_destroy(session
);
3021 * Command LTTNG_CALIBRATE processed by the client thread.
3023 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3028 case LTTNG_DOMAIN_KERNEL
:
3030 struct lttng_kernel_calibrate kcalibrate
;
3032 kcalibrate
.type
= calibrate
->type
;
3033 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3035 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3041 /* TODO: Userspace tracing */
3042 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3053 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3055 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3061 case LTTNG_DOMAIN_KERNEL
:
3062 /* Can't register a consumer if there is already one */
3063 if (session
->kernel_session
->consumer_fd
!= 0) {
3064 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3068 sock
= lttcomm_connect_unix_sock(sock_path
);
3070 ret
= LTTCOMM_CONNECT_FAIL
;
3074 session
->kernel_session
->consumer_fd
= sock
;
3077 /* TODO: Userspace tracing */
3078 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3089 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3091 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3092 struct lttng_domain
**domains
)
3097 if (session
->kernel_session
!= NULL
) {
3098 DBG3("Listing domains found kernel domain");
3102 if (session
->ust_session
!= NULL
) {
3103 DBG3("Listing domains found UST global domain");
3107 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3108 if (*domains
== NULL
) {
3109 ret
= -LTTCOMM_FATAL
;
3113 if (session
->kernel_session
!= NULL
) {
3114 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3118 if (session
->ust_session
!= NULL
) {
3119 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3130 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3132 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3133 struct lttng_channel
**channels
)
3136 ssize_t nb_chan
= 0;
3139 case LTTNG_DOMAIN_KERNEL
:
3140 if (session
->kernel_session
!= NULL
) {
3141 nb_chan
= session
->kernel_session
->channel_count
;
3143 DBG3("Number of kernel channels %zd", nb_chan
);
3145 case LTTNG_DOMAIN_UST
:
3146 if (session
->ust_session
!= NULL
) {
3147 nb_chan
= hashtable_get_count(
3148 session
->ust_session
->domain_global
.channels
);
3150 DBG3("Number of UST global channels %zd", nb_chan
);
3154 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3159 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3160 if (*channels
== NULL
) {
3161 ret
= -LTTCOMM_FATAL
;
3165 list_lttng_channels(domain
, session
, *channels
);
3177 * Command LTTNG_LIST_EVENTS processed by the client thread.
3179 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3180 char *channel_name
, struct lttng_event
**events
)
3183 ssize_t nb_event
= 0;
3186 case LTTNG_DOMAIN_KERNEL
:
3187 if (session
->kernel_session
!= NULL
) {
3188 nb_event
= list_lttng_kernel_events(channel_name
,
3189 session
->kernel_session
, events
);
3192 case LTTNG_DOMAIN_UST
:
3194 if (session
->ust_session
!= NULL
) {
3195 nb_event
= list_lttng_ust_global_events(channel_name
,
3196 &session
->ust_session
->domain_global
, events
);
3201 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3212 * Process the command requested by the lttng client within the command
3213 * context structure. This function make sure that the return structure (llm)
3214 * is set and ready for transmission before returning.
3216 * Return any error encountered or 0 for success.
3218 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3220 int ret
= LTTCOMM_OK
;
3221 int need_tracing_session
= 1;
3223 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3226 * Check for command that don't needs to allocate a returned payload. We do
3227 * this here so we don't have to make the call for no payload at each
3230 switch(cmd_ctx
->lsm
->cmd_type
) {
3231 case LTTNG_LIST_SESSIONS
:
3232 case LTTNG_LIST_TRACEPOINTS
:
3233 case LTTNG_LIST_DOMAINS
:
3234 case LTTNG_LIST_CHANNELS
:
3235 case LTTNG_LIST_EVENTS
:
3238 /* Setup lttng message with no payload */
3239 ret
= setup_lttng_msg(cmd_ctx
, 0);
3241 /* This label does not try to unlock the session */
3242 goto init_setup_error
;
3246 /* Commands that DO NOT need a session. */
3247 switch (cmd_ctx
->lsm
->cmd_type
) {
3248 case LTTNG_CALIBRATE
:
3249 case LTTNG_CREATE_SESSION
:
3250 case LTTNG_LIST_SESSIONS
:
3251 case LTTNG_LIST_TRACEPOINTS
:
3252 need_tracing_session
= 0;
3255 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3256 session_lock_list();
3257 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3258 session_unlock_list();
3259 if (cmd_ctx
->session
== NULL
) {
3260 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3261 ret
= LTTCOMM_SESS_NOT_FOUND
;
3263 /* If no session name specified */
3264 ret
= LTTCOMM_SELECT_SESS
;
3268 /* Acquire lock for the session */
3269 session_lock(cmd_ctx
->session
);
3275 * Check domain type for specific "pre-action".
3277 switch (cmd_ctx
->lsm
->domain
.type
) {
3278 case LTTNG_DOMAIN_KERNEL
:
3279 /* Kernel tracer check */
3280 if (kernel_tracer_fd
== 0) {
3281 /* Basically, load kernel tracer modules */
3282 init_kernel_tracer();
3283 if (kernel_tracer_fd
== 0) {
3284 ret
= LTTCOMM_KERN_NA
;
3289 /* Need a session for kernel command */
3290 if (need_tracing_session
) {
3291 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3292 ret
= create_kernel_session(cmd_ctx
->session
);
3294 ret
= LTTCOMM_KERN_SESS_FAIL
;
3299 /* Start the kernel consumer daemon */
3300 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3301 if (kconsumer_data
.pid
== 0 &&
3302 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3303 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3304 ret
= start_consumerd(&kconsumer_data
);
3306 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3310 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3314 case LTTNG_DOMAIN_UST
:
3316 if (need_tracing_session
) {
3317 if (cmd_ctx
->session
->ust_session
== NULL
) {
3318 ret
= create_ust_session(cmd_ctx
->session
,
3319 &cmd_ctx
->lsm
->domain
);
3320 if (ret
!= LTTCOMM_OK
) {
3324 /* Start the UST consumer daemons */
3326 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3327 if (consumerd64_path
[0] != '\0' &&
3328 ustconsumer64_data
.pid
== 0 &&
3329 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3330 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3331 ret
= start_consumerd(&ustconsumer64_data
);
3333 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3334 ust_consumerd64_fd
= -EINVAL
;
3338 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3340 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3343 if (consumerd32_path
[0] != '\0' &&
3344 ustconsumer32_data
.pid
== 0 &&
3345 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3346 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3347 ret
= start_consumerd(&ustconsumer32_data
);
3349 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3350 ust_consumerd32_fd
= -EINVAL
;
3353 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3355 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3364 /* Process by command type */
3365 switch (cmd_ctx
->lsm
->cmd_type
) {
3366 case LTTNG_ADD_CONTEXT
:
3368 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3369 cmd_ctx
->lsm
->u
.context
.channel_name
,
3370 cmd_ctx
->lsm
->u
.context
.event_name
,
3371 &cmd_ctx
->lsm
->u
.context
.ctx
);
3374 case LTTNG_DISABLE_CHANNEL
:
3376 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3377 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3380 case LTTNG_DISABLE_EVENT
:
3382 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3383 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3384 cmd_ctx
->lsm
->u
.disable
.name
);
3388 case LTTNG_DISABLE_ALL_EVENT
:
3390 DBG("Disabling all events");
3392 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3393 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3396 case LTTNG_ENABLE_CHANNEL
:
3398 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3399 &cmd_ctx
->lsm
->u
.channel
.chan
);
3402 case LTTNG_ENABLE_EVENT
:
3404 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3405 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3406 &cmd_ctx
->lsm
->u
.enable
.event
);
3409 case LTTNG_ENABLE_ALL_EVENT
:
3411 DBG("Enabling all events");
3413 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3414 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3415 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3418 case LTTNG_LIST_TRACEPOINTS
:
3420 struct lttng_event
*events
;
3423 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3424 if (nb_events
< 0) {
3430 * Setup lttng message with payload size set to the event list size in
3431 * bytes and then copy list into the llm payload.
3433 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3439 /* Copy event list into message payload */
3440 memcpy(cmd_ctx
->llm
->payload
, events
,
3441 sizeof(struct lttng_event
) * nb_events
);
3448 case LTTNG_START_TRACE
:
3450 ret
= cmd_start_trace(cmd_ctx
->session
);
3453 case LTTNG_STOP_TRACE
:
3455 ret
= cmd_stop_trace(cmd_ctx
->session
);
3458 case LTTNG_CREATE_SESSION
:
3460 tracepoint(create_session_start
);
3461 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3462 cmd_ctx
->lsm
->session
.path
);
3463 tracepoint(create_session_end
);
3466 case LTTNG_DESTROY_SESSION
:
3468 tracepoint(destroy_session_start
);
3469 ret
= cmd_destroy_session(cmd_ctx
->session
,
3470 cmd_ctx
->lsm
->session
.name
);
3471 tracepoint(destroy_session_end
);
3474 case LTTNG_LIST_DOMAINS
:
3477 struct lttng_domain
*domains
;
3479 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3485 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3490 /* Copy event list into message payload */
3491 memcpy(cmd_ctx
->llm
->payload
, domains
,
3492 nb_dom
* sizeof(struct lttng_domain
));
3499 case LTTNG_LIST_CHANNELS
:
3502 struct lttng_channel
*channels
;
3504 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3505 cmd_ctx
->session
, &channels
);
3511 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3516 /* Copy event list into message payload */
3517 memcpy(cmd_ctx
->llm
->payload
, channels
,
3518 nb_chan
* sizeof(struct lttng_channel
));
3525 case LTTNG_LIST_EVENTS
:
3528 struct lttng_event
*events
= NULL
;
3530 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3531 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3537 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3542 /* Copy event list into message payload */
3543 memcpy(cmd_ctx
->llm
->payload
, events
,
3544 nb_event
* sizeof(struct lttng_event
));
3551 case LTTNG_LIST_SESSIONS
:
3553 session_lock_list();
3555 if (session_list_ptr
->count
== 0) {
3556 ret
= LTTCOMM_NO_SESSION
;
3557 session_unlock_list();
3561 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3562 session_list_ptr
->count
);
3564 session_unlock_list();
3568 /* Filled the session array */
3569 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3571 session_unlock_list();
3576 case LTTNG_CALIBRATE
:
3578 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3579 &cmd_ctx
->lsm
->u
.calibrate
);
3582 case LTTNG_REGISTER_CONSUMER
:
3584 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3585 cmd_ctx
->lsm
->u
.reg
.path
);
3594 if (cmd_ctx
->llm
== NULL
) {
3595 DBG("Missing llm structure. Allocating one.");
3596 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3600 /* Set return code */
3601 cmd_ctx
->llm
->ret_code
= ret
;
3603 if (cmd_ctx
->session
) {
3604 session_unlock(cmd_ctx
->session
);
3611 * This thread manage all clients request using the unix client socket for
3614 static void *thread_manage_clients(void *data
)
3616 int sock
= 0, ret
, i
, pollfd
;
3617 uint32_t revents
, nb_fd
;
3618 struct command_ctx
*cmd_ctx
= NULL
;
3619 struct lttng_poll_event events
;
3621 tracepoint(sessiond_th_cli_start
);
3623 DBG("[thread] Manage client started");
3625 rcu_register_thread();
3627 ret
= lttcomm_listen_unix_sock(client_sock
);
3633 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3634 * more will be added to this poll set.
3636 ret
= create_thread_poll_set(&events
, 2);
3641 /* Add the application registration socket */
3642 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3648 * Notify parent pid that we are ready to accept command for client side.
3650 if (opt_sig_parent
) {
3651 kill(ppid
, SIGCHLD
);
3655 DBG("Accepting client command ...");
3657 tracepoint(sessiond_th_cli_poll
);
3659 nb_fd
= LTTNG_POLL_GETNB(&events
);
3661 /* Inifinite blocking call, waiting for transmission */
3662 ret
= lttng_poll_wait(&events
, -1);
3667 for (i
= 0; i
< nb_fd
; i
++) {
3668 /* Fetch once the poll data */
3669 revents
= LTTNG_POLL_GETEV(&events
, i
);
3670 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3672 /* Thread quit pipe has been closed. Killing thread. */
3673 ret
= check_thread_quit_pipe(pollfd
, revents
);
3678 /* Event on the registration socket */
3679 if (pollfd
== client_sock
) {
3680 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3681 ERR("Client socket poll error");
3687 DBG("Wait for client response");
3689 sock
= lttcomm_accept_unix_sock(client_sock
);
3694 /* Allocate context command to process the client request */
3695 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3696 if (cmd_ctx
== NULL
) {
3697 perror("zmalloc cmd_ctx");
3701 /* Allocate data buffer for reception */
3702 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3703 if (cmd_ctx
->lsm
== NULL
) {
3704 perror("zmalloc cmd_ctx->lsm");
3708 cmd_ctx
->llm
= NULL
;
3709 cmd_ctx
->session
= NULL
;
3712 * Data is received from the lttng client. The struct
3713 * lttcomm_session_msg (lsm) contains the command and data request of
3716 DBG("Receiving data from client ...");
3717 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
,
3718 sizeof(struct lttcomm_session_msg
));
3720 DBG("Nothing recv() from client... continuing");
3726 // TODO: Validate cmd_ctx including sanity check for
3727 // security purpose.
3729 rcu_thread_online();
3731 * This function dispatch the work to the kernel or userspace tracer
3732 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3733 * informations for the client. The command context struct contains
3734 * everything this function may needs.
3736 ret
= process_client_msg(cmd_ctx
);
3737 rcu_thread_offline();
3740 * TODO: Inform client somehow of the fatal error. At
3741 * this point, ret < 0 means that a zmalloc failed
3742 * (ENOMEM). Error detected but still accept command.
3744 clean_command_ctx(&cmd_ctx
);
3748 DBG("Sending response (size: %d, retcode: %s)",
3749 cmd_ctx
->lttng_msg_size
,
3750 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3751 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3753 ERR("Failed to send data back to client");
3756 clean_command_ctx(&cmd_ctx
);
3758 /* End of transmission */
3763 DBG("Client thread dying");
3764 unlink(client_unix_sock_path
);
3768 lttng_poll_clean(&events
);
3769 clean_command_ctx(&cmd_ctx
);
3771 rcu_unregister_thread();
3777 * usage function on stderr
3779 static void usage(void)
3781 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3782 fprintf(stderr
, " -h, --help Display this usage.\n");
3783 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3784 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3785 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3786 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3787 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3788 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3789 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3790 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3791 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3792 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3793 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3794 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3795 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3796 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3797 fprintf(stderr
, " -V, --version Show version number.\n");
3798 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3799 fprintf(stderr
, " -q, --quiet No output at all.\n");
3800 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3801 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3805 * daemon argument parsing
3807 static int parse_args(int argc
, char **argv
)
3811 static struct option long_options
[] = {
3812 { "client-sock", 1, 0, 'c' },
3813 { "apps-sock", 1, 0, 'a' },
3814 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3815 { "kconsumerd-err-sock", 1, 0, 'E' },
3816 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3817 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3818 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3819 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3820 { "consumerd32-path", 1, 0, 'u' },
3821 { "consumerd32-libdir", 1, 0, 'U' },
3822 { "consumerd64-path", 1, 0, 't' },
3823 { "consumerd64-libdir", 1, 0, 'T' },
3824 { "daemonize", 0, 0, 'd' },
3825 { "sig-parent", 0, 0, 'S' },
3826 { "help", 0, 0, 'h' },
3827 { "group", 1, 0, 'g' },
3828 { "version", 0, 0, 'V' },
3829 { "quiet", 0, 0, 'q' },
3830 { "verbose", 0, 0, 'v' },
3831 { "verbose-consumer", 0, 0, 'Z' },
3836 int option_index
= 0;
3837 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:C:E:D:F:Z:u:t",
3838 long_options
, &option_index
);
3845 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3847 fprintf(stderr
, " with arg %s\n", optarg
);
3851 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3854 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3860 opt_tracing_group
= optarg
;
3866 fprintf(stdout
, "%s\n", VERSION
);
3872 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3875 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3878 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3881 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3884 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3887 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3893 /* Verbose level can increase using multiple -v */
3897 opt_verbose_consumer
+= 1;
3900 consumerd32_path
= optarg
;
3903 consumerd32_libdir
= optarg
;
3906 consumerd64_path
= optarg
;
3909 consumerd64_libdir
= optarg
;
3912 /* Unknown option or other error.
3913 * Error is printed by getopt, just return */
3922 * Creates the two needed socket by the daemon.
3923 * apps_sock - The communication socket for all UST apps.
3924 * client_sock - The communication of the cli tool (lttng).
3926 static int init_daemon_socket(void)
3931 old_umask
= umask(0);
3933 /* Create client tool unix socket */
3934 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3935 if (client_sock
< 0) {
3936 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3941 /* File permission MUST be 660 */
3942 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3944 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3949 /* Create the application unix socket */
3950 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3951 if (apps_sock
< 0) {
3952 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3957 /* File permission MUST be 666 */
3958 ret
= chmod(apps_unix_sock_path
,
3959 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3961 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3972 * Check if the global socket is available, and if a daemon is answering at the
3973 * other side. If yes, error is returned.
3975 static int check_existing_daemon(void)
3977 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3978 access(apps_unix_sock_path
, F_OK
) < 0) {
3982 /* Is there anybody out there ? */
3983 if (lttng_session_daemon_alive()) {
3991 * Set the tracing group gid onto the client socket.
3993 * Race window between mkdir and chown is OK because we are going from more
3994 * permissive (root.root) to les permissive (root.tracing).
3996 static int set_permissions(void)
4001 gid
= allowed_group();
4004 WARN("No tracing group detected");
4007 ERR("Missing tracing group. Aborting execution.");
4013 /* Set lttng run dir */
4014 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
4016 ERR("Unable to set group on " LTTNG_RUNDIR
);
4020 /* lttng client socket path */
4021 ret
= chown(client_unix_sock_path
, 0, gid
);
4023 ERR("Unable to set group on %s", client_unix_sock_path
);
4027 /* kconsumer error socket path */
4028 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4030 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4034 /* 64-bit ustconsumer error socket path */
4035 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4037 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4041 /* 32-bit ustconsumer compat32 error socket path */
4042 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4044 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4048 DBG("All permissions are set");
4055 * Create the pipe used to wake up the kernel thread.
4057 static int create_kernel_poll_pipe(void)
4059 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4063 * Create the application command pipe to wake thread_manage_apps.
4065 static int create_apps_cmd_pipe(void)
4067 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4071 * Create the lttng run directory needed for all global sockets and pipe.
4073 static int create_lttng_rundir(void)
4077 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
4079 if (errno
!= EEXIST
) {
4080 ERR("Unable to create " LTTNG_RUNDIR
);
4092 * Setup sockets and directory needed by the kconsumerd communication with the
4095 static int set_consumer_sockets(struct consumer_data
*consumer_data
)
4100 switch (consumer_data
->type
) {
4101 case LTTNG_CONSUMER_KERNEL
:
4102 path
= KCONSUMERD_PATH
;
4104 case LTTNG_CONSUMER64_UST
:
4105 path
= USTCONSUMERD64_PATH
;
4107 case LTTNG_CONSUMER32_UST
:
4108 path
= USTCONSUMERD32_PATH
;
4111 ERR("Consumer type unknown");
4116 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4118 if (errno
!= EEXIST
) {
4119 ERR("Failed to create %s", path
);
4125 /* Create the kconsumerd error unix socket */
4126 consumer_data
->err_sock
=
4127 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4128 if (consumer_data
->err_sock
< 0) {
4129 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4134 /* File permission MUST be 660 */
4135 ret
= chmod(consumer_data
->err_unix_sock_path
,
4136 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4138 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4148 * Signal handler for the daemon
4150 * Simply stop all worker threads, leaving main() return gracefully after
4151 * joining all threads and calling cleanup().
4153 static void sighandler(int sig
)
4157 DBG("SIGPIPE catched");
4160 DBG("SIGINT catched");
4164 DBG("SIGTERM catched");
4173 * Setup signal handler for :
4174 * SIGINT, SIGTERM, SIGPIPE
4176 static int set_signal_handler(void)
4179 struct sigaction sa
;
4182 if ((ret
= sigemptyset(&sigset
)) < 0) {
4183 perror("sigemptyset");
4187 sa
.sa_handler
= sighandler
;
4188 sa
.sa_mask
= sigset
;
4190 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4191 perror("sigaction");
4195 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4196 perror("sigaction");
4200 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4201 perror("sigaction");
4205 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4211 * Set open files limit to unlimited. This daemon can open a large number of
4212 * file descriptors in order to consumer multiple kernel traces.
4214 static void set_ulimit(void)
4219 /* The kernel does not allowed an infinite limit for open files */
4220 lim
.rlim_cur
= 65535;
4221 lim
.rlim_max
= 65535;
4223 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4225 perror("failed to set open files limit");
4232 int main(int argc
, char **argv
)
4236 const char *home_path
;
4238 tracepoint(sessiond_boot_start
);
4239 rcu_register_thread();
4241 /* Create thread quit pipe */
4242 if ((ret
= init_thread_quit_pipe()) < 0) {
4246 setup_consumerd_path();
4248 /* Parse arguments */
4250 if ((ret
= parse_args(argc
, argv
) < 0)) {
4263 /* Check if daemon is UID = 0 */
4264 is_root
= !getuid();
4267 ret
= create_lttng_rundir();
4272 if (strlen(apps_unix_sock_path
) == 0) {
4273 snprintf(apps_unix_sock_path
, PATH_MAX
,
4274 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4277 if (strlen(client_unix_sock_path
) == 0) {
4278 snprintf(client_unix_sock_path
, PATH_MAX
,
4279 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4282 /* Set global SHM for ust */
4283 if (strlen(wait_shm_path
) == 0) {
4284 snprintf(wait_shm_path
, PATH_MAX
,
4285 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4288 home_path
= get_home_dir();
4289 if (home_path
== NULL
) {
4290 /* TODO: Add --socket PATH option */
4291 ERR("Can't get HOME directory for sockets creation.");
4296 if (strlen(apps_unix_sock_path
) == 0) {
4297 snprintf(apps_unix_sock_path
, PATH_MAX
,
4298 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4301 /* Set the cli tool unix socket path */
4302 if (strlen(client_unix_sock_path
) == 0) {
4303 snprintf(client_unix_sock_path
, PATH_MAX
,
4304 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4307 /* Set global SHM for ust */
4308 if (strlen(wait_shm_path
) == 0) {
4309 snprintf(wait_shm_path
, PATH_MAX
,
4310 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4314 DBG("Client socket path %s", client_unix_sock_path
);
4315 DBG("Application socket path %s", apps_unix_sock_path
);
4318 * See if daemon already exist.
4320 if ((ret
= check_existing_daemon()) < 0) {
4321 ERR("Already running daemon.\n");
4323 * We do not goto exit because we must not cleanup()
4324 * because a daemon is already running.
4329 /* After this point, we can safely call cleanup() with "goto exit" */
4332 * These actions must be executed as root. We do that *after* setting up
4333 * the sockets path because we MUST make the check for another daemon using
4334 * those paths *before* trying to set the kernel consumer sockets and init
4338 ret
= set_consumer_sockets(&kconsumer_data
);
4343 ret
= set_consumer_sockets(&ustconsumer64_data
);
4348 ret
= set_consumer_sockets(&ustconsumer32_data
);
4353 /* Setup kernel tracer */
4354 init_kernel_tracer();
4356 /* Set ulimit for open files */
4360 if ((ret
= set_signal_handler()) < 0) {
4364 /* Setup the needed unix socket */
4365 if ((ret
= init_daemon_socket()) < 0) {
4369 /* Set credentials to socket */
4370 if (is_root
&& ((ret
= set_permissions()) < 0)) {
4374 /* Get parent pid if -S, --sig-parent is specified. */
4375 if (opt_sig_parent
) {
4379 /* Setup the kernel pipe for waking up the kernel thread */
4380 if ((ret
= create_kernel_poll_pipe()) < 0) {
4384 /* Setup the thread apps communication pipe. */
4385 if ((ret
= create_apps_cmd_pipe()) < 0) {
4389 /* Init UST command queue. */
4390 cds_wfq_init(&ust_cmd_queue
.queue
);
4392 /* Init UST app hash table */
4396 * Get session list pointer. This pointer MUST NOT be free(). This list is
4397 * statically declared in session.c
4399 session_list_ptr
= session_get_list();
4401 /* Set up max poll set size */
4402 lttng_poll_set_max_size();
4404 /* Create thread to manage the client socket */
4405 ret
= pthread_create(&client_thread
, NULL
,
4406 thread_manage_clients
, (void *) NULL
);
4408 perror("pthread_create clients");
4412 /* Create thread to dispatch registration */
4413 ret
= pthread_create(&dispatch_thread
, NULL
,
4414 thread_dispatch_ust_registration
, (void *) NULL
);
4416 perror("pthread_create dispatch");
4420 /* Create thread to manage application registration. */
4421 ret
= pthread_create(®_apps_thread
, NULL
,
4422 thread_registration_apps
, (void *) NULL
);
4424 perror("pthread_create registration");
4428 /* Create thread to manage application socket */
4429 ret
= pthread_create(&apps_thread
, NULL
,
4430 thread_manage_apps
, (void *) NULL
);
4432 perror("pthread_create apps");
4436 /* Create kernel thread to manage kernel event */
4437 ret
= pthread_create(&kernel_thread
, NULL
,
4438 thread_manage_kernel
, (void *) NULL
);
4440 perror("pthread_create kernel");
4444 tracepoint(sessiond_boot_end
);
4446 ret
= pthread_join(kernel_thread
, &status
);
4448 perror("pthread_join");
4449 goto error
; /* join error, exit without cleanup */
4453 ret
= pthread_join(apps_thread
, &status
);
4455 perror("pthread_join");
4456 goto error
; /* join error, exit without cleanup */
4460 ret
= pthread_join(reg_apps_thread
, &status
);
4462 perror("pthread_join");
4463 goto error
; /* join error, exit without cleanup */
4467 ret
= pthread_join(dispatch_thread
, &status
);
4469 perror("pthread_join");
4470 goto error
; /* join error, exit without cleanup */
4474 ret
= pthread_join(client_thread
, &status
);
4476 perror("pthread_join");
4477 goto error
; /* join error, exit without cleanup */
4480 ret
= join_consumer_thread(&kconsumer_data
);
4482 perror("join_consumer");
4483 goto error
; /* join error, exit without cleanup */
4489 * cleanup() is called when no other thread is running.
4491 rcu_thread_online();
4493 rcu_thread_offline();
4494 rcu_unregister_thread();