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
,
104 static struct consumer_data ustconsumer64_data
= {
105 .type
= LTTNG_CONSUMER64_UST
,
106 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
107 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
109 static struct consumer_data ustconsumer32_data
= {
110 .type
= LTTNG_CONSUMER32_UST
,
111 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
112 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
115 static int dispatch_thread_exit
;
117 /* Global application Unix socket path */
118 static char apps_unix_sock_path
[PATH_MAX
];
119 /* Global client Unix socket path */
120 static char client_unix_sock_path
[PATH_MAX
];
121 /* global wait shm path for UST */
122 static char wait_shm_path
[PATH_MAX
];
124 /* Sockets and FDs */
125 static int client_sock
= -1;
126 static int apps_sock
= -1;
127 static int kernel_tracer_fd
= -1;
128 static int kernel_poll_pipe
[2];
131 * Quit pipe for all threads. This permits a single cancellation point
132 * for all threads when receiving an event on the pipe.
134 static int thread_quit_pipe
[2];
137 * This pipe is used to inform the thread managing application communication
138 * that a command is queued and ready to be processed.
140 static int apps_cmd_pipe
[2];
142 /* Pthread, Mutexes and Semaphores */
143 static pthread_t apps_thread
;
144 static pthread_t reg_apps_thread
;
145 static pthread_t client_thread
;
146 static pthread_t kernel_thread
;
147 static pthread_t dispatch_thread
;
151 * UST registration command queue. This queue is tied with a futex and uses a N
152 * wakers / 1 waiter implemented and detailed in futex.c/.h
154 * The thread_manage_apps and thread_dispatch_ust_registration interact with
155 * this queue and the wait/wake scheme.
157 static struct ust_cmd_queue ust_cmd_queue
;
160 * Pointer initialized before thread creation.
162 * This points to the tracing session list containing the session count and a
163 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
164 * MUST NOT be taken if you call a public function in session.c.
166 * The lock is nested inside the structure: session_list_ptr->lock. Please use
167 * session_lock_list and session_unlock_list for lock acquisition.
169 static struct ltt_session_list
*session_list_ptr
;
171 int ust_consumerd64_fd
= -1;
172 int ust_consumerd32_fd
= -1;
174 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
175 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
176 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
177 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
180 void setup_consumerd_path(void)
182 const char *bin
, *libdir
;
185 * Allow INSTALL_BIN_PATH to be used as a target path for the
186 * native architecture size consumer if CONFIG_CONSUMER*_PATH
187 * has not been defined.
189 #if (CAA_BITS_PER_LONG == 32)
190 if (!consumerd32_bin
[0]) {
191 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
193 if (!consumerd32_libdir
[0]) {
194 consumerd32_libdir
= INSTALL_LIB_PATH
;
196 #elif (CAA_BITS_PER_LONG == 64)
197 if (!consumerd64_bin
[0]) {
198 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
200 if (!consumerd64_libdir
[0]) {
201 consumerd64_libdir
= INSTALL_LIB_PATH
;
204 #error "Unknown bitness"
208 * runtime env. var. overrides the build default.
210 bin
= getenv("LTTNG_CONSUMERD32_BIN");
212 consumerd32_bin
= bin
;
214 bin
= getenv("LTTNG_CONSUMERD64_BIN");
216 consumerd64_bin
= bin
;
218 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
220 consumerd32_libdir
= libdir
;
222 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
224 consumerd64_libdir
= libdir
;
229 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
231 static int create_thread_poll_set(struct lttng_poll_event
*events
,
236 if (events
== NULL
|| size
== 0) {
241 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
247 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
259 * Check if the thread quit pipe was triggered.
261 * Return 1 if it was triggered else 0;
263 static int check_thread_quit_pipe(int fd
, uint32_t events
)
265 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
273 * Return group ID of the tracing group or -1 if not found.
275 static gid_t
allowed_group(void)
279 if (opt_tracing_group
) {
280 grp
= getgrnam(opt_tracing_group
);
282 grp
= getgrnam(default_tracing_group
);
292 * Init thread quit pipe.
294 * Return -1 on error or 0 if all pipes are created.
296 static int init_thread_quit_pipe(void)
300 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
302 perror("thread quit pipe");
311 * Complete teardown of a kernel session. This free all data structure related
312 * to a kernel session and update counter.
314 static void teardown_kernel_session(struct ltt_session
*session
)
316 if (!session
->kernel_session
) {
317 DBG3("No kernel session when tearing down session");
321 DBG("Tearing down kernel session");
324 * If a custom kernel consumer was registered, close the socket before
325 * tearing down the complete kernel session structure
327 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
328 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
331 trace_kernel_destroy_session(session
->kernel_session
);
335 * Complete teardown of all UST sessions. This will free everything on his path
336 * and destroy the core essence of all ust sessions :)
338 static void teardown_ust_session(struct ltt_session
*session
)
342 if (!session
->ust_session
) {
343 DBG3("No UST session when tearing down session");
347 DBG("Tearing down UST session(s)");
349 ret
= ust_app_destroy_trace_all(session
->ust_session
);
351 ERR("Error in ust_app_destroy_trace_all");
354 trace_ust_destroy_session(session
->ust_session
);
358 * Stop all threads by closing the thread quit pipe.
360 static void stop_threads(void)
364 /* Stopping all threads */
365 DBG("Terminating all threads");
366 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
368 ERR("write error on thread quit pipe");
371 /* Dispatch thread */
372 dispatch_thread_exit
= 1;
373 futex_nto1_wake(&ust_cmd_queue
.futex
);
379 static void cleanup(void)
383 struct ltt_session
*sess
, *stmp
;
387 DBG("Removing %s directory", rundir
);
388 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
390 ERR("asprintf failed. Something is really wrong!");
393 /* Remove lttng run directory */
396 ERR("Unable to clean %s", rundir
);
400 DBG("Cleaning up all sessions");
402 /* Destroy session list mutex */
403 if (session_list_ptr
!= NULL
) {
404 pthread_mutex_destroy(&session_list_ptr
->lock
);
406 /* Cleanup ALL session */
407 cds_list_for_each_entry_safe(sess
, stmp
,
408 &session_list_ptr
->head
, list
) {
409 teardown_kernel_session(sess
);
410 teardown_ust_session(sess
);
415 DBG("Closing all UST sockets");
416 ust_app_clean_list();
418 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
420 if (is_root
&& !opt_no_kernel
) {
421 DBG2("Closing kernel fd");
422 if (kernel_tracer_fd
>= 0) {
423 close(kernel_tracer_fd
);
425 DBG("Unloading kernel modules");
426 modprobe_remove_lttng_all();
429 close(thread_quit_pipe
[0]);
430 close(thread_quit_pipe
[1]);
433 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
434 "Matthew, BEET driven development works!%c[%dm",
435 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
440 * Send data on a unix socket using the liblttsessiondcomm API.
442 * Return lttcomm error code.
444 static int send_unix_sock(int sock
, void *buf
, size_t len
)
446 /* Check valid length */
451 return lttcomm_send_unix_sock(sock
, buf
, len
);
455 * Free memory of a command context structure.
457 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
459 DBG("Clean command context structure");
461 if ((*cmd_ctx
)->llm
) {
462 free((*cmd_ctx
)->llm
);
464 if ((*cmd_ctx
)->lsm
) {
465 free((*cmd_ctx
)->lsm
);
473 * Send all stream fds of kernel channel to the consumer.
475 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
476 int sock
, struct ltt_kernel_channel
*channel
,
477 uid_t uid
, gid_t gid
)
480 struct ltt_kernel_stream
*stream
;
481 struct lttcomm_consumer_msg lkm
;
483 DBG("Sending streams of channel %s to kernel consumer",
484 channel
->channel
->name
);
487 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
488 lkm
.u
.channel
.channel_key
= channel
->fd
;
489 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
490 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
491 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
492 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
494 perror("send consumer channel");
499 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
503 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
504 lkm
.u
.stream
.channel_key
= channel
->fd
;
505 lkm
.u
.stream
.stream_key
= stream
->fd
;
506 lkm
.u
.stream
.state
= stream
->state
;
507 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
508 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
509 lkm
.u
.stream
.uid
= uid
;
510 lkm
.u
.stream
.gid
= gid
;
511 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
512 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
513 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
514 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
516 perror("send consumer stream");
519 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
521 perror("send consumer stream ancillary data");
526 DBG("consumer channel streams sent");
535 * Send all stream fds of the kernel session to the consumer.
537 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
538 struct ltt_kernel_session
*session
)
541 struct ltt_kernel_channel
*chan
;
542 struct lttcomm_consumer_msg lkm
;
543 int sock
= session
->consumer_fd
;
545 DBG("Sending metadata stream fd");
547 /* Extra protection. It's NOT supposed to be set to 0 at this point */
548 if (session
->consumer_fd
== 0) {
549 session
->consumer_fd
= consumer_data
->cmd_sock
;
552 if (session
->metadata_stream_fd
!= 0) {
553 /* Send metadata channel fd */
554 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
555 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
556 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
557 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
558 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
559 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
561 perror("send consumer channel");
565 /* Send metadata stream fd */
566 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
567 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
568 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
569 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
570 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
571 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
572 lkm
.u
.stream
.uid
= session
->uid
;
573 lkm
.u
.stream
.gid
= session
->gid
;
574 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
575 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
576 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
577 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
579 perror("send consumer stream");
582 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
584 perror("send consumer stream");
589 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
590 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
591 session
->uid
, session
->gid
);
597 DBG("consumer fds (metadata and channel streams) sent");
606 * Notify UST applications using the shm mmap futex.
608 static int notify_ust_apps(int active
)
612 DBG("Notifying applications of session daemon state: %d", active
);
614 /* See shm.c for this call implying mmap, shm and futex calls */
615 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
616 if (wait_shm_mmap
== NULL
) {
620 /* Wake waiting process */
621 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
623 /* Apps notified successfully */
631 * Setup the outgoing data buffer for the response (llm) by allocating the
632 * right amount of memory and copying the original information from the lsm
635 * Return total size of the buffer pointed by buf.
637 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
643 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
644 if (cmd_ctx
->llm
== NULL
) {
650 /* Copy common data */
651 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
652 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
654 cmd_ctx
->llm
->data_size
= size
;
655 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
664 * Update the kernel poll set of all channel fd available over all tracing
665 * session. Add the wakeup pipe at the end of the set.
667 static int update_kernel_poll(struct lttng_poll_event
*events
)
670 struct ltt_session
*session
;
671 struct ltt_kernel_channel
*channel
;
673 DBG("Updating kernel poll set");
676 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
677 session_lock(session
);
678 if (session
->kernel_session
== NULL
) {
679 session_unlock(session
);
683 cds_list_for_each_entry(channel
,
684 &session
->kernel_session
->channel_list
.head
, list
) {
685 /* Add channel fd to the kernel poll set */
686 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
688 session_unlock(session
);
691 DBG("Channel fd %d added to kernel set", channel
->fd
);
693 session_unlock(session
);
695 session_unlock_list();
700 session_unlock_list();
705 * Find the channel fd from 'fd' over all tracing session. When found, check
706 * for new channel stream and send those stream fds to the kernel consumer.
708 * Useful for CPU hotplug feature.
710 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
713 struct ltt_session
*session
;
714 struct ltt_kernel_channel
*channel
;
716 DBG("Updating kernel streams for channel fd %d", fd
);
719 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
720 session_lock(session
);
721 if (session
->kernel_session
== NULL
) {
722 session_unlock(session
);
726 /* This is not suppose to be 0 but this is an extra security check */
727 if (session
->kernel_session
->consumer_fd
== 0) {
728 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
731 cds_list_for_each_entry(channel
,
732 &session
->kernel_session
->channel_list
.head
, list
) {
733 if (channel
->fd
== fd
) {
734 DBG("Channel found, updating kernel streams");
735 ret
= kernel_open_channel_stream(channel
);
741 * Have we already sent fds to the consumer? If yes, it means
742 * that tracing is started so it is safe to send our updated
745 if (session
->kernel_session
->consumer_fds_sent
== 1) {
746 ret
= send_kconsumer_channel_streams(consumer_data
,
747 session
->kernel_session
->consumer_fd
, channel
,
748 session
->uid
, session
->gid
);
756 session_unlock(session
);
758 session_unlock_list();
762 session_unlock(session
);
763 session_unlock_list();
768 * For each tracing session, update newly registered apps.
770 static void update_ust_app(int app_sock
)
772 struct ltt_session
*sess
, *stmp
;
776 /* For all tracing session(s) */
777 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
779 if (sess
->ust_session
) {
780 ust_app_global_update(sess
->ust_session
, app_sock
);
782 session_unlock(sess
);
785 session_unlock_list();
789 * This thread manage event coming from the kernel.
791 * Features supported in this thread:
794 static void *thread_manage_kernel(void *data
)
796 int ret
, i
, pollfd
, update_poll_flag
= 1;
797 uint32_t revents
, nb_fd
;
799 struct lttng_poll_event events
;
801 DBG("Thread manage kernel started");
803 ret
= create_thread_poll_set(&events
, 2);
808 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
814 if (update_poll_flag
== 1) {
816 * Reset number of fd in the poll set. Always 2 since there is the thread
817 * quit pipe and the kernel pipe.
821 ret
= update_kernel_poll(&events
);
825 update_poll_flag
= 0;
828 nb_fd
= LTTNG_POLL_GETNB(&events
);
830 DBG("Thread kernel polling on %d fds", nb_fd
);
832 /* Zeroed the poll events */
833 lttng_poll_reset(&events
);
835 /* Poll infinite value of time */
837 ret
= lttng_poll_wait(&events
, -1);
840 * Restart interrupted system call.
842 if (errno
== EINTR
) {
846 } else if (ret
== 0) {
847 /* Should not happen since timeout is infinite */
848 ERR("Return value of poll is 0 with an infinite timeout.\n"
849 "This should not have happened! Continuing...");
853 for (i
= 0; i
< nb_fd
; i
++) {
854 /* Fetch once the poll data */
855 revents
= LTTNG_POLL_GETEV(&events
, i
);
856 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
858 /* Thread quit pipe has been closed. Killing thread. */
859 ret
= check_thread_quit_pipe(pollfd
, revents
);
864 /* Check for data on kernel pipe */
865 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
866 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
867 update_poll_flag
= 1;
871 * New CPU detected by the kernel. Adding kernel stream to
872 * kernel session and updating the kernel consumer
874 if (revents
& LPOLLIN
) {
875 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
881 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
882 * and unregister kernel stream at this point.
890 DBG("Kernel thread dying");
891 close(kernel_poll_pipe
[0]);
892 close(kernel_poll_pipe
[1]);
894 lttng_poll_clean(&events
);
900 * This thread manage the consumer error sent back to the session daemon.
902 static void *thread_manage_consumer(void *data
)
904 int sock
= 0, i
, ret
, pollfd
;
905 uint32_t revents
, nb_fd
;
906 enum lttcomm_return_code code
;
907 struct lttng_poll_event events
;
908 struct consumer_data
*consumer_data
= data
;
910 DBG("[thread] Manage consumer started");
912 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
918 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
919 * Nothing more will be added to this poll set.
921 ret
= create_thread_poll_set(&events
, 2);
926 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
931 nb_fd
= LTTNG_POLL_GETNB(&events
);
933 /* Inifinite blocking call, waiting for transmission */
935 ret
= lttng_poll_wait(&events
, -1);
938 * Restart interrupted system call.
940 if (errno
== EINTR
) {
946 for (i
= 0; i
< nb_fd
; i
++) {
947 /* Fetch once the poll data */
948 revents
= LTTNG_POLL_GETEV(&events
, i
);
949 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
951 /* Thread quit pipe has been closed. Killing thread. */
952 ret
= check_thread_quit_pipe(pollfd
, revents
);
957 /* Event on the registration socket */
958 if (pollfd
== consumer_data
->err_sock
) {
959 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
960 ERR("consumer err socket poll error");
966 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
971 DBG2("Receiving code from consumer err_sock");
973 /* Getting status code from kconsumerd */
974 ret
= lttcomm_recv_unix_sock(sock
, &code
,
975 sizeof(enum lttcomm_return_code
));
980 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
981 consumer_data
->cmd_sock
=
982 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
983 if (consumer_data
->cmd_sock
< 0) {
984 sem_post(&consumer_data
->sem
);
985 PERROR("consumer connect");
988 /* Signal condition to tell that the kconsumerd is ready */
989 sem_post(&consumer_data
->sem
);
990 DBG("consumer command socket ready");
992 ERR("consumer error when waiting for SOCK_READY : %s",
993 lttcomm_get_readable_code(-code
));
997 /* Remove the kconsumerd error sock since we've established a connexion */
998 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1003 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1008 /* Update number of fd */
1009 nb_fd
= LTTNG_POLL_GETNB(&events
);
1011 /* Inifinite blocking call, waiting for transmission */
1013 ret
= lttng_poll_wait(&events
, -1);
1016 * Restart interrupted system call.
1018 if (errno
== EINTR
) {
1024 for (i
= 0; i
< nb_fd
; i
++) {
1025 /* Fetch once the poll data */
1026 revents
= LTTNG_POLL_GETEV(&events
, i
);
1027 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1029 /* Thread quit pipe has been closed. Killing thread. */
1030 ret
= check_thread_quit_pipe(pollfd
, revents
);
1035 /* Event on the kconsumerd socket */
1036 if (pollfd
== sock
) {
1037 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1038 ERR("consumer err socket second poll error");
1044 /* Wait for any kconsumerd error */
1045 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1046 sizeof(enum lttcomm_return_code
));
1048 ERR("consumer closed the command socket");
1052 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1055 DBG("consumer thread dying");
1056 close(consumer_data
->err_sock
);
1057 close(consumer_data
->cmd_sock
);
1060 unlink(consumer_data
->err_unix_sock_path
);
1061 unlink(consumer_data
->cmd_unix_sock_path
);
1062 consumer_data
->pid
= 0;
1064 lttng_poll_clean(&events
);
1070 * This thread manage application communication.
1072 static void *thread_manage_apps(void *data
)
1075 uint32_t revents
, nb_fd
;
1076 struct ust_command ust_cmd
;
1077 struct lttng_poll_event events
;
1079 DBG("[thread] Manage application started");
1081 rcu_register_thread();
1082 rcu_thread_online();
1084 ret
= create_thread_poll_set(&events
, 2);
1089 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1095 /* Zeroed the events structure */
1096 lttng_poll_reset(&events
);
1098 nb_fd
= LTTNG_POLL_GETNB(&events
);
1100 DBG("Apps thread polling on %d fds", nb_fd
);
1102 /* Inifinite blocking call, waiting for transmission */
1104 ret
= lttng_poll_wait(&events
, -1);
1107 * Restart interrupted system call.
1109 if (errno
== EINTR
) {
1115 for (i
= 0; i
< nb_fd
; i
++) {
1116 /* Fetch once the poll data */
1117 revents
= LTTNG_POLL_GETEV(&events
, i
);
1118 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1120 /* Thread quit pipe has been closed. Killing thread. */
1121 ret
= check_thread_quit_pipe(pollfd
, revents
);
1126 /* Inspect the apps cmd pipe */
1127 if (pollfd
== apps_cmd_pipe
[0]) {
1128 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1129 ERR("Apps command pipe error");
1131 } else if (revents
& LPOLLIN
) {
1133 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1134 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1135 perror("read apps cmd pipe");
1139 /* Register applicaton to the session daemon */
1140 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1142 if (ret
== -ENOMEM
) {
1144 } else if (ret
< 0) {
1149 * Validate UST version compatibility.
1151 ret
= ust_app_validate_version(ust_cmd
.sock
);
1154 * Add channel(s) and event(s) to newly registered apps
1155 * from lttng global UST domain.
1157 update_ust_app(ust_cmd
.sock
);
1160 ret
= ust_app_register_done(ust_cmd
.sock
);
1163 * If the registration is not possible, we simply
1164 * unregister the apps and continue
1166 ust_app_unregister(ust_cmd
.sock
);
1169 * We just need here to monitor the close of the UST
1170 * socket and poll set monitor those by default.
1171 * Listen on POLLIN (even if we never expect any
1172 * data) to ensure that hangup wakes us.
1174 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1179 DBG("Apps with sock %d added to poll set",
1187 * At this point, we know that a registered application made
1188 * the event at poll_wait.
1190 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1191 /* Removing from the poll set */
1192 ret
= lttng_poll_del(&events
, pollfd
);
1197 /* Socket closed on remote end. */
1198 ust_app_unregister(pollfd
);
1206 DBG("Application communication apps dying");
1207 close(apps_cmd_pipe
[0]);
1208 close(apps_cmd_pipe
[1]);
1210 lttng_poll_clean(&events
);
1212 rcu_thread_offline();
1213 rcu_unregister_thread();
1218 * Dispatch request from the registration threads to the application
1219 * communication thread.
1221 static void *thread_dispatch_ust_registration(void *data
)
1224 struct cds_wfq_node
*node
;
1225 struct ust_command
*ust_cmd
= NULL
;
1227 DBG("[thread] Dispatch UST command started");
1229 while (!dispatch_thread_exit
) {
1230 /* Atomically prepare the queue futex */
1231 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1234 /* Dequeue command for registration */
1235 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1237 DBG("Woken up but nothing in the UST command queue");
1238 /* Continue thread execution */
1242 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1244 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1245 " gid:%d sock:%d name:%s (version %d.%d)",
1246 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1247 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1248 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1249 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1251 * Inform apps thread of the new application registration. This
1252 * call is blocking so we can be assured that the data will be read
1253 * at some point in time or wait to the end of the world :)
1255 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1256 sizeof(struct ust_command
));
1258 perror("write apps cmd pipe");
1259 if (errno
== EBADF
) {
1261 * We can't inform the application thread to process
1262 * registration. We will exit or else application
1263 * registration will not occur and tracing will never
1270 } while (node
!= NULL
);
1272 /* Futex wait on queue. Blocking call on futex() */
1273 futex_nto1_wait(&ust_cmd_queue
.futex
);
1277 DBG("Dispatch thread dying");
1282 * This thread manage application registration.
1284 static void *thread_registration_apps(void *data
)
1286 int sock
= -1, i
, ret
, pollfd
;
1287 uint32_t revents
, nb_fd
;
1288 struct lttng_poll_event events
;
1290 * Get allocated in this thread, enqueued to a global queue, dequeued and
1291 * freed in the manage apps thread.
1293 struct ust_command
*ust_cmd
= NULL
;
1295 DBG("[thread] Manage application registration started");
1297 ret
= lttcomm_listen_unix_sock(apps_sock
);
1303 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1304 * more will be added to this poll set.
1306 ret
= create_thread_poll_set(&events
, 2);
1311 /* Add the application registration socket */
1312 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1317 /* Notify all applications to register */
1318 ret
= notify_ust_apps(1);
1320 ERR("Failed to notify applications or create the wait shared memory.\n"
1321 "Execution continues but there might be problem for already\n"
1322 "running applications that wishes to register.");
1326 DBG("Accepting application registration");
1328 nb_fd
= LTTNG_POLL_GETNB(&events
);
1330 /* Inifinite blocking call, waiting for transmission */
1332 ret
= lttng_poll_wait(&events
, -1);
1335 * Restart interrupted system call.
1337 if (errno
== EINTR
) {
1343 for (i
= 0; i
< nb_fd
; i
++) {
1344 /* Fetch once the poll data */
1345 revents
= LTTNG_POLL_GETEV(&events
, i
);
1346 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1348 /* Thread quit pipe has been closed. Killing thread. */
1349 ret
= check_thread_quit_pipe(pollfd
, revents
);
1354 /* Event on the registration socket */
1355 if (pollfd
== apps_sock
) {
1356 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1357 ERR("Register apps socket poll error");
1359 } else if (revents
& LPOLLIN
) {
1360 sock
= lttcomm_accept_unix_sock(apps_sock
);
1365 /* Create UST registration command for enqueuing */
1366 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1367 if (ust_cmd
== NULL
) {
1368 perror("ust command zmalloc");
1373 * Using message-based transmissions to ensure we don't
1374 * have to deal with partially received messages.
1376 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1377 sizeof(struct ust_register_msg
));
1378 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1380 perror("lttcomm_recv_unix_sock register apps");
1382 ERR("Wrong size received on apps register");
1389 ust_cmd
->sock
= sock
;
1391 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1392 " gid:%d sock:%d name:%s (version %d.%d)",
1393 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1394 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1395 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1396 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1399 * Lock free enqueue the registration request. The red pill
1400 * has been taken! This apps will be part of the *system*.
1402 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1405 * Wake the registration queue futex. Implicit memory
1406 * barrier with the exchange in cds_wfq_enqueue.
1408 futex_nto1_wake(&ust_cmd_queue
.futex
);
1415 DBG("UST Registration thread dying");
1417 /* Notify that the registration thread is gone */
1420 if (apps_sock
>= 0) {
1426 unlink(apps_unix_sock_path
);
1428 lttng_poll_clean(&events
);
1434 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1435 * exec or it will fails.
1437 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1440 struct timespec timeout
;
1442 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1443 timeout
.tv_nsec
= 0;
1445 /* Setup semaphore */
1446 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1448 PERROR("sem_init consumer semaphore");
1452 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1453 thread_manage_consumer
, consumer_data
);
1455 PERROR("pthread_create consumer");
1460 /* Get time for sem_timedwait absolute timeout */
1461 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1463 PERROR("clock_gettime spawn consumer");
1464 /* Infinite wait for the kconsumerd thread to be ready */
1465 ret
= sem_wait(&consumer_data
->sem
);
1467 /* Normal timeout if the gettime was successful */
1468 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1469 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1473 if (errno
== ETIMEDOUT
) {
1475 * Call has timed out so we kill the kconsumerd_thread and return
1478 ERR("The consumer thread was never ready. Killing it");
1479 ret
= pthread_cancel(consumer_data
->thread
);
1481 PERROR("pthread_cancel consumer thread");
1484 PERROR("semaphore wait failed consumer thread");
1489 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1490 if (consumer_data
->pid
== 0) {
1491 ERR("Kconsumerd did not start");
1492 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1495 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1504 * Join consumer thread
1506 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1511 if (consumer_data
->pid
!= 0) {
1512 ret
= kill(consumer_data
->pid
, SIGTERM
);
1514 ERR("Error killing consumer daemon");
1517 return pthread_join(consumer_data
->thread
, &status
);
1524 * Fork and exec a consumer daemon (consumerd).
1526 * Return pid if successful else -1.
1528 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1532 const char *consumer_to_use
;
1533 const char *verbosity
;
1536 DBG("Spawning consumerd");
1543 if (opt_verbose_consumer
) {
1544 verbosity
= "--verbose";
1546 verbosity
= "--quiet";
1548 switch (consumer_data
->type
) {
1549 case LTTNG_CONSUMER_KERNEL
:
1551 * Find out which consumerd to execute. We will first try the
1552 * 64-bit path, then the sessiond's installation directory, and
1553 * fallback on the 32-bit one,
1555 DBG3("Looking for a kernel consumer at these locations:");
1556 DBG3(" 1) %s", consumerd64_bin
);
1557 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1558 DBG3(" 3) %s", consumerd32_bin
);
1559 if (stat(consumerd64_bin
, &st
) == 0) {
1560 DBG3("Found location #1");
1561 consumer_to_use
= consumerd64_bin
;
1562 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1563 DBG3("Found location #2");
1564 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1565 } else if (stat(consumerd32_bin
, &st
) == 0) {
1566 DBG3("Found location #3");
1567 consumer_to_use
= consumerd32_bin
;
1569 DBG("Could not find any valid consumerd executable");
1572 DBG("Using kernel consumer at: %s", consumer_to_use
);
1573 execl(consumer_to_use
,
1574 "lttng-consumerd", verbosity
, "-k",
1575 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1576 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1579 case LTTNG_CONSUMER64_UST
:
1581 char *tmpnew
= NULL
;
1583 if (consumerd64_libdir
[0] != '\0') {
1587 tmp
= getenv("LD_LIBRARY_PATH");
1591 tmplen
= strlen("LD_LIBRARY_PATH=")
1592 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1593 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1598 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1599 strcat(tmpnew
, consumerd64_libdir
);
1600 if (tmp
[0] != '\0') {
1601 strcat(tmpnew
, ":");
1602 strcat(tmpnew
, tmp
);
1604 ret
= putenv(tmpnew
);
1610 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1611 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1612 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1613 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1615 if (consumerd64_libdir
[0] != '\0') {
1623 case LTTNG_CONSUMER32_UST
:
1625 char *tmpnew
= NULL
;
1627 if (consumerd32_libdir
[0] != '\0') {
1631 tmp
= getenv("LD_LIBRARY_PATH");
1635 tmplen
= strlen("LD_LIBRARY_PATH=")
1636 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1637 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1642 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1643 strcat(tmpnew
, consumerd32_libdir
);
1644 if (tmp
[0] != '\0') {
1645 strcat(tmpnew
, ":");
1646 strcat(tmpnew
, tmp
);
1648 ret
= putenv(tmpnew
);
1654 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1655 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1656 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1657 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1659 if (consumerd32_libdir
[0] != '\0') {
1668 perror("unknown consumer type");
1672 perror("kernel start consumer exec");
1675 } else if (pid
> 0) {
1678 perror("start consumer fork");
1686 * Spawn the consumerd daemon and session daemon thread.
1688 static int start_consumerd(struct consumer_data
*consumer_data
)
1692 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1693 if (consumer_data
->pid
!= 0) {
1694 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1698 ret
= spawn_consumerd(consumer_data
);
1700 ERR("Spawning consumerd failed");
1701 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1705 /* Setting up the consumer_data pid */
1706 consumer_data
->pid
= ret
;
1707 DBG2("Consumer pid %d", consumer_data
->pid
);
1708 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1710 DBG2("Spawning consumer control thread");
1711 ret
= spawn_consumer_thread(consumer_data
);
1713 ERR("Fatal error spawning consumer control thread");
1725 * Check version of the lttng-modules.
1727 static int validate_lttng_modules_version(void)
1729 return kernel_validate_version(kernel_tracer_fd
);
1733 * Setup necessary data for kernel tracer action.
1735 static int init_kernel_tracer(void)
1739 /* Modprobe lttng kernel modules */
1740 ret
= modprobe_lttng_control();
1745 /* Open debugfs lttng */
1746 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1747 if (kernel_tracer_fd
< 0) {
1748 DBG("Failed to open %s", module_proc_lttng
);
1753 /* Validate kernel version */
1754 ret
= validate_lttng_modules_version();
1759 ret
= modprobe_lttng_data();
1764 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1768 modprobe_remove_lttng_control();
1769 close(kernel_tracer_fd
);
1770 kernel_tracer_fd
= 0;
1771 return LTTCOMM_KERN_VERSION
;
1774 close(kernel_tracer_fd
);
1777 modprobe_remove_lttng_control();
1780 WARN("No kernel tracer available");
1781 kernel_tracer_fd
= -1;
1782 return LTTCOMM_KERN_NA
;
1786 * Init tracing by creating trace directory and sending fds kernel consumer.
1788 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1792 if (session
->consumer_fds_sent
== 0) {
1794 * Assign default kernel consumer socket if no consumer assigned to the
1795 * kernel session. At this point, it's NOT suppose to be 0 but this is
1796 * an extra security check.
1798 if (session
->consumer_fd
== 0) {
1799 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1802 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1804 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1808 session
->consumer_fds_sent
= 1;
1816 * Create an UST session and add it to the session ust list.
1818 static int create_ust_session(struct ltt_session
*session
,
1819 struct lttng_domain
*domain
)
1821 struct ltt_ust_session
*lus
= NULL
;
1824 switch (domain
->type
) {
1825 case LTTNG_DOMAIN_UST
:
1828 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1832 DBG("Creating UST session");
1834 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1836 ret
= LTTCOMM_UST_SESS_FAIL
;
1840 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1841 session
->uid
, session
->gid
);
1843 if (ret
!= -EEXIST
) {
1844 ERR("Trace directory creation error");
1845 ret
= LTTCOMM_UST_SESS_FAIL
;
1850 /* The domain type dictate different actions on session creation */
1851 switch (domain
->type
) {
1852 case LTTNG_DOMAIN_UST
:
1853 /* No ustctl for the global UST domain */
1856 ERR("Unknown UST domain on create session %d", domain
->type
);
1859 lus
->uid
= session
->uid
;
1860 lus
->gid
= session
->gid
;
1861 session
->ust_session
= lus
;
1871 * Create a kernel tracer session then create the default channel.
1873 static int create_kernel_session(struct ltt_session
*session
)
1877 DBG("Creating kernel session");
1879 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1881 ret
= LTTCOMM_KERN_SESS_FAIL
;
1885 /* Set kernel consumer socket fd */
1886 if (kconsumer_data
.cmd_sock
) {
1887 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1890 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1891 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1893 if (ret
!= -EEXIST
) {
1894 ERR("Trace directory creation error");
1898 session
->kernel_session
->uid
= session
->uid
;
1899 session
->kernel_session
->gid
= session
->gid
;
1906 * Check if the UID or GID match the session. Root user has access to all
1909 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1911 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1918 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1921 struct ltt_session
*session
;
1923 DBG("Counting number of available session for UID %d GID %d",
1925 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1927 * Only list the sessions the user can control.
1929 if (!session_access_ok(session
, uid
, gid
)) {
1938 * Using the session list, filled a lttng_session array to send back to the
1939 * client for session listing.
1941 * The session list lock MUST be acquired before calling this function. Use
1942 * session_lock_list() and session_unlock_list().
1944 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1948 struct ltt_session
*session
;
1950 DBG("Getting all available session for UID %d GID %d",
1953 * Iterate over session list and append data after the control struct in
1956 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1958 * Only list the sessions the user can control.
1960 if (!session_access_ok(session
, uid
, gid
)) {
1963 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1964 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1965 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1966 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1967 sessions
[i
].enabled
= session
->enabled
;
1973 * Fill lttng_channel array of all channels.
1975 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1976 struct lttng_channel
*channels
)
1979 struct ltt_kernel_channel
*kchan
;
1981 DBG("Listing channels for session %s", session
->name
);
1984 case LTTNG_DOMAIN_KERNEL
:
1985 /* Kernel channels */
1986 if (session
->kernel_session
!= NULL
) {
1987 cds_list_for_each_entry(kchan
,
1988 &session
->kernel_session
->channel_list
.head
, list
) {
1989 /* Copy lttng_channel struct to array */
1990 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1991 channels
[i
].enabled
= kchan
->enabled
;
1996 case LTTNG_DOMAIN_UST
:
1998 struct lttng_ht_iter iter
;
1999 struct ltt_ust_channel
*uchan
;
2001 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2002 &iter
.iter
, uchan
, node
.node
) {
2003 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2004 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2005 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2006 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2007 channels
[i
].attr
.switch_timer_interval
=
2008 uchan
->attr
.switch_timer_interval
;
2009 channels
[i
].attr
.read_timer_interval
=
2010 uchan
->attr
.read_timer_interval
;
2011 channels
[i
].enabled
= uchan
->enabled
;
2012 switch (uchan
->attr
.output
) {
2013 case LTTNG_UST_MMAP
:
2015 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2028 * Create a list of ust global domain events.
2030 static int list_lttng_ust_global_events(char *channel_name
,
2031 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2034 unsigned int nb_event
= 0;
2035 struct lttng_ht_iter iter
;
2036 struct lttng_ht_node_str
*node
;
2037 struct ltt_ust_channel
*uchan
;
2038 struct ltt_ust_event
*uevent
;
2039 struct lttng_event
*tmp
;
2041 DBG("Listing UST global events for channel %s", channel_name
);
2045 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2046 node
= lttng_ht_iter_get_node_str(&iter
);
2048 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2052 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2054 nb_event
+= lttng_ht_get_count(uchan
->events
);
2056 if (nb_event
== 0) {
2061 DBG3("Listing UST global %d events", nb_event
);
2063 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2065 ret
= -LTTCOMM_FATAL
;
2069 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2070 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2071 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2072 tmp
[i
].enabled
= uevent
->enabled
;
2073 switch (uevent
->attr
.instrumentation
) {
2074 case LTTNG_UST_TRACEPOINT
:
2075 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2077 case LTTNG_UST_PROBE
:
2078 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2080 case LTTNG_UST_FUNCTION
:
2081 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2084 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2085 switch (uevent
->attr
.loglevel_type
) {
2086 case LTTNG_UST_LOGLEVEL_ALL
:
2087 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2089 case LTTNG_UST_LOGLEVEL_RANGE
:
2090 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2092 case LTTNG_UST_LOGLEVEL_SINGLE
:
2093 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2108 * Fill lttng_event array of all kernel events in the channel.
2110 static int list_lttng_kernel_events(char *channel_name
,
2111 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2114 unsigned int nb_event
;
2115 struct ltt_kernel_event
*event
;
2116 struct ltt_kernel_channel
*kchan
;
2118 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2119 if (kchan
== NULL
) {
2120 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2124 nb_event
= kchan
->event_count
;
2126 DBG("Listing events for channel %s", kchan
->channel
->name
);
2128 if (nb_event
== 0) {
2133 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2134 if (*events
== NULL
) {
2135 ret
= LTTCOMM_FATAL
;
2139 /* Kernel channels */
2140 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2141 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2142 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2143 (*events
)[i
].enabled
= event
->enabled
;
2144 switch (event
->event
->instrumentation
) {
2145 case LTTNG_KERNEL_TRACEPOINT
:
2146 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2148 case LTTNG_KERNEL_KPROBE
:
2149 case LTTNG_KERNEL_KRETPROBE
:
2150 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2151 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2152 sizeof(struct lttng_kernel_kprobe
));
2154 case LTTNG_KERNEL_FUNCTION
:
2155 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2156 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2157 sizeof(struct lttng_kernel_function
));
2159 case LTTNG_KERNEL_NOOP
:
2160 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2162 case LTTNG_KERNEL_SYSCALL
:
2163 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2165 case LTTNG_KERNEL_ALL
:
2179 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2181 static int cmd_disable_channel(struct ltt_session
*session
,
2182 int domain
, char *channel_name
)
2185 struct ltt_ust_session
*usess
;
2187 usess
= session
->ust_session
;
2190 case LTTNG_DOMAIN_KERNEL
:
2192 ret
= channel_kernel_disable(session
->kernel_session
,
2194 if (ret
!= LTTCOMM_OK
) {
2198 kernel_wait_quiescent(kernel_tracer_fd
);
2201 case LTTNG_DOMAIN_UST
:
2203 struct ltt_ust_channel
*uchan
;
2204 struct lttng_ht
*chan_ht
;
2206 chan_ht
= usess
->domain_global
.channels
;
2208 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2209 if (uchan
== NULL
) {
2210 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2214 ret
= channel_ust_disable(usess
, domain
, uchan
);
2215 if (ret
!= LTTCOMM_OK
) {
2221 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2222 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2223 case LTTNG_DOMAIN_UST_PID
:
2226 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2237 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2239 static int cmd_enable_channel(struct ltt_session
*session
,
2240 int domain
, struct lttng_channel
*attr
)
2243 struct ltt_ust_session
*usess
= session
->ust_session
;
2244 struct lttng_ht
*chan_ht
;
2246 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2249 case LTTNG_DOMAIN_KERNEL
:
2251 struct ltt_kernel_channel
*kchan
;
2253 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2254 session
->kernel_session
);
2255 if (kchan
== NULL
) {
2256 ret
= channel_kernel_create(session
->kernel_session
,
2257 attr
, kernel_poll_pipe
[1]);
2259 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2262 if (ret
!= LTTCOMM_OK
) {
2266 kernel_wait_quiescent(kernel_tracer_fd
);
2269 case LTTNG_DOMAIN_UST
:
2271 struct ltt_ust_channel
*uchan
;
2273 chan_ht
= usess
->domain_global
.channels
;
2275 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2276 if (uchan
== NULL
) {
2277 ret
= channel_ust_create(usess
, domain
, attr
);
2279 ret
= channel_ust_enable(usess
, domain
, uchan
);
2284 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2285 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2286 case LTTNG_DOMAIN_UST_PID
:
2289 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2298 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2300 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2301 char *channel_name
, char *event_name
)
2306 case LTTNG_DOMAIN_KERNEL
:
2308 struct ltt_kernel_channel
*kchan
;
2309 struct ltt_kernel_session
*ksess
;
2311 ksess
= session
->kernel_session
;
2313 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2314 if (kchan
== NULL
) {
2315 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2319 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2320 if (ret
!= LTTCOMM_OK
) {
2324 kernel_wait_quiescent(kernel_tracer_fd
);
2327 case LTTNG_DOMAIN_UST
:
2329 struct ltt_ust_channel
*uchan
;
2330 struct ltt_ust_session
*usess
;
2332 usess
= session
->ust_session
;
2334 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2336 if (uchan
== NULL
) {
2337 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2341 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2342 if (ret
!= LTTCOMM_OK
) {
2346 DBG3("Disable UST event %s in channel %s completed", event_name
,
2351 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2352 case LTTNG_DOMAIN_UST_PID
:
2353 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2367 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2369 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2375 case LTTNG_DOMAIN_KERNEL
:
2377 struct ltt_kernel_session
*ksess
;
2378 struct ltt_kernel_channel
*kchan
;
2380 ksess
= session
->kernel_session
;
2382 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2383 if (kchan
== NULL
) {
2384 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2388 ret
= event_kernel_disable_all(ksess
, kchan
);
2389 if (ret
!= LTTCOMM_OK
) {
2393 kernel_wait_quiescent(kernel_tracer_fd
);
2396 case LTTNG_DOMAIN_UST
:
2398 struct ltt_ust_session
*usess
;
2399 struct ltt_ust_channel
*uchan
;
2401 usess
= session
->ust_session
;
2403 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2405 if (uchan
== NULL
) {
2406 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2410 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2415 DBG3("Disable all UST events in channel %s completed", channel_name
);
2420 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2421 case LTTNG_DOMAIN_UST_PID
:
2422 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2436 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2438 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2439 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2444 case LTTNG_DOMAIN_KERNEL
:
2445 /* Add kernel context to kernel tracer */
2446 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2447 event_name
, channel_name
);
2448 if (ret
!= LTTCOMM_OK
) {
2452 case LTTNG_DOMAIN_UST
:
2454 struct ltt_ust_session
*usess
= session
->ust_session
;
2456 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2457 if (ret
!= LTTCOMM_OK
) {
2463 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2464 case LTTNG_DOMAIN_UST_PID
:
2465 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2479 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2481 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2482 char *channel_name
, struct lttng_event
*event
)
2485 struct lttng_channel
*attr
;
2486 struct ltt_ust_session
*usess
= session
->ust_session
;
2489 case LTTNG_DOMAIN_KERNEL
:
2491 struct ltt_kernel_channel
*kchan
;
2493 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2494 session
->kernel_session
);
2495 if (kchan
== NULL
) {
2496 attr
= channel_new_default_attr(domain
);
2498 ret
= LTTCOMM_FATAL
;
2501 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2503 /* This call will notify the kernel thread */
2504 ret
= channel_kernel_create(session
->kernel_session
,
2505 attr
, kernel_poll_pipe
[1]);
2506 if (ret
!= LTTCOMM_OK
) {
2513 /* Get the newly created kernel channel pointer */
2514 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2515 session
->kernel_session
);
2516 if (kchan
== NULL
) {
2517 /* This sould not happen... */
2518 ret
= LTTCOMM_FATAL
;
2522 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2524 if (ret
!= LTTCOMM_OK
) {
2528 kernel_wait_quiescent(kernel_tracer_fd
);
2531 case LTTNG_DOMAIN_UST
:
2533 struct lttng_channel
*attr
;
2534 struct ltt_ust_channel
*uchan
;
2536 /* Get channel from global UST domain */
2537 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2539 if (uchan
== NULL
) {
2540 /* Create default channel */
2541 attr
= channel_new_default_attr(domain
);
2543 ret
= LTTCOMM_FATAL
;
2546 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2547 attr
->name
[NAME_MAX
- 1] = '\0';
2549 ret
= channel_ust_create(usess
, domain
, attr
);
2550 if (ret
!= LTTCOMM_OK
) {
2556 /* Get the newly created channel reference back */
2557 uchan
= trace_ust_find_channel_by_name(
2558 usess
->domain_global
.channels
, channel_name
);
2559 if (uchan
== NULL
) {
2560 /* Something is really wrong */
2561 ret
= LTTCOMM_FATAL
;
2566 /* At this point, the session and channel exist on the tracer */
2567 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2568 if (ret
!= LTTCOMM_OK
) {
2574 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2575 case LTTNG_DOMAIN_UST_PID
:
2576 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2590 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2592 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2593 char *channel_name
, int event_type
)
2596 struct ltt_kernel_channel
*kchan
;
2599 case LTTNG_DOMAIN_KERNEL
:
2600 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2601 session
->kernel_session
);
2602 if (kchan
== NULL
) {
2603 /* This call will notify the kernel thread */
2604 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2605 kernel_poll_pipe
[1]);
2606 if (ret
!= LTTCOMM_OK
) {
2610 /* Get the newly created kernel channel pointer */
2611 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2612 session
->kernel_session
);
2613 if (kchan
== NULL
) {
2614 /* This sould not happen... */
2615 ret
= LTTCOMM_FATAL
;
2621 switch (event_type
) {
2622 case LTTNG_EVENT_SYSCALL
:
2623 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2624 kchan
, kernel_tracer_fd
);
2626 case LTTNG_EVENT_TRACEPOINT
:
2628 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2629 * events already registered to the channel.
2631 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2632 kchan
, kernel_tracer_fd
);
2634 case LTTNG_EVENT_ALL
:
2635 /* Enable syscalls and tracepoints */
2636 ret
= event_kernel_enable_all(session
->kernel_session
,
2637 kchan
, kernel_tracer_fd
);
2640 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2644 /* Manage return value */
2645 if (ret
!= LTTCOMM_OK
) {
2649 kernel_wait_quiescent(kernel_tracer_fd
);
2651 case LTTNG_DOMAIN_UST
:
2653 struct lttng_channel
*attr
;
2654 struct ltt_ust_channel
*uchan
;
2655 struct ltt_ust_session
*usess
= session
->ust_session
;
2657 /* Get channel from global UST domain */
2658 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2660 if (uchan
== NULL
) {
2661 /* Create default channel */
2662 attr
= channel_new_default_attr(domain
);
2664 ret
= LTTCOMM_FATAL
;
2667 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2668 attr
->name
[NAME_MAX
- 1] = '\0';
2670 /* Use the internal command enable channel */
2671 ret
= channel_ust_create(usess
, domain
, attr
);
2672 if (ret
!= LTTCOMM_OK
) {
2678 /* Get the newly created channel reference back */
2679 uchan
= trace_ust_find_channel_by_name(
2680 usess
->domain_global
.channels
, channel_name
);
2681 if (uchan
== NULL
) {
2682 /* Something is really wrong */
2683 ret
= LTTCOMM_FATAL
;
2688 /* At this point, the session and channel exist on the tracer */
2690 switch (event_type
) {
2691 case LTTNG_EVENT_ALL
:
2692 case LTTNG_EVENT_TRACEPOINT
:
2693 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2694 if (ret
!= LTTCOMM_OK
) {
2699 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2703 /* Manage return value */
2704 if (ret
!= LTTCOMM_OK
) {
2711 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2712 case LTTNG_DOMAIN_UST_PID
:
2713 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2727 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2729 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2732 ssize_t nb_events
= 0;
2735 case LTTNG_DOMAIN_KERNEL
:
2736 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2737 if (nb_events
< 0) {
2738 ret
= LTTCOMM_KERN_LIST_FAIL
;
2742 case LTTNG_DOMAIN_UST
:
2743 nb_events
= ust_app_list_events(events
);
2744 if (nb_events
< 0) {
2745 ret
= LTTCOMM_UST_LIST_FAIL
;
2757 /* Return negative value to differentiate return code */
2762 * Command LTTNG_START_TRACE processed by the client thread.
2764 static int cmd_start_trace(struct ltt_session
*session
)
2767 struct ltt_kernel_session
*ksession
;
2768 struct ltt_ust_session
*usess
;
2771 ksession
= session
->kernel_session
;
2772 usess
= session
->ust_session
;
2774 if (session
->enabled
) {
2775 ret
= LTTCOMM_UST_START_FAIL
;
2779 session
->enabled
= 1;
2781 /* Kernel tracing */
2782 if (ksession
!= NULL
) {
2783 struct ltt_kernel_channel
*kchan
;
2785 /* Open kernel metadata */
2786 if (ksession
->metadata
== NULL
) {
2787 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2789 ret
= LTTCOMM_KERN_META_FAIL
;
2794 /* Open kernel metadata stream */
2795 if (ksession
->metadata_stream_fd
== 0) {
2796 ret
= kernel_open_metadata_stream(ksession
);
2798 ERR("Kernel create metadata stream failed");
2799 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2804 /* For each channel */
2805 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2806 if (kchan
->stream_count
== 0) {
2807 ret
= kernel_open_channel_stream(kchan
);
2809 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2812 /* Update the stream global counter */
2813 ksession
->stream_count_global
+= ret
;
2817 /* Setup kernel consumer socket and send fds to it */
2818 ret
= init_kernel_tracing(ksession
);
2820 ret
= LTTCOMM_KERN_START_FAIL
;
2824 /* This start the kernel tracing */
2825 ret
= kernel_start_session(ksession
);
2827 ret
= LTTCOMM_KERN_START_FAIL
;
2831 /* Quiescent wait after starting trace */
2832 kernel_wait_quiescent(kernel_tracer_fd
);
2835 /* Flag session that trace should start automatically */
2837 usess
->start_trace
= 1;
2839 ret
= ust_app_start_trace_all(usess
);
2841 ret
= LTTCOMM_UST_START_FAIL
;
2853 * Command LTTNG_STOP_TRACE processed by the client thread.
2855 static int cmd_stop_trace(struct ltt_session
*session
)
2858 struct ltt_kernel_channel
*kchan
;
2859 struct ltt_kernel_session
*ksession
;
2860 struct ltt_ust_session
*usess
;
2863 ksession
= session
->kernel_session
;
2864 usess
= session
->ust_session
;
2866 if (!session
->enabled
) {
2867 ret
= LTTCOMM_UST_STOP_FAIL
;
2871 session
->enabled
= 0;
2874 if (ksession
!= NULL
) {
2875 DBG("Stop kernel tracing");
2877 /* Flush all buffers before stopping */
2878 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2880 ERR("Kernel metadata flush failed");
2883 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2884 ret
= kernel_flush_buffer(kchan
);
2886 ERR("Kernel flush buffer error");
2890 ret
= kernel_stop_session(ksession
);
2892 ret
= LTTCOMM_KERN_STOP_FAIL
;
2896 kernel_wait_quiescent(kernel_tracer_fd
);
2900 usess
->start_trace
= 0;
2902 ret
= ust_app_stop_trace_all(usess
);
2904 ret
= LTTCOMM_UST_STOP_FAIL
;
2916 * Command LTTNG_CREATE_SESSION processed by the client thread.
2918 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2922 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2923 if (ret
!= LTTCOMM_OK
) {
2934 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2936 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2940 /* Clean kernel session teardown */
2941 teardown_kernel_session(session
);
2942 /* UST session teardown */
2943 teardown_ust_session(session
);
2946 * Must notify the kernel thread here to update it's poll setin order
2947 * to remove the channel(s)' fd just destroyed.
2949 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2951 perror("write kernel poll pipe");
2954 ret
= session_destroy(session
);
2960 * Command LTTNG_CALIBRATE processed by the client thread.
2962 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2967 case LTTNG_DOMAIN_KERNEL
:
2969 struct lttng_kernel_calibrate kcalibrate
;
2971 kcalibrate
.type
= calibrate
->type
;
2972 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2974 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2979 case LTTNG_DOMAIN_UST
:
2981 struct lttng_ust_calibrate ucalibrate
;
2983 ucalibrate
.type
= calibrate
->type
;
2984 ret
= ust_app_calibrate_glb(&ucalibrate
);
2986 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3003 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3005 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3011 case LTTNG_DOMAIN_KERNEL
:
3012 /* Can't register a consumer if there is already one */
3013 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3014 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3018 sock
= lttcomm_connect_unix_sock(sock_path
);
3020 ret
= LTTCOMM_CONNECT_FAIL
;
3024 session
->kernel_session
->consumer_fd
= sock
;
3027 /* TODO: Userspace tracing */
3039 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3041 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3042 struct lttng_domain
**domains
)
3047 if (session
->kernel_session
!= NULL
) {
3048 DBG3("Listing domains found kernel domain");
3052 if (session
->ust_session
!= NULL
) {
3053 DBG3("Listing domains found UST global domain");
3057 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3058 if (*domains
== NULL
) {
3059 ret
= -LTTCOMM_FATAL
;
3063 if (session
->kernel_session
!= NULL
) {
3064 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3068 if (session
->ust_session
!= NULL
) {
3069 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3080 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3082 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3083 struct lttng_channel
**channels
)
3086 ssize_t nb_chan
= 0;
3089 case LTTNG_DOMAIN_KERNEL
:
3090 if (session
->kernel_session
!= NULL
) {
3091 nb_chan
= session
->kernel_session
->channel_count
;
3093 DBG3("Number of kernel channels %zd", nb_chan
);
3095 case LTTNG_DOMAIN_UST
:
3096 if (session
->ust_session
!= NULL
) {
3097 nb_chan
= lttng_ht_get_count(
3098 session
->ust_session
->domain_global
.channels
);
3100 DBG3("Number of UST global channels %zd", nb_chan
);
3109 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3110 if (*channels
== NULL
) {
3111 ret
= -LTTCOMM_FATAL
;
3115 list_lttng_channels(domain
, session
, *channels
);
3127 * Command LTTNG_LIST_EVENTS processed by the client thread.
3129 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3130 char *channel_name
, struct lttng_event
**events
)
3133 ssize_t nb_event
= 0;
3136 case LTTNG_DOMAIN_KERNEL
:
3137 if (session
->kernel_session
!= NULL
) {
3138 nb_event
= list_lttng_kernel_events(channel_name
,
3139 session
->kernel_session
, events
);
3142 case LTTNG_DOMAIN_UST
:
3144 if (session
->ust_session
!= NULL
) {
3145 nb_event
= list_lttng_ust_global_events(channel_name
,
3146 &session
->ust_session
->domain_global
, events
);
3162 * Process the command requested by the lttng client within the command
3163 * context structure. This function make sure that the return structure (llm)
3164 * is set and ready for transmission before returning.
3166 * Return any error encountered or 0 for success.
3168 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3170 int ret
= LTTCOMM_OK
;
3171 int need_tracing_session
= 1;
3174 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3176 switch (cmd_ctx
->lsm
->cmd_type
) {
3177 case LTTNG_CREATE_SESSION
:
3178 case LTTNG_DESTROY_SESSION
:
3179 case LTTNG_LIST_SESSIONS
:
3180 case LTTNG_LIST_DOMAINS
:
3181 case LTTNG_START_TRACE
:
3182 case LTTNG_STOP_TRACE
:
3189 if (opt_no_kernel
&& need_domain
3190 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3191 ret
= LTTCOMM_KERN_NA
;
3196 * Check for command that don't needs to allocate a returned payload. We do
3197 * this here so we don't have to make the call for no payload at each
3200 switch(cmd_ctx
->lsm
->cmd_type
) {
3201 case LTTNG_LIST_SESSIONS
:
3202 case LTTNG_LIST_TRACEPOINTS
:
3203 case LTTNG_LIST_DOMAINS
:
3204 case LTTNG_LIST_CHANNELS
:
3205 case LTTNG_LIST_EVENTS
:
3208 /* Setup lttng message with no payload */
3209 ret
= setup_lttng_msg(cmd_ctx
, 0);
3211 /* This label does not try to unlock the session */
3212 goto init_setup_error
;
3216 /* Commands that DO NOT need a session. */
3217 switch (cmd_ctx
->lsm
->cmd_type
) {
3218 case LTTNG_CREATE_SESSION
:
3219 case LTTNG_CALIBRATE
:
3220 case LTTNG_LIST_SESSIONS
:
3221 case LTTNG_LIST_TRACEPOINTS
:
3222 need_tracing_session
= 0;
3225 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3226 session_lock_list();
3227 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3228 session_unlock_list();
3229 if (cmd_ctx
->session
== NULL
) {
3230 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3231 ret
= LTTCOMM_SESS_NOT_FOUND
;
3233 /* If no session name specified */
3234 ret
= LTTCOMM_SELECT_SESS
;
3238 /* Acquire lock for the session */
3239 session_lock(cmd_ctx
->session
);
3248 * Check domain type for specific "pre-action".
3250 switch (cmd_ctx
->lsm
->domain
.type
) {
3251 case LTTNG_DOMAIN_KERNEL
:
3253 ret
= LTTCOMM_KERN_NA
;
3257 /* Kernel tracer check */
3258 if (kernel_tracer_fd
== -1) {
3259 /* Basically, load kernel tracer modules */
3260 ret
= init_kernel_tracer();
3266 /* Need a session for kernel command */
3267 if (need_tracing_session
) {
3268 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3269 ret
= create_kernel_session(cmd_ctx
->session
);
3271 ret
= LTTCOMM_KERN_SESS_FAIL
;
3276 /* Start the kernel consumer daemon */
3277 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3278 if (kconsumer_data
.pid
== 0 &&
3279 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3280 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3281 ret
= start_consumerd(&kconsumer_data
);
3283 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3287 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3291 case LTTNG_DOMAIN_UST
:
3293 if (need_tracing_session
) {
3294 if (cmd_ctx
->session
->ust_session
== NULL
) {
3295 ret
= create_ust_session(cmd_ctx
->session
,
3296 &cmd_ctx
->lsm
->domain
);
3297 if (ret
!= LTTCOMM_OK
) {
3301 /* Start the UST consumer daemons */
3303 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3304 if (consumerd64_bin
[0] != '\0' &&
3305 ustconsumer64_data
.pid
== 0 &&
3306 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3307 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3308 ret
= start_consumerd(&ustconsumer64_data
);
3310 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3311 ust_consumerd64_fd
= -EINVAL
;
3315 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3317 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3320 if (consumerd32_bin
[0] != '\0' &&
3321 ustconsumer32_data
.pid
== 0 &&
3322 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3323 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3324 ret
= start_consumerd(&ustconsumer32_data
);
3326 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3327 ust_consumerd32_fd
= -EINVAL
;
3330 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3332 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3343 * Check that the UID or GID match that of the tracing session.
3344 * The root user can interact with all sessions.
3346 if (need_tracing_session
) {
3347 if (!session_access_ok(cmd_ctx
->session
,
3348 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3349 ret
= LTTCOMM_EPERM
;
3354 /* Process by command type */
3355 switch (cmd_ctx
->lsm
->cmd_type
) {
3356 case LTTNG_ADD_CONTEXT
:
3358 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3359 cmd_ctx
->lsm
->u
.context
.channel_name
,
3360 cmd_ctx
->lsm
->u
.context
.event_name
,
3361 &cmd_ctx
->lsm
->u
.context
.ctx
);
3364 case LTTNG_DISABLE_CHANNEL
:
3366 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3367 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3370 case LTTNG_DISABLE_EVENT
:
3372 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3373 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3374 cmd_ctx
->lsm
->u
.disable
.name
);
3377 case LTTNG_DISABLE_ALL_EVENT
:
3379 DBG("Disabling all events");
3381 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3382 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3385 case LTTNG_ENABLE_CHANNEL
:
3387 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3388 &cmd_ctx
->lsm
->u
.channel
.chan
);
3391 case LTTNG_ENABLE_EVENT
:
3393 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3394 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3395 &cmd_ctx
->lsm
->u
.enable
.event
);
3398 case LTTNG_ENABLE_ALL_EVENT
:
3400 DBG("Enabling all events");
3402 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3403 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3404 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3407 case LTTNG_LIST_TRACEPOINTS
:
3409 struct lttng_event
*events
;
3412 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3413 if (nb_events
< 0) {
3419 * Setup lttng message with payload size set to the event list size in
3420 * bytes and then copy list into the llm payload.
3422 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3428 /* Copy event list into message payload */
3429 memcpy(cmd_ctx
->llm
->payload
, events
,
3430 sizeof(struct lttng_event
) * nb_events
);
3437 case LTTNG_START_TRACE
:
3439 ret
= cmd_start_trace(cmd_ctx
->session
);
3442 case LTTNG_STOP_TRACE
:
3444 ret
= cmd_stop_trace(cmd_ctx
->session
);
3447 case LTTNG_CREATE_SESSION
:
3449 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3450 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3453 case LTTNG_DESTROY_SESSION
:
3455 ret
= cmd_destroy_session(cmd_ctx
->session
,
3456 cmd_ctx
->lsm
->session
.name
);
3459 case LTTNG_LIST_DOMAINS
:
3462 struct lttng_domain
*domains
;
3464 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3470 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3475 /* Copy event list into message payload */
3476 memcpy(cmd_ctx
->llm
->payload
, domains
,
3477 nb_dom
* sizeof(struct lttng_domain
));
3484 case LTTNG_LIST_CHANNELS
:
3487 struct lttng_channel
*channels
;
3489 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3490 cmd_ctx
->session
, &channels
);
3496 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3501 /* Copy event list into message payload */
3502 memcpy(cmd_ctx
->llm
->payload
, channels
,
3503 nb_chan
* sizeof(struct lttng_channel
));
3510 case LTTNG_LIST_EVENTS
:
3513 struct lttng_event
*events
= NULL
;
3515 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3516 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3522 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3527 /* Copy event list into message payload */
3528 memcpy(cmd_ctx
->llm
->payload
, events
,
3529 nb_event
* sizeof(struct lttng_event
));
3536 case LTTNG_LIST_SESSIONS
:
3538 unsigned int nr_sessions
;
3540 session_lock_list();
3541 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3543 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3545 session_unlock_list();
3549 /* Filled the session array */
3550 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3551 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3553 session_unlock_list();
3558 case LTTNG_CALIBRATE
:
3560 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3561 &cmd_ctx
->lsm
->u
.calibrate
);
3564 case LTTNG_REGISTER_CONSUMER
:
3566 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3567 cmd_ctx
->lsm
->u
.reg
.path
);
3576 if (cmd_ctx
->llm
== NULL
) {
3577 DBG("Missing llm structure. Allocating one.");
3578 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3582 /* Set return code */
3583 cmd_ctx
->llm
->ret_code
= ret
;
3585 if (cmd_ctx
->session
) {
3586 session_unlock(cmd_ctx
->session
);
3593 * This thread manage all clients request using the unix client socket for
3596 static void *thread_manage_clients(void *data
)
3598 int sock
= -1, ret
, i
, pollfd
;
3599 uint32_t revents
, nb_fd
;
3600 struct command_ctx
*cmd_ctx
= NULL
;
3601 struct lttng_poll_event events
;
3603 DBG("[thread] Manage client started");
3605 rcu_register_thread();
3607 ret
= lttcomm_listen_unix_sock(client_sock
);
3613 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3614 * more will be added to this poll set.
3616 ret
= create_thread_poll_set(&events
, 2);
3621 /* Add the application registration socket */
3622 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3628 * Notify parent pid that we are ready to accept command for client side.
3630 if (opt_sig_parent
) {
3631 kill(ppid
, SIGUSR1
);
3635 DBG("Accepting client command ...");
3637 nb_fd
= LTTNG_POLL_GETNB(&events
);
3639 /* Inifinite blocking call, waiting for transmission */
3641 ret
= lttng_poll_wait(&events
, -1);
3644 * Restart interrupted system call.
3646 if (errno
== EINTR
) {
3652 for (i
= 0; i
< nb_fd
; i
++) {
3653 /* Fetch once the poll data */
3654 revents
= LTTNG_POLL_GETEV(&events
, i
);
3655 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3657 /* Thread quit pipe has been closed. Killing thread. */
3658 ret
= check_thread_quit_pipe(pollfd
, revents
);
3663 /* Event on the registration socket */
3664 if (pollfd
== client_sock
) {
3665 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3666 ERR("Client socket poll error");
3672 DBG("Wait for client response");
3674 sock
= lttcomm_accept_unix_sock(client_sock
);
3679 /* Set socket option for credentials retrieval */
3680 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3685 /* Allocate context command to process the client request */
3686 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3687 if (cmd_ctx
== NULL
) {
3688 perror("zmalloc cmd_ctx");
3692 /* Allocate data buffer for reception */
3693 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3694 if (cmd_ctx
->lsm
== NULL
) {
3695 perror("zmalloc cmd_ctx->lsm");
3699 cmd_ctx
->llm
= NULL
;
3700 cmd_ctx
->session
= NULL
;
3703 * Data is received from the lttng client. The struct
3704 * lttcomm_session_msg (lsm) contains the command and data request of
3707 DBG("Receiving data from client ...");
3708 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3709 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3711 DBG("Nothing recv() from client... continuing");
3717 // TODO: Validate cmd_ctx including sanity check for
3718 // security purpose.
3720 rcu_thread_online();
3722 * This function dispatch the work to the kernel or userspace tracer
3723 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3724 * informations for the client. The command context struct contains
3725 * everything this function may needs.
3727 ret
= process_client_msg(cmd_ctx
);
3728 rcu_thread_offline();
3731 * TODO: Inform client somehow of the fatal error. At
3732 * this point, ret < 0 means that a zmalloc failed
3733 * (ENOMEM). Error detected but still accept command.
3735 clean_command_ctx(&cmd_ctx
);
3739 DBG("Sending response (size: %d, retcode: %s)",
3740 cmd_ctx
->lttng_msg_size
,
3741 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3742 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3744 ERR("Failed to send data back to client");
3747 /* End of transmission */
3750 clean_command_ctx(&cmd_ctx
);
3754 DBG("Client thread dying");
3755 unlink(client_unix_sock_path
);
3763 lttng_poll_clean(&events
);
3764 clean_command_ctx(&cmd_ctx
);
3766 rcu_unregister_thread();
3772 * usage function on stderr
3774 static void usage(void)
3776 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3777 fprintf(stderr
, " -h, --help Display this usage.\n");
3778 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3779 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3780 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3781 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3782 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3783 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3784 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3785 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3786 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3787 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3788 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3789 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3790 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3791 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3792 fprintf(stderr
, " -V, --version Show version number.\n");
3793 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3794 fprintf(stderr
, " -q, --quiet No output at all.\n");
3795 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3796 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3797 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3801 * daemon argument parsing
3803 static int parse_args(int argc
, char **argv
)
3807 static struct option long_options
[] = {
3808 { "client-sock", 1, 0, 'c' },
3809 { "apps-sock", 1, 0, 'a' },
3810 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3811 { "kconsumerd-err-sock", 1, 0, 'E' },
3812 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3813 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3814 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3815 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3816 { "consumerd32-path", 1, 0, 'u' },
3817 { "consumerd32-libdir", 1, 0, 'U' },
3818 { "consumerd64-path", 1, 0, 't' },
3819 { "consumerd64-libdir", 1, 0, 'T' },
3820 { "daemonize", 0, 0, 'd' },
3821 { "sig-parent", 0, 0, 'S' },
3822 { "help", 0, 0, 'h' },
3823 { "group", 1, 0, 'g' },
3824 { "version", 0, 0, 'V' },
3825 { "quiet", 0, 0, 'q' },
3826 { "verbose", 0, 0, 'v' },
3827 { "verbose-consumer", 0, 0, 'Z' },
3828 { "no-kernel", 0, 0, 'N' },
3833 int option_index
= 0;
3834 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3835 long_options
, &option_index
);
3842 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3844 fprintf(stderr
, " with arg %s\n", optarg
);
3848 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3851 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3857 opt_tracing_group
= optarg
;
3863 fprintf(stdout
, "%s\n", VERSION
);
3869 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3872 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3875 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3878 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3881 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3884 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3893 /* Verbose level can increase using multiple -v */
3897 opt_verbose_consumer
+= 1;
3900 consumerd32_bin
= optarg
;
3903 consumerd32_libdir
= optarg
;
3906 consumerd64_bin
= optarg
;
3909 consumerd64_libdir
= optarg
;
3912 /* Unknown option or other error.
3913 * Error is printed by getopt, just return */
3922 * Creates the two needed socket by the daemon.
3923 * apps_sock - The communication socket for all UST apps.
3924 * client_sock - The communication of the cli tool (lttng).
3926 static int init_daemon_socket(void)
3931 old_umask
= umask(0);
3933 /* Create client tool unix socket */
3934 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3935 if (client_sock
< 0) {
3936 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3941 /* File permission MUST be 660 */
3942 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3944 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3949 /* Create the application unix socket */
3950 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3951 if (apps_sock
< 0) {
3952 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3957 /* File permission MUST be 666 */
3958 ret
= chmod(apps_unix_sock_path
,
3959 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3961 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3972 * Check if the global socket is available, and if a daemon is answering at the
3973 * other side. If yes, error is returned.
3975 static int check_existing_daemon(void)
3977 /* Is there anybody out there ? */
3978 if (lttng_session_daemon_alive()) {
3986 * Set the tracing group gid onto the client socket.
3988 * Race window between mkdir and chown is OK because we are going from more
3989 * permissive (root.root) to less permissive (root.tracing).
3991 static int set_permissions(char *rundir
)
3996 gid
= allowed_group();
3998 WARN("No tracing group detected");
4003 /* Set lttng run dir */
4004 ret
= chown(rundir
, 0, gid
);
4006 ERR("Unable to set group on %s", rundir
);
4010 /* Ensure tracing group can search the run dir */
4011 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4013 ERR("Unable to set permissions on %s", rundir
);
4017 /* lttng client socket path */
4018 ret
= chown(client_unix_sock_path
, 0, gid
);
4020 ERR("Unable to set group on %s", client_unix_sock_path
);
4024 /* kconsumer error socket path */
4025 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4027 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4031 /* 64-bit ustconsumer error socket path */
4032 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4034 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4038 /* 32-bit ustconsumer compat32 error socket path */
4039 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4041 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4045 DBG("All permissions are set");
4052 * Create the pipe used to wake up the kernel thread.
4054 static int create_kernel_poll_pipe(void)
4056 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4060 * Create the application command pipe to wake thread_manage_apps.
4062 static int create_apps_cmd_pipe(void)
4064 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4068 * Create the lttng run directory needed for all global sockets and pipe.
4070 static int create_lttng_rundir(const char *rundir
)
4074 DBG3("Creating LTTng run directory: %s", rundir
);
4076 ret
= mkdir(rundir
, S_IRWXU
);
4078 if (errno
!= EEXIST
) {
4079 ERR("Unable to create %s", rundir
);
4091 * Setup sockets and directory needed by the kconsumerd communication with the
4094 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4098 char path
[PATH_MAX
];
4100 switch (consumer_data
->type
) {
4101 case LTTNG_CONSUMER_KERNEL
:
4102 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4104 case LTTNG_CONSUMER64_UST
:
4105 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4107 case LTTNG_CONSUMER32_UST
:
4108 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4111 ERR("Consumer type unknown");
4116 DBG2("Creating consumer directory: %s", path
);
4118 ret
= mkdir(path
, S_IRWXU
);
4120 if (errno
!= EEXIST
) {
4121 ERR("Failed to create %s", path
);
4127 /* Create the kconsumerd error unix socket */
4128 consumer_data
->err_sock
=
4129 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4130 if (consumer_data
->err_sock
< 0) {
4131 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4136 /* File permission MUST be 660 */
4137 ret
= chmod(consumer_data
->err_unix_sock_path
,
4138 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4140 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4150 * Signal handler for the daemon
4152 * Simply stop all worker threads, leaving main() return gracefully after
4153 * joining all threads and calling cleanup().
4155 static void sighandler(int sig
)
4159 DBG("SIGPIPE caught");
4162 DBG("SIGINT caught");
4166 DBG("SIGTERM caught");
4175 * Setup signal handler for :
4176 * SIGINT, SIGTERM, SIGPIPE
4178 static int set_signal_handler(void)
4181 struct sigaction sa
;
4184 if ((ret
= sigemptyset(&sigset
)) < 0) {
4185 perror("sigemptyset");
4189 sa
.sa_handler
= sighandler
;
4190 sa
.sa_mask
= sigset
;
4192 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4193 perror("sigaction");
4197 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4198 perror("sigaction");
4202 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4203 perror("sigaction");
4207 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4213 * Set open files limit to unlimited. This daemon can open a large number of
4214 * file descriptors in order to consumer multiple kernel traces.
4216 static void set_ulimit(void)
4221 /* The kernel does not allowed an infinite limit for open files */
4222 lim
.rlim_cur
= 65535;
4223 lim
.rlim_max
= 65535;
4225 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4227 perror("failed to set open files limit");
4234 int main(int argc
, char **argv
)
4238 const char *home_path
;
4240 init_kernel_workarounds();
4242 rcu_register_thread();
4244 /* Create thread quit pipe */
4245 if ((ret
= init_thread_quit_pipe()) < 0) {
4249 setup_consumerd_path();
4251 /* Parse arguments */
4253 if ((ret
= parse_args(argc
, argv
) < 0)) {
4266 /* Check if daemon is UID = 0 */
4267 is_root
= !getuid();
4270 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4272 /* Create global run dir with root access */
4273 ret
= create_lttng_rundir(rundir
);
4278 if (strlen(apps_unix_sock_path
) == 0) {
4279 snprintf(apps_unix_sock_path
, PATH_MAX
,
4280 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4283 if (strlen(client_unix_sock_path
) == 0) {
4284 snprintf(client_unix_sock_path
, PATH_MAX
,
4285 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4288 /* Set global SHM for ust */
4289 if (strlen(wait_shm_path
) == 0) {
4290 snprintf(wait_shm_path
, PATH_MAX
,
4291 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4294 /* Setup kernel consumerd path */
4295 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4296 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4297 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4298 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4300 DBG2("Kernel consumer err path: %s",
4301 kconsumer_data
.err_unix_sock_path
);
4302 DBG2("Kernel consumer cmd path: %s",
4303 kconsumer_data
.cmd_unix_sock_path
);
4305 home_path
= get_home_dir();
4306 if (home_path
== NULL
) {
4307 /* TODO: Add --socket PATH option */
4308 ERR("Can't get HOME directory for sockets creation.");
4314 * Create rundir from home path. This will create something like
4317 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4323 ret
= create_lttng_rundir(rundir
);
4328 if (strlen(apps_unix_sock_path
) == 0) {
4329 snprintf(apps_unix_sock_path
, PATH_MAX
,
4330 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4333 /* Set the cli tool unix socket path */
4334 if (strlen(client_unix_sock_path
) == 0) {
4335 snprintf(client_unix_sock_path
, PATH_MAX
,
4336 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4339 /* Set global SHM for ust */
4340 if (strlen(wait_shm_path
) == 0) {
4341 snprintf(wait_shm_path
, PATH_MAX
,
4342 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4346 DBG("Client socket path %s", client_unix_sock_path
);
4347 DBG("Application socket path %s", apps_unix_sock_path
);
4348 DBG("LTTng run directory path: %s", rundir
);
4350 /* 32 bits consumerd path setup */
4351 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4352 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4353 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4354 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4356 DBG2("UST consumer 32 bits err path: %s",
4357 ustconsumer32_data
.err_unix_sock_path
);
4358 DBG2("UST consumer 32 bits cmd path: %s",
4359 ustconsumer32_data
.cmd_unix_sock_path
);
4361 /* 64 bits consumerd path setup */
4362 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4363 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4364 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4365 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4367 DBG2("UST consumer 64 bits err path: %s",
4368 ustconsumer64_data
.err_unix_sock_path
);
4369 DBG2("UST consumer 64 bits cmd path: %s",
4370 ustconsumer64_data
.cmd_unix_sock_path
);
4373 * See if daemon already exist.
4375 if ((ret
= check_existing_daemon()) < 0) {
4376 ERR("Already running daemon.\n");
4378 * We do not goto exit because we must not cleanup()
4379 * because a daemon is already running.
4384 /* After this point, we can safely call cleanup() with "goto exit" */
4387 * These actions must be executed as root. We do that *after* setting up
4388 * the sockets path because we MUST make the check for another daemon using
4389 * those paths *before* trying to set the kernel consumer sockets and init
4393 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4398 /* Setup kernel tracer */
4399 if (!opt_no_kernel
) {
4400 init_kernel_tracer();
4403 /* Set ulimit for open files */
4407 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4412 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4417 if ((ret
= set_signal_handler()) < 0) {
4421 /* Setup the needed unix socket */
4422 if ((ret
= init_daemon_socket()) < 0) {
4426 /* Set credentials to socket */
4427 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4431 /* Get parent pid if -S, --sig-parent is specified. */
4432 if (opt_sig_parent
) {
4436 /* Setup the kernel pipe for waking up the kernel thread */
4437 if ((ret
= create_kernel_poll_pipe()) < 0) {
4441 /* Setup the thread apps communication pipe. */
4442 if ((ret
= create_apps_cmd_pipe()) < 0) {
4446 /* Init UST command queue. */
4447 cds_wfq_init(&ust_cmd_queue
.queue
);
4449 /* Init UST app hash table */
4453 * Get session list pointer. This pointer MUST NOT be free(). This list is
4454 * statically declared in session.c
4456 session_list_ptr
= session_get_list();
4458 /* Set up max poll set size */
4459 lttng_poll_set_max_size();
4461 /* Create thread to manage the client socket */
4462 ret
= pthread_create(&client_thread
, NULL
,
4463 thread_manage_clients
, (void *) NULL
);
4465 perror("pthread_create clients");
4469 /* Create thread to dispatch registration */
4470 ret
= pthread_create(&dispatch_thread
, NULL
,
4471 thread_dispatch_ust_registration
, (void *) NULL
);
4473 perror("pthread_create dispatch");
4477 /* Create thread to manage application registration. */
4478 ret
= pthread_create(®_apps_thread
, NULL
,
4479 thread_registration_apps
, (void *) NULL
);
4481 perror("pthread_create registration");
4485 /* Create thread to manage application socket */
4486 ret
= pthread_create(&apps_thread
, NULL
,
4487 thread_manage_apps
, (void *) NULL
);
4489 perror("pthread_create apps");
4493 /* Create kernel thread to manage kernel event */
4494 ret
= pthread_create(&kernel_thread
, NULL
,
4495 thread_manage_kernel
, (void *) NULL
);
4497 perror("pthread_create kernel");
4501 ret
= pthread_join(kernel_thread
, &status
);
4503 perror("pthread_join");
4504 goto error
; /* join error, exit without cleanup */
4508 ret
= pthread_join(apps_thread
, &status
);
4510 perror("pthread_join");
4511 goto error
; /* join error, exit without cleanup */
4515 ret
= pthread_join(reg_apps_thread
, &status
);
4517 perror("pthread_join");
4518 goto error
; /* join error, exit without cleanup */
4522 ret
= pthread_join(dispatch_thread
, &status
);
4524 perror("pthread_join");
4525 goto error
; /* join error, exit without cleanup */
4529 ret
= pthread_join(client_thread
, &status
);
4531 perror("pthread_join");
4532 goto error
; /* join error, exit without cleanup */
4535 ret
= join_consumer_thread(&kconsumer_data
);
4537 perror("join_consumer");
4538 goto error
; /* join error, exit without cleanup */
4544 * cleanup() is called when no other thread is running.
4546 rcu_thread_online();
4548 rcu_thread_offline();
4549 rcu_unregister_thread();