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 <bin/lttng-consumerd/lttng-consumerd.h>
42 #include <common/lttngerr.h>
43 #include <common/kernel-consumer/kernel-consumer.h>
44 #include <common/ust-consumer/ust-consumer.h>
45 #include <common/common.h>
46 #include <common/defaults.h>
47 #include <common/compat/poll.h>
49 #include "lttng-sessiond.h"
59 #define CONSUMERD_FILE "lttng-consumerd"
61 struct consumer_data
{
62 enum lttng_consumer_type type
;
64 pthread_t thread
; /* Worker thread interacting with the consumer */
67 /* Mutex to control consumerd pid assignation */
68 pthread_mutex_t pid_mutex
;
74 /* consumer error and command Unix socket path */
75 char err_unix_sock_path
[PATH_MAX
];
76 char cmd_unix_sock_path
[PATH_MAX
];
80 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
81 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
82 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
83 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
86 int opt_verbose
; /* Not static for lttngerr.h */
87 int opt_verbose_consumer
; /* Not static for lttngerr.h */
88 int opt_quiet
; /* Not static for lttngerr.h */
91 const char *opt_tracing_group
;
92 static int opt_sig_parent
;
93 static int opt_daemon
;
94 static int opt_no_kernel
;
95 static int is_root
; /* Set to 1 if the daemon is running as root */
96 static pid_t ppid
; /* Parent PID for --sig-parent option */
99 /* Consumer daemon specific control data */
100 static struct consumer_data kconsumer_data
= {
101 .type
= LTTNG_CONSUMER_KERNEL
,
102 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
103 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
105 static struct consumer_data ustconsumer64_data
= {
106 .type
= LTTNG_CONSUMER64_UST
,
107 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
108 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
110 static struct consumer_data ustconsumer32_data
= {
111 .type
= LTTNG_CONSUMER32_UST
,
112 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
113 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
116 static int dispatch_thread_exit
;
118 /* Global application Unix socket path */
119 static char apps_unix_sock_path
[PATH_MAX
];
120 /* Global client Unix socket path */
121 static char client_unix_sock_path
[PATH_MAX
];
122 /* global wait shm path for UST */
123 static char wait_shm_path
[PATH_MAX
];
125 /* Sockets and FDs */
126 static int client_sock
;
127 static int apps_sock
;
128 static int kernel_tracer_fd
;
129 static int kernel_poll_pipe
[2];
132 * Quit pipe for all threads. This permits a single cancellation point
133 * for all threads when receiving an event on the pipe.
135 static int thread_quit_pipe
[2];
138 * This pipe is used to inform the thread managing application communication
139 * that a command is queued and ready to be processed.
141 static int apps_cmd_pipe
[2];
143 /* Pthread, Mutexes and Semaphores */
144 static pthread_t apps_thread
;
145 static pthread_t reg_apps_thread
;
146 static pthread_t client_thread
;
147 static pthread_t kernel_thread
;
148 static pthread_t dispatch_thread
;
152 * UST registration command queue. This queue is tied with a futex and uses a N
153 * wakers / 1 waiter implemented and detailed in futex.c/.h
155 * The thread_manage_apps and thread_dispatch_ust_registration interact with
156 * this queue and the wait/wake scheme.
158 static struct ust_cmd_queue ust_cmd_queue
;
161 * Pointer initialized before thread creation.
163 * This points to the tracing session list containing the session count and a
164 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
165 * MUST NOT be taken if you call a public function in session.c.
167 * The lock is nested inside the structure: session_list_ptr->lock. Please use
168 * session_lock_list and session_unlock_list for lock acquisition.
170 static struct ltt_session_list
*session_list_ptr
;
172 int ust_consumerd64_fd
= -1;
173 int ust_consumerd32_fd
= -1;
175 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
176 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
177 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
178 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
181 void setup_consumerd_path(void)
183 const char *bin
, *libdir
;
186 * Allow INSTALL_BIN_PATH to be used as a target path for the
187 * native architecture size consumer if CONFIG_CONSUMER*_PATH
188 * has not been defined.
190 #if (CAA_BITS_PER_LONG == 32)
191 if (!consumerd32_bin
[0]) {
192 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
194 if (!consumerd32_libdir
[0]) {
195 consumerd32_libdir
= INSTALL_LIB_PATH
;
197 #elif (CAA_BITS_PER_LONG == 64)
198 if (!consumerd64_bin
[0]) {
199 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
201 if (!consumerd64_libdir
[0]) {
202 consumerd64_libdir
= INSTALL_LIB_PATH
;
205 #error "Unknown bitness"
209 * runtime env. var. overrides the build default.
211 bin
= getenv("LTTNG_CONSUMERD32_BIN");
213 consumerd32_bin
= bin
;
215 bin
= getenv("LTTNG_CONSUMERD64_BIN");
217 consumerd64_bin
= bin
;
219 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
221 consumerd32_libdir
= libdir
;
223 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
225 consumerd64_libdir
= libdir
;
230 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
232 static int create_thread_poll_set(struct lttng_poll_event
*events
,
237 if (events
== NULL
|| size
== 0) {
242 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
248 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
260 * Check if the thread quit pipe was triggered.
262 * Return 1 if it was triggered else 0;
264 static int check_thread_quit_pipe(int fd
, uint32_t events
)
266 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
274 * Remove modules in reverse load order.
276 static int modprobe_remove_kernel_modules(void)
281 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
282 ret
= snprintf(modprobe
, sizeof(modprobe
),
283 "/sbin/modprobe -r -q %s",
284 kernel_modules_list
[i
].name
);
286 perror("snprintf modprobe -r");
289 modprobe
[sizeof(modprobe
) - 1] = '\0';
290 ret
= system(modprobe
);
292 ERR("Unable to launch modprobe -r for module %s",
293 kernel_modules_list
[i
].name
);
294 } else if (kernel_modules_list
[i
].required
295 && WEXITSTATUS(ret
) != 0) {
296 ERR("Unable to remove module %s",
297 kernel_modules_list
[i
].name
);
299 DBG("Modprobe removal successful %s",
300 kernel_modules_list
[i
].name
);
309 * Return group ID of the tracing group or -1 if not found.
311 static gid_t
allowed_group(void)
315 if (opt_tracing_group
) {
316 grp
= getgrnam(opt_tracing_group
);
318 grp
= getgrnam(default_tracing_group
);
328 * Init thread quit pipe.
330 * Return -1 on error or 0 if all pipes are created.
332 static int init_thread_quit_pipe(void)
336 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
338 perror("thread quit pipe");
347 * Complete teardown of a kernel session. This free all data structure related
348 * to a kernel session and update counter.
350 static void teardown_kernel_session(struct ltt_session
*session
)
352 if (!session
->kernel_session
) {
353 DBG3("No kernel session when tearingdown session");
357 DBG("Tearing down kernel session");
360 * If a custom kernel consumer was registered, close the socket before
361 * tearing down the complete kernel session structure
363 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
364 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
367 trace_kernel_destroy_session(session
->kernel_session
);
371 * Complete teardown of all UST sessions. This will free everything on his path
372 * and destroy the core essence of all ust sessions :)
374 static void teardown_ust_session(struct ltt_session
*session
)
378 if (!session
->ust_session
) {
379 DBG3("No UST session when tearingdown session");
383 DBG("Tearing down UST session(s)");
385 ret
= ust_app_destroy_trace_all(session
->ust_session
);
387 ERR("Error in ust_app_destroy_trace_all");
390 trace_ust_destroy_session(session
->ust_session
);
394 * Stop all threads by closing the thread quit pipe.
396 static void stop_threads(void)
400 /* Stopping all threads */
401 DBG("Terminating all threads");
402 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
404 ERR("write error on thread quit pipe");
407 /* Dispatch thread */
408 dispatch_thread_exit
= 1;
409 futex_nto1_wake(&ust_cmd_queue
.futex
);
415 static void cleanup(void)
419 struct ltt_session
*sess
, *stmp
;
423 DBG("Removing %s directory", rundir
);
424 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
426 ERR("asprintf failed. Something is really wrong!");
429 /* Remove lttng run directory */
432 ERR("Unable to clean %s", rundir
);
436 DBG("Cleaning up all session");
438 /* Destroy session list mutex */
439 if (session_list_ptr
!= NULL
) {
440 pthread_mutex_destroy(&session_list_ptr
->lock
);
442 /* Cleanup ALL session */
443 cds_list_for_each_entry_safe(sess
, stmp
,
444 &session_list_ptr
->head
, list
) {
445 teardown_kernel_session(sess
);
446 teardown_ust_session(sess
);
451 DBG("Closing all UST sockets");
452 ust_app_clean_list();
454 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
456 if (is_root
&& !opt_no_kernel
) {
457 DBG2("Closing kernel fd");
458 close(kernel_tracer_fd
);
459 DBG("Unloading kernel modules");
460 modprobe_remove_kernel_modules();
463 close(thread_quit_pipe
[0]);
464 close(thread_quit_pipe
[1]);
467 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
468 "Matthew, BEET driven development works!%c[%dm",
469 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
474 * Send data on a unix socket using the liblttsessiondcomm API.
476 * Return lttcomm error code.
478 static int send_unix_sock(int sock
, void *buf
, size_t len
)
480 /* Check valid length */
485 return lttcomm_send_unix_sock(sock
, buf
, len
);
489 * Free memory of a command context structure.
491 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
493 DBG("Clean command context structure");
495 if ((*cmd_ctx
)->llm
) {
496 free((*cmd_ctx
)->llm
);
498 if ((*cmd_ctx
)->lsm
) {
499 free((*cmd_ctx
)->lsm
);
507 * Send all stream fds of kernel channel to the consumer.
509 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
510 int sock
, struct ltt_kernel_channel
*channel
,
511 uid_t uid
, gid_t gid
)
514 struct ltt_kernel_stream
*stream
;
515 struct lttcomm_consumer_msg lkm
;
517 DBG("Sending streams of channel %s to kernel consumer",
518 channel
->channel
->name
);
521 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
522 lkm
.u
.channel
.channel_key
= channel
->fd
;
523 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
524 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
525 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
526 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
528 perror("send consumer channel");
533 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
537 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
538 lkm
.u
.stream
.channel_key
= channel
->fd
;
539 lkm
.u
.stream
.stream_key
= stream
->fd
;
540 lkm
.u
.stream
.state
= stream
->state
;
541 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
542 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
543 lkm
.u
.stream
.uid
= uid
;
544 lkm
.u
.stream
.gid
= gid
;
545 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
546 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
547 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
548 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
550 perror("send consumer stream");
553 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
555 perror("send consumer stream ancillary data");
560 DBG("consumer channel streams sent");
569 * Send all stream fds of the kernel session to the consumer.
571 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
572 struct ltt_kernel_session
*session
)
575 struct ltt_kernel_channel
*chan
;
576 struct lttcomm_consumer_msg lkm
;
577 int sock
= session
->consumer_fd
;
579 DBG("Sending metadata stream fd");
581 /* Extra protection. It's NOT supposed to be set to 0 at this point */
582 if (session
->consumer_fd
== 0) {
583 session
->consumer_fd
= consumer_data
->cmd_sock
;
586 if (session
->metadata_stream_fd
!= 0) {
587 /* Send metadata channel fd */
588 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
589 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
590 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
591 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
592 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
593 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
595 perror("send consumer channel");
599 /* Send metadata stream fd */
600 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
601 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
602 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
603 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
604 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
605 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
606 lkm
.u
.stream
.uid
= session
->uid
;
607 lkm
.u
.stream
.gid
= session
->gid
;
608 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
609 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
610 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
611 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
613 perror("send consumer stream");
616 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
618 perror("send consumer stream");
623 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
624 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
625 session
->uid
, session
->gid
);
631 DBG("consumer fds (metadata and channel streams) sent");
640 * Notify UST applications using the shm mmap futex.
642 static int notify_ust_apps(int active
)
646 DBG("Notifying applications of session daemon state: %d", active
);
648 /* See shm.c for this call implying mmap, shm and futex calls */
649 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
650 if (wait_shm_mmap
== NULL
) {
654 /* Wake waiting process */
655 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
657 /* Apps notified successfully */
665 * Setup the outgoing data buffer for the response (llm) by allocating the
666 * right amount of memory and copying the original information from the lsm
669 * Return total size of the buffer pointed by buf.
671 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
677 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
678 if (cmd_ctx
->llm
== NULL
) {
684 /* Copy common data */
685 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
686 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
688 cmd_ctx
->llm
->data_size
= size
;
689 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
698 * Update the kernel poll set of all channel fd available over all tracing
699 * session. Add the wakeup pipe at the end of the set.
701 static int update_kernel_poll(struct lttng_poll_event
*events
)
704 struct ltt_session
*session
;
705 struct ltt_kernel_channel
*channel
;
707 DBG("Updating kernel poll set");
710 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
711 session_lock(session
);
712 if (session
->kernel_session
== NULL
) {
713 session_unlock(session
);
717 cds_list_for_each_entry(channel
,
718 &session
->kernel_session
->channel_list
.head
, list
) {
719 /* Add channel fd to the kernel poll set */
720 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
722 session_unlock(session
);
725 DBG("Channel fd %d added to kernel set", channel
->fd
);
727 session_unlock(session
);
729 session_unlock_list();
734 session_unlock_list();
739 * Find the channel fd from 'fd' over all tracing session. When found, check
740 * for new channel stream and send those stream fds to the kernel consumer.
742 * Useful for CPU hotplug feature.
744 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
747 struct ltt_session
*session
;
748 struct ltt_kernel_channel
*channel
;
750 DBG("Updating kernel streams for channel fd %d", fd
);
753 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
754 session_lock(session
);
755 if (session
->kernel_session
== NULL
) {
756 session_unlock(session
);
760 /* This is not suppose to be 0 but this is an extra security check */
761 if (session
->kernel_session
->consumer_fd
== 0) {
762 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
765 cds_list_for_each_entry(channel
,
766 &session
->kernel_session
->channel_list
.head
, list
) {
767 if (channel
->fd
== fd
) {
768 DBG("Channel found, updating kernel streams");
769 ret
= kernel_open_channel_stream(channel
);
775 * Have we already sent fds to the consumer? If yes, it means
776 * that tracing is started so it is safe to send our updated
779 if (session
->kernel_session
->consumer_fds_sent
== 1) {
780 ret
= send_kconsumer_channel_streams(consumer_data
,
781 session
->kernel_session
->consumer_fd
, channel
,
782 session
->uid
, session
->gid
);
790 session_unlock(session
);
792 session_unlock_list();
796 session_unlock(session
);
797 session_unlock_list();
802 * For each tracing session, update newly registered apps.
804 static void update_ust_app(int app_sock
)
806 struct ltt_session
*sess
, *stmp
;
808 /* For all tracing session(s) */
809 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
810 if (sess
->ust_session
) {
811 ust_app_global_update(sess
->ust_session
, app_sock
);
817 * This thread manage event coming from the kernel.
819 * Features supported in this thread:
822 static void *thread_manage_kernel(void *data
)
824 int ret
, i
, pollfd
, update_poll_flag
= 1;
825 uint32_t revents
, nb_fd
;
827 struct lttng_poll_event events
;
829 DBG("Thread manage kernel started");
831 ret
= create_thread_poll_set(&events
, 2);
836 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
842 if (update_poll_flag
== 1) {
844 * Reset number of fd in the poll set. Always 2 since there is the thread
845 * quit pipe and the kernel pipe.
849 ret
= update_kernel_poll(&events
);
853 update_poll_flag
= 0;
856 nb_fd
= LTTNG_POLL_GETNB(&events
);
858 DBG("Thread kernel polling on %d fds", nb_fd
);
860 /* Zeroed the poll events */
861 lttng_poll_reset(&events
);
863 /* Poll infinite value of time */
864 ret
= lttng_poll_wait(&events
, -1);
867 } else if (ret
== 0) {
868 /* Should not happen since timeout is infinite */
869 ERR("Return value of poll is 0 with an infinite timeout.\n"
870 "This should not have happened! Continuing...");
874 for (i
= 0; i
< nb_fd
; i
++) {
875 /* Fetch once the poll data */
876 revents
= LTTNG_POLL_GETEV(&events
, i
);
877 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
879 /* Thread quit pipe has been closed. Killing thread. */
880 ret
= check_thread_quit_pipe(pollfd
, revents
);
885 /* Check for data on kernel pipe */
886 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
887 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
888 update_poll_flag
= 1;
892 * New CPU detected by the kernel. Adding kernel stream to
893 * kernel session and updating the kernel consumer
895 if (revents
& LPOLLIN
) {
896 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
902 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
903 * and unregister kernel stream at this point.
911 DBG("Kernel thread dying");
912 close(kernel_poll_pipe
[0]);
913 close(kernel_poll_pipe
[1]);
915 lttng_poll_clean(&events
);
921 * This thread manage the consumer error sent back to the session daemon.
923 static void *thread_manage_consumer(void *data
)
925 int sock
= 0, i
, ret
, pollfd
;
926 uint32_t revents
, nb_fd
;
927 enum lttcomm_return_code code
;
928 struct lttng_poll_event events
;
929 struct consumer_data
*consumer_data
= data
;
931 DBG("[thread] Manage consumer started");
933 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
939 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
940 * Nothing more will be added to this poll set.
942 ret
= create_thread_poll_set(&events
, 2);
947 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
952 nb_fd
= LTTNG_POLL_GETNB(&events
);
954 /* Inifinite blocking call, waiting for transmission */
955 ret
= lttng_poll_wait(&events
, -1);
960 for (i
= 0; i
< nb_fd
; i
++) {
961 /* Fetch once the poll data */
962 revents
= LTTNG_POLL_GETEV(&events
, i
);
963 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
965 /* Thread quit pipe has been closed. Killing thread. */
966 ret
= check_thread_quit_pipe(pollfd
, revents
);
971 /* Event on the registration socket */
972 if (pollfd
== consumer_data
->err_sock
) {
973 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
974 ERR("consumer err socket poll error");
980 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
985 DBG2("Receiving code from consumer err_sock");
987 /* Getting status code from kconsumerd */
988 ret
= lttcomm_recv_unix_sock(sock
, &code
,
989 sizeof(enum lttcomm_return_code
));
994 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
995 consumer_data
->cmd_sock
=
996 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
997 if (consumer_data
->cmd_sock
< 0) {
998 sem_post(&consumer_data
->sem
);
999 PERROR("consumer connect");
1002 /* Signal condition to tell that the kconsumerd is ready */
1003 sem_post(&consumer_data
->sem
);
1004 DBG("consumer command socket ready");
1006 ERR("consumer error when waiting for SOCK_READY : %s",
1007 lttcomm_get_readable_code(-code
));
1011 /* Remove the kconsumerd error sock since we've established a connexion */
1012 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1017 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1022 /* Update number of fd */
1023 nb_fd
= LTTNG_POLL_GETNB(&events
);
1025 /* Inifinite blocking call, waiting for transmission */
1026 ret
= lttng_poll_wait(&events
, -1);
1031 for (i
= 0; i
< nb_fd
; i
++) {
1032 /* Fetch once the poll data */
1033 revents
= LTTNG_POLL_GETEV(&events
, i
);
1034 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1036 /* Thread quit pipe has been closed. Killing thread. */
1037 ret
= check_thread_quit_pipe(pollfd
, revents
);
1042 /* Event on the kconsumerd socket */
1043 if (pollfd
== sock
) {
1044 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1045 ERR("consumer err socket second poll error");
1051 /* Wait for any kconsumerd error */
1052 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1053 sizeof(enum lttcomm_return_code
));
1055 ERR("consumer closed the command socket");
1059 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1062 DBG("consumer thread dying");
1063 close(consumer_data
->err_sock
);
1064 close(consumer_data
->cmd_sock
);
1067 unlink(consumer_data
->err_unix_sock_path
);
1068 unlink(consumer_data
->cmd_unix_sock_path
);
1069 consumer_data
->pid
= 0;
1071 lttng_poll_clean(&events
);
1077 * This thread manage application communication.
1079 static void *thread_manage_apps(void *data
)
1082 uint32_t revents
, nb_fd
;
1083 struct ust_command ust_cmd
;
1084 struct lttng_poll_event events
;
1086 DBG("[thread] Manage application started");
1088 rcu_register_thread();
1089 rcu_thread_online();
1091 ret
= create_thread_poll_set(&events
, 2);
1096 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1102 /* Zeroed the events structure */
1103 lttng_poll_reset(&events
);
1105 nb_fd
= LTTNG_POLL_GETNB(&events
);
1107 DBG("Apps thread polling on %d fds", nb_fd
);
1109 /* Inifinite blocking call, waiting for transmission */
1110 ret
= lttng_poll_wait(&events
, -1);
1115 for (i
= 0; i
< nb_fd
; i
++) {
1116 /* Fetch once the poll data */
1117 revents
= LTTNG_POLL_GETEV(&events
, i
);
1118 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1120 /* Thread quit pipe has been closed. Killing thread. */
1121 ret
= check_thread_quit_pipe(pollfd
, revents
);
1126 /* Inspect the apps cmd pipe */
1127 if (pollfd
== apps_cmd_pipe
[0]) {
1128 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1129 ERR("Apps command pipe error");
1131 } else if (revents
& LPOLLIN
) {
1133 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1134 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1135 perror("read apps cmd pipe");
1139 /* Register applicaton to the session daemon */
1140 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1142 if (ret
== -ENOMEM
) {
1144 } else if (ret
< 0) {
1149 * Add channel(s) and event(s) to newly registered apps
1150 * from lttng global UST domain.
1152 update_ust_app(ust_cmd
.sock
);
1154 ret
= ust_app_register_done(ust_cmd
.sock
);
1157 * If the registration is not possible, we simply
1158 * unregister the apps and continue
1160 ust_app_unregister(ust_cmd
.sock
);
1163 * We just need here to monitor the close of the UST
1164 * socket and poll set monitor those by default.
1166 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1171 DBG("Apps with sock %d added to poll set",
1179 * At this point, we know that a registered application made
1180 * the event at poll_wait.
1182 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1183 /* Removing from the poll set */
1184 ret
= lttng_poll_del(&events
, pollfd
);
1189 /* Socket closed on remote end. */
1190 ust_app_unregister(pollfd
);
1198 DBG("Application communication apps dying");
1199 close(apps_cmd_pipe
[0]);
1200 close(apps_cmd_pipe
[1]);
1202 lttng_poll_clean(&events
);
1204 rcu_thread_offline();
1205 rcu_unregister_thread();
1210 * Dispatch request from the registration threads to the application
1211 * communication thread.
1213 static void *thread_dispatch_ust_registration(void *data
)
1216 struct cds_wfq_node
*node
;
1217 struct ust_command
*ust_cmd
= NULL
;
1219 DBG("[thread] Dispatch UST command started");
1221 while (!dispatch_thread_exit
) {
1222 /* Atomically prepare the queue futex */
1223 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1226 /* Dequeue command for registration */
1227 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1229 DBG("Woken up but nothing in the UST command queue");
1230 /* Continue thread execution */
1234 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1236 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1237 " gid:%d sock:%d name:%s (version %d.%d)",
1238 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1239 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1240 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1241 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1243 * Inform apps thread of the new application registration. This
1244 * call is blocking so we can be assured that the data will be read
1245 * at some point in time or wait to the end of the world :)
1247 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1248 sizeof(struct ust_command
));
1250 perror("write apps cmd pipe");
1251 if (errno
== EBADF
) {
1253 * We can't inform the application thread to process
1254 * registration. We will exit or else application
1255 * registration will not occur and tracing will never
1262 } while (node
!= NULL
);
1264 /* Futex wait on queue. Blocking call on futex() */
1265 futex_nto1_wait(&ust_cmd_queue
.futex
);
1269 DBG("Dispatch thread dying");
1274 * This thread manage application registration.
1276 static void *thread_registration_apps(void *data
)
1278 int sock
= 0, i
, ret
, pollfd
;
1279 uint32_t revents
, nb_fd
;
1280 struct lttng_poll_event events
;
1282 * Get allocated in this thread, enqueued to a global queue, dequeued and
1283 * freed in the manage apps thread.
1285 struct ust_command
*ust_cmd
= NULL
;
1287 DBG("[thread] Manage application registration started");
1289 ret
= lttcomm_listen_unix_sock(apps_sock
);
1295 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1296 * more will be added to this poll set.
1298 ret
= create_thread_poll_set(&events
, 2);
1303 /* Add the application registration socket */
1304 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1309 /* Notify all applications to register */
1310 ret
= notify_ust_apps(1);
1312 ERR("Failed to notify applications or create the wait shared memory.\n"
1313 "Execution continues but there might be problem for already\n"
1314 "running applications that wishes to register.");
1318 DBG("Accepting application registration");
1320 nb_fd
= LTTNG_POLL_GETNB(&events
);
1322 /* Inifinite blocking call, waiting for transmission */
1323 ret
= lttng_poll_wait(&events
, -1);
1328 for (i
= 0; i
< nb_fd
; i
++) {
1329 /* Fetch once the poll data */
1330 revents
= LTTNG_POLL_GETEV(&events
, i
);
1331 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1333 /* Thread quit pipe has been closed. Killing thread. */
1334 ret
= check_thread_quit_pipe(pollfd
, revents
);
1339 /* Event on the registration socket */
1340 if (pollfd
== apps_sock
) {
1341 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1342 ERR("Register apps socket poll error");
1344 } else if (revents
& LPOLLIN
) {
1345 sock
= lttcomm_accept_unix_sock(apps_sock
);
1350 /* Create UST registration command for enqueuing */
1351 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1352 if (ust_cmd
== NULL
) {
1353 perror("ust command zmalloc");
1358 * Using message-based transmissions to ensure we don't
1359 * have to deal with partially received messages.
1361 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1362 sizeof(struct ust_register_msg
));
1363 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1365 perror("lttcomm_recv_unix_sock register apps");
1367 ERR("Wrong size received on apps register");
1374 ust_cmd
->sock
= sock
;
1376 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1377 " gid:%d sock:%d name:%s (version %d.%d)",
1378 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1379 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1380 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1381 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1384 * Lock free enqueue the registration request. The red pill
1385 * has been taken! This apps will be part of the *system*.
1387 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1390 * Wake the registration queue futex. Implicit memory
1391 * barrier with the exchange in cds_wfq_enqueue.
1393 futex_nto1_wake(&ust_cmd_queue
.futex
);
1400 DBG("UST Registration thread dying");
1402 /* Notify that the registration thread is gone */
1407 unlink(apps_unix_sock_path
);
1409 lttng_poll_clean(&events
);
1415 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1416 * exec or it will fails.
1418 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1421 struct timespec timeout
;
1423 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1424 timeout
.tv_nsec
= 0;
1426 /* Setup semaphore */
1427 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1429 PERROR("sem_init consumer semaphore");
1433 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1434 thread_manage_consumer
, consumer_data
);
1436 PERROR("pthread_create consumer");
1441 /* Get time for sem_timedwait absolute timeout */
1442 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1444 PERROR("clock_gettime spawn consumer");
1445 /* Infinite wait for the kconsumerd thread to be ready */
1446 ret
= sem_wait(&consumer_data
->sem
);
1448 /* Normal timeout if the gettime was successful */
1449 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1450 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1454 if (errno
== ETIMEDOUT
) {
1456 * Call has timed out so we kill the kconsumerd_thread and return
1459 ERR("The consumer thread was never ready. Killing it");
1460 ret
= pthread_cancel(consumer_data
->thread
);
1462 PERROR("pthread_cancel consumer thread");
1465 PERROR("semaphore wait failed consumer thread");
1470 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1471 if (consumer_data
->pid
== 0) {
1472 ERR("Kconsumerd did not start");
1473 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1476 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1485 * Join consumer thread
1487 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1492 if (consumer_data
->pid
!= 0) {
1493 ret
= kill(consumer_data
->pid
, SIGTERM
);
1495 ERR("Error killing consumer daemon");
1498 return pthread_join(consumer_data
->thread
, &status
);
1505 * Fork and exec a consumer daemon (consumerd).
1507 * Return pid if successful else -1.
1509 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1513 const char *consumer_to_use
;
1514 const char *verbosity
;
1517 DBG("Spawning consumerd");
1524 if (opt_verbose_consumer
) {
1525 verbosity
= "--verbose";
1527 verbosity
= "--quiet";
1529 switch (consumer_data
->type
) {
1530 case LTTNG_CONSUMER_KERNEL
:
1532 * Find out which consumerd to execute. We will first try the
1533 * 64-bit path, then the sessiond's installation directory, and
1534 * fallback on the 32-bit one,
1536 DBG3("Looking for a kernel consumer at these locations:");
1537 DBG3(" 1) %s", consumerd64_bin
);
1538 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1539 DBG3(" 3) %s", consumerd32_bin
);
1540 if (stat(consumerd64_bin
, &st
) == 0) {
1541 DBG3("Found location #1");
1542 consumer_to_use
= consumerd64_bin
;
1543 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1544 DBG3("Found location #2");
1545 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1546 } else if (stat(consumerd32_bin
, &st
) == 0) {
1547 DBG3("Found location #3");
1548 consumer_to_use
= consumerd32_bin
;
1550 DBG("Could not find any valid consumerd executable");
1553 DBG("Using kernel consumer at: %s", consumer_to_use
);
1554 execl(consumer_to_use
,
1555 "lttng-consumerd", verbosity
, "-k",
1556 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1557 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1560 case LTTNG_CONSUMER64_UST
:
1562 char *tmpnew
= NULL
;
1564 if (consumerd64_libdir
[0] != '\0') {
1568 tmp
= getenv("LD_LIBRARY_PATH");
1572 tmplen
= strlen("LD_LIBRARY_PATH=")
1573 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1574 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1579 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1580 strcat(tmpnew
, consumerd64_libdir
);
1581 if (tmp
[0] != '\0') {
1582 strcat(tmpnew
, ":");
1583 strcat(tmpnew
, tmp
);
1585 ret
= putenv(tmpnew
);
1591 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1592 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1593 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1594 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1596 if (consumerd64_libdir
[0] != '\0') {
1604 case LTTNG_CONSUMER32_UST
:
1606 char *tmpnew
= NULL
;
1608 if (consumerd32_libdir
[0] != '\0') {
1612 tmp
= getenv("LD_LIBRARY_PATH");
1616 tmplen
= strlen("LD_LIBRARY_PATH=")
1617 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1618 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1623 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1624 strcat(tmpnew
, consumerd32_libdir
);
1625 if (tmp
[0] != '\0') {
1626 strcat(tmpnew
, ":");
1627 strcat(tmpnew
, tmp
);
1629 ret
= putenv(tmpnew
);
1635 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1636 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1637 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1638 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1640 if (consumerd32_libdir
[0] != '\0') {
1649 perror("unknown consumer type");
1653 perror("kernel start consumer exec");
1656 } else if (pid
> 0) {
1659 perror("start consumer fork");
1667 * Spawn the consumerd daemon and session daemon thread.
1669 static int start_consumerd(struct consumer_data
*consumer_data
)
1673 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1674 if (consumer_data
->pid
!= 0) {
1675 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1679 ret
= spawn_consumerd(consumer_data
);
1681 ERR("Spawning consumerd failed");
1682 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1686 /* Setting up the consumer_data pid */
1687 consumer_data
->pid
= ret
;
1688 DBG2("Consumer pid %d", consumer_data
->pid
);
1689 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1691 DBG2("Spawning consumer control thread");
1692 ret
= spawn_consumer_thread(consumer_data
);
1694 ERR("Fatal error spawning consumer control thread");
1706 * modprobe_kernel_modules
1708 static int modprobe_kernel_modules(void)
1713 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1714 ret
= snprintf(modprobe
, sizeof(modprobe
),
1715 "/sbin/modprobe %s%s",
1716 kernel_modules_list
[i
].required
? "" : "-q ",
1717 kernel_modules_list
[i
].name
);
1719 perror("snprintf modprobe");
1722 modprobe
[sizeof(modprobe
) - 1] = '\0';
1723 ret
= system(modprobe
);
1725 ERR("Unable to launch modprobe for module %s",
1726 kernel_modules_list
[i
].name
);
1727 } else if (kernel_modules_list
[i
].required
1728 && WEXITSTATUS(ret
) != 0) {
1729 ERR("Unable to load module %s",
1730 kernel_modules_list
[i
].name
);
1732 DBG("Modprobe successfully %s",
1733 kernel_modules_list
[i
].name
);
1744 static int mount_debugfs(char *path
)
1747 char *type
= "debugfs";
1749 ret
= run_as_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1751 PERROR("Cannot create debugfs path");
1755 ret
= mount(type
, path
, type
, 0, NULL
);
1757 PERROR("Cannot mount debugfs");
1761 DBG("Mounted debugfs successfully at %s", path
);
1768 * Setup necessary data for kernel tracer action.
1770 static void init_kernel_tracer(void)
1773 char *proc_mounts
= "/proc/mounts";
1775 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1778 /* Detect debugfs */
1779 fp
= fopen(proc_mounts
, "r");
1781 ERR("Unable to probe %s", proc_mounts
);
1785 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1786 if (strstr(line
, "debugfs") != NULL
) {
1787 /* Remove first string */
1789 /* Dup string here so we can reuse line later on */
1790 debugfs_path
= strdup(strtok(NULL
, " "));
1791 DBG("Got debugfs path : %s", debugfs_path
);
1798 /* Mount debugfs if needded */
1799 if (debugfs_path
== NULL
) {
1800 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1802 perror("asprintf debugfs path");
1805 ret
= mount_debugfs(debugfs_path
);
1807 perror("Cannot mount debugfs");
1812 /* Modprobe lttng kernel modules */
1813 ret
= modprobe_kernel_modules();
1818 /* Setup lttng kernel path */
1819 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1821 perror("asprintf lttng path");
1825 /* Open debugfs lttng */
1826 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1827 if (kernel_tracer_fd
< 0) {
1828 DBG("Failed to open %s", lttng_path
);
1834 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1844 WARN("No kernel tracer available");
1845 kernel_tracer_fd
= 0;
1850 * Init tracing by creating trace directory and sending fds kernel consumer.
1852 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1856 if (session
->consumer_fds_sent
== 0) {
1858 * Assign default kernel consumer socket if no consumer assigned to the
1859 * kernel session. At this point, it's NOT suppose to be 0 but this is
1860 * an extra security check.
1862 if (session
->consumer_fd
== 0) {
1863 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1866 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1868 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1872 session
->consumer_fds_sent
= 1;
1880 * Create an UST session and add it to the session ust list.
1882 static int create_ust_session(struct ltt_session
*session
,
1883 struct lttng_domain
*domain
)
1885 struct ltt_ust_session
*lus
= NULL
;
1888 switch (domain
->type
) {
1889 case LTTNG_DOMAIN_UST
:
1892 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1896 DBG("Creating UST session");
1898 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1900 ret
= LTTCOMM_UST_SESS_FAIL
;
1904 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1905 session
->uid
, session
->gid
);
1907 if (ret
!= -EEXIST
) {
1908 ERR("Trace directory creation error");
1909 ret
= LTTCOMM_UST_SESS_FAIL
;
1914 /* The domain type dictate different actions on session creation */
1915 switch (domain
->type
) {
1916 case LTTNG_DOMAIN_UST
:
1917 /* No ustctl for the global UST domain */
1920 ERR("Unknown UST domain on create session %d", domain
->type
);
1923 lus
->uid
= session
->uid
;
1924 lus
->gid
= session
->gid
;
1925 session
->ust_session
= lus
;
1935 * Create a kernel tracer session then create the default channel.
1937 static int create_kernel_session(struct ltt_session
*session
)
1941 DBG("Creating kernel session");
1943 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1945 ret
= LTTCOMM_KERN_SESS_FAIL
;
1949 /* Set kernel consumer socket fd */
1950 if (kconsumer_data
.cmd_sock
) {
1951 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1954 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1955 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1957 if (ret
!= -EEXIST
) {
1958 ERR("Trace directory creation error");
1962 session
->kernel_session
->uid
= session
->uid
;
1963 session
->kernel_session
->gid
= session
->gid
;
1970 * Check if the UID or GID match the session. Root user has access to all
1973 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1975 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1982 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1985 struct ltt_session
*session
;
1987 DBG("Counting number of available session for UID %d GID %d",
1989 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1991 * Only list the sessions the user can control.
1993 if (!session_access_ok(session
, uid
, gid
)) {
2002 * Using the session list, filled a lttng_session array to send back to the
2003 * client for session listing.
2005 * The session list lock MUST be acquired before calling this function. Use
2006 * session_lock_list() and session_unlock_list().
2008 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2012 struct ltt_session
*session
;
2014 DBG("Getting all available session for UID %d GID %d",
2017 * Iterate over session list and append data after the control struct in
2020 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2022 * Only list the sessions the user can control.
2024 if (!session_access_ok(session
, uid
, gid
)) {
2027 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2028 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2029 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2030 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2031 sessions
[i
].enabled
= session
->enabled
;
2037 * Fill lttng_channel array of all channels.
2039 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2040 struct lttng_channel
*channels
)
2043 struct ltt_kernel_channel
*kchan
;
2045 DBG("Listing channels for session %s", session
->name
);
2048 case LTTNG_DOMAIN_KERNEL
:
2049 /* Kernel channels */
2050 if (session
->kernel_session
!= NULL
) {
2051 cds_list_for_each_entry(kchan
,
2052 &session
->kernel_session
->channel_list
.head
, list
) {
2053 /* Copy lttng_channel struct to array */
2054 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2055 channels
[i
].enabled
= kchan
->enabled
;
2060 case LTTNG_DOMAIN_UST
:
2062 struct lttng_ht_iter iter
;
2063 struct ltt_ust_channel
*uchan
;
2065 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2066 &iter
.iter
, uchan
, node
.node
) {
2067 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2068 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2069 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2070 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2071 channels
[i
].attr
.switch_timer_interval
=
2072 uchan
->attr
.switch_timer_interval
;
2073 channels
[i
].attr
.read_timer_interval
=
2074 uchan
->attr
.read_timer_interval
;
2075 channels
[i
].enabled
= uchan
->enabled
;
2076 switch (uchan
->attr
.output
) {
2077 case LTTNG_UST_MMAP
:
2079 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2092 * Create a list of ust global domain events.
2094 static int list_lttng_ust_global_events(char *channel_name
,
2095 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2098 unsigned int nb_event
= 0;
2099 struct lttng_ht_iter iter
;
2100 struct lttng_ht_node_str
*node
;
2101 struct ltt_ust_channel
*uchan
;
2102 struct ltt_ust_event
*uevent
;
2103 struct lttng_event
*tmp
;
2105 DBG("Listing UST global events for channel %s", channel_name
);
2109 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2110 node
= lttng_ht_iter_get_node_str(&iter
);
2112 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2116 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2118 nb_event
+= lttng_ht_get_count(uchan
->events
);
2120 if (nb_event
== 0) {
2125 DBG3("Listing UST global %d events", nb_event
);
2127 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2129 ret
= -LTTCOMM_FATAL
;
2133 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2134 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2135 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2136 tmp
[i
].enabled
= uevent
->enabled
;
2137 switch (uevent
->attr
.instrumentation
) {
2138 case LTTNG_UST_TRACEPOINT
:
2139 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2141 case LTTNG_UST_PROBE
:
2142 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2144 case LTTNG_UST_FUNCTION
:
2145 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2147 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2148 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2163 * Fill lttng_event array of all kernel events in the channel.
2165 static int list_lttng_kernel_events(char *channel_name
,
2166 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2169 unsigned int nb_event
;
2170 struct ltt_kernel_event
*event
;
2171 struct ltt_kernel_channel
*kchan
;
2173 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2174 if (kchan
== NULL
) {
2175 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2179 nb_event
= kchan
->event_count
;
2181 DBG("Listing events for channel %s", kchan
->channel
->name
);
2183 if (nb_event
== 0) {
2188 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2189 if (*events
== NULL
) {
2190 ret
= LTTCOMM_FATAL
;
2194 /* Kernel channels */
2195 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2196 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2197 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2198 (*events
)[i
].enabled
= event
->enabled
;
2199 switch (event
->event
->instrumentation
) {
2200 case LTTNG_KERNEL_TRACEPOINT
:
2201 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2203 case LTTNG_KERNEL_KPROBE
:
2204 case LTTNG_KERNEL_KRETPROBE
:
2205 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2206 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2207 sizeof(struct lttng_kernel_kprobe
));
2209 case LTTNG_KERNEL_FUNCTION
:
2210 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2211 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2212 sizeof(struct lttng_kernel_function
));
2214 case LTTNG_KERNEL_NOOP
:
2215 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2217 case LTTNG_KERNEL_SYSCALL
:
2218 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2220 case LTTNG_KERNEL_ALL
:
2234 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2236 static int cmd_disable_channel(struct ltt_session
*session
,
2237 int domain
, char *channel_name
)
2240 struct ltt_ust_session
*usess
;
2242 usess
= session
->ust_session
;
2245 case LTTNG_DOMAIN_KERNEL
:
2247 ret
= channel_kernel_disable(session
->kernel_session
,
2249 if (ret
!= LTTCOMM_OK
) {
2253 kernel_wait_quiescent(kernel_tracer_fd
);
2256 case LTTNG_DOMAIN_UST
:
2258 struct ltt_ust_channel
*uchan
;
2259 struct lttng_ht
*chan_ht
;
2261 chan_ht
= usess
->domain_global
.channels
;
2263 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2264 if (uchan
== NULL
) {
2265 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2269 ret
= channel_ust_disable(usess
, domain
, uchan
);
2270 if (ret
!= LTTCOMM_OK
) {
2275 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2276 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2277 case LTTNG_DOMAIN_UST_PID
:
2278 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2281 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2292 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2294 static int cmd_enable_channel(struct ltt_session
*session
,
2295 int domain
, struct lttng_channel
*attr
)
2298 struct ltt_ust_session
*usess
= session
->ust_session
;
2299 struct lttng_ht
*chan_ht
;
2301 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2304 case LTTNG_DOMAIN_KERNEL
:
2306 struct ltt_kernel_channel
*kchan
;
2308 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2309 session
->kernel_session
);
2310 if (kchan
== NULL
) {
2311 ret
= channel_kernel_create(session
->kernel_session
,
2312 attr
, kernel_poll_pipe
[1]);
2314 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2317 if (ret
!= LTTCOMM_OK
) {
2321 kernel_wait_quiescent(kernel_tracer_fd
);
2324 case LTTNG_DOMAIN_UST
:
2326 struct ltt_ust_channel
*uchan
;
2328 chan_ht
= usess
->domain_global
.channels
;
2330 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2331 if (uchan
== NULL
) {
2332 ret
= channel_ust_create(usess
, domain
, attr
);
2334 ret
= channel_ust_enable(usess
, domain
, uchan
);
2338 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2339 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2340 case LTTNG_DOMAIN_UST_PID
:
2341 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2344 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2353 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2355 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2356 char *channel_name
, char *event_name
)
2361 case LTTNG_DOMAIN_KERNEL
:
2363 struct ltt_kernel_channel
*kchan
;
2364 struct ltt_kernel_session
*ksess
;
2366 ksess
= session
->kernel_session
;
2368 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2369 if (kchan
== NULL
) {
2370 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2374 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2375 if (ret
!= LTTCOMM_OK
) {
2379 kernel_wait_quiescent(kernel_tracer_fd
);
2382 case LTTNG_DOMAIN_UST
:
2384 struct ltt_ust_channel
*uchan
;
2385 struct ltt_ust_session
*usess
;
2387 usess
= session
->ust_session
;
2389 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2391 if (uchan
== NULL
) {
2392 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2396 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2397 if (ret
!= LTTCOMM_OK
) {
2401 DBG3("Disable UST event %s in channel %s completed", event_name
,
2405 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2406 case LTTNG_DOMAIN_UST_PID
:
2407 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2409 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2420 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2422 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2428 case LTTNG_DOMAIN_KERNEL
:
2430 struct ltt_kernel_session
*ksess
;
2431 struct ltt_kernel_channel
*kchan
;
2433 ksess
= session
->kernel_session
;
2435 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2436 if (kchan
== NULL
) {
2437 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2441 ret
= event_kernel_disable_all(ksess
, kchan
);
2442 if (ret
!= LTTCOMM_OK
) {
2446 kernel_wait_quiescent(kernel_tracer_fd
);
2449 case LTTNG_DOMAIN_UST
:
2451 struct ltt_ust_session
*usess
;
2452 struct ltt_ust_channel
*uchan
;
2454 usess
= session
->ust_session
;
2456 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2458 if (uchan
== NULL
) {
2459 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2463 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2468 DBG3("Disable all UST events in channel %s completed", channel_name
);
2472 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2473 case LTTNG_DOMAIN_UST_PID
:
2474 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2476 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2487 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2489 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2490 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2495 case LTTNG_DOMAIN_KERNEL
:
2496 /* Add kernel context to kernel tracer */
2497 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2498 event_name
, channel_name
);
2499 if (ret
!= LTTCOMM_OK
) {
2503 case LTTNG_DOMAIN_UST
:
2505 struct ltt_ust_session
*usess
= session
->ust_session
;
2507 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2508 if (ret
!= LTTCOMM_OK
) {
2513 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2514 case LTTNG_DOMAIN_UST_PID
:
2515 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2517 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2528 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2530 * TODO: currently, both events and loglevels are kept within the same
2531 * namespace for UST global registry/app registery, so if an event
2532 * happen to have the same name as the loglevel (very unlikely though),
2533 * and an attempt is made to enable/disable both in the same session,
2534 * the first to be created will be the only one allowed to exist.
2536 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2537 char *channel_name
, struct lttng_event
*event
)
2540 struct lttng_channel
*attr
;
2541 struct ltt_ust_session
*usess
= session
->ust_session
;
2544 case LTTNG_DOMAIN_KERNEL
:
2546 struct ltt_kernel_channel
*kchan
;
2548 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2549 session
->kernel_session
);
2550 if (kchan
== NULL
) {
2551 attr
= channel_new_default_attr(domain
);
2553 ret
= LTTCOMM_FATAL
;
2556 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2558 /* This call will notify the kernel thread */
2559 ret
= channel_kernel_create(session
->kernel_session
,
2560 attr
, kernel_poll_pipe
[1]);
2561 if (ret
!= LTTCOMM_OK
) {
2568 /* Get the newly created kernel channel pointer */
2569 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2570 session
->kernel_session
);
2571 if (kchan
== NULL
) {
2572 /* This sould not happen... */
2573 ret
= LTTCOMM_FATAL
;
2577 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2579 if (ret
!= LTTCOMM_OK
) {
2583 kernel_wait_quiescent(kernel_tracer_fd
);
2586 case LTTNG_DOMAIN_UST
:
2588 struct lttng_channel
*attr
;
2589 struct ltt_ust_channel
*uchan
;
2591 /* Get channel from global UST domain */
2592 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2594 if (uchan
== NULL
) {
2595 /* Create default channel */
2596 attr
= channel_new_default_attr(domain
);
2598 ret
= LTTCOMM_FATAL
;
2601 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2602 attr
->name
[NAME_MAX
- 1] = '\0';
2604 ret
= channel_ust_create(usess
, domain
, attr
);
2605 if (ret
!= LTTCOMM_OK
) {
2611 /* Get the newly created channel reference back */
2612 uchan
= trace_ust_find_channel_by_name(
2613 usess
->domain_global
.channels
, channel_name
);
2614 if (uchan
== NULL
) {
2615 /* Something is really wrong */
2616 ret
= LTTCOMM_FATAL
;
2621 /* At this point, the session and channel exist on the tracer */
2622 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2623 if (ret
!= LTTCOMM_OK
) {
2628 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2629 case LTTNG_DOMAIN_UST_PID
:
2630 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2632 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2643 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2645 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2646 char *channel_name
, int event_type
)
2649 struct ltt_kernel_channel
*kchan
;
2652 case LTTNG_DOMAIN_KERNEL
:
2653 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2654 session
->kernel_session
);
2655 if (kchan
== NULL
) {
2656 /* This call will notify the kernel thread */
2657 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2658 kernel_poll_pipe
[1]);
2659 if (ret
!= LTTCOMM_OK
) {
2663 /* Get the newly created kernel channel pointer */
2664 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2665 session
->kernel_session
);
2666 if (kchan
== NULL
) {
2667 /* This sould not happen... */
2668 ret
= LTTCOMM_FATAL
;
2674 switch (event_type
) {
2675 case LTTNG_EVENT_SYSCALL
:
2676 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2677 kchan
, kernel_tracer_fd
);
2679 case LTTNG_EVENT_TRACEPOINT
:
2681 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2682 * events already registered to the channel.
2684 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2685 kchan
, kernel_tracer_fd
);
2687 case LTTNG_EVENT_ALL
:
2688 /* Enable syscalls and tracepoints */
2689 ret
= event_kernel_enable_all(session
->kernel_session
,
2690 kchan
, kernel_tracer_fd
);
2693 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2697 /* Manage return value */
2698 if (ret
!= LTTCOMM_OK
) {
2702 kernel_wait_quiescent(kernel_tracer_fd
);
2704 case LTTNG_DOMAIN_UST
:
2706 struct lttng_channel
*attr
;
2707 struct ltt_ust_channel
*uchan
;
2708 struct ltt_ust_session
*usess
= session
->ust_session
;
2710 /* Get channel from global UST domain */
2711 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2713 if (uchan
== NULL
) {
2714 /* Create default channel */
2715 attr
= channel_new_default_attr(domain
);
2717 ret
= LTTCOMM_FATAL
;
2720 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2721 attr
->name
[NAME_MAX
- 1] = '\0';
2723 /* Use the internal command enable channel */
2724 ret
= channel_ust_create(usess
, domain
, attr
);
2725 if (ret
!= LTTCOMM_OK
) {
2731 /* Get the newly created channel reference back */
2732 uchan
= trace_ust_find_channel_by_name(
2733 usess
->domain_global
.channels
, channel_name
);
2734 if (uchan
== NULL
) {
2735 /* Something is really wrong */
2736 ret
= LTTCOMM_FATAL
;
2741 /* At this point, the session and channel exist on the tracer */
2743 switch (event_type
) {
2744 case LTTNG_EVENT_ALL
:
2745 case LTTNG_EVENT_TRACEPOINT
:
2746 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2747 if (ret
!= LTTCOMM_OK
) {
2752 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2756 /* Manage return value */
2757 if (ret
!= LTTCOMM_OK
) {
2763 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2764 case LTTNG_DOMAIN_UST_PID
:
2765 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2767 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2778 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2780 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2783 ssize_t nb_events
= 0;
2786 case LTTNG_DOMAIN_KERNEL
:
2787 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2788 if (nb_events
< 0) {
2789 ret
= LTTCOMM_KERN_LIST_FAIL
;
2793 case LTTNG_DOMAIN_UST
:
2794 nb_events
= ust_app_list_events(events
);
2795 if (nb_events
< 0) {
2796 ret
= LTTCOMM_UST_LIST_FAIL
;
2801 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2808 /* Return negative value to differentiate return code */
2813 * Command LTTNG_START_TRACE processed by the client thread.
2815 static int cmd_start_trace(struct ltt_session
*session
)
2818 struct ltt_kernel_session
*ksession
;
2819 struct ltt_ust_session
*usess
;
2822 ksession
= session
->kernel_session
;
2823 usess
= session
->ust_session
;
2825 if (session
->enabled
) {
2826 ret
= LTTCOMM_UST_START_FAIL
;
2830 session
->enabled
= 1;
2832 /* Kernel tracing */
2833 if (ksession
!= NULL
) {
2834 struct ltt_kernel_channel
*kchan
;
2836 /* Open kernel metadata */
2837 if (ksession
->metadata
== NULL
) {
2838 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2840 ret
= LTTCOMM_KERN_META_FAIL
;
2845 /* Open kernel metadata stream */
2846 if (ksession
->metadata_stream_fd
== 0) {
2847 ret
= kernel_open_metadata_stream(ksession
);
2849 ERR("Kernel create metadata stream failed");
2850 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2855 /* For each channel */
2856 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2857 if (kchan
->stream_count
== 0) {
2858 ret
= kernel_open_channel_stream(kchan
);
2860 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2863 /* Update the stream global counter */
2864 ksession
->stream_count_global
+= ret
;
2868 /* Setup kernel consumer socket and send fds to it */
2869 ret
= init_kernel_tracing(ksession
);
2871 ret
= LTTCOMM_KERN_START_FAIL
;
2875 /* This start the kernel tracing */
2876 ret
= kernel_start_session(ksession
);
2878 ret
= LTTCOMM_KERN_START_FAIL
;
2882 /* Quiescent wait after starting trace */
2883 kernel_wait_quiescent(kernel_tracer_fd
);
2886 /* Flag session that trace should start automatically */
2888 usess
->start_trace
= 1;
2890 ret
= ust_app_start_trace_all(usess
);
2892 ret
= LTTCOMM_UST_START_FAIL
;
2904 * Command LTTNG_STOP_TRACE processed by the client thread.
2906 static int cmd_stop_trace(struct ltt_session
*session
)
2909 struct ltt_kernel_channel
*kchan
;
2910 struct ltt_kernel_session
*ksession
;
2911 struct ltt_ust_session
*usess
;
2914 ksession
= session
->kernel_session
;
2915 usess
= session
->ust_session
;
2917 if (!session
->enabled
) {
2918 ret
= LTTCOMM_UST_STOP_FAIL
;
2922 session
->enabled
= 0;
2925 if (ksession
!= NULL
) {
2926 DBG("Stop kernel tracing");
2928 /* Flush all buffers before stopping */
2929 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2931 ERR("Kernel metadata flush failed");
2934 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2935 ret
= kernel_flush_buffer(kchan
);
2937 ERR("Kernel flush buffer error");
2941 ret
= kernel_stop_session(ksession
);
2943 ret
= LTTCOMM_KERN_STOP_FAIL
;
2947 kernel_wait_quiescent(kernel_tracer_fd
);
2951 usess
->start_trace
= 0;
2953 ret
= ust_app_stop_trace_all(usess
);
2955 ret
= LTTCOMM_UST_STOP_FAIL
;
2967 * Command LTTNG_CREATE_SESSION processed by the client thread.
2969 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2973 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2974 if (ret
!= LTTCOMM_OK
) {
2985 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2987 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2991 /* Clean kernel session teardown */
2992 teardown_kernel_session(session
);
2993 /* UST session teardown */
2994 teardown_ust_session(session
);
2997 * Must notify the kernel thread here to update it's poll setin order
2998 * to remove the channel(s)' fd just destroyed.
3000 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3002 perror("write kernel poll pipe");
3005 ret
= session_destroy(session
);
3011 * Command LTTNG_CALIBRATE processed by the client thread.
3013 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3018 case LTTNG_DOMAIN_KERNEL
:
3020 struct lttng_kernel_calibrate kcalibrate
;
3022 kcalibrate
.type
= calibrate
->type
;
3023 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3025 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3031 /* TODO: Userspace tracing */
3032 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3043 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3045 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3051 case LTTNG_DOMAIN_KERNEL
:
3052 /* Can't register a consumer if there is already one */
3053 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3054 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3058 sock
= lttcomm_connect_unix_sock(sock_path
);
3060 ret
= LTTCOMM_CONNECT_FAIL
;
3064 session
->kernel_session
->consumer_fd
= sock
;
3067 /* TODO: Userspace tracing */
3068 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3079 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3081 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3082 struct lttng_domain
**domains
)
3087 if (session
->kernel_session
!= NULL
) {
3088 DBG3("Listing domains found kernel domain");
3092 if (session
->ust_session
!= NULL
) {
3093 DBG3("Listing domains found UST global domain");
3097 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3098 if (*domains
== NULL
) {
3099 ret
= -LTTCOMM_FATAL
;
3103 if (session
->kernel_session
!= NULL
) {
3104 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3108 if (session
->ust_session
!= NULL
) {
3109 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3120 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3122 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3123 struct lttng_channel
**channels
)
3126 ssize_t nb_chan
= 0;
3129 case LTTNG_DOMAIN_KERNEL
:
3130 if (session
->kernel_session
!= NULL
) {
3131 nb_chan
= session
->kernel_session
->channel_count
;
3133 DBG3("Number of kernel channels %zd", nb_chan
);
3135 case LTTNG_DOMAIN_UST
:
3136 if (session
->ust_session
!= NULL
) {
3137 nb_chan
= lttng_ht_get_count(
3138 session
->ust_session
->domain_global
.channels
);
3140 DBG3("Number of UST global channels %zd", nb_chan
);
3144 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3149 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3150 if (*channels
== NULL
) {
3151 ret
= -LTTCOMM_FATAL
;
3155 list_lttng_channels(domain
, session
, *channels
);
3167 * Command LTTNG_LIST_EVENTS processed by the client thread.
3169 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3170 char *channel_name
, struct lttng_event
**events
)
3173 ssize_t nb_event
= 0;
3176 case LTTNG_DOMAIN_KERNEL
:
3177 if (session
->kernel_session
!= NULL
) {
3178 nb_event
= list_lttng_kernel_events(channel_name
,
3179 session
->kernel_session
, events
);
3182 case LTTNG_DOMAIN_UST
:
3184 if (session
->ust_session
!= NULL
) {
3185 nb_event
= list_lttng_ust_global_events(channel_name
,
3186 &session
->ust_session
->domain_global
, events
);
3191 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3202 * Process the command requested by the lttng client within the command
3203 * context structure. This function make sure that the return structure (llm)
3204 * is set and ready for transmission before returning.
3206 * Return any error encountered or 0 for success.
3208 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3210 int ret
= LTTCOMM_OK
;
3211 int need_tracing_session
= 1;
3213 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3215 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3216 ret
= LTTCOMM_KERN_NA
;
3221 * Check for command that don't needs to allocate a returned payload. We do
3222 * this here so we don't have to make the call for no payload at each
3225 switch(cmd_ctx
->lsm
->cmd_type
) {
3226 case LTTNG_LIST_SESSIONS
:
3227 case LTTNG_LIST_TRACEPOINTS
:
3228 case LTTNG_LIST_DOMAINS
:
3229 case LTTNG_LIST_CHANNELS
:
3230 case LTTNG_LIST_EVENTS
:
3233 /* Setup lttng message with no payload */
3234 ret
= setup_lttng_msg(cmd_ctx
, 0);
3236 /* This label does not try to unlock the session */
3237 goto init_setup_error
;
3241 /* Commands that DO NOT need a session. */
3242 switch (cmd_ctx
->lsm
->cmd_type
) {
3243 case LTTNG_CALIBRATE
:
3244 case LTTNG_CREATE_SESSION
:
3245 case LTTNG_LIST_SESSIONS
:
3246 case LTTNG_LIST_TRACEPOINTS
:
3247 need_tracing_session
= 0;
3250 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3251 session_lock_list();
3252 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3253 session_unlock_list();
3254 if (cmd_ctx
->session
== NULL
) {
3255 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3256 ret
= LTTCOMM_SESS_NOT_FOUND
;
3258 /* If no session name specified */
3259 ret
= LTTCOMM_SELECT_SESS
;
3263 /* Acquire lock for the session */
3264 session_lock(cmd_ctx
->session
);
3270 * Check domain type for specific "pre-action".
3272 switch (cmd_ctx
->lsm
->domain
.type
) {
3273 case LTTNG_DOMAIN_KERNEL
:
3275 ret
= LTTCOMM_KERN_NA
;
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_bin
[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_bin
[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
);
3365 * Check that the UID or GID match that of the tracing session.
3366 * The root user can interact with all sessions.
3368 if (need_tracing_session
) {
3369 if (!session_access_ok(cmd_ctx
->session
,
3370 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3371 ret
= LTTCOMM_EPERM
;
3376 /* Process by command type */
3377 switch (cmd_ctx
->lsm
->cmd_type
) {
3378 case LTTNG_ADD_CONTEXT
:
3380 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3381 cmd_ctx
->lsm
->u
.context
.channel_name
,
3382 cmd_ctx
->lsm
->u
.context
.event_name
,
3383 &cmd_ctx
->lsm
->u
.context
.ctx
);
3386 case LTTNG_DISABLE_CHANNEL
:
3388 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3389 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3392 case LTTNG_DISABLE_EVENT
:
3394 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3395 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3396 cmd_ctx
->lsm
->u
.disable
.name
);
3400 case LTTNG_DISABLE_ALL_EVENT
:
3402 DBG("Disabling all events");
3404 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3405 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3408 case LTTNG_ENABLE_CHANNEL
:
3410 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3411 &cmd_ctx
->lsm
->u
.channel
.chan
);
3414 case LTTNG_ENABLE_EVENT
:
3416 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3417 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3418 &cmd_ctx
->lsm
->u
.enable
.event
);
3421 case LTTNG_ENABLE_ALL_EVENT
:
3423 DBG("Enabling all events");
3425 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3426 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3427 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3430 case LTTNG_LIST_TRACEPOINTS
:
3432 struct lttng_event
*events
;
3435 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3436 if (nb_events
< 0) {
3442 * Setup lttng message with payload size set to the event list size in
3443 * bytes and then copy list into the llm payload.
3445 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3451 /* Copy event list into message payload */
3452 memcpy(cmd_ctx
->llm
->payload
, events
,
3453 sizeof(struct lttng_event
) * nb_events
);
3460 case LTTNG_START_TRACE
:
3462 ret
= cmd_start_trace(cmd_ctx
->session
);
3465 case LTTNG_STOP_TRACE
:
3467 ret
= cmd_stop_trace(cmd_ctx
->session
);
3470 case LTTNG_CREATE_SESSION
:
3472 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3473 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3476 case LTTNG_DESTROY_SESSION
:
3478 ret
= cmd_destroy_session(cmd_ctx
->session
,
3479 cmd_ctx
->lsm
->session
.name
);
3482 case LTTNG_LIST_DOMAINS
:
3485 struct lttng_domain
*domains
;
3487 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3493 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3498 /* Copy event list into message payload */
3499 memcpy(cmd_ctx
->llm
->payload
, domains
,
3500 nb_dom
* sizeof(struct lttng_domain
));
3507 case LTTNG_LIST_CHANNELS
:
3510 struct lttng_channel
*channels
;
3512 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3513 cmd_ctx
->session
, &channels
);
3519 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3524 /* Copy event list into message payload */
3525 memcpy(cmd_ctx
->llm
->payload
, channels
,
3526 nb_chan
* sizeof(struct lttng_channel
));
3533 case LTTNG_LIST_EVENTS
:
3536 struct lttng_event
*events
= NULL
;
3538 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3539 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3545 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3550 /* Copy event list into message payload */
3551 memcpy(cmd_ctx
->llm
->payload
, events
,
3552 nb_event
* sizeof(struct lttng_event
));
3559 case LTTNG_LIST_SESSIONS
:
3561 unsigned int nr_sessions
;
3563 session_lock_list();
3564 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3565 if (nr_sessions
== 0) {
3566 ret
= LTTCOMM_NO_SESSION
;
3567 session_unlock_list();
3570 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3572 session_unlock_list();
3576 /* Filled the session array */
3577 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3578 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3580 session_unlock_list();
3585 case LTTNG_CALIBRATE
:
3587 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3588 &cmd_ctx
->lsm
->u
.calibrate
);
3591 case LTTNG_REGISTER_CONSUMER
:
3593 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3594 cmd_ctx
->lsm
->u
.reg
.path
);
3603 if (cmd_ctx
->llm
== NULL
) {
3604 DBG("Missing llm structure. Allocating one.");
3605 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3609 /* Set return code */
3610 cmd_ctx
->llm
->ret_code
= ret
;
3612 if (cmd_ctx
->session
) {
3613 session_unlock(cmd_ctx
->session
);
3620 * This thread manage all clients request using the unix client socket for
3623 static void *thread_manage_clients(void *data
)
3625 int sock
= 0, ret
, i
, pollfd
;
3626 uint32_t revents
, nb_fd
;
3627 struct command_ctx
*cmd_ctx
= NULL
;
3628 struct lttng_poll_event events
;
3630 DBG("[thread] Manage client started");
3632 rcu_register_thread();
3634 ret
= lttcomm_listen_unix_sock(client_sock
);
3640 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3641 * more will be added to this poll set.
3643 ret
= create_thread_poll_set(&events
, 2);
3648 /* Add the application registration socket */
3649 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3655 * Notify parent pid that we are ready to accept command for client side.
3657 if (opt_sig_parent
) {
3658 kill(ppid
, SIGCHLD
);
3662 DBG("Accepting client command ...");
3664 nb_fd
= LTTNG_POLL_GETNB(&events
);
3666 /* Inifinite blocking call, waiting for transmission */
3667 ret
= lttng_poll_wait(&events
, -1);
3672 for (i
= 0; i
< nb_fd
; i
++) {
3673 /* Fetch once the poll data */
3674 revents
= LTTNG_POLL_GETEV(&events
, i
);
3675 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3677 /* Thread quit pipe has been closed. Killing thread. */
3678 ret
= check_thread_quit_pipe(pollfd
, revents
);
3683 /* Event on the registration socket */
3684 if (pollfd
== client_sock
) {
3685 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3686 ERR("Client socket poll error");
3692 DBG("Wait for client response");
3694 sock
= lttcomm_accept_unix_sock(client_sock
);
3699 /* Set socket option for credentials retrieval */
3700 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3705 /* Allocate context command to process the client request */
3706 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3707 if (cmd_ctx
== NULL
) {
3708 perror("zmalloc cmd_ctx");
3712 /* Allocate data buffer for reception */
3713 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3714 if (cmd_ctx
->lsm
== NULL
) {
3715 perror("zmalloc cmd_ctx->lsm");
3719 cmd_ctx
->llm
= NULL
;
3720 cmd_ctx
->session
= NULL
;
3723 * Data is received from the lttng client. The struct
3724 * lttcomm_session_msg (lsm) contains the command and data request of
3727 DBG("Receiving data from client ...");
3728 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3729 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3731 DBG("Nothing recv() from client... continuing");
3737 // TODO: Validate cmd_ctx including sanity check for
3738 // security purpose.
3740 rcu_thread_online();
3742 * This function dispatch the work to the kernel or userspace tracer
3743 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3744 * informations for the client. The command context struct contains
3745 * everything this function may needs.
3747 ret
= process_client_msg(cmd_ctx
);
3748 rcu_thread_offline();
3751 * TODO: Inform client somehow of the fatal error. At
3752 * this point, ret < 0 means that a zmalloc failed
3753 * (ENOMEM). Error detected but still accept command.
3755 clean_command_ctx(&cmd_ctx
);
3759 DBG("Sending response (size: %d, retcode: %s)",
3760 cmd_ctx
->lttng_msg_size
,
3761 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3762 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3764 ERR("Failed to send data back to client");
3767 /* End of transmission */
3770 clean_command_ctx(&cmd_ctx
);
3774 DBG("Client thread dying");
3775 unlink(client_unix_sock_path
);
3779 lttng_poll_clean(&events
);
3780 clean_command_ctx(&cmd_ctx
);
3782 rcu_unregister_thread();
3788 * usage function on stderr
3790 static void usage(void)
3792 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3793 fprintf(stderr
, " -h, --help Display this usage.\n");
3794 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3795 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3796 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3797 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3798 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3799 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3800 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3801 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3802 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3803 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3804 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3805 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3806 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3807 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3808 fprintf(stderr
, " -V, --version Show version number.\n");
3809 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3810 fprintf(stderr
, " -q, --quiet No output at all.\n");
3811 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3812 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3813 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3817 * daemon argument parsing
3819 static int parse_args(int argc
, char **argv
)
3823 static struct option long_options
[] = {
3824 { "client-sock", 1, 0, 'c' },
3825 { "apps-sock", 1, 0, 'a' },
3826 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3827 { "kconsumerd-err-sock", 1, 0, 'E' },
3828 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3829 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3830 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3831 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3832 { "consumerd32-path", 1, 0, 'u' },
3833 { "consumerd32-libdir", 1, 0, 'U' },
3834 { "consumerd64-path", 1, 0, 't' },
3835 { "consumerd64-libdir", 1, 0, 'T' },
3836 { "daemonize", 0, 0, 'd' },
3837 { "sig-parent", 0, 0, 'S' },
3838 { "help", 0, 0, 'h' },
3839 { "group", 1, 0, 'g' },
3840 { "version", 0, 0, 'V' },
3841 { "quiet", 0, 0, 'q' },
3842 { "verbose", 0, 0, 'v' },
3843 { "verbose-consumer", 0, 0, 'Z' },
3844 { "no-kernel", 0, 0, 'N' },
3849 int option_index
= 0;
3850 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3851 long_options
, &option_index
);
3858 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3860 fprintf(stderr
, " with arg %s\n", optarg
);
3864 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3867 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3873 opt_tracing_group
= optarg
;
3879 fprintf(stdout
, "%s\n", VERSION
);
3885 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3888 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3891 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3894 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3897 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3900 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3909 /* Verbose level can increase using multiple -v */
3913 opt_verbose_consumer
+= 1;
3916 consumerd32_bin
= optarg
;
3919 consumerd32_libdir
= optarg
;
3922 consumerd64_bin
= optarg
;
3925 consumerd64_libdir
= optarg
;
3928 /* Unknown option or other error.
3929 * Error is printed by getopt, just return */
3938 * Creates the two needed socket by the daemon.
3939 * apps_sock - The communication socket for all UST apps.
3940 * client_sock - The communication of the cli tool (lttng).
3942 static int init_daemon_socket(void)
3947 old_umask
= umask(0);
3949 /* Create client tool unix socket */
3950 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3951 if (client_sock
< 0) {
3952 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3957 /* File permission MUST be 660 */
3958 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3960 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3965 /* Create the application unix socket */
3966 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3967 if (apps_sock
< 0) {
3968 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3973 /* File permission MUST be 666 */
3974 ret
= chmod(apps_unix_sock_path
,
3975 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3977 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3988 * Check if the global socket is available, and if a daemon is answering at the
3989 * other side. If yes, error is returned.
3991 static int check_existing_daemon(void)
3993 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3994 access(apps_unix_sock_path
, F_OK
) < 0) {
3998 /* Is there anybody out there ? */
3999 if (lttng_session_daemon_alive()) {
4007 * Set the tracing group gid onto the client socket.
4009 * Race window between mkdir and chown is OK because we are going from more
4010 * permissive (root.root) to les permissive (root.tracing).
4012 static int set_permissions(char *rundir
)
4017 gid
= allowed_group();
4019 WARN("No tracing group detected");
4024 /* Set lttng run dir */
4025 ret
= chown(rundir
, 0, gid
);
4027 ERR("Unable to set group on %s", rundir
);
4031 /* lttng client socket path */
4032 ret
= chown(client_unix_sock_path
, 0, gid
);
4034 ERR("Unable to set group on %s", client_unix_sock_path
);
4038 /* kconsumer error socket path */
4039 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4041 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4045 /* 64-bit ustconsumer error socket path */
4046 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4048 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4052 /* 32-bit ustconsumer compat32 error socket path */
4053 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4055 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4059 DBG("All permissions are set");
4066 * Create the pipe used to wake up the kernel thread.
4068 static int create_kernel_poll_pipe(void)
4070 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4074 * Create the application command pipe to wake thread_manage_apps.
4076 static int create_apps_cmd_pipe(void)
4078 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4082 * Create the lttng run directory needed for all global sockets and pipe.
4084 static int create_lttng_rundir(const char *rundir
)
4088 DBG3("Creating LTTng run directory: %s", rundir
);
4090 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4092 if (errno
!= EEXIST
) {
4093 ERR("Unable to create %s", rundir
);
4105 * Setup sockets and directory needed by the kconsumerd communication with the
4108 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4112 char path
[PATH_MAX
];
4114 switch (consumer_data
->type
) {
4115 case LTTNG_CONSUMER_KERNEL
:
4116 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4118 case LTTNG_CONSUMER64_UST
:
4119 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4121 case LTTNG_CONSUMER32_UST
:
4122 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4125 ERR("Consumer type unknown");
4130 DBG2("Creating consumer directory: %s", path
);
4132 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4134 if (errno
!= EEXIST
) {
4135 ERR("Failed to create %s", path
);
4141 /* Create the kconsumerd error unix socket */
4142 consumer_data
->err_sock
=
4143 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4144 if (consumer_data
->err_sock
< 0) {
4145 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4150 /* File permission MUST be 660 */
4151 ret
= chmod(consumer_data
->err_unix_sock_path
,
4152 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4154 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4164 * Signal handler for the daemon
4166 * Simply stop all worker threads, leaving main() return gracefully after
4167 * joining all threads and calling cleanup().
4169 static void sighandler(int sig
)
4173 DBG("SIGPIPE caugth");
4176 DBG("SIGINT caugth");
4180 DBG("SIGTERM caugth");
4189 * Setup signal handler for :
4190 * SIGINT, SIGTERM, SIGPIPE
4192 static int set_signal_handler(void)
4195 struct sigaction sa
;
4198 if ((ret
= sigemptyset(&sigset
)) < 0) {
4199 perror("sigemptyset");
4203 sa
.sa_handler
= sighandler
;
4204 sa
.sa_mask
= sigset
;
4206 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4207 perror("sigaction");
4211 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4212 perror("sigaction");
4216 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4217 perror("sigaction");
4221 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4227 * Set open files limit to unlimited. This daemon can open a large number of
4228 * file descriptors in order to consumer multiple kernel traces.
4230 static void set_ulimit(void)
4235 /* The kernel does not allowed an infinite limit for open files */
4236 lim
.rlim_cur
= 65535;
4237 lim
.rlim_max
= 65535;
4239 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4241 perror("failed to set open files limit");
4248 int main(int argc
, char **argv
)
4252 const char *home_path
;
4254 rcu_register_thread();
4256 /* Create thread quit pipe */
4257 if ((ret
= init_thread_quit_pipe()) < 0) {
4261 setup_consumerd_path();
4263 /* Parse arguments */
4265 if ((ret
= parse_args(argc
, argv
) < 0)) {
4278 /* Check if daemon is UID = 0 */
4279 is_root
= !getuid();
4282 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4284 /* Create global run dir with root access */
4285 ret
= create_lttng_rundir(rundir
);
4290 if (strlen(apps_unix_sock_path
) == 0) {
4291 snprintf(apps_unix_sock_path
, PATH_MAX
,
4292 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4295 if (strlen(client_unix_sock_path
) == 0) {
4296 snprintf(client_unix_sock_path
, PATH_MAX
,
4297 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4300 /* Set global SHM for ust */
4301 if (strlen(wait_shm_path
) == 0) {
4302 snprintf(wait_shm_path
, PATH_MAX
,
4303 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4306 /* Setup kernel consumerd path */
4307 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4308 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4309 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4310 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4312 DBG2("Kernel consumer err path: %s",
4313 kconsumer_data
.err_unix_sock_path
);
4314 DBG2("Kernel consumer cmd path: %s",
4315 kconsumer_data
.cmd_unix_sock_path
);
4317 home_path
= get_home_dir();
4318 if (home_path
== NULL
) {
4319 /* TODO: Add --socket PATH option */
4320 ERR("Can't get HOME directory for sockets creation.");
4326 * Create rundir from home path. This will create something like
4329 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4335 ret
= create_lttng_rundir(rundir
);
4340 if (strlen(apps_unix_sock_path
) == 0) {
4341 snprintf(apps_unix_sock_path
, PATH_MAX
,
4342 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4345 /* Set the cli tool unix socket path */
4346 if (strlen(client_unix_sock_path
) == 0) {
4347 snprintf(client_unix_sock_path
, PATH_MAX
,
4348 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4351 /* Set global SHM for ust */
4352 if (strlen(wait_shm_path
) == 0) {
4353 snprintf(wait_shm_path
, PATH_MAX
,
4354 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4358 DBG("Client socket path %s", client_unix_sock_path
);
4359 DBG("Application socket path %s", apps_unix_sock_path
);
4360 DBG("LTTng run directory path: %s", rundir
);
4362 /* 32 bits consumerd path setup */
4363 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4364 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4365 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4366 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4368 DBG2("UST consumer 32 bits err path: %s",
4369 ustconsumer32_data
.err_unix_sock_path
);
4370 DBG2("UST consumer 32 bits cmd path: %s",
4371 ustconsumer32_data
.cmd_unix_sock_path
);
4373 /* 64 bits consumerd path setup */
4374 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4375 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4376 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4377 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4379 DBG2("UST consumer 64 bits err path: %s",
4380 ustconsumer64_data
.err_unix_sock_path
);
4381 DBG2("UST consumer 64 bits cmd path: %s",
4382 ustconsumer64_data
.cmd_unix_sock_path
);
4385 * See if daemon already exist.
4387 if ((ret
= check_existing_daemon()) < 0) {
4388 ERR("Already running daemon.\n");
4390 * We do not goto exit because we must not cleanup()
4391 * because a daemon is already running.
4396 /* After this point, we can safely call cleanup() with "goto exit" */
4399 * These actions must be executed as root. We do that *after* setting up
4400 * the sockets path because we MUST make the check for another daemon using
4401 * those paths *before* trying to set the kernel consumer sockets and init
4405 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4410 /* Setup kernel tracer */
4411 if (!opt_no_kernel
) {
4412 init_kernel_tracer();
4415 /* Set ulimit for open files */
4419 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4424 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4429 if ((ret
= set_signal_handler()) < 0) {
4433 /* Setup the needed unix socket */
4434 if ((ret
= init_daemon_socket()) < 0) {
4438 /* Set credentials to socket */
4439 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4443 /* Get parent pid if -S, --sig-parent is specified. */
4444 if (opt_sig_parent
) {
4448 /* Setup the kernel pipe for waking up the kernel thread */
4449 if ((ret
= create_kernel_poll_pipe()) < 0) {
4453 /* Setup the thread apps communication pipe. */
4454 if ((ret
= create_apps_cmd_pipe()) < 0) {
4458 /* Init UST command queue. */
4459 cds_wfq_init(&ust_cmd_queue
.queue
);
4461 /* Init UST app hash table */
4465 * Get session list pointer. This pointer MUST NOT be free(). This list is
4466 * statically declared in session.c
4468 session_list_ptr
= session_get_list();
4470 /* Set up max poll set size */
4471 lttng_poll_set_max_size();
4473 /* Create thread to manage the client socket */
4474 ret
= pthread_create(&client_thread
, NULL
,
4475 thread_manage_clients
, (void *) NULL
);
4477 perror("pthread_create clients");
4481 /* Create thread to dispatch registration */
4482 ret
= pthread_create(&dispatch_thread
, NULL
,
4483 thread_dispatch_ust_registration
, (void *) NULL
);
4485 perror("pthread_create dispatch");
4489 /* Create thread to manage application registration. */
4490 ret
= pthread_create(®_apps_thread
, NULL
,
4491 thread_registration_apps
, (void *) NULL
);
4493 perror("pthread_create registration");
4497 /* Create thread to manage application socket */
4498 ret
= pthread_create(&apps_thread
, NULL
,
4499 thread_manage_apps
, (void *) NULL
);
4501 perror("pthread_create apps");
4505 /* Create kernel thread to manage kernel event */
4506 ret
= pthread_create(&kernel_thread
, NULL
,
4507 thread_manage_kernel
, (void *) NULL
);
4509 perror("pthread_create kernel");
4513 ret
= pthread_join(kernel_thread
, &status
);
4515 perror("pthread_join");
4516 goto error
; /* join error, exit without cleanup */
4520 ret
= pthread_join(apps_thread
, &status
);
4522 perror("pthread_join");
4523 goto error
; /* join error, exit without cleanup */
4527 ret
= pthread_join(reg_apps_thread
, &status
);
4529 perror("pthread_join");
4530 goto error
; /* join error, exit without cleanup */
4534 ret
= pthread_join(dispatch_thread
, &status
);
4536 perror("pthread_join");
4537 goto error
; /* join error, exit without cleanup */
4541 ret
= pthread_join(client_thread
, &status
);
4543 perror("pthread_join");
4544 goto error
; /* join error, exit without cleanup */
4547 ret
= join_consumer_thread(&kconsumer_data
);
4549 perror("join_consumer");
4550 goto error
; /* join error, exit without cleanup */
4556 * cleanup() is called when no other thread is running.
4558 rcu_thread_online();
4560 rcu_thread_offline();
4561 rcu_unregister_thread();