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 <common/common.h>
42 #include <common/compat/poll.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
58 #define CONSUMERD_FILE "lttng-consumerd"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
79 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
80 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
81 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
82 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
85 int opt_verbose
; /* Not static for lttngerr.h */
86 int opt_verbose_consumer
; /* Not static for lttngerr.h */
87 int opt_quiet
; /* Not static for lttngerr.h */
90 const char *opt_tracing_group
;
91 static int opt_sig_parent
;
92 static int opt_daemon
;
93 static int opt_no_kernel
;
94 static int is_root
; /* Set to 1 if the daemon is running as root */
95 static pid_t ppid
; /* Parent PID for --sig-parent option */
98 /* Consumer daemon specific control data */
99 static struct consumer_data kconsumer_data
= {
100 .type
= LTTNG_CONSUMER_KERNEL
,
101 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
102 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
106 static struct consumer_data ustconsumer64_data
= {
107 .type
= LTTNG_CONSUMER64_UST
,
108 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
109 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
113 static struct consumer_data ustconsumer32_data
= {
114 .type
= LTTNG_CONSUMER32_UST
,
115 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
116 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
121 static int dispatch_thread_exit
;
123 /* Global application Unix socket path */
124 static char apps_unix_sock_path
[PATH_MAX
];
125 /* Global client Unix socket path */
126 static char client_unix_sock_path
[PATH_MAX
];
127 /* global wait shm path for UST */
128 static char wait_shm_path
[PATH_MAX
];
130 /* Sockets and FDs */
131 static int client_sock
= -1;
132 static int apps_sock
= -1;
133 static int kernel_tracer_fd
= -1;
134 static int kernel_poll_pipe
[2] = { -1, -1 };
137 * Quit pipe for all threads. This permits a single cancellation point
138 * for all threads when receiving an event on the pipe.
140 static int thread_quit_pipe
[2] = { -1, -1 };
143 * This pipe is used to inform the thread managing application communication
144 * that a command is queued and ready to be processed.
146 static int apps_cmd_pipe
[2] = { -1, -1 };
148 /* Pthread, Mutexes and Semaphores */
149 static pthread_t apps_thread
;
150 static pthread_t reg_apps_thread
;
151 static pthread_t client_thread
;
152 static pthread_t kernel_thread
;
153 static pthread_t dispatch_thread
;
157 * UST registration command queue. This queue is tied with a futex and uses a N
158 * wakers / 1 waiter implemented and detailed in futex.c/.h
160 * The thread_manage_apps and thread_dispatch_ust_registration interact with
161 * this queue and the wait/wake scheme.
163 static struct ust_cmd_queue ust_cmd_queue
;
166 * Pointer initialized before thread creation.
168 * This points to the tracing session list containing the session count and a
169 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
170 * MUST NOT be taken if you call a public function in session.c.
172 * The lock is nested inside the structure: session_list_ptr->lock. Please use
173 * session_lock_list and session_unlock_list for lock acquisition.
175 static struct ltt_session_list
*session_list_ptr
;
177 int ust_consumerd64_fd
= -1;
178 int ust_consumerd32_fd
= -1;
180 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
181 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
182 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
183 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
186 void setup_consumerd_path(void)
188 const char *bin
, *libdir
;
191 * Allow INSTALL_BIN_PATH to be used as a target path for the
192 * native architecture size consumer if CONFIG_CONSUMER*_PATH
193 * has not been defined.
195 #if (CAA_BITS_PER_LONG == 32)
196 if (!consumerd32_bin
[0]) {
197 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
199 if (!consumerd32_libdir
[0]) {
200 consumerd32_libdir
= INSTALL_LIB_PATH
;
202 #elif (CAA_BITS_PER_LONG == 64)
203 if (!consumerd64_bin
[0]) {
204 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
206 if (!consumerd64_libdir
[0]) {
207 consumerd64_libdir
= INSTALL_LIB_PATH
;
210 #error "Unknown bitness"
214 * runtime env. var. overrides the build default.
216 bin
= getenv("LTTNG_CONSUMERD32_BIN");
218 consumerd32_bin
= bin
;
220 bin
= getenv("LTTNG_CONSUMERD64_BIN");
222 consumerd64_bin
= bin
;
224 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
226 consumerd32_libdir
= libdir
;
228 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
230 consumerd64_libdir
= libdir
;
235 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
237 static int create_thread_poll_set(struct lttng_poll_event
*events
,
242 if (events
== NULL
|| size
== 0) {
247 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
253 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
265 * Check if the thread quit pipe was triggered.
267 * Return 1 if it was triggered else 0;
269 static int check_thread_quit_pipe(int fd
, uint32_t events
)
271 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
279 * Return group ID of the tracing group or -1 if not found.
281 static gid_t
allowed_group(void)
285 if (opt_tracing_group
) {
286 grp
= getgrnam(opt_tracing_group
);
288 grp
= getgrnam(default_tracing_group
);
298 * Init thread quit pipe.
300 * Return -1 on error or 0 if all pipes are created.
302 static int init_thread_quit_pipe(void)
306 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
308 PERROR("thread quit pipe");
317 * Complete teardown of a kernel session. This free all data structure related
318 * to a kernel session and update counter.
320 static void teardown_kernel_session(struct ltt_session
*session
)
322 if (!session
->kernel_session
) {
323 DBG3("No kernel session when tearing down session");
327 DBG("Tearing down kernel session");
330 * If a custom kernel consumer was registered, close the socket before
331 * tearing down the complete kernel session structure
333 if (kconsumer_data
.cmd_sock
>= 0 &&
334 session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
335 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
338 trace_kernel_destroy_session(session
->kernel_session
);
342 * Complete teardown of all UST sessions. This will free everything on his path
343 * and destroy the core essence of all ust sessions :)
345 static void teardown_ust_session(struct ltt_session
*session
)
349 if (!session
->ust_session
) {
350 DBG3("No UST session when tearing down session");
354 DBG("Tearing down UST session(s)");
356 ret
= ust_app_destroy_trace_all(session
->ust_session
);
358 ERR("Error in ust_app_destroy_trace_all");
361 trace_ust_destroy_session(session
->ust_session
);
365 * Stop all threads by closing the thread quit pipe.
367 static void stop_threads(void)
371 /* Stopping all threads */
372 DBG("Terminating all threads");
373 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
375 ERR("write error on thread quit pipe");
378 /* Dispatch thread */
379 dispatch_thread_exit
= 1;
380 futex_nto1_wake(&ust_cmd_queue
.futex
);
386 static void cleanup(void)
390 struct ltt_session
*sess
, *stmp
;
394 DBG("Removing %s directory", rundir
);
395 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
397 ERR("asprintf failed. Something is really wrong!");
400 /* Remove lttng run directory */
403 ERR("Unable to clean %s", rundir
);
407 DBG("Cleaning up all sessions");
409 /* Destroy session list mutex */
410 if (session_list_ptr
!= NULL
) {
411 pthread_mutex_destroy(&session_list_ptr
->lock
);
413 /* Cleanup ALL session */
414 cds_list_for_each_entry_safe(sess
, stmp
,
415 &session_list_ptr
->head
, list
) {
416 teardown_kernel_session(sess
);
417 teardown_ust_session(sess
);
422 DBG("Closing all UST sockets");
423 ust_app_clean_list();
425 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
427 if (is_root
&& !opt_no_kernel
) {
428 DBG2("Closing kernel fd");
429 if (kernel_tracer_fd
>= 0) {
430 ret
= close(kernel_tracer_fd
);
435 DBG("Unloading kernel modules");
436 modprobe_remove_lttng_all();
440 * Closing all pipes used for communication between threads.
442 for (i
= 0; i
< 2; i
++) {
443 if (kernel_poll_pipe
[i
] >= 0) {
444 ret
= close(kernel_poll_pipe
[i
]);
451 for (i
= 0; i
< 2; i
++) {
452 if (thread_quit_pipe
[i
] >= 0) {
453 ret
= close(thread_quit_pipe
[i
]);
459 for (i
= 0; i
< 2; i
++) {
460 if (apps_cmd_pipe
[i
] >= 0) {
461 ret
= close(apps_cmd_pipe
[i
]);
469 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
470 "Matthew, BEET driven development works!%c[%dm",
471 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
476 * Send data on a unix socket using the liblttsessiondcomm API.
478 * Return lttcomm error code.
480 static int send_unix_sock(int sock
, void *buf
, size_t len
)
482 /* Check valid length */
487 return lttcomm_send_unix_sock(sock
, buf
, len
);
491 * Free memory of a command context structure.
493 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
495 DBG("Clean command context structure");
497 if ((*cmd_ctx
)->llm
) {
498 free((*cmd_ctx
)->llm
);
500 if ((*cmd_ctx
)->lsm
) {
501 free((*cmd_ctx
)->lsm
);
509 * Send all stream fds of kernel channel to the consumer.
511 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
512 int sock
, struct ltt_kernel_channel
*channel
,
513 uid_t uid
, gid_t gid
)
516 struct ltt_kernel_stream
*stream
;
517 struct lttcomm_consumer_msg lkm
;
519 DBG("Sending streams of channel %s to kernel consumer",
520 channel
->channel
->name
);
523 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
524 lkm
.u
.channel
.channel_key
= channel
->fd
;
525 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
526 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
527 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
528 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
530 PERROR("send consumer channel");
535 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
539 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
540 lkm
.u
.stream
.channel_key
= channel
->fd
;
541 lkm
.u
.stream
.stream_key
= stream
->fd
;
542 lkm
.u
.stream
.state
= stream
->state
;
543 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
544 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
545 lkm
.u
.stream
.uid
= uid
;
546 lkm
.u
.stream
.gid
= gid
;
547 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
548 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
549 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
550 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
552 PERROR("send consumer stream");
555 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
557 PERROR("send consumer stream ancillary data");
562 DBG("consumer channel streams sent");
571 * Send all stream fds of the kernel session to the consumer.
573 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
574 struct ltt_kernel_session
*session
)
577 struct ltt_kernel_channel
*chan
;
578 struct lttcomm_consumer_msg lkm
;
579 int sock
= session
->consumer_fd
;
581 DBG("Sending metadata stream fd");
583 /* Extra protection. It's NOT supposed to be set to -1 at this point */
584 if (session
->consumer_fd
< 0) {
585 session
->consumer_fd
= consumer_data
->cmd_sock
;
588 if (session
->metadata_stream_fd
>= 0) {
589 /* Send metadata channel fd */
590 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
591 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
592 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
593 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
594 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
595 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
597 PERROR("send consumer channel");
601 /* Send metadata stream fd */
602 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
603 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
604 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
605 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
606 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
607 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
608 lkm
.u
.stream
.uid
= session
->uid
;
609 lkm
.u
.stream
.gid
= session
->gid
;
610 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
611 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
612 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
613 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
615 PERROR("send consumer stream");
618 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
620 PERROR("send consumer stream");
625 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
626 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
627 session
->uid
, session
->gid
);
633 DBG("consumer fds (metadata and channel streams) sent");
642 * Notify UST applications using the shm mmap futex.
644 static int notify_ust_apps(int active
)
648 DBG("Notifying applications of session daemon state: %d", active
);
650 /* See shm.c for this call implying mmap, shm and futex calls */
651 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
652 if (wait_shm_mmap
== NULL
) {
656 /* Wake waiting process */
657 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
659 /* Apps notified successfully */
667 * Setup the outgoing data buffer for the response (llm) by allocating the
668 * right amount of memory and copying the original information from the lsm
671 * Return total size of the buffer pointed by buf.
673 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
679 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
680 if (cmd_ctx
->llm
== NULL
) {
686 /* Copy common data */
687 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
688 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
690 cmd_ctx
->llm
->data_size
= size
;
691 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
700 * Update the kernel poll set of all channel fd available over all tracing
701 * session. Add the wakeup pipe at the end of the set.
703 static int update_kernel_poll(struct lttng_poll_event
*events
)
706 struct ltt_session
*session
;
707 struct ltt_kernel_channel
*channel
;
709 DBG("Updating kernel poll set");
712 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
713 session_lock(session
);
714 if (session
->kernel_session
== NULL
) {
715 session_unlock(session
);
719 cds_list_for_each_entry(channel
,
720 &session
->kernel_session
->channel_list
.head
, list
) {
721 /* Add channel fd to the kernel poll set */
722 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
724 session_unlock(session
);
727 DBG("Channel fd %d added to kernel set", channel
->fd
);
729 session_unlock(session
);
731 session_unlock_list();
736 session_unlock_list();
741 * Find the channel fd from 'fd' over all tracing session. When found, check
742 * for new channel stream and send those stream fds to the kernel consumer.
744 * Useful for CPU hotplug feature.
746 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
749 struct ltt_session
*session
;
750 struct ltt_kernel_channel
*channel
;
752 DBG("Updating kernel streams for channel fd %d", fd
);
755 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
756 session_lock(session
);
757 if (session
->kernel_session
== NULL
) {
758 session_unlock(session
);
762 /* This is not suppose to be -1 but this is an extra security check */
763 if (session
->kernel_session
->consumer_fd
< 0) {
764 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
767 cds_list_for_each_entry(channel
,
768 &session
->kernel_session
->channel_list
.head
, list
) {
769 if (channel
->fd
== fd
) {
770 DBG("Channel found, updating kernel streams");
771 ret
= kernel_open_channel_stream(channel
);
777 * Have we already sent fds to the consumer? If yes, it means
778 * that tracing is started so it is safe to send our updated
781 if (session
->kernel_session
->consumer_fds_sent
== 1) {
782 ret
= send_kconsumer_channel_streams(consumer_data
,
783 session
->kernel_session
->consumer_fd
, channel
,
784 session
->uid
, session
->gid
);
792 session_unlock(session
);
794 session_unlock_list();
798 session_unlock(session
);
799 session_unlock_list();
804 * For each tracing session, update newly registered apps.
806 static void update_ust_app(int app_sock
)
808 struct ltt_session
*sess
, *stmp
;
812 /* For all tracing session(s) */
813 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
815 if (sess
->ust_session
) {
816 ust_app_global_update(sess
->ust_session
, app_sock
);
818 session_unlock(sess
);
821 session_unlock_list();
825 * This thread manage event coming from the kernel.
827 * Features supported in this thread:
830 static void *thread_manage_kernel(void *data
)
832 int ret
, i
, pollfd
, update_poll_flag
= 1;
833 uint32_t revents
, nb_fd
;
835 struct lttng_poll_event events
;
837 DBG("Thread manage kernel started");
839 ret
= create_thread_poll_set(&events
, 2);
841 goto error_poll_create
;
844 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
850 if (update_poll_flag
== 1) {
852 * Reset number of fd in the poll set. Always 2 since there is the thread
853 * quit pipe and the kernel pipe.
857 ret
= update_kernel_poll(&events
);
861 update_poll_flag
= 0;
864 nb_fd
= LTTNG_POLL_GETNB(&events
);
866 DBG("Thread kernel polling on %d fds", nb_fd
);
868 /* Zeroed the poll events */
869 lttng_poll_reset(&events
);
871 /* Poll infinite value of time */
873 ret
= lttng_poll_wait(&events
, -1);
876 * Restart interrupted system call.
878 if (errno
== EINTR
) {
882 } else if (ret
== 0) {
883 /* Should not happen since timeout is infinite */
884 ERR("Return value of poll is 0 with an infinite timeout.\n"
885 "This should not have happened! Continuing...");
889 for (i
= 0; i
< nb_fd
; i
++) {
890 /* Fetch once the poll data */
891 revents
= LTTNG_POLL_GETEV(&events
, i
);
892 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
894 /* Thread quit pipe has been closed. Killing thread. */
895 ret
= check_thread_quit_pipe(pollfd
, revents
);
900 /* Check for data on kernel pipe */
901 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
902 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
903 update_poll_flag
= 1;
907 * New CPU detected by the kernel. Adding kernel stream to
908 * kernel session and updating the kernel consumer
910 if (revents
& LPOLLIN
) {
911 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
917 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
918 * and unregister kernel stream at this point.
926 lttng_poll_clean(&events
);
928 DBG("Kernel thread dying");
933 * This thread manage the consumer error sent back to the session daemon.
935 static void *thread_manage_consumer(void *data
)
937 int sock
= -1, i
, ret
, pollfd
;
938 uint32_t revents
, nb_fd
;
939 enum lttcomm_return_code code
;
940 struct lttng_poll_event events
;
941 struct consumer_data
*consumer_data
= data
;
943 DBG("[thread] Manage consumer started");
945 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
951 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
952 * Nothing more will be added to this poll set.
954 ret
= create_thread_poll_set(&events
, 2);
959 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
964 nb_fd
= LTTNG_POLL_GETNB(&events
);
966 /* Inifinite blocking call, waiting for transmission */
968 ret
= lttng_poll_wait(&events
, -1);
971 * Restart interrupted system call.
973 if (errno
== EINTR
) {
979 for (i
= 0; i
< nb_fd
; i
++) {
980 /* Fetch once the poll data */
981 revents
= LTTNG_POLL_GETEV(&events
, i
);
982 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
984 /* Thread quit pipe has been closed. Killing thread. */
985 ret
= check_thread_quit_pipe(pollfd
, revents
);
990 /* Event on the registration socket */
991 if (pollfd
== consumer_data
->err_sock
) {
992 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
993 ERR("consumer err socket poll error");
999 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1004 DBG2("Receiving code from consumer err_sock");
1006 /* Getting status code from kconsumerd */
1007 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1008 sizeof(enum lttcomm_return_code
));
1013 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1014 consumer_data
->cmd_sock
=
1015 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1016 if (consumer_data
->cmd_sock
< 0) {
1017 sem_post(&consumer_data
->sem
);
1018 PERROR("consumer connect");
1021 /* Signal condition to tell that the kconsumerd is ready */
1022 sem_post(&consumer_data
->sem
);
1023 DBG("consumer command socket ready");
1025 ERR("consumer error when waiting for SOCK_READY : %s",
1026 lttcomm_get_readable_code(-code
));
1030 /* Remove the kconsumerd error sock since we've established a connexion */
1031 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1036 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1041 /* Update number of fd */
1042 nb_fd
= LTTNG_POLL_GETNB(&events
);
1044 /* Inifinite blocking call, waiting for transmission */
1046 ret
= lttng_poll_wait(&events
, -1);
1049 * Restart interrupted system call.
1051 if (errno
== EINTR
) {
1057 for (i
= 0; i
< nb_fd
; i
++) {
1058 /* Fetch once the poll data */
1059 revents
= LTTNG_POLL_GETEV(&events
, i
);
1060 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1062 /* Thread quit pipe has been closed. Killing thread. */
1063 ret
= check_thread_quit_pipe(pollfd
, revents
);
1068 /* Event on the kconsumerd socket */
1069 if (pollfd
== sock
) {
1070 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1071 ERR("consumer err socket second poll error");
1077 /* Wait for any kconsumerd error */
1078 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1079 sizeof(enum lttcomm_return_code
));
1081 ERR("consumer closed the command socket");
1085 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1088 if (consumer_data
->err_sock
>= 0) {
1089 ret
= close(consumer_data
->err_sock
);
1094 if (consumer_data
->cmd_sock
>= 0) {
1095 ret
= close(consumer_data
->cmd_sock
);
1107 unlink(consumer_data
->err_unix_sock_path
);
1108 unlink(consumer_data
->cmd_unix_sock_path
);
1109 consumer_data
->pid
= 0;
1111 lttng_poll_clean(&events
);
1114 DBG("consumer thread cleanup completed");
1120 * This thread manage application communication.
1122 static void *thread_manage_apps(void *data
)
1125 uint32_t revents
, nb_fd
;
1126 struct ust_command ust_cmd
;
1127 struct lttng_poll_event events
;
1129 DBG("[thread] Manage application started");
1131 rcu_register_thread();
1132 rcu_thread_online();
1134 ret
= create_thread_poll_set(&events
, 2);
1136 goto error_poll_create
;
1139 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1145 /* Zeroed the events structure */
1146 lttng_poll_reset(&events
);
1148 nb_fd
= LTTNG_POLL_GETNB(&events
);
1150 DBG("Apps thread polling on %d fds", nb_fd
);
1152 /* Inifinite blocking call, waiting for transmission */
1154 ret
= lttng_poll_wait(&events
, -1);
1157 * Restart interrupted system call.
1159 if (errno
== EINTR
) {
1165 for (i
= 0; i
< nb_fd
; i
++) {
1166 /* Fetch once the poll data */
1167 revents
= LTTNG_POLL_GETEV(&events
, i
);
1168 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1170 /* Thread quit pipe has been closed. Killing thread. */
1171 ret
= check_thread_quit_pipe(pollfd
, revents
);
1176 /* Inspect the apps cmd pipe */
1177 if (pollfd
== apps_cmd_pipe
[0]) {
1178 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1179 ERR("Apps command pipe error");
1181 } else if (revents
& LPOLLIN
) {
1183 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1184 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1185 PERROR("read apps cmd pipe");
1189 /* Register applicaton to the session daemon */
1190 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1192 if (ret
== -ENOMEM
) {
1194 } else if (ret
< 0) {
1199 * Validate UST version compatibility.
1201 ret
= ust_app_validate_version(ust_cmd
.sock
);
1204 * Add channel(s) and event(s) to newly registered apps
1205 * from lttng global UST domain.
1207 update_ust_app(ust_cmd
.sock
);
1210 ret
= ust_app_register_done(ust_cmd
.sock
);
1213 * If the registration is not possible, we simply
1214 * unregister the apps and continue
1216 ust_app_unregister(ust_cmd
.sock
);
1219 * We just need here to monitor the close of the UST
1220 * socket and poll set monitor those by default.
1221 * Listen on POLLIN (even if we never expect any
1222 * data) to ensure that hangup wakes us.
1224 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1229 DBG("Apps with sock %d added to poll set",
1237 * At this point, we know that a registered application made
1238 * the event at poll_wait.
1240 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1241 /* Removing from the poll set */
1242 ret
= lttng_poll_del(&events
, pollfd
);
1247 /* Socket closed on remote end. */
1248 ust_app_unregister(pollfd
);
1256 lttng_poll_clean(&events
);
1258 DBG("Application communication apps thread cleanup complete");
1259 rcu_thread_offline();
1260 rcu_unregister_thread();
1265 * Dispatch request from the registration threads to the application
1266 * communication thread.
1268 static void *thread_dispatch_ust_registration(void *data
)
1271 struct cds_wfq_node
*node
;
1272 struct ust_command
*ust_cmd
= NULL
;
1274 DBG("[thread] Dispatch UST command started");
1276 while (!dispatch_thread_exit
) {
1277 /* Atomically prepare the queue futex */
1278 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1281 /* Dequeue command for registration */
1282 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1284 DBG("Woken up but nothing in the UST command queue");
1285 /* Continue thread execution */
1289 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1291 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1292 " gid:%d sock:%d name:%s (version %d.%d)",
1293 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1294 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1295 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1296 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1298 * Inform apps thread of the new application registration. This
1299 * call is blocking so we can be assured that the data will be read
1300 * at some point in time or wait to the end of the world :)
1302 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1303 sizeof(struct ust_command
));
1305 PERROR("write apps cmd pipe");
1306 if (errno
== EBADF
) {
1308 * We can't inform the application thread to process
1309 * registration. We will exit or else application
1310 * registration will not occur and tracing will never
1317 } while (node
!= NULL
);
1319 /* Futex wait on queue. Blocking call on futex() */
1320 futex_nto1_wait(&ust_cmd_queue
.futex
);
1324 DBG("Dispatch thread dying");
1329 * This thread manage application registration.
1331 static void *thread_registration_apps(void *data
)
1333 int sock
= -1, i
, ret
, pollfd
;
1334 uint32_t revents
, nb_fd
;
1335 struct lttng_poll_event events
;
1337 * Get allocated in this thread, enqueued to a global queue, dequeued and
1338 * freed in the manage apps thread.
1340 struct ust_command
*ust_cmd
= NULL
;
1342 DBG("[thread] Manage application registration started");
1344 ret
= lttcomm_listen_unix_sock(apps_sock
);
1350 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1351 * more will be added to this poll set.
1353 ret
= create_thread_poll_set(&events
, 2);
1355 goto error_create_poll
;
1358 /* Add the application registration socket */
1359 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1361 goto error_poll_add
;
1364 /* Notify all applications to register */
1365 ret
= notify_ust_apps(1);
1367 ERR("Failed to notify applications or create the wait shared memory.\n"
1368 "Execution continues but there might be problem for already\n"
1369 "running applications that wishes to register.");
1373 DBG("Accepting application registration");
1375 nb_fd
= LTTNG_POLL_GETNB(&events
);
1377 /* Inifinite blocking call, waiting for transmission */
1379 ret
= lttng_poll_wait(&events
, -1);
1382 * Restart interrupted system call.
1384 if (errno
== EINTR
) {
1390 for (i
= 0; i
< nb_fd
; i
++) {
1391 /* Fetch once the poll data */
1392 revents
= LTTNG_POLL_GETEV(&events
, i
);
1393 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1395 /* Thread quit pipe has been closed. Killing thread. */
1396 ret
= check_thread_quit_pipe(pollfd
, revents
);
1401 /* Event on the registration socket */
1402 if (pollfd
== apps_sock
) {
1403 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1404 ERR("Register apps socket poll error");
1406 } else if (revents
& LPOLLIN
) {
1407 sock
= lttcomm_accept_unix_sock(apps_sock
);
1412 /* Create UST registration command for enqueuing */
1413 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1414 if (ust_cmd
== NULL
) {
1415 PERROR("ust command zmalloc");
1420 * Using message-based transmissions to ensure we don't
1421 * have to deal with partially received messages.
1423 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1424 sizeof(struct ust_register_msg
));
1425 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1427 PERROR("lttcomm_recv_unix_sock register apps");
1429 ERR("Wrong size received on apps register");
1440 ust_cmd
->sock
= sock
;
1443 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1444 " gid:%d sock:%d name:%s (version %d.%d)",
1445 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1446 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1447 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1448 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1451 * Lock free enqueue the registration request. The red pill
1452 * has been taken! This apps will be part of the *system*.
1454 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1457 * Wake the registration queue futex. Implicit memory
1458 * barrier with the exchange in cds_wfq_enqueue.
1460 futex_nto1_wake(&ust_cmd_queue
.futex
);
1467 /* Notify that the registration thread is gone */
1470 if (apps_sock
>= 0) {
1471 ret
= close(apps_sock
);
1482 unlink(apps_unix_sock_path
);
1485 lttng_poll_clean(&events
);
1488 DBG("UST Registration thread cleanup complete");
1494 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1495 * exec or it will fails.
1497 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1500 struct timespec timeout
;
1502 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1503 timeout
.tv_nsec
= 0;
1505 /* Setup semaphore */
1506 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1508 PERROR("sem_init consumer semaphore");
1512 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1513 thread_manage_consumer
, consumer_data
);
1515 PERROR("pthread_create consumer");
1520 /* Get time for sem_timedwait absolute timeout */
1521 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1523 PERROR("clock_gettime spawn consumer");
1524 /* Infinite wait for the kconsumerd thread to be ready */
1525 ret
= sem_wait(&consumer_data
->sem
);
1527 /* Normal timeout if the gettime was successful */
1528 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1529 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1533 if (errno
== ETIMEDOUT
) {
1535 * Call has timed out so we kill the kconsumerd_thread and return
1538 ERR("The consumer thread was never ready. Killing it");
1539 ret
= pthread_cancel(consumer_data
->thread
);
1541 PERROR("pthread_cancel consumer thread");
1544 PERROR("semaphore wait failed consumer thread");
1549 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1550 if (consumer_data
->pid
== 0) {
1551 ERR("Kconsumerd did not start");
1552 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1555 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1564 * Join consumer thread
1566 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1571 if (consumer_data
->pid
!= 0) {
1572 ret
= kill(consumer_data
->pid
, SIGTERM
);
1574 ERR("Error killing consumer daemon");
1577 return pthread_join(consumer_data
->thread
, &status
);
1584 * Fork and exec a consumer daemon (consumerd).
1586 * Return pid if successful else -1.
1588 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1592 const char *consumer_to_use
;
1593 const char *verbosity
;
1596 DBG("Spawning consumerd");
1603 if (opt_verbose_consumer
) {
1604 verbosity
= "--verbose";
1606 verbosity
= "--quiet";
1608 switch (consumer_data
->type
) {
1609 case LTTNG_CONSUMER_KERNEL
:
1611 * Find out which consumerd to execute. We will first try the
1612 * 64-bit path, then the sessiond's installation directory, and
1613 * fallback on the 32-bit one,
1615 DBG3("Looking for a kernel consumer at these locations:");
1616 DBG3(" 1) %s", consumerd64_bin
);
1617 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1618 DBG3(" 3) %s", consumerd32_bin
);
1619 if (stat(consumerd64_bin
, &st
) == 0) {
1620 DBG3("Found location #1");
1621 consumer_to_use
= consumerd64_bin
;
1622 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1623 DBG3("Found location #2");
1624 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1625 } else if (stat(consumerd32_bin
, &st
) == 0) {
1626 DBG3("Found location #3");
1627 consumer_to_use
= consumerd32_bin
;
1629 DBG("Could not find any valid consumerd executable");
1632 DBG("Using kernel consumer at: %s", consumer_to_use
);
1633 execl(consumer_to_use
,
1634 "lttng-consumerd", verbosity
, "-k",
1635 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1636 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1639 case LTTNG_CONSUMER64_UST
:
1641 char *tmpnew
= NULL
;
1643 if (consumerd64_libdir
[0] != '\0') {
1647 tmp
= getenv("LD_LIBRARY_PATH");
1651 tmplen
= strlen("LD_LIBRARY_PATH=")
1652 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1653 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1658 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1659 strcat(tmpnew
, consumerd64_libdir
);
1660 if (tmp
[0] != '\0') {
1661 strcat(tmpnew
, ":");
1662 strcat(tmpnew
, tmp
);
1664 ret
= putenv(tmpnew
);
1670 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1671 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1672 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1673 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1675 if (consumerd64_libdir
[0] != '\0') {
1683 case LTTNG_CONSUMER32_UST
:
1685 char *tmpnew
= NULL
;
1687 if (consumerd32_libdir
[0] != '\0') {
1691 tmp
= getenv("LD_LIBRARY_PATH");
1695 tmplen
= strlen("LD_LIBRARY_PATH=")
1696 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1697 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1702 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1703 strcat(tmpnew
, consumerd32_libdir
);
1704 if (tmp
[0] != '\0') {
1705 strcat(tmpnew
, ":");
1706 strcat(tmpnew
, tmp
);
1708 ret
= putenv(tmpnew
);
1714 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1715 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1716 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1717 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1719 if (consumerd32_libdir
[0] != '\0') {
1728 PERROR("unknown consumer type");
1732 PERROR("kernel start consumer exec");
1735 } else if (pid
> 0) {
1738 PERROR("start consumer fork");
1746 * Spawn the consumerd daemon and session daemon thread.
1748 static int start_consumerd(struct consumer_data
*consumer_data
)
1752 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1753 if (consumer_data
->pid
!= 0) {
1754 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1758 ret
= spawn_consumerd(consumer_data
);
1760 ERR("Spawning consumerd failed");
1761 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1765 /* Setting up the consumer_data pid */
1766 consumer_data
->pid
= ret
;
1767 DBG2("Consumer pid %d", consumer_data
->pid
);
1768 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1770 DBG2("Spawning consumer control thread");
1771 ret
= spawn_consumer_thread(consumer_data
);
1773 ERR("Fatal error spawning consumer control thread");
1785 * Check version of the lttng-modules.
1787 static int validate_lttng_modules_version(void)
1789 return kernel_validate_version(kernel_tracer_fd
);
1793 * Setup necessary data for kernel tracer action.
1795 static int init_kernel_tracer(void)
1799 /* Modprobe lttng kernel modules */
1800 ret
= modprobe_lttng_control();
1805 /* Open debugfs lttng */
1806 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1807 if (kernel_tracer_fd
< 0) {
1808 DBG("Failed to open %s", module_proc_lttng
);
1813 /* Validate kernel version */
1814 ret
= validate_lttng_modules_version();
1819 ret
= modprobe_lttng_data();
1824 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1828 modprobe_remove_lttng_control();
1829 ret
= close(kernel_tracer_fd
);
1833 kernel_tracer_fd
= -1;
1834 return LTTCOMM_KERN_VERSION
;
1837 ret
= close(kernel_tracer_fd
);
1843 modprobe_remove_lttng_control();
1846 WARN("No kernel tracer available");
1847 kernel_tracer_fd
= -1;
1848 return LTTCOMM_KERN_NA
;
1852 * Init tracing by creating trace directory and sending fds kernel consumer.
1854 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1858 if (session
->consumer_fds_sent
== 0) {
1860 * Assign default kernel consumer socket if no consumer assigned to the
1861 * kernel session. At this point, it's NOT supposed to be -1 but this is
1862 * an extra security check.
1864 if (session
->consumer_fd
< 0) {
1865 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1868 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1870 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1874 session
->consumer_fds_sent
= 1;
1882 * Create an UST session and add it to the session ust list.
1884 static int create_ust_session(struct ltt_session
*session
,
1885 struct lttng_domain
*domain
)
1887 struct ltt_ust_session
*lus
= NULL
;
1890 switch (domain
->type
) {
1891 case LTTNG_DOMAIN_UST
:
1894 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1898 DBG("Creating UST session");
1900 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1902 ret
= LTTCOMM_UST_SESS_FAIL
;
1906 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1907 session
->uid
, session
->gid
);
1909 if (ret
!= -EEXIST
) {
1910 ERR("Trace directory creation error");
1911 ret
= LTTCOMM_UST_SESS_FAIL
;
1916 /* The domain type dictate different actions on session creation */
1917 switch (domain
->type
) {
1918 case LTTNG_DOMAIN_UST
:
1919 /* No ustctl for the global UST domain */
1922 ERR("Unknown UST domain on create session %d", domain
->type
);
1925 lus
->uid
= session
->uid
;
1926 lus
->gid
= session
->gid
;
1927 session
->ust_session
= lus
;
1937 * Create a kernel tracer session then create the default channel.
1939 static int create_kernel_session(struct ltt_session
*session
)
1943 DBG("Creating kernel session");
1945 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1947 ret
= LTTCOMM_KERN_SESS_FAIL
;
1951 /* Set kernel consumer socket fd */
1952 if (kconsumer_data
.cmd_sock
>= 0) {
1953 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1956 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1957 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1959 if (ret
!= -EEXIST
) {
1960 ERR("Trace directory creation error");
1964 session
->kernel_session
->uid
= session
->uid
;
1965 session
->kernel_session
->gid
= session
->gid
;
1972 * Check if the UID or GID match the session. Root user has access to all
1975 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1977 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1984 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1987 struct ltt_session
*session
;
1989 DBG("Counting number of available session for UID %d GID %d",
1991 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1993 * Only list the sessions the user can control.
1995 if (!session_access_ok(session
, uid
, gid
)) {
2004 * Using the session list, filled a lttng_session array to send back to the
2005 * client for session listing.
2007 * The session list lock MUST be acquired before calling this function. Use
2008 * session_lock_list() and session_unlock_list().
2010 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2014 struct ltt_session
*session
;
2016 DBG("Getting all available session for UID %d GID %d",
2019 * Iterate over session list and append data after the control struct in
2022 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2024 * Only list the sessions the user can control.
2026 if (!session_access_ok(session
, uid
, gid
)) {
2029 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2030 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2031 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2032 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2033 sessions
[i
].enabled
= session
->enabled
;
2039 * Fill lttng_channel array of all channels.
2041 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2042 struct lttng_channel
*channels
)
2045 struct ltt_kernel_channel
*kchan
;
2047 DBG("Listing channels for session %s", session
->name
);
2050 case LTTNG_DOMAIN_KERNEL
:
2051 /* Kernel channels */
2052 if (session
->kernel_session
!= NULL
) {
2053 cds_list_for_each_entry(kchan
,
2054 &session
->kernel_session
->channel_list
.head
, list
) {
2055 /* Copy lttng_channel struct to array */
2056 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2057 channels
[i
].enabled
= kchan
->enabled
;
2062 case LTTNG_DOMAIN_UST
:
2064 struct lttng_ht_iter iter
;
2065 struct ltt_ust_channel
*uchan
;
2067 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2068 &iter
.iter
, uchan
, node
.node
) {
2069 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2070 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2071 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2072 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2073 channels
[i
].attr
.switch_timer_interval
=
2074 uchan
->attr
.switch_timer_interval
;
2075 channels
[i
].attr
.read_timer_interval
=
2076 uchan
->attr
.read_timer_interval
;
2077 channels
[i
].enabled
= uchan
->enabled
;
2078 switch (uchan
->attr
.output
) {
2079 case LTTNG_UST_MMAP
:
2081 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2094 * Create a list of ust global domain events.
2096 static int list_lttng_ust_global_events(char *channel_name
,
2097 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2100 unsigned int nb_event
= 0;
2101 struct lttng_ht_iter iter
;
2102 struct lttng_ht_node_str
*node
;
2103 struct ltt_ust_channel
*uchan
;
2104 struct ltt_ust_event
*uevent
;
2105 struct lttng_event
*tmp
;
2107 DBG("Listing UST global events for channel %s", channel_name
);
2111 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2112 node
= lttng_ht_iter_get_node_str(&iter
);
2114 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2118 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2120 nb_event
+= lttng_ht_get_count(uchan
->events
);
2122 if (nb_event
== 0) {
2127 DBG3("Listing UST global %d events", nb_event
);
2129 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2131 ret
= -LTTCOMM_FATAL
;
2135 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2136 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2137 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2138 tmp
[i
].enabled
= uevent
->enabled
;
2139 switch (uevent
->attr
.instrumentation
) {
2140 case LTTNG_UST_TRACEPOINT
:
2141 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2143 case LTTNG_UST_PROBE
:
2144 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2146 case LTTNG_UST_FUNCTION
:
2147 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2150 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2151 switch (uevent
->attr
.loglevel_type
) {
2152 case LTTNG_UST_LOGLEVEL_ALL
:
2153 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2155 case LTTNG_UST_LOGLEVEL_RANGE
:
2156 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2158 case LTTNG_UST_LOGLEVEL_SINGLE
:
2159 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2174 * Fill lttng_event array of all kernel events in the channel.
2176 static int list_lttng_kernel_events(char *channel_name
,
2177 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2180 unsigned int nb_event
;
2181 struct ltt_kernel_event
*event
;
2182 struct ltt_kernel_channel
*kchan
;
2184 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2185 if (kchan
== NULL
) {
2186 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2190 nb_event
= kchan
->event_count
;
2192 DBG("Listing events for channel %s", kchan
->channel
->name
);
2194 if (nb_event
== 0) {
2199 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2200 if (*events
== NULL
) {
2201 ret
= LTTCOMM_FATAL
;
2205 /* Kernel channels */
2206 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2207 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2208 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2209 (*events
)[i
].enabled
= event
->enabled
;
2210 switch (event
->event
->instrumentation
) {
2211 case LTTNG_KERNEL_TRACEPOINT
:
2212 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2214 case LTTNG_KERNEL_KPROBE
:
2215 case LTTNG_KERNEL_KRETPROBE
:
2216 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2217 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2218 sizeof(struct lttng_kernel_kprobe
));
2220 case LTTNG_KERNEL_FUNCTION
:
2221 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2222 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2223 sizeof(struct lttng_kernel_function
));
2225 case LTTNG_KERNEL_NOOP
:
2226 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2228 case LTTNG_KERNEL_SYSCALL
:
2229 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2231 case LTTNG_KERNEL_ALL
:
2245 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2247 static int cmd_disable_channel(struct ltt_session
*session
,
2248 int domain
, char *channel_name
)
2251 struct ltt_ust_session
*usess
;
2253 usess
= session
->ust_session
;
2256 case LTTNG_DOMAIN_KERNEL
:
2258 ret
= channel_kernel_disable(session
->kernel_session
,
2260 if (ret
!= LTTCOMM_OK
) {
2264 kernel_wait_quiescent(kernel_tracer_fd
);
2267 case LTTNG_DOMAIN_UST
:
2269 struct ltt_ust_channel
*uchan
;
2270 struct lttng_ht
*chan_ht
;
2272 chan_ht
= usess
->domain_global
.channels
;
2274 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2275 if (uchan
== NULL
) {
2276 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2280 ret
= channel_ust_disable(usess
, domain
, uchan
);
2281 if (ret
!= LTTCOMM_OK
) {
2287 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2288 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2289 case LTTNG_DOMAIN_UST_PID
:
2292 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2303 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2305 static int cmd_enable_channel(struct ltt_session
*session
,
2306 int domain
, struct lttng_channel
*attr
)
2309 struct ltt_ust_session
*usess
= session
->ust_session
;
2310 struct lttng_ht
*chan_ht
;
2312 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2315 case LTTNG_DOMAIN_KERNEL
:
2317 struct ltt_kernel_channel
*kchan
;
2319 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2320 session
->kernel_session
);
2321 if (kchan
== NULL
) {
2322 ret
= channel_kernel_create(session
->kernel_session
,
2323 attr
, kernel_poll_pipe
[1]);
2325 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2328 if (ret
!= LTTCOMM_OK
) {
2332 kernel_wait_quiescent(kernel_tracer_fd
);
2335 case LTTNG_DOMAIN_UST
:
2337 struct ltt_ust_channel
*uchan
;
2339 chan_ht
= usess
->domain_global
.channels
;
2341 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2342 if (uchan
== NULL
) {
2343 ret
= channel_ust_create(usess
, domain
, attr
);
2345 ret
= channel_ust_enable(usess
, domain
, uchan
);
2350 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2351 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2352 case LTTNG_DOMAIN_UST_PID
:
2355 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2364 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2366 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2367 char *channel_name
, char *event_name
)
2372 case LTTNG_DOMAIN_KERNEL
:
2374 struct ltt_kernel_channel
*kchan
;
2375 struct ltt_kernel_session
*ksess
;
2377 ksess
= session
->kernel_session
;
2379 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2380 if (kchan
== NULL
) {
2381 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2385 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2386 if (ret
!= LTTCOMM_OK
) {
2390 kernel_wait_quiescent(kernel_tracer_fd
);
2393 case LTTNG_DOMAIN_UST
:
2395 struct ltt_ust_channel
*uchan
;
2396 struct ltt_ust_session
*usess
;
2398 usess
= session
->ust_session
;
2400 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2402 if (uchan
== NULL
) {
2403 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2407 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2408 if (ret
!= LTTCOMM_OK
) {
2412 DBG3("Disable UST event %s in channel %s completed", event_name
,
2417 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2418 case LTTNG_DOMAIN_UST_PID
:
2419 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2433 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2435 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2441 case LTTNG_DOMAIN_KERNEL
:
2443 struct ltt_kernel_session
*ksess
;
2444 struct ltt_kernel_channel
*kchan
;
2446 ksess
= session
->kernel_session
;
2448 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2449 if (kchan
== NULL
) {
2450 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2454 ret
= event_kernel_disable_all(ksess
, kchan
);
2455 if (ret
!= LTTCOMM_OK
) {
2459 kernel_wait_quiescent(kernel_tracer_fd
);
2462 case LTTNG_DOMAIN_UST
:
2464 struct ltt_ust_session
*usess
;
2465 struct ltt_ust_channel
*uchan
;
2467 usess
= session
->ust_session
;
2469 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2471 if (uchan
== NULL
) {
2472 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2476 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2481 DBG3("Disable all UST events in channel %s completed", channel_name
);
2486 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2487 case LTTNG_DOMAIN_UST_PID
:
2488 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2502 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2504 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2505 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2510 case LTTNG_DOMAIN_KERNEL
:
2511 /* Add kernel context to kernel tracer */
2512 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2513 event_name
, channel_name
);
2514 if (ret
!= LTTCOMM_OK
) {
2518 case LTTNG_DOMAIN_UST
:
2520 struct ltt_ust_session
*usess
= session
->ust_session
;
2522 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2523 if (ret
!= LTTCOMM_OK
) {
2529 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2530 case LTTNG_DOMAIN_UST_PID
:
2531 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2545 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2547 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2548 char *channel_name
, struct lttng_event
*event
)
2551 struct lttng_channel
*attr
;
2552 struct ltt_ust_session
*usess
= session
->ust_session
;
2555 case LTTNG_DOMAIN_KERNEL
:
2557 struct ltt_kernel_channel
*kchan
;
2559 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2560 session
->kernel_session
);
2561 if (kchan
== NULL
) {
2562 attr
= channel_new_default_attr(domain
);
2564 ret
= LTTCOMM_FATAL
;
2567 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2569 /* This call will notify the kernel thread */
2570 ret
= channel_kernel_create(session
->kernel_session
,
2571 attr
, kernel_poll_pipe
[1]);
2572 if (ret
!= LTTCOMM_OK
) {
2579 /* Get the newly created kernel channel pointer */
2580 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2581 session
->kernel_session
);
2582 if (kchan
== NULL
) {
2583 /* This sould not happen... */
2584 ret
= LTTCOMM_FATAL
;
2588 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2590 if (ret
!= LTTCOMM_OK
) {
2594 kernel_wait_quiescent(kernel_tracer_fd
);
2597 case LTTNG_DOMAIN_UST
:
2599 struct lttng_channel
*attr
;
2600 struct ltt_ust_channel
*uchan
;
2602 /* Get channel from global UST domain */
2603 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2605 if (uchan
== NULL
) {
2606 /* Create default channel */
2607 attr
= channel_new_default_attr(domain
);
2609 ret
= LTTCOMM_FATAL
;
2612 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2613 attr
->name
[NAME_MAX
- 1] = '\0';
2615 ret
= channel_ust_create(usess
, domain
, attr
);
2616 if (ret
!= LTTCOMM_OK
) {
2622 /* Get the newly created channel reference back */
2623 uchan
= trace_ust_find_channel_by_name(
2624 usess
->domain_global
.channels
, channel_name
);
2625 if (uchan
== NULL
) {
2626 /* Something is really wrong */
2627 ret
= LTTCOMM_FATAL
;
2632 /* At this point, the session and channel exist on the tracer */
2633 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2634 if (ret
!= LTTCOMM_OK
) {
2640 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2641 case LTTNG_DOMAIN_UST_PID
:
2642 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2656 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2658 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2659 char *channel_name
, int event_type
)
2662 struct ltt_kernel_channel
*kchan
;
2665 case LTTNG_DOMAIN_KERNEL
:
2666 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2667 session
->kernel_session
);
2668 if (kchan
== NULL
) {
2669 /* This call will notify the kernel thread */
2670 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2671 kernel_poll_pipe
[1]);
2672 if (ret
!= LTTCOMM_OK
) {
2676 /* Get the newly created kernel channel pointer */
2677 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2678 session
->kernel_session
);
2679 if (kchan
== NULL
) {
2680 /* This sould not happen... */
2681 ret
= LTTCOMM_FATAL
;
2687 switch (event_type
) {
2688 case LTTNG_EVENT_SYSCALL
:
2689 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2690 kchan
, kernel_tracer_fd
);
2692 case LTTNG_EVENT_TRACEPOINT
:
2694 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2695 * events already registered to the channel.
2697 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2698 kchan
, kernel_tracer_fd
);
2700 case LTTNG_EVENT_ALL
:
2701 /* Enable syscalls and tracepoints */
2702 ret
= event_kernel_enable_all(session
->kernel_session
,
2703 kchan
, kernel_tracer_fd
);
2706 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2710 /* Manage return value */
2711 if (ret
!= LTTCOMM_OK
) {
2715 kernel_wait_quiescent(kernel_tracer_fd
);
2717 case LTTNG_DOMAIN_UST
:
2719 struct lttng_channel
*attr
;
2720 struct ltt_ust_channel
*uchan
;
2721 struct ltt_ust_session
*usess
= session
->ust_session
;
2723 /* Get channel from global UST domain */
2724 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2726 if (uchan
== NULL
) {
2727 /* Create default channel */
2728 attr
= channel_new_default_attr(domain
);
2730 ret
= LTTCOMM_FATAL
;
2733 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2734 attr
->name
[NAME_MAX
- 1] = '\0';
2736 /* Use the internal command enable channel */
2737 ret
= channel_ust_create(usess
, domain
, attr
);
2738 if (ret
!= LTTCOMM_OK
) {
2744 /* Get the newly created channel reference back */
2745 uchan
= trace_ust_find_channel_by_name(
2746 usess
->domain_global
.channels
, channel_name
);
2747 if (uchan
== NULL
) {
2748 /* Something is really wrong */
2749 ret
= LTTCOMM_FATAL
;
2754 /* At this point, the session and channel exist on the tracer */
2756 switch (event_type
) {
2757 case LTTNG_EVENT_ALL
:
2758 case LTTNG_EVENT_TRACEPOINT
:
2759 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2760 if (ret
!= LTTCOMM_OK
) {
2765 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2769 /* Manage return value */
2770 if (ret
!= LTTCOMM_OK
) {
2777 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2778 case LTTNG_DOMAIN_UST_PID
:
2779 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2793 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2795 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2798 ssize_t nb_events
= 0;
2801 case LTTNG_DOMAIN_KERNEL
:
2802 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2803 if (nb_events
< 0) {
2804 ret
= LTTCOMM_KERN_LIST_FAIL
;
2808 case LTTNG_DOMAIN_UST
:
2809 nb_events
= ust_app_list_events(events
);
2810 if (nb_events
< 0) {
2811 ret
= LTTCOMM_UST_LIST_FAIL
;
2823 /* Return negative value to differentiate return code */
2828 * Command LTTNG_START_TRACE processed by the client thread.
2830 static int cmd_start_trace(struct ltt_session
*session
)
2833 struct ltt_kernel_session
*ksession
;
2834 struct ltt_ust_session
*usess
;
2837 ksession
= session
->kernel_session
;
2838 usess
= session
->ust_session
;
2840 if (session
->enabled
) {
2841 ret
= LTTCOMM_UST_START_FAIL
;
2845 session
->enabled
= 1;
2847 /* Kernel tracing */
2848 if (ksession
!= NULL
) {
2849 struct ltt_kernel_channel
*kchan
;
2851 /* Open kernel metadata */
2852 if (ksession
->metadata
== NULL
) {
2853 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2855 ret
= LTTCOMM_KERN_META_FAIL
;
2860 /* Open kernel metadata stream */
2861 if (ksession
->metadata_stream_fd
< 0) {
2862 ret
= kernel_open_metadata_stream(ksession
);
2864 ERR("Kernel create metadata stream failed");
2865 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2870 /* For each channel */
2871 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2872 if (kchan
->stream_count
== 0) {
2873 ret
= kernel_open_channel_stream(kchan
);
2875 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2878 /* Update the stream global counter */
2879 ksession
->stream_count_global
+= ret
;
2883 /* Setup kernel consumer socket and send fds to it */
2884 ret
= init_kernel_tracing(ksession
);
2886 ret
= LTTCOMM_KERN_START_FAIL
;
2890 /* This start the kernel tracing */
2891 ret
= kernel_start_session(ksession
);
2893 ret
= LTTCOMM_KERN_START_FAIL
;
2897 /* Quiescent wait after starting trace */
2898 kernel_wait_quiescent(kernel_tracer_fd
);
2901 /* Flag session that trace should start automatically */
2903 usess
->start_trace
= 1;
2905 ret
= ust_app_start_trace_all(usess
);
2907 ret
= LTTCOMM_UST_START_FAIL
;
2919 * Command LTTNG_STOP_TRACE processed by the client thread.
2921 static int cmd_stop_trace(struct ltt_session
*session
)
2924 struct ltt_kernel_channel
*kchan
;
2925 struct ltt_kernel_session
*ksession
;
2926 struct ltt_ust_session
*usess
;
2929 ksession
= session
->kernel_session
;
2930 usess
= session
->ust_session
;
2932 if (!session
->enabled
) {
2933 ret
= LTTCOMM_UST_STOP_FAIL
;
2937 session
->enabled
= 0;
2940 if (ksession
!= NULL
) {
2941 DBG("Stop kernel tracing");
2943 /* Flush all buffers before stopping */
2944 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2946 ERR("Kernel metadata flush failed");
2949 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2950 ret
= kernel_flush_buffer(kchan
);
2952 ERR("Kernel flush buffer error");
2956 ret
= kernel_stop_session(ksession
);
2958 ret
= LTTCOMM_KERN_STOP_FAIL
;
2962 kernel_wait_quiescent(kernel_tracer_fd
);
2966 usess
->start_trace
= 0;
2968 ret
= ust_app_stop_trace_all(usess
);
2970 ret
= LTTCOMM_UST_STOP_FAIL
;
2982 * Command LTTNG_CREATE_SESSION processed by the client thread.
2984 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2988 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2989 if (ret
!= LTTCOMM_OK
) {
3000 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3002 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3006 /* Clean kernel session teardown */
3007 teardown_kernel_session(session
);
3008 /* UST session teardown */
3009 teardown_ust_session(session
);
3012 * Must notify the kernel thread here to update it's poll setin order
3013 * to remove the channel(s)' fd just destroyed.
3015 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3017 PERROR("write kernel poll pipe");
3020 ret
= session_destroy(session
);
3026 * Command LTTNG_CALIBRATE processed by the client thread.
3028 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3033 case LTTNG_DOMAIN_KERNEL
:
3035 struct lttng_kernel_calibrate kcalibrate
;
3037 kcalibrate
.type
= calibrate
->type
;
3038 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3040 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3045 case LTTNG_DOMAIN_UST
:
3047 struct lttng_ust_calibrate ucalibrate
;
3049 ucalibrate
.type
= calibrate
->type
;
3050 ret
= ust_app_calibrate_glb(&ucalibrate
);
3052 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3069 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3071 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3077 case LTTNG_DOMAIN_KERNEL
:
3078 /* Can't register a consumer if there is already one */
3079 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3080 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3084 sock
= lttcomm_connect_unix_sock(sock_path
);
3086 ret
= LTTCOMM_CONNECT_FAIL
;
3090 session
->kernel_session
->consumer_fd
= sock
;
3093 /* TODO: Userspace tracing */
3105 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3107 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3108 struct lttng_domain
**domains
)
3113 if (session
->kernel_session
!= NULL
) {
3114 DBG3("Listing domains found kernel domain");
3118 if (session
->ust_session
!= NULL
) {
3119 DBG3("Listing domains found UST global domain");
3123 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3124 if (*domains
== NULL
) {
3125 ret
= -LTTCOMM_FATAL
;
3129 if (session
->kernel_session
!= NULL
) {
3130 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3134 if (session
->ust_session
!= NULL
) {
3135 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3146 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3148 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3149 struct lttng_channel
**channels
)
3152 ssize_t nb_chan
= 0;
3155 case LTTNG_DOMAIN_KERNEL
:
3156 if (session
->kernel_session
!= NULL
) {
3157 nb_chan
= session
->kernel_session
->channel_count
;
3159 DBG3("Number of kernel channels %zd", nb_chan
);
3161 case LTTNG_DOMAIN_UST
:
3162 if (session
->ust_session
!= NULL
) {
3163 nb_chan
= lttng_ht_get_count(
3164 session
->ust_session
->domain_global
.channels
);
3166 DBG3("Number of UST global channels %zd", nb_chan
);
3175 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3176 if (*channels
== NULL
) {
3177 ret
= -LTTCOMM_FATAL
;
3181 list_lttng_channels(domain
, session
, *channels
);
3193 * Command LTTNG_LIST_EVENTS processed by the client thread.
3195 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3196 char *channel_name
, struct lttng_event
**events
)
3199 ssize_t nb_event
= 0;
3202 case LTTNG_DOMAIN_KERNEL
:
3203 if (session
->kernel_session
!= NULL
) {
3204 nb_event
= list_lttng_kernel_events(channel_name
,
3205 session
->kernel_session
, events
);
3208 case LTTNG_DOMAIN_UST
:
3210 if (session
->ust_session
!= NULL
) {
3211 nb_event
= list_lttng_ust_global_events(channel_name
,
3212 &session
->ust_session
->domain_global
, events
);
3228 * Process the command requested by the lttng client within the command
3229 * context structure. This function make sure that the return structure (llm)
3230 * is set and ready for transmission before returning.
3232 * Return any error encountered or 0 for success.
3234 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3236 int ret
= LTTCOMM_OK
;
3237 int need_tracing_session
= 1;
3240 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3242 switch (cmd_ctx
->lsm
->cmd_type
) {
3243 case LTTNG_CREATE_SESSION
:
3244 case LTTNG_DESTROY_SESSION
:
3245 case LTTNG_LIST_SESSIONS
:
3246 case LTTNG_LIST_DOMAINS
:
3247 case LTTNG_START_TRACE
:
3248 case LTTNG_STOP_TRACE
:
3255 if (opt_no_kernel
&& need_domain
3256 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3257 ret
= LTTCOMM_KERN_NA
;
3262 * Check for command that don't needs to allocate a returned payload. We do
3263 * this here so we don't have to make the call for no payload at each
3266 switch(cmd_ctx
->lsm
->cmd_type
) {
3267 case LTTNG_LIST_SESSIONS
:
3268 case LTTNG_LIST_TRACEPOINTS
:
3269 case LTTNG_LIST_DOMAINS
:
3270 case LTTNG_LIST_CHANNELS
:
3271 case LTTNG_LIST_EVENTS
:
3274 /* Setup lttng message with no payload */
3275 ret
= setup_lttng_msg(cmd_ctx
, 0);
3277 /* This label does not try to unlock the session */
3278 goto init_setup_error
;
3282 /* Commands that DO NOT need a session. */
3283 switch (cmd_ctx
->lsm
->cmd_type
) {
3284 case LTTNG_CREATE_SESSION
:
3285 case LTTNG_CALIBRATE
:
3286 case LTTNG_LIST_SESSIONS
:
3287 case LTTNG_LIST_TRACEPOINTS
:
3288 need_tracing_session
= 0;
3291 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3292 session_lock_list();
3293 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3294 session_unlock_list();
3295 if (cmd_ctx
->session
== NULL
) {
3296 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3297 ret
= LTTCOMM_SESS_NOT_FOUND
;
3299 /* If no session name specified */
3300 ret
= LTTCOMM_SELECT_SESS
;
3304 /* Acquire lock for the session */
3305 session_lock(cmd_ctx
->session
);
3314 * Check domain type for specific "pre-action".
3316 switch (cmd_ctx
->lsm
->domain
.type
) {
3317 case LTTNG_DOMAIN_KERNEL
:
3319 ret
= LTTCOMM_KERN_NA
;
3323 /* Kernel tracer check */
3324 if (kernel_tracer_fd
== -1) {
3325 /* Basically, load kernel tracer modules */
3326 ret
= init_kernel_tracer();
3332 /* Need a session for kernel command */
3333 if (need_tracing_session
) {
3334 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3335 ret
= create_kernel_session(cmd_ctx
->session
);
3337 ret
= LTTCOMM_KERN_SESS_FAIL
;
3342 /* Start the kernel consumer daemon */
3343 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3344 if (kconsumer_data
.pid
== 0 &&
3345 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3346 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3347 ret
= start_consumerd(&kconsumer_data
);
3349 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3353 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3357 case LTTNG_DOMAIN_UST
:
3359 if (need_tracing_session
) {
3360 if (cmd_ctx
->session
->ust_session
== NULL
) {
3361 ret
= create_ust_session(cmd_ctx
->session
,
3362 &cmd_ctx
->lsm
->domain
);
3363 if (ret
!= LTTCOMM_OK
) {
3367 /* Start the UST consumer daemons */
3369 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3370 if (consumerd64_bin
[0] != '\0' &&
3371 ustconsumer64_data
.pid
== 0 &&
3372 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3373 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3374 ret
= start_consumerd(&ustconsumer64_data
);
3376 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3377 ust_consumerd64_fd
= -EINVAL
;
3381 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3383 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3386 if (consumerd32_bin
[0] != '\0' &&
3387 ustconsumer32_data
.pid
== 0 &&
3388 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3389 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3390 ret
= start_consumerd(&ustconsumer32_data
);
3392 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3393 ust_consumerd32_fd
= -EINVAL
;
3396 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3398 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3409 * Check that the UID or GID match that of the tracing session.
3410 * The root user can interact with all sessions.
3412 if (need_tracing_session
) {
3413 if (!session_access_ok(cmd_ctx
->session
,
3414 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3415 ret
= LTTCOMM_EPERM
;
3420 /* Process by command type */
3421 switch (cmd_ctx
->lsm
->cmd_type
) {
3422 case LTTNG_ADD_CONTEXT
:
3424 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3425 cmd_ctx
->lsm
->u
.context
.channel_name
,
3426 cmd_ctx
->lsm
->u
.context
.event_name
,
3427 &cmd_ctx
->lsm
->u
.context
.ctx
);
3430 case LTTNG_DISABLE_CHANNEL
:
3432 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3433 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3436 case LTTNG_DISABLE_EVENT
:
3438 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3439 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3440 cmd_ctx
->lsm
->u
.disable
.name
);
3443 case LTTNG_DISABLE_ALL_EVENT
:
3445 DBG("Disabling all events");
3447 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3448 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3451 case LTTNG_ENABLE_CHANNEL
:
3453 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3454 &cmd_ctx
->lsm
->u
.channel
.chan
);
3457 case LTTNG_ENABLE_EVENT
:
3459 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3460 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3461 &cmd_ctx
->lsm
->u
.enable
.event
);
3464 case LTTNG_ENABLE_ALL_EVENT
:
3466 DBG("Enabling all events");
3468 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3469 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3470 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3473 case LTTNG_LIST_TRACEPOINTS
:
3475 struct lttng_event
*events
;
3478 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3479 if (nb_events
< 0) {
3485 * Setup lttng message with payload size set to the event list size in
3486 * bytes and then copy list into the llm payload.
3488 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3494 /* Copy event list into message payload */
3495 memcpy(cmd_ctx
->llm
->payload
, events
,
3496 sizeof(struct lttng_event
) * nb_events
);
3503 case LTTNG_START_TRACE
:
3505 ret
= cmd_start_trace(cmd_ctx
->session
);
3508 case LTTNG_STOP_TRACE
:
3510 ret
= cmd_stop_trace(cmd_ctx
->session
);
3513 case LTTNG_CREATE_SESSION
:
3515 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3516 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3519 case LTTNG_DESTROY_SESSION
:
3521 ret
= cmd_destroy_session(cmd_ctx
->session
,
3522 cmd_ctx
->lsm
->session
.name
);
3525 case LTTNG_LIST_DOMAINS
:
3528 struct lttng_domain
*domains
;
3530 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3536 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3541 /* Copy event list into message payload */
3542 memcpy(cmd_ctx
->llm
->payload
, domains
,
3543 nb_dom
* sizeof(struct lttng_domain
));
3550 case LTTNG_LIST_CHANNELS
:
3553 struct lttng_channel
*channels
;
3555 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3556 cmd_ctx
->session
, &channels
);
3562 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3567 /* Copy event list into message payload */
3568 memcpy(cmd_ctx
->llm
->payload
, channels
,
3569 nb_chan
* sizeof(struct lttng_channel
));
3576 case LTTNG_LIST_EVENTS
:
3579 struct lttng_event
*events
= NULL
;
3581 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3582 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3588 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3593 /* Copy event list into message payload */
3594 memcpy(cmd_ctx
->llm
->payload
, events
,
3595 nb_event
* sizeof(struct lttng_event
));
3602 case LTTNG_LIST_SESSIONS
:
3604 unsigned int nr_sessions
;
3606 session_lock_list();
3607 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3609 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3611 session_unlock_list();
3615 /* Filled the session array */
3616 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3617 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3619 session_unlock_list();
3624 case LTTNG_CALIBRATE
:
3626 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3627 &cmd_ctx
->lsm
->u
.calibrate
);
3630 case LTTNG_REGISTER_CONSUMER
:
3632 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3633 cmd_ctx
->lsm
->u
.reg
.path
);
3642 if (cmd_ctx
->llm
== NULL
) {
3643 DBG("Missing llm structure. Allocating one.");
3644 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3648 /* Set return code */
3649 cmd_ctx
->llm
->ret_code
= ret
;
3651 if (cmd_ctx
->session
) {
3652 session_unlock(cmd_ctx
->session
);
3659 * This thread manage all clients request using the unix client socket for
3662 static void *thread_manage_clients(void *data
)
3664 int sock
= -1, ret
, i
, pollfd
;
3665 uint32_t revents
, nb_fd
;
3666 struct command_ctx
*cmd_ctx
= NULL
;
3667 struct lttng_poll_event events
;
3669 DBG("[thread] Manage client started");
3671 rcu_register_thread();
3673 ret
= lttcomm_listen_unix_sock(client_sock
);
3679 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3680 * more will be added to this poll set.
3682 ret
= create_thread_poll_set(&events
, 2);
3687 /* Add the application registration socket */
3688 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3694 * Notify parent pid that we are ready to accept command for client side.
3696 if (opt_sig_parent
) {
3697 kill(ppid
, SIGUSR1
);
3701 DBG("Accepting client command ...");
3703 nb_fd
= LTTNG_POLL_GETNB(&events
);
3705 /* Inifinite blocking call, waiting for transmission */
3707 ret
= lttng_poll_wait(&events
, -1);
3710 * Restart interrupted system call.
3712 if (errno
== EINTR
) {
3718 for (i
= 0; i
< nb_fd
; i
++) {
3719 /* Fetch once the poll data */
3720 revents
= LTTNG_POLL_GETEV(&events
, i
);
3721 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3723 /* Thread quit pipe has been closed. Killing thread. */
3724 ret
= check_thread_quit_pipe(pollfd
, revents
);
3729 /* Event on the registration socket */
3730 if (pollfd
== client_sock
) {
3731 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3732 ERR("Client socket poll error");
3738 DBG("Wait for client response");
3740 sock
= lttcomm_accept_unix_sock(client_sock
);
3745 /* Set socket option for credentials retrieval */
3746 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3751 /* Allocate context command to process the client request */
3752 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3753 if (cmd_ctx
== NULL
) {
3754 PERROR("zmalloc cmd_ctx");
3758 /* Allocate data buffer for reception */
3759 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3760 if (cmd_ctx
->lsm
== NULL
) {
3761 PERROR("zmalloc cmd_ctx->lsm");
3765 cmd_ctx
->llm
= NULL
;
3766 cmd_ctx
->session
= NULL
;
3769 * Data is received from the lttng client. The struct
3770 * lttcomm_session_msg (lsm) contains the command and data request of
3773 DBG("Receiving data from client ...");
3774 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3775 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3777 DBG("Nothing recv() from client... continuing");
3787 // TODO: Validate cmd_ctx including sanity check for
3788 // security purpose.
3790 rcu_thread_online();
3792 * This function dispatch the work to the kernel or userspace tracer
3793 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3794 * informations for the client. The command context struct contains
3795 * everything this function may needs.
3797 ret
= process_client_msg(cmd_ctx
);
3798 rcu_thread_offline();
3801 * TODO: Inform client somehow of the fatal error. At
3802 * this point, ret < 0 means that a zmalloc failed
3803 * (ENOMEM). Error detected but still accept command.
3805 clean_command_ctx(&cmd_ctx
);
3809 DBG("Sending response (size: %d, retcode: %s)",
3810 cmd_ctx
->lttng_msg_size
,
3811 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3812 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3814 ERR("Failed to send data back to client");
3817 /* End of transmission */
3824 clean_command_ctx(&cmd_ctx
);
3828 DBG("Client thread dying");
3829 unlink(client_unix_sock_path
);
3830 if (client_sock
>= 0) {
3831 ret
= close(client_sock
);
3843 lttng_poll_clean(&events
);
3844 clean_command_ctx(&cmd_ctx
);
3846 rcu_unregister_thread();
3852 * usage function on stderr
3854 static void usage(void)
3856 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3857 fprintf(stderr
, " -h, --help Display this usage.\n");
3858 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3859 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3860 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3861 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3862 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3863 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3864 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3865 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3866 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3867 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3868 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3869 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3870 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3871 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3872 fprintf(stderr
, " -V, --version Show version number.\n");
3873 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3874 fprintf(stderr
, " -q, --quiet No output at all.\n");
3875 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3876 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3877 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3881 * daemon argument parsing
3883 static int parse_args(int argc
, char **argv
)
3887 static struct option long_options
[] = {
3888 { "client-sock", 1, 0, 'c' },
3889 { "apps-sock", 1, 0, 'a' },
3890 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3891 { "kconsumerd-err-sock", 1, 0, 'E' },
3892 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3893 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3894 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3895 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3896 { "consumerd32-path", 1, 0, 'u' },
3897 { "consumerd32-libdir", 1, 0, 'U' },
3898 { "consumerd64-path", 1, 0, 't' },
3899 { "consumerd64-libdir", 1, 0, 'T' },
3900 { "daemonize", 0, 0, 'd' },
3901 { "sig-parent", 0, 0, 'S' },
3902 { "help", 0, 0, 'h' },
3903 { "group", 1, 0, 'g' },
3904 { "version", 0, 0, 'V' },
3905 { "quiet", 0, 0, 'q' },
3906 { "verbose", 0, 0, 'v' },
3907 { "verbose-consumer", 0, 0, 'Z' },
3908 { "no-kernel", 0, 0, 'N' },
3913 int option_index
= 0;
3914 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3915 long_options
, &option_index
);
3922 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3924 fprintf(stderr
, " with arg %s\n", optarg
);
3928 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3931 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3937 opt_tracing_group
= optarg
;
3943 fprintf(stdout
, "%s\n", VERSION
);
3949 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3952 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3955 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3958 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3961 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3964 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3973 /* Verbose level can increase using multiple -v */
3977 opt_verbose_consumer
+= 1;
3980 consumerd32_bin
= optarg
;
3983 consumerd32_libdir
= optarg
;
3986 consumerd64_bin
= optarg
;
3989 consumerd64_libdir
= optarg
;
3992 /* Unknown option or other error.
3993 * Error is printed by getopt, just return */
4002 * Creates the two needed socket by the daemon.
4003 * apps_sock - The communication socket for all UST apps.
4004 * client_sock - The communication of the cli tool (lttng).
4006 static int init_daemon_socket(void)
4011 old_umask
= umask(0);
4013 /* Create client tool unix socket */
4014 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4015 if (client_sock
< 0) {
4016 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4021 /* File permission MUST be 660 */
4022 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4024 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4029 /* Create the application unix socket */
4030 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4031 if (apps_sock
< 0) {
4032 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4037 /* File permission MUST be 666 */
4038 ret
= chmod(apps_unix_sock_path
,
4039 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4041 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4052 * Check if the global socket is available, and if a daemon is answering at the
4053 * other side. If yes, error is returned.
4055 static int check_existing_daemon(void)
4057 /* Is there anybody out there ? */
4058 if (lttng_session_daemon_alive()) {
4066 * Set the tracing group gid onto the client socket.
4068 * Race window between mkdir and chown is OK because we are going from more
4069 * permissive (root.root) to less permissive (root.tracing).
4071 static int set_permissions(char *rundir
)
4076 gid
= allowed_group();
4078 WARN("No tracing group detected");
4083 /* Set lttng run dir */
4084 ret
= chown(rundir
, 0, gid
);
4086 ERR("Unable to set group on %s", rundir
);
4090 /* Ensure tracing group can search the run dir */
4091 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4093 ERR("Unable to set permissions on %s", rundir
);
4097 /* lttng client socket path */
4098 ret
= chown(client_unix_sock_path
, 0, gid
);
4100 ERR("Unable to set group on %s", client_unix_sock_path
);
4104 /* kconsumer error socket path */
4105 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4107 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4111 /* 64-bit ustconsumer error socket path */
4112 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4114 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4118 /* 32-bit ustconsumer compat32 error socket path */
4119 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4121 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4125 DBG("All permissions are set");
4132 * Create the pipe used to wake up the kernel thread.
4133 * Closed in cleanup().
4135 static int create_kernel_poll_pipe(void)
4137 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4141 * Create the application command pipe to wake thread_manage_apps.
4142 * Closed in cleanup().
4144 static int create_apps_cmd_pipe(void)
4146 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4150 * Create the lttng run directory needed for all global sockets and pipe.
4152 static int create_lttng_rundir(const char *rundir
)
4156 DBG3("Creating LTTng run directory: %s", rundir
);
4158 ret
= mkdir(rundir
, S_IRWXU
);
4160 if (errno
!= EEXIST
) {
4161 ERR("Unable to create %s", rundir
);
4173 * Setup sockets and directory needed by the kconsumerd communication with the
4176 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4180 char path
[PATH_MAX
];
4182 switch (consumer_data
->type
) {
4183 case LTTNG_CONSUMER_KERNEL
:
4184 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4186 case LTTNG_CONSUMER64_UST
:
4187 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4189 case LTTNG_CONSUMER32_UST
:
4190 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4193 ERR("Consumer type unknown");
4198 DBG2("Creating consumer directory: %s", path
);
4200 ret
= mkdir(path
, S_IRWXU
);
4202 if (errno
!= EEXIST
) {
4203 ERR("Failed to create %s", path
);
4209 /* Create the kconsumerd error unix socket */
4210 consumer_data
->err_sock
=
4211 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4212 if (consumer_data
->err_sock
< 0) {
4213 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4218 /* File permission MUST be 660 */
4219 ret
= chmod(consumer_data
->err_unix_sock_path
,
4220 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4222 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4232 * Signal handler for the daemon
4234 * Simply stop all worker threads, leaving main() return gracefully after
4235 * joining all threads and calling cleanup().
4237 static void sighandler(int sig
)
4241 DBG("SIGPIPE caught");
4244 DBG("SIGINT caught");
4248 DBG("SIGTERM caught");
4257 * Setup signal handler for :
4258 * SIGINT, SIGTERM, SIGPIPE
4260 static int set_signal_handler(void)
4263 struct sigaction sa
;
4266 if ((ret
= sigemptyset(&sigset
)) < 0) {
4267 PERROR("sigemptyset");
4271 sa
.sa_handler
= sighandler
;
4272 sa
.sa_mask
= sigset
;
4274 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4275 PERROR("sigaction");
4279 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4280 PERROR("sigaction");
4284 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4285 PERROR("sigaction");
4289 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4295 * Set open files limit to unlimited. This daemon can open a large number of
4296 * file descriptors in order to consumer multiple kernel traces.
4298 static void set_ulimit(void)
4303 /* The kernel does not allowed an infinite limit for open files */
4304 lim
.rlim_cur
= 65535;
4305 lim
.rlim_max
= 65535;
4307 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4309 PERROR("failed to set open files limit");
4316 int main(int argc
, char **argv
)
4320 const char *home_path
;
4322 init_kernel_workarounds();
4324 rcu_register_thread();
4326 /* Create thread quit pipe */
4327 if ((ret
= init_thread_quit_pipe()) < 0) {
4331 setup_consumerd_path();
4333 /* Parse arguments */
4335 if ((ret
= parse_args(argc
, argv
) < 0)) {
4348 /* Check if daemon is UID = 0 */
4349 is_root
= !getuid();
4352 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4354 /* Create global run dir with root access */
4355 ret
= create_lttng_rundir(rundir
);
4360 if (strlen(apps_unix_sock_path
) == 0) {
4361 snprintf(apps_unix_sock_path
, PATH_MAX
,
4362 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4365 if (strlen(client_unix_sock_path
) == 0) {
4366 snprintf(client_unix_sock_path
, PATH_MAX
,
4367 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4370 /* Set global SHM for ust */
4371 if (strlen(wait_shm_path
) == 0) {
4372 snprintf(wait_shm_path
, PATH_MAX
,
4373 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4376 /* Setup kernel consumerd path */
4377 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4378 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4379 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4380 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4382 DBG2("Kernel consumer err path: %s",
4383 kconsumer_data
.err_unix_sock_path
);
4384 DBG2("Kernel consumer cmd path: %s",
4385 kconsumer_data
.cmd_unix_sock_path
);
4387 home_path
= get_home_dir();
4388 if (home_path
== NULL
) {
4389 /* TODO: Add --socket PATH option */
4390 ERR("Can't get HOME directory for sockets creation.");
4396 * Create rundir from home path. This will create something like
4399 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4405 ret
= create_lttng_rundir(rundir
);
4410 if (strlen(apps_unix_sock_path
) == 0) {
4411 snprintf(apps_unix_sock_path
, PATH_MAX
,
4412 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4415 /* Set the cli tool unix socket path */
4416 if (strlen(client_unix_sock_path
) == 0) {
4417 snprintf(client_unix_sock_path
, PATH_MAX
,
4418 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4421 /* Set global SHM for ust */
4422 if (strlen(wait_shm_path
) == 0) {
4423 snprintf(wait_shm_path
, PATH_MAX
,
4424 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4428 DBG("Client socket path %s", client_unix_sock_path
);
4429 DBG("Application socket path %s", apps_unix_sock_path
);
4430 DBG("LTTng run directory path: %s", rundir
);
4432 /* 32 bits consumerd path setup */
4433 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4434 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4435 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4436 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4438 DBG2("UST consumer 32 bits err path: %s",
4439 ustconsumer32_data
.err_unix_sock_path
);
4440 DBG2("UST consumer 32 bits cmd path: %s",
4441 ustconsumer32_data
.cmd_unix_sock_path
);
4443 /* 64 bits consumerd path setup */
4444 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4445 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4446 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4447 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4449 DBG2("UST consumer 64 bits err path: %s",
4450 ustconsumer64_data
.err_unix_sock_path
);
4451 DBG2("UST consumer 64 bits cmd path: %s",
4452 ustconsumer64_data
.cmd_unix_sock_path
);
4455 * See if daemon already exist.
4457 if ((ret
= check_existing_daemon()) < 0) {
4458 ERR("Already running daemon.\n");
4460 * We do not goto exit because we must not cleanup()
4461 * because a daemon is already running.
4466 /* After this point, we can safely call cleanup() with "goto exit" */
4469 * These actions must be executed as root. We do that *after* setting up
4470 * the sockets path because we MUST make the check for another daemon using
4471 * those paths *before* trying to set the kernel consumer sockets and init
4475 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4480 /* Setup kernel tracer */
4481 if (!opt_no_kernel
) {
4482 init_kernel_tracer();
4485 /* Set ulimit for open files */
4489 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4494 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4499 if ((ret
= set_signal_handler()) < 0) {
4503 /* Setup the needed unix socket */
4504 if ((ret
= init_daemon_socket()) < 0) {
4508 /* Set credentials to socket */
4509 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4513 /* Get parent pid if -S, --sig-parent is specified. */
4514 if (opt_sig_parent
) {
4518 /* Setup the kernel pipe for waking up the kernel thread */
4519 if ((ret
= create_kernel_poll_pipe()) < 0) {
4523 /* Setup the thread apps communication pipe. */
4524 if ((ret
= create_apps_cmd_pipe()) < 0) {
4528 /* Init UST command queue. */
4529 cds_wfq_init(&ust_cmd_queue
.queue
);
4531 /* Init UST app hash table */
4535 * Get session list pointer. This pointer MUST NOT be free(). This list is
4536 * statically declared in session.c
4538 session_list_ptr
= session_get_list();
4540 /* Set up max poll set size */
4541 lttng_poll_set_max_size();
4543 /* Create thread to manage the client socket */
4544 ret
= pthread_create(&client_thread
, NULL
,
4545 thread_manage_clients
, (void *) NULL
);
4547 PERROR("pthread_create clients");
4551 /* Create thread to dispatch registration */
4552 ret
= pthread_create(&dispatch_thread
, NULL
,
4553 thread_dispatch_ust_registration
, (void *) NULL
);
4555 PERROR("pthread_create dispatch");
4559 /* Create thread to manage application registration. */
4560 ret
= pthread_create(®_apps_thread
, NULL
,
4561 thread_registration_apps
, (void *) NULL
);
4563 PERROR("pthread_create registration");
4567 /* Create thread to manage application socket */
4568 ret
= pthread_create(&apps_thread
, NULL
,
4569 thread_manage_apps
, (void *) NULL
);
4571 PERROR("pthread_create apps");
4575 /* Create kernel thread to manage kernel event */
4576 ret
= pthread_create(&kernel_thread
, NULL
,
4577 thread_manage_kernel
, (void *) NULL
);
4579 PERROR("pthread_create kernel");
4583 ret
= pthread_join(kernel_thread
, &status
);
4585 PERROR("pthread_join");
4586 goto error
; /* join error, exit without cleanup */
4590 ret
= pthread_join(apps_thread
, &status
);
4592 PERROR("pthread_join");
4593 goto error
; /* join error, exit without cleanup */
4597 ret
= pthread_join(reg_apps_thread
, &status
);
4599 PERROR("pthread_join");
4600 goto error
; /* join error, exit without cleanup */
4604 ret
= pthread_join(dispatch_thread
, &status
);
4606 PERROR("pthread_join");
4607 goto error
; /* join error, exit without cleanup */
4611 ret
= pthread_join(client_thread
, &status
);
4613 PERROR("pthread_join");
4614 goto error
; /* join error, exit without cleanup */
4617 ret
= join_consumer_thread(&kconsumer_data
);
4619 PERROR("join_consumer");
4620 goto error
; /* join error, exit without cleanup */
4626 * cleanup() is called when no other thread is running.
4628 rcu_thread_online();
4630 rcu_thread_offline();
4631 rcu_unregister_thread();