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
;
126 static int apps_sock
;
127 static int kernel_tracer_fd
;
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 close(kernel_tracer_fd
);
423 DBG("Unloading kernel modules");
424 modprobe_remove_lttng_all();
427 close(thread_quit_pipe
[0]);
428 close(thread_quit_pipe
[1]);
431 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
432 "Matthew, BEET driven development works!%c[%dm",
433 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
438 * Send data on a unix socket using the liblttsessiondcomm API.
440 * Return lttcomm error code.
442 static int send_unix_sock(int sock
, void *buf
, size_t len
)
444 /* Check valid length */
449 return lttcomm_send_unix_sock(sock
, buf
, len
);
453 * Free memory of a command context structure.
455 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
457 DBG("Clean command context structure");
459 if ((*cmd_ctx
)->llm
) {
460 free((*cmd_ctx
)->llm
);
462 if ((*cmd_ctx
)->lsm
) {
463 free((*cmd_ctx
)->lsm
);
471 * Send all stream fds of kernel channel to the consumer.
473 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
474 int sock
, struct ltt_kernel_channel
*channel
,
475 uid_t uid
, gid_t gid
)
478 struct ltt_kernel_stream
*stream
;
479 struct lttcomm_consumer_msg lkm
;
481 DBG("Sending streams of channel %s to kernel consumer",
482 channel
->channel
->name
);
485 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
486 lkm
.u
.channel
.channel_key
= channel
->fd
;
487 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
488 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
489 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
490 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
492 perror("send consumer channel");
497 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
501 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
502 lkm
.u
.stream
.channel_key
= channel
->fd
;
503 lkm
.u
.stream
.stream_key
= stream
->fd
;
504 lkm
.u
.stream
.state
= stream
->state
;
505 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
506 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
507 lkm
.u
.stream
.uid
= uid
;
508 lkm
.u
.stream
.gid
= gid
;
509 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
510 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
511 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
512 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
514 perror("send consumer stream");
517 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
519 perror("send consumer stream ancillary data");
524 DBG("consumer channel streams sent");
533 * Send all stream fds of the kernel session to the consumer.
535 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
536 struct ltt_kernel_session
*session
)
539 struct ltt_kernel_channel
*chan
;
540 struct lttcomm_consumer_msg lkm
;
541 int sock
= session
->consumer_fd
;
543 DBG("Sending metadata stream fd");
545 /* Extra protection. It's NOT supposed to be set to 0 at this point */
546 if (session
->consumer_fd
== 0) {
547 session
->consumer_fd
= consumer_data
->cmd_sock
;
550 if (session
->metadata_stream_fd
!= 0) {
551 /* Send metadata channel fd */
552 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
553 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
554 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
555 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
556 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
557 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
559 perror("send consumer channel");
563 /* Send metadata stream fd */
564 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
565 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
566 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
567 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
568 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
569 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
570 lkm
.u
.stream
.uid
= session
->uid
;
571 lkm
.u
.stream
.gid
= session
->gid
;
572 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
573 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
574 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
575 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
577 perror("send consumer stream");
580 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
582 perror("send consumer stream");
587 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
588 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
589 session
->uid
, session
->gid
);
595 DBG("consumer fds (metadata and channel streams) sent");
604 * Notify UST applications using the shm mmap futex.
606 static int notify_ust_apps(int active
)
610 DBG("Notifying applications of session daemon state: %d", active
);
612 /* See shm.c for this call implying mmap, shm and futex calls */
613 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
614 if (wait_shm_mmap
== NULL
) {
618 /* Wake waiting process */
619 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
621 /* Apps notified successfully */
629 * Setup the outgoing data buffer for the response (llm) by allocating the
630 * right amount of memory and copying the original information from the lsm
633 * Return total size of the buffer pointed by buf.
635 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
641 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
642 if (cmd_ctx
->llm
== NULL
) {
648 /* Copy common data */
649 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
650 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
652 cmd_ctx
->llm
->data_size
= size
;
653 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
662 * Update the kernel poll set of all channel fd available over all tracing
663 * session. Add the wakeup pipe at the end of the set.
665 static int update_kernel_poll(struct lttng_poll_event
*events
)
668 struct ltt_session
*session
;
669 struct ltt_kernel_channel
*channel
;
671 DBG("Updating kernel poll set");
674 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
675 session_lock(session
);
676 if (session
->kernel_session
== NULL
) {
677 session_unlock(session
);
681 cds_list_for_each_entry(channel
,
682 &session
->kernel_session
->channel_list
.head
, list
) {
683 /* Add channel fd to the kernel poll set */
684 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
686 session_unlock(session
);
689 DBG("Channel fd %d added to kernel set", channel
->fd
);
691 session_unlock(session
);
693 session_unlock_list();
698 session_unlock_list();
703 * Find the channel fd from 'fd' over all tracing session. When found, check
704 * for new channel stream and send those stream fds to the kernel consumer.
706 * Useful for CPU hotplug feature.
708 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
711 struct ltt_session
*session
;
712 struct ltt_kernel_channel
*channel
;
714 DBG("Updating kernel streams for channel fd %d", fd
);
717 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
718 session_lock(session
);
719 if (session
->kernel_session
== NULL
) {
720 session_unlock(session
);
724 /* This is not suppose to be 0 but this is an extra security check */
725 if (session
->kernel_session
->consumer_fd
== 0) {
726 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
729 cds_list_for_each_entry(channel
,
730 &session
->kernel_session
->channel_list
.head
, list
) {
731 if (channel
->fd
== fd
) {
732 DBG("Channel found, updating kernel streams");
733 ret
= kernel_open_channel_stream(channel
);
739 * Have we already sent fds to the consumer? If yes, it means
740 * that tracing is started so it is safe to send our updated
743 if (session
->kernel_session
->consumer_fds_sent
== 1) {
744 ret
= send_kconsumer_channel_streams(consumer_data
,
745 session
->kernel_session
->consumer_fd
, channel
,
746 session
->uid
, session
->gid
);
754 session_unlock(session
);
756 session_unlock_list();
760 session_unlock(session
);
761 session_unlock_list();
766 * For each tracing session, update newly registered apps.
768 static void update_ust_app(int app_sock
)
770 struct ltt_session
*sess
, *stmp
;
774 /* For all tracing session(s) */
775 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
777 if (sess
->ust_session
) {
778 ust_app_global_update(sess
->ust_session
, app_sock
);
780 session_unlock(sess
);
783 session_unlock_list();
787 * This thread manage event coming from the kernel.
789 * Features supported in this thread:
792 static void *thread_manage_kernel(void *data
)
794 int ret
, i
, pollfd
, update_poll_flag
= 1;
795 uint32_t revents
, nb_fd
;
797 struct lttng_poll_event events
;
799 DBG("Thread manage kernel started");
801 ret
= create_thread_poll_set(&events
, 2);
806 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
812 if (update_poll_flag
== 1) {
814 * Reset number of fd in the poll set. Always 2 since there is the thread
815 * quit pipe and the kernel pipe.
819 ret
= update_kernel_poll(&events
);
823 update_poll_flag
= 0;
826 nb_fd
= LTTNG_POLL_GETNB(&events
);
828 DBG("Thread kernel polling on %d fds", nb_fd
);
830 /* Zeroed the poll events */
831 lttng_poll_reset(&events
);
833 /* Poll infinite value of time */
835 ret
= lttng_poll_wait(&events
, -1);
838 * Restart interrupted system call.
840 if (errno
== EINTR
) {
844 } else if (ret
== 0) {
845 /* Should not happen since timeout is infinite */
846 ERR("Return value of poll is 0 with an infinite timeout.\n"
847 "This should not have happened! Continuing...");
851 for (i
= 0; i
< nb_fd
; i
++) {
852 /* Fetch once the poll data */
853 revents
= LTTNG_POLL_GETEV(&events
, i
);
854 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
856 /* Thread quit pipe has been closed. Killing thread. */
857 ret
= check_thread_quit_pipe(pollfd
, revents
);
862 /* Check for data on kernel pipe */
863 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
864 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
865 update_poll_flag
= 1;
869 * New CPU detected by the kernel. Adding kernel stream to
870 * kernel session and updating the kernel consumer
872 if (revents
& LPOLLIN
) {
873 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
879 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
880 * and unregister kernel stream at this point.
888 DBG("Kernel thread dying");
889 close(kernel_poll_pipe
[0]);
890 close(kernel_poll_pipe
[1]);
892 lttng_poll_clean(&events
);
898 * This thread manage the consumer error sent back to the session daemon.
900 static void *thread_manage_consumer(void *data
)
902 int sock
= 0, i
, ret
, pollfd
;
903 uint32_t revents
, nb_fd
;
904 enum lttcomm_return_code code
;
905 struct lttng_poll_event events
;
906 struct consumer_data
*consumer_data
= data
;
908 DBG("[thread] Manage consumer started");
910 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
916 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
917 * Nothing more will be added to this poll set.
919 ret
= create_thread_poll_set(&events
, 2);
924 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
929 nb_fd
= LTTNG_POLL_GETNB(&events
);
931 /* Inifinite blocking call, waiting for transmission */
933 ret
= lttng_poll_wait(&events
, -1);
936 * Restart interrupted system call.
938 if (errno
== EINTR
) {
944 for (i
= 0; i
< nb_fd
; i
++) {
945 /* Fetch once the poll data */
946 revents
= LTTNG_POLL_GETEV(&events
, i
);
947 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
949 /* Thread quit pipe has been closed. Killing thread. */
950 ret
= check_thread_quit_pipe(pollfd
, revents
);
955 /* Event on the registration socket */
956 if (pollfd
== consumer_data
->err_sock
) {
957 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
958 ERR("consumer err socket poll error");
964 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
969 DBG2("Receiving code from consumer err_sock");
971 /* Getting status code from kconsumerd */
972 ret
= lttcomm_recv_unix_sock(sock
, &code
,
973 sizeof(enum lttcomm_return_code
));
978 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
979 consumer_data
->cmd_sock
=
980 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
981 if (consumer_data
->cmd_sock
< 0) {
982 sem_post(&consumer_data
->sem
);
983 PERROR("consumer connect");
986 /* Signal condition to tell that the kconsumerd is ready */
987 sem_post(&consumer_data
->sem
);
988 DBG("consumer command socket ready");
990 ERR("consumer error when waiting for SOCK_READY : %s",
991 lttcomm_get_readable_code(-code
));
995 /* Remove the kconsumerd error sock since we've established a connexion */
996 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1001 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1006 /* Update number of fd */
1007 nb_fd
= LTTNG_POLL_GETNB(&events
);
1009 /* Inifinite blocking call, waiting for transmission */
1011 ret
= lttng_poll_wait(&events
, -1);
1014 * Restart interrupted system call.
1016 if (errno
== EINTR
) {
1022 for (i
= 0; i
< nb_fd
; i
++) {
1023 /* Fetch once the poll data */
1024 revents
= LTTNG_POLL_GETEV(&events
, i
);
1025 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1027 /* Thread quit pipe has been closed. Killing thread. */
1028 ret
= check_thread_quit_pipe(pollfd
, revents
);
1033 /* Event on the kconsumerd socket */
1034 if (pollfd
== sock
) {
1035 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1036 ERR("consumer err socket second poll error");
1042 /* Wait for any kconsumerd error */
1043 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1044 sizeof(enum lttcomm_return_code
));
1046 ERR("consumer closed the command socket");
1050 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1053 DBG("consumer thread dying");
1054 close(consumer_data
->err_sock
);
1055 close(consumer_data
->cmd_sock
);
1058 unlink(consumer_data
->err_unix_sock_path
);
1059 unlink(consumer_data
->cmd_unix_sock_path
);
1060 consumer_data
->pid
= 0;
1062 lttng_poll_clean(&events
);
1068 * This thread manage application communication.
1070 static void *thread_manage_apps(void *data
)
1073 uint32_t revents
, nb_fd
;
1074 struct ust_command ust_cmd
;
1075 struct lttng_poll_event events
;
1077 DBG("[thread] Manage application started");
1079 rcu_register_thread();
1080 rcu_thread_online();
1082 ret
= create_thread_poll_set(&events
, 2);
1087 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1093 /* Zeroed the events structure */
1094 lttng_poll_reset(&events
);
1096 nb_fd
= LTTNG_POLL_GETNB(&events
);
1098 DBG("Apps thread polling on %d fds", nb_fd
);
1100 /* Inifinite blocking call, waiting for transmission */
1102 ret
= lttng_poll_wait(&events
, -1);
1105 * Restart interrupted system call.
1107 if (errno
== EINTR
) {
1113 for (i
= 0; i
< nb_fd
; i
++) {
1114 /* Fetch once the poll data */
1115 revents
= LTTNG_POLL_GETEV(&events
, i
);
1116 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1118 /* Thread quit pipe has been closed. Killing thread. */
1119 ret
= check_thread_quit_pipe(pollfd
, revents
);
1124 /* Inspect the apps cmd pipe */
1125 if (pollfd
== apps_cmd_pipe
[0]) {
1126 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1127 ERR("Apps command pipe error");
1129 } else if (revents
& LPOLLIN
) {
1131 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1132 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1133 perror("read apps cmd pipe");
1137 /* Register applicaton to the session daemon */
1138 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1140 if (ret
== -ENOMEM
) {
1142 } else if (ret
< 0) {
1147 * Validate UST version compatibility.
1149 ret
= ust_app_validate_version(ust_cmd
.sock
);
1152 * Add channel(s) and event(s) to newly registered apps
1153 * from lttng global UST domain.
1155 update_ust_app(ust_cmd
.sock
);
1158 ret
= ust_app_register_done(ust_cmd
.sock
);
1161 * If the registration is not possible, we simply
1162 * unregister the apps and continue
1164 ust_app_unregister(ust_cmd
.sock
);
1167 * We just need here to monitor the close of the UST
1168 * socket and poll set monitor those by default.
1170 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1175 DBG("Apps with sock %d added to poll set",
1183 * At this point, we know that a registered application made
1184 * the event at poll_wait.
1186 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1187 /* Removing from the poll set */
1188 ret
= lttng_poll_del(&events
, pollfd
);
1193 /* Socket closed on remote end. */
1194 ust_app_unregister(pollfd
);
1202 DBG("Application communication apps dying");
1203 close(apps_cmd_pipe
[0]);
1204 close(apps_cmd_pipe
[1]);
1206 lttng_poll_clean(&events
);
1208 rcu_thread_offline();
1209 rcu_unregister_thread();
1214 * Dispatch request from the registration threads to the application
1215 * communication thread.
1217 static void *thread_dispatch_ust_registration(void *data
)
1220 struct cds_wfq_node
*node
;
1221 struct ust_command
*ust_cmd
= NULL
;
1223 DBG("[thread] Dispatch UST command started");
1225 while (!dispatch_thread_exit
) {
1226 /* Atomically prepare the queue futex */
1227 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1230 /* Dequeue command for registration */
1231 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1233 DBG("Woken up but nothing in the UST command queue");
1234 /* Continue thread execution */
1238 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1240 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1241 " gid:%d sock:%d name:%s (version %d.%d)",
1242 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1243 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1244 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1245 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1247 * Inform apps thread of the new application registration. This
1248 * call is blocking so we can be assured that the data will be read
1249 * at some point in time or wait to the end of the world :)
1251 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1252 sizeof(struct ust_command
));
1254 perror("write apps cmd pipe");
1255 if (errno
== EBADF
) {
1257 * We can't inform the application thread to process
1258 * registration. We will exit or else application
1259 * registration will not occur and tracing will never
1266 } while (node
!= NULL
);
1268 /* Futex wait on queue. Blocking call on futex() */
1269 futex_nto1_wait(&ust_cmd_queue
.futex
);
1273 DBG("Dispatch thread dying");
1278 * This thread manage application registration.
1280 static void *thread_registration_apps(void *data
)
1282 int sock
= 0, i
, ret
, pollfd
;
1283 uint32_t revents
, nb_fd
;
1284 struct lttng_poll_event events
;
1286 * Get allocated in this thread, enqueued to a global queue, dequeued and
1287 * freed in the manage apps thread.
1289 struct ust_command
*ust_cmd
= NULL
;
1291 DBG("[thread] Manage application registration started");
1293 ret
= lttcomm_listen_unix_sock(apps_sock
);
1299 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1300 * more will be added to this poll set.
1302 ret
= create_thread_poll_set(&events
, 2);
1307 /* Add the application registration socket */
1308 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1313 /* Notify all applications to register */
1314 ret
= notify_ust_apps(1);
1316 ERR("Failed to notify applications or create the wait shared memory.\n"
1317 "Execution continues but there might be problem for already\n"
1318 "running applications that wishes to register.");
1322 DBG("Accepting application registration");
1324 nb_fd
= LTTNG_POLL_GETNB(&events
);
1326 /* Inifinite blocking call, waiting for transmission */
1328 ret
= lttng_poll_wait(&events
, -1);
1331 * Restart interrupted system call.
1333 if (errno
== EINTR
) {
1339 for (i
= 0; i
< nb_fd
; i
++) {
1340 /* Fetch once the poll data */
1341 revents
= LTTNG_POLL_GETEV(&events
, i
);
1342 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1344 /* Thread quit pipe has been closed. Killing thread. */
1345 ret
= check_thread_quit_pipe(pollfd
, revents
);
1350 /* Event on the registration socket */
1351 if (pollfd
== apps_sock
) {
1352 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1353 ERR("Register apps socket poll error");
1355 } else if (revents
& LPOLLIN
) {
1356 sock
= lttcomm_accept_unix_sock(apps_sock
);
1361 /* Create UST registration command for enqueuing */
1362 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1363 if (ust_cmd
== NULL
) {
1364 perror("ust command zmalloc");
1369 * Using message-based transmissions to ensure we don't
1370 * have to deal with partially received messages.
1372 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1373 sizeof(struct ust_register_msg
));
1374 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1376 perror("lttcomm_recv_unix_sock register apps");
1378 ERR("Wrong size received on apps register");
1385 ust_cmd
->sock
= sock
;
1387 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1388 " gid:%d sock:%d name:%s (version %d.%d)",
1389 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1390 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1391 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1392 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1395 * Lock free enqueue the registration request. The red pill
1396 * has been taken! This apps will be part of the *system*.
1398 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1401 * Wake the registration queue futex. Implicit memory
1402 * barrier with the exchange in cds_wfq_enqueue.
1404 futex_nto1_wake(&ust_cmd_queue
.futex
);
1411 DBG("UST Registration thread dying");
1413 /* Notify that the registration thread is gone */
1418 unlink(apps_unix_sock_path
);
1420 lttng_poll_clean(&events
);
1426 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1427 * exec or it will fails.
1429 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1432 struct timespec timeout
;
1434 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1435 timeout
.tv_nsec
= 0;
1437 /* Setup semaphore */
1438 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1440 PERROR("sem_init consumer semaphore");
1444 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1445 thread_manage_consumer
, consumer_data
);
1447 PERROR("pthread_create consumer");
1452 /* Get time for sem_timedwait absolute timeout */
1453 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1455 PERROR("clock_gettime spawn consumer");
1456 /* Infinite wait for the kconsumerd thread to be ready */
1457 ret
= sem_wait(&consumer_data
->sem
);
1459 /* Normal timeout if the gettime was successful */
1460 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1461 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1465 if (errno
== ETIMEDOUT
) {
1467 * Call has timed out so we kill the kconsumerd_thread and return
1470 ERR("The consumer thread was never ready. Killing it");
1471 ret
= pthread_cancel(consumer_data
->thread
);
1473 PERROR("pthread_cancel consumer thread");
1476 PERROR("semaphore wait failed consumer thread");
1481 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1482 if (consumer_data
->pid
== 0) {
1483 ERR("Kconsumerd did not start");
1484 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1487 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1496 * Join consumer thread
1498 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1503 if (consumer_data
->pid
!= 0) {
1504 ret
= kill(consumer_data
->pid
, SIGTERM
);
1506 ERR("Error killing consumer daemon");
1509 return pthread_join(consumer_data
->thread
, &status
);
1516 * Fork and exec a consumer daemon (consumerd).
1518 * Return pid if successful else -1.
1520 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1524 const char *consumer_to_use
;
1525 const char *verbosity
;
1528 DBG("Spawning consumerd");
1535 if (opt_verbose_consumer
) {
1536 verbosity
= "--verbose";
1538 verbosity
= "--quiet";
1540 switch (consumer_data
->type
) {
1541 case LTTNG_CONSUMER_KERNEL
:
1543 * Find out which consumerd to execute. We will first try the
1544 * 64-bit path, then the sessiond's installation directory, and
1545 * fallback on the 32-bit one,
1547 DBG3("Looking for a kernel consumer at these locations:");
1548 DBG3(" 1) %s", consumerd64_bin
);
1549 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1550 DBG3(" 3) %s", consumerd32_bin
);
1551 if (stat(consumerd64_bin
, &st
) == 0) {
1552 DBG3("Found location #1");
1553 consumer_to_use
= consumerd64_bin
;
1554 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1555 DBG3("Found location #2");
1556 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1557 } else if (stat(consumerd32_bin
, &st
) == 0) {
1558 DBG3("Found location #3");
1559 consumer_to_use
= consumerd32_bin
;
1561 DBG("Could not find any valid consumerd executable");
1564 DBG("Using kernel consumer at: %s", consumer_to_use
);
1565 execl(consumer_to_use
,
1566 "lttng-consumerd", verbosity
, "-k",
1567 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1568 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1571 case LTTNG_CONSUMER64_UST
:
1573 char *tmpnew
= NULL
;
1575 if (consumerd64_libdir
[0] != '\0') {
1579 tmp
= getenv("LD_LIBRARY_PATH");
1583 tmplen
= strlen("LD_LIBRARY_PATH=")
1584 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1585 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1590 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1591 strcat(tmpnew
, consumerd64_libdir
);
1592 if (tmp
[0] != '\0') {
1593 strcat(tmpnew
, ":");
1594 strcat(tmpnew
, tmp
);
1596 ret
= putenv(tmpnew
);
1602 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1603 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1604 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1605 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1607 if (consumerd64_libdir
[0] != '\0') {
1615 case LTTNG_CONSUMER32_UST
:
1617 char *tmpnew
= NULL
;
1619 if (consumerd32_libdir
[0] != '\0') {
1623 tmp
= getenv("LD_LIBRARY_PATH");
1627 tmplen
= strlen("LD_LIBRARY_PATH=")
1628 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1629 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1634 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1635 strcat(tmpnew
, consumerd32_libdir
);
1636 if (tmp
[0] != '\0') {
1637 strcat(tmpnew
, ":");
1638 strcat(tmpnew
, tmp
);
1640 ret
= putenv(tmpnew
);
1646 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1647 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1648 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1649 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1651 if (consumerd32_libdir
[0] != '\0') {
1660 perror("unknown consumer type");
1664 perror("kernel start consumer exec");
1667 } else if (pid
> 0) {
1670 perror("start consumer fork");
1678 * Spawn the consumerd daemon and session daemon thread.
1680 static int start_consumerd(struct consumer_data
*consumer_data
)
1684 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1685 if (consumer_data
->pid
!= 0) {
1686 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1690 ret
= spawn_consumerd(consumer_data
);
1692 ERR("Spawning consumerd failed");
1693 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1697 /* Setting up the consumer_data pid */
1698 consumer_data
->pid
= ret
;
1699 DBG2("Consumer pid %d", consumer_data
->pid
);
1700 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1702 DBG2("Spawning consumer control thread");
1703 ret
= spawn_consumer_thread(consumer_data
);
1705 ERR("Fatal error spawning consumer control thread");
1717 * Check version of the lttng-modules.
1719 static int validate_lttng_modules_version(void)
1721 return kernel_validate_version(kernel_tracer_fd
);
1725 * Setup necessary data for kernel tracer action.
1727 static int init_kernel_tracer(void)
1731 /* Modprobe lttng kernel modules */
1732 ret
= modprobe_lttng_control();
1737 /* Open debugfs lttng */
1738 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1739 if (kernel_tracer_fd
< 0) {
1740 DBG("Failed to open %s", module_proc_lttng
);
1745 /* Validate kernel version */
1746 ret
= validate_lttng_modules_version();
1751 ret
= modprobe_lttng_data();
1756 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1760 modprobe_remove_lttng_control();
1761 close(kernel_tracer_fd
);
1762 kernel_tracer_fd
= 0;
1763 return LTTCOMM_KERN_VERSION
;
1766 close(kernel_tracer_fd
);
1769 modprobe_remove_lttng_control();
1772 WARN("No kernel tracer available");
1773 kernel_tracer_fd
= 0;
1774 return LTTCOMM_KERN_NA
;
1778 * Init tracing by creating trace directory and sending fds kernel consumer.
1780 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1784 if (session
->consumer_fds_sent
== 0) {
1786 * Assign default kernel consumer socket if no consumer assigned to the
1787 * kernel session. At this point, it's NOT suppose to be 0 but this is
1788 * an extra security check.
1790 if (session
->consumer_fd
== 0) {
1791 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1794 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1796 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1800 session
->consumer_fds_sent
= 1;
1808 * Create an UST session and add it to the session ust list.
1810 static int create_ust_session(struct ltt_session
*session
,
1811 struct lttng_domain
*domain
)
1813 struct ltt_ust_session
*lus
= NULL
;
1816 switch (domain
->type
) {
1817 case LTTNG_DOMAIN_UST
:
1820 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1824 DBG("Creating UST session");
1826 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1828 ret
= LTTCOMM_UST_SESS_FAIL
;
1832 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1833 session
->uid
, session
->gid
);
1835 if (ret
!= -EEXIST
) {
1836 ERR("Trace directory creation error");
1837 ret
= LTTCOMM_UST_SESS_FAIL
;
1842 /* The domain type dictate different actions on session creation */
1843 switch (domain
->type
) {
1844 case LTTNG_DOMAIN_UST
:
1845 /* No ustctl for the global UST domain */
1848 ERR("Unknown UST domain on create session %d", domain
->type
);
1851 lus
->uid
= session
->uid
;
1852 lus
->gid
= session
->gid
;
1853 session
->ust_session
= lus
;
1863 * Create a kernel tracer session then create the default channel.
1865 static int create_kernel_session(struct ltt_session
*session
)
1869 DBG("Creating kernel session");
1871 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1873 ret
= LTTCOMM_KERN_SESS_FAIL
;
1877 /* Set kernel consumer socket fd */
1878 if (kconsumer_data
.cmd_sock
) {
1879 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1882 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1883 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1885 if (ret
!= -EEXIST
) {
1886 ERR("Trace directory creation error");
1890 session
->kernel_session
->uid
= session
->uid
;
1891 session
->kernel_session
->gid
= session
->gid
;
1898 * Check if the UID or GID match the session. Root user has access to all
1901 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1903 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1910 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1913 struct ltt_session
*session
;
1915 DBG("Counting number of available session for UID %d GID %d",
1917 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1919 * Only list the sessions the user can control.
1921 if (!session_access_ok(session
, uid
, gid
)) {
1930 * Using the session list, filled a lttng_session array to send back to the
1931 * client for session listing.
1933 * The session list lock MUST be acquired before calling this function. Use
1934 * session_lock_list() and session_unlock_list().
1936 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1940 struct ltt_session
*session
;
1942 DBG("Getting all available session for UID %d GID %d",
1945 * Iterate over session list and append data after the control struct in
1948 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1950 * Only list the sessions the user can control.
1952 if (!session_access_ok(session
, uid
, gid
)) {
1955 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1956 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1957 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1958 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1959 sessions
[i
].enabled
= session
->enabled
;
1965 * Fill lttng_channel array of all channels.
1967 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1968 struct lttng_channel
*channels
)
1971 struct ltt_kernel_channel
*kchan
;
1973 DBG("Listing channels for session %s", session
->name
);
1976 case LTTNG_DOMAIN_KERNEL
:
1977 /* Kernel channels */
1978 if (session
->kernel_session
!= NULL
) {
1979 cds_list_for_each_entry(kchan
,
1980 &session
->kernel_session
->channel_list
.head
, list
) {
1981 /* Copy lttng_channel struct to array */
1982 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1983 channels
[i
].enabled
= kchan
->enabled
;
1988 case LTTNG_DOMAIN_UST
:
1990 struct lttng_ht_iter iter
;
1991 struct ltt_ust_channel
*uchan
;
1993 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1994 &iter
.iter
, uchan
, node
.node
) {
1995 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1996 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1997 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1998 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1999 channels
[i
].attr
.switch_timer_interval
=
2000 uchan
->attr
.switch_timer_interval
;
2001 channels
[i
].attr
.read_timer_interval
=
2002 uchan
->attr
.read_timer_interval
;
2003 channels
[i
].enabled
= uchan
->enabled
;
2004 switch (uchan
->attr
.output
) {
2005 case LTTNG_UST_MMAP
:
2007 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2020 * Create a list of ust global domain events.
2022 static int list_lttng_ust_global_events(char *channel_name
,
2023 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2026 unsigned int nb_event
= 0;
2027 struct lttng_ht_iter iter
;
2028 struct lttng_ht_node_str
*node
;
2029 struct ltt_ust_channel
*uchan
;
2030 struct ltt_ust_event
*uevent
;
2031 struct lttng_event
*tmp
;
2033 DBG("Listing UST global events for channel %s", channel_name
);
2037 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2038 node
= lttng_ht_iter_get_node_str(&iter
);
2040 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2044 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2046 nb_event
+= lttng_ht_get_count(uchan
->events
);
2048 if (nb_event
== 0) {
2053 DBG3("Listing UST global %d events", nb_event
);
2055 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2057 ret
= -LTTCOMM_FATAL
;
2061 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2062 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2063 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2064 tmp
[i
].enabled
= uevent
->enabled
;
2065 switch (uevent
->attr
.instrumentation
) {
2066 case LTTNG_UST_TRACEPOINT
:
2067 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2069 case LTTNG_UST_PROBE
:
2070 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2072 case LTTNG_UST_FUNCTION
:
2073 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2076 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2077 switch (uevent
->attr
.loglevel_type
) {
2078 case LTTNG_UST_LOGLEVEL_ALL
:
2079 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2081 case LTTNG_UST_LOGLEVEL_RANGE
:
2082 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2084 case LTTNG_UST_LOGLEVEL_SINGLE
:
2085 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2100 * Fill lttng_event array of all kernel events in the channel.
2102 static int list_lttng_kernel_events(char *channel_name
,
2103 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2106 unsigned int nb_event
;
2107 struct ltt_kernel_event
*event
;
2108 struct ltt_kernel_channel
*kchan
;
2110 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2111 if (kchan
== NULL
) {
2112 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2116 nb_event
= kchan
->event_count
;
2118 DBG("Listing events for channel %s", kchan
->channel
->name
);
2120 if (nb_event
== 0) {
2125 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2126 if (*events
== NULL
) {
2127 ret
= LTTCOMM_FATAL
;
2131 /* Kernel channels */
2132 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2133 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2134 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2135 (*events
)[i
].enabled
= event
->enabled
;
2136 switch (event
->event
->instrumentation
) {
2137 case LTTNG_KERNEL_TRACEPOINT
:
2138 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2140 case LTTNG_KERNEL_KPROBE
:
2141 case LTTNG_KERNEL_KRETPROBE
:
2142 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2143 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2144 sizeof(struct lttng_kernel_kprobe
));
2146 case LTTNG_KERNEL_FUNCTION
:
2147 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2148 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2149 sizeof(struct lttng_kernel_function
));
2151 case LTTNG_KERNEL_NOOP
:
2152 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2154 case LTTNG_KERNEL_SYSCALL
:
2155 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2157 case LTTNG_KERNEL_ALL
:
2171 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2173 static int cmd_disable_channel(struct ltt_session
*session
,
2174 int domain
, char *channel_name
)
2177 struct ltt_ust_session
*usess
;
2179 usess
= session
->ust_session
;
2182 case LTTNG_DOMAIN_KERNEL
:
2184 ret
= channel_kernel_disable(session
->kernel_session
,
2186 if (ret
!= LTTCOMM_OK
) {
2190 kernel_wait_quiescent(kernel_tracer_fd
);
2193 case LTTNG_DOMAIN_UST
:
2195 struct ltt_ust_channel
*uchan
;
2196 struct lttng_ht
*chan_ht
;
2198 chan_ht
= usess
->domain_global
.channels
;
2200 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2201 if (uchan
== NULL
) {
2202 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2206 ret
= channel_ust_disable(usess
, domain
, uchan
);
2207 if (ret
!= LTTCOMM_OK
) {
2213 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2214 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2215 case LTTNG_DOMAIN_UST_PID
:
2218 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2229 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2231 static int cmd_enable_channel(struct ltt_session
*session
,
2232 int domain
, struct lttng_channel
*attr
)
2235 struct ltt_ust_session
*usess
= session
->ust_session
;
2236 struct lttng_ht
*chan_ht
;
2238 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2241 case LTTNG_DOMAIN_KERNEL
:
2243 struct ltt_kernel_channel
*kchan
;
2245 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2246 session
->kernel_session
);
2247 if (kchan
== NULL
) {
2248 ret
= channel_kernel_create(session
->kernel_session
,
2249 attr
, kernel_poll_pipe
[1]);
2251 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2254 if (ret
!= LTTCOMM_OK
) {
2258 kernel_wait_quiescent(kernel_tracer_fd
);
2261 case LTTNG_DOMAIN_UST
:
2263 struct ltt_ust_channel
*uchan
;
2265 chan_ht
= usess
->domain_global
.channels
;
2267 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2268 if (uchan
== NULL
) {
2269 ret
= channel_ust_create(usess
, domain
, attr
);
2271 ret
= channel_ust_enable(usess
, domain
, uchan
);
2276 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2277 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2278 case LTTNG_DOMAIN_UST_PID
:
2281 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2290 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2292 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2293 char *channel_name
, char *event_name
)
2298 case LTTNG_DOMAIN_KERNEL
:
2300 struct ltt_kernel_channel
*kchan
;
2301 struct ltt_kernel_session
*ksess
;
2303 ksess
= session
->kernel_session
;
2305 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2306 if (kchan
== NULL
) {
2307 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2311 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2312 if (ret
!= LTTCOMM_OK
) {
2316 kernel_wait_quiescent(kernel_tracer_fd
);
2319 case LTTNG_DOMAIN_UST
:
2321 struct ltt_ust_channel
*uchan
;
2322 struct ltt_ust_session
*usess
;
2324 usess
= session
->ust_session
;
2326 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2328 if (uchan
== NULL
) {
2329 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2333 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2334 if (ret
!= LTTCOMM_OK
) {
2338 DBG3("Disable UST event %s in channel %s completed", event_name
,
2343 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2344 case LTTNG_DOMAIN_UST_PID
:
2345 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2359 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2361 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2367 case LTTNG_DOMAIN_KERNEL
:
2369 struct ltt_kernel_session
*ksess
;
2370 struct ltt_kernel_channel
*kchan
;
2372 ksess
= session
->kernel_session
;
2374 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2375 if (kchan
== NULL
) {
2376 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2380 ret
= event_kernel_disable_all(ksess
, kchan
);
2381 if (ret
!= LTTCOMM_OK
) {
2385 kernel_wait_quiescent(kernel_tracer_fd
);
2388 case LTTNG_DOMAIN_UST
:
2390 struct ltt_ust_session
*usess
;
2391 struct ltt_ust_channel
*uchan
;
2393 usess
= session
->ust_session
;
2395 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2397 if (uchan
== NULL
) {
2398 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2402 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2407 DBG3("Disable all UST events in channel %s completed", channel_name
);
2412 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2413 case LTTNG_DOMAIN_UST_PID
:
2414 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2428 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2430 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2431 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2436 case LTTNG_DOMAIN_KERNEL
:
2437 /* Add kernel context to kernel tracer */
2438 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2439 event_name
, channel_name
);
2440 if (ret
!= LTTCOMM_OK
) {
2444 case LTTNG_DOMAIN_UST
:
2446 struct ltt_ust_session
*usess
= session
->ust_session
;
2448 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2449 if (ret
!= LTTCOMM_OK
) {
2455 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2456 case LTTNG_DOMAIN_UST_PID
:
2457 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2471 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2473 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2474 char *channel_name
, struct lttng_event
*event
)
2477 struct lttng_channel
*attr
;
2478 struct ltt_ust_session
*usess
= session
->ust_session
;
2481 case LTTNG_DOMAIN_KERNEL
:
2483 struct ltt_kernel_channel
*kchan
;
2485 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2486 session
->kernel_session
);
2487 if (kchan
== NULL
) {
2488 attr
= channel_new_default_attr(domain
);
2490 ret
= LTTCOMM_FATAL
;
2493 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2495 /* This call will notify the kernel thread */
2496 ret
= channel_kernel_create(session
->kernel_session
,
2497 attr
, kernel_poll_pipe
[1]);
2498 if (ret
!= LTTCOMM_OK
) {
2505 /* Get the newly created kernel channel pointer */
2506 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2507 session
->kernel_session
);
2508 if (kchan
== NULL
) {
2509 /* This sould not happen... */
2510 ret
= LTTCOMM_FATAL
;
2514 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2516 if (ret
!= LTTCOMM_OK
) {
2520 kernel_wait_quiescent(kernel_tracer_fd
);
2523 case LTTNG_DOMAIN_UST
:
2525 struct lttng_channel
*attr
;
2526 struct ltt_ust_channel
*uchan
;
2528 /* Get channel from global UST domain */
2529 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2531 if (uchan
== NULL
) {
2532 /* Create default channel */
2533 attr
= channel_new_default_attr(domain
);
2535 ret
= LTTCOMM_FATAL
;
2538 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2539 attr
->name
[NAME_MAX
- 1] = '\0';
2541 ret
= channel_ust_create(usess
, domain
, attr
);
2542 if (ret
!= LTTCOMM_OK
) {
2548 /* Get the newly created channel reference back */
2549 uchan
= trace_ust_find_channel_by_name(
2550 usess
->domain_global
.channels
, channel_name
);
2551 if (uchan
== NULL
) {
2552 /* Something is really wrong */
2553 ret
= LTTCOMM_FATAL
;
2558 /* At this point, the session and channel exist on the tracer */
2559 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2560 if (ret
!= LTTCOMM_OK
) {
2566 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2567 case LTTNG_DOMAIN_UST_PID
:
2568 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2582 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2584 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2585 char *channel_name
, int event_type
)
2588 struct ltt_kernel_channel
*kchan
;
2591 case LTTNG_DOMAIN_KERNEL
:
2592 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2593 session
->kernel_session
);
2594 if (kchan
== NULL
) {
2595 /* This call will notify the kernel thread */
2596 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2597 kernel_poll_pipe
[1]);
2598 if (ret
!= LTTCOMM_OK
) {
2602 /* Get the newly created kernel channel pointer */
2603 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2604 session
->kernel_session
);
2605 if (kchan
== NULL
) {
2606 /* This sould not happen... */
2607 ret
= LTTCOMM_FATAL
;
2613 switch (event_type
) {
2614 case LTTNG_EVENT_SYSCALL
:
2615 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2616 kchan
, kernel_tracer_fd
);
2618 case LTTNG_EVENT_TRACEPOINT
:
2620 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2621 * events already registered to the channel.
2623 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2624 kchan
, kernel_tracer_fd
);
2626 case LTTNG_EVENT_ALL
:
2627 /* Enable syscalls and tracepoints */
2628 ret
= event_kernel_enable_all(session
->kernel_session
,
2629 kchan
, kernel_tracer_fd
);
2632 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2636 /* Manage return value */
2637 if (ret
!= LTTCOMM_OK
) {
2641 kernel_wait_quiescent(kernel_tracer_fd
);
2643 case LTTNG_DOMAIN_UST
:
2645 struct lttng_channel
*attr
;
2646 struct ltt_ust_channel
*uchan
;
2647 struct ltt_ust_session
*usess
= session
->ust_session
;
2649 /* Get channel from global UST domain */
2650 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2652 if (uchan
== NULL
) {
2653 /* Create default channel */
2654 attr
= channel_new_default_attr(domain
);
2656 ret
= LTTCOMM_FATAL
;
2659 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2660 attr
->name
[NAME_MAX
- 1] = '\0';
2662 /* Use the internal command enable channel */
2663 ret
= channel_ust_create(usess
, domain
, attr
);
2664 if (ret
!= LTTCOMM_OK
) {
2670 /* Get the newly created channel reference back */
2671 uchan
= trace_ust_find_channel_by_name(
2672 usess
->domain_global
.channels
, channel_name
);
2673 if (uchan
== NULL
) {
2674 /* Something is really wrong */
2675 ret
= LTTCOMM_FATAL
;
2680 /* At this point, the session and channel exist on the tracer */
2682 switch (event_type
) {
2683 case LTTNG_EVENT_ALL
:
2684 case LTTNG_EVENT_TRACEPOINT
:
2685 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2686 if (ret
!= LTTCOMM_OK
) {
2691 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2695 /* Manage return value */
2696 if (ret
!= LTTCOMM_OK
) {
2703 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2704 case LTTNG_DOMAIN_UST_PID
:
2705 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2719 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2721 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2724 ssize_t nb_events
= 0;
2727 case LTTNG_DOMAIN_KERNEL
:
2728 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2729 if (nb_events
< 0) {
2730 ret
= LTTCOMM_KERN_LIST_FAIL
;
2734 case LTTNG_DOMAIN_UST
:
2735 nb_events
= ust_app_list_events(events
);
2736 if (nb_events
< 0) {
2737 ret
= LTTCOMM_UST_LIST_FAIL
;
2749 /* Return negative value to differentiate return code */
2754 * Command LTTNG_START_TRACE processed by the client thread.
2756 static int cmd_start_trace(struct ltt_session
*session
)
2759 struct ltt_kernel_session
*ksession
;
2760 struct ltt_ust_session
*usess
;
2763 ksession
= session
->kernel_session
;
2764 usess
= session
->ust_session
;
2766 if (session
->enabled
) {
2767 ret
= LTTCOMM_UST_START_FAIL
;
2771 session
->enabled
= 1;
2773 /* Kernel tracing */
2774 if (ksession
!= NULL
) {
2775 struct ltt_kernel_channel
*kchan
;
2777 /* Open kernel metadata */
2778 if (ksession
->metadata
== NULL
) {
2779 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2781 ret
= LTTCOMM_KERN_META_FAIL
;
2786 /* Open kernel metadata stream */
2787 if (ksession
->metadata_stream_fd
== 0) {
2788 ret
= kernel_open_metadata_stream(ksession
);
2790 ERR("Kernel create metadata stream failed");
2791 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2796 /* For each channel */
2797 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2798 if (kchan
->stream_count
== 0) {
2799 ret
= kernel_open_channel_stream(kchan
);
2801 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2804 /* Update the stream global counter */
2805 ksession
->stream_count_global
+= ret
;
2809 /* Setup kernel consumer socket and send fds to it */
2810 ret
= init_kernel_tracing(ksession
);
2812 ret
= LTTCOMM_KERN_START_FAIL
;
2816 /* This start the kernel tracing */
2817 ret
= kernel_start_session(ksession
);
2819 ret
= LTTCOMM_KERN_START_FAIL
;
2823 /* Quiescent wait after starting trace */
2824 kernel_wait_quiescent(kernel_tracer_fd
);
2827 /* Flag session that trace should start automatically */
2829 usess
->start_trace
= 1;
2831 ret
= ust_app_start_trace_all(usess
);
2833 ret
= LTTCOMM_UST_START_FAIL
;
2845 * Command LTTNG_STOP_TRACE processed by the client thread.
2847 static int cmd_stop_trace(struct ltt_session
*session
)
2850 struct ltt_kernel_channel
*kchan
;
2851 struct ltt_kernel_session
*ksession
;
2852 struct ltt_ust_session
*usess
;
2855 ksession
= session
->kernel_session
;
2856 usess
= session
->ust_session
;
2858 if (!session
->enabled
) {
2859 ret
= LTTCOMM_UST_STOP_FAIL
;
2863 session
->enabled
= 0;
2866 if (ksession
!= NULL
) {
2867 DBG("Stop kernel tracing");
2869 /* Flush all buffers before stopping */
2870 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2872 ERR("Kernel metadata flush failed");
2875 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2876 ret
= kernel_flush_buffer(kchan
);
2878 ERR("Kernel flush buffer error");
2882 ret
= kernel_stop_session(ksession
);
2884 ret
= LTTCOMM_KERN_STOP_FAIL
;
2888 kernel_wait_quiescent(kernel_tracer_fd
);
2892 usess
->start_trace
= 0;
2894 ret
= ust_app_stop_trace_all(usess
);
2896 ret
= LTTCOMM_UST_STOP_FAIL
;
2908 * Command LTTNG_CREATE_SESSION processed by the client thread.
2910 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2914 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2915 if (ret
!= LTTCOMM_OK
) {
2926 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2928 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2932 /* Clean kernel session teardown */
2933 teardown_kernel_session(session
);
2934 /* UST session teardown */
2935 teardown_ust_session(session
);
2938 * Must notify the kernel thread here to update it's poll setin order
2939 * to remove the channel(s)' fd just destroyed.
2941 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2943 perror("write kernel poll pipe");
2946 ret
= session_destroy(session
);
2952 * Command LTTNG_CALIBRATE processed by the client thread.
2954 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2959 case LTTNG_DOMAIN_KERNEL
:
2961 struct lttng_kernel_calibrate kcalibrate
;
2963 kcalibrate
.type
= calibrate
->type
;
2964 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2966 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2971 case LTTNG_DOMAIN_UST
:
2973 struct lttng_ust_calibrate ucalibrate
;
2975 ucalibrate
.type
= calibrate
->type
;
2976 ret
= ust_app_calibrate_glb(&ucalibrate
);
2978 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2995 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2997 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3003 case LTTNG_DOMAIN_KERNEL
:
3004 /* Can't register a consumer if there is already one */
3005 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3006 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3010 sock
= lttcomm_connect_unix_sock(sock_path
);
3012 ret
= LTTCOMM_CONNECT_FAIL
;
3016 session
->kernel_session
->consumer_fd
= sock
;
3019 /* TODO: Userspace tracing */
3031 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3033 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3034 struct lttng_domain
**domains
)
3039 if (session
->kernel_session
!= NULL
) {
3040 DBG3("Listing domains found kernel domain");
3044 if (session
->ust_session
!= NULL
) {
3045 DBG3("Listing domains found UST global domain");
3049 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3050 if (*domains
== NULL
) {
3051 ret
= -LTTCOMM_FATAL
;
3055 if (session
->kernel_session
!= NULL
) {
3056 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3060 if (session
->ust_session
!= NULL
) {
3061 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3072 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3074 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3075 struct lttng_channel
**channels
)
3078 ssize_t nb_chan
= 0;
3081 case LTTNG_DOMAIN_KERNEL
:
3082 if (session
->kernel_session
!= NULL
) {
3083 nb_chan
= session
->kernel_session
->channel_count
;
3085 DBG3("Number of kernel channels %zd", nb_chan
);
3087 case LTTNG_DOMAIN_UST
:
3088 if (session
->ust_session
!= NULL
) {
3089 nb_chan
= lttng_ht_get_count(
3090 session
->ust_session
->domain_global
.channels
);
3092 DBG3("Number of UST global channels %zd", nb_chan
);
3101 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3102 if (*channels
== NULL
) {
3103 ret
= -LTTCOMM_FATAL
;
3107 list_lttng_channels(domain
, session
, *channels
);
3119 * Command LTTNG_LIST_EVENTS processed by the client thread.
3121 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3122 char *channel_name
, struct lttng_event
**events
)
3125 ssize_t nb_event
= 0;
3128 case LTTNG_DOMAIN_KERNEL
:
3129 if (session
->kernel_session
!= NULL
) {
3130 nb_event
= list_lttng_kernel_events(channel_name
,
3131 session
->kernel_session
, events
);
3134 case LTTNG_DOMAIN_UST
:
3136 if (session
->ust_session
!= NULL
) {
3137 nb_event
= list_lttng_ust_global_events(channel_name
,
3138 &session
->ust_session
->domain_global
, events
);
3154 * Process the command requested by the lttng client within the command
3155 * context structure. This function make sure that the return structure (llm)
3156 * is set and ready for transmission before returning.
3158 * Return any error encountered or 0 for success.
3160 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3162 int ret
= LTTCOMM_OK
;
3163 int need_tracing_session
= 1;
3166 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3168 switch (cmd_ctx
->lsm
->cmd_type
) {
3169 case LTTNG_CREATE_SESSION
:
3170 case LTTNG_DESTROY_SESSION
:
3171 case LTTNG_LIST_SESSIONS
:
3172 case LTTNG_LIST_DOMAINS
:
3173 case LTTNG_START_TRACE
:
3174 case LTTNG_STOP_TRACE
:
3181 if (opt_no_kernel
&& need_domain
3182 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3183 ret
= LTTCOMM_KERN_NA
;
3188 * Check for command that don't needs to allocate a returned payload. We do
3189 * this here so we don't have to make the call for no payload at each
3192 switch(cmd_ctx
->lsm
->cmd_type
) {
3193 case LTTNG_LIST_SESSIONS
:
3194 case LTTNG_LIST_TRACEPOINTS
:
3195 case LTTNG_LIST_DOMAINS
:
3196 case LTTNG_LIST_CHANNELS
:
3197 case LTTNG_LIST_EVENTS
:
3200 /* Setup lttng message with no payload */
3201 ret
= setup_lttng_msg(cmd_ctx
, 0);
3203 /* This label does not try to unlock the session */
3204 goto init_setup_error
;
3208 /* Commands that DO NOT need a session. */
3209 switch (cmd_ctx
->lsm
->cmd_type
) {
3210 case LTTNG_CREATE_SESSION
:
3211 case LTTNG_CALIBRATE
:
3212 case LTTNG_LIST_SESSIONS
:
3213 case LTTNG_LIST_TRACEPOINTS
:
3214 need_tracing_session
= 0;
3217 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3218 session_lock_list();
3219 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3220 session_unlock_list();
3221 if (cmd_ctx
->session
== NULL
) {
3222 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3223 ret
= LTTCOMM_SESS_NOT_FOUND
;
3225 /* If no session name specified */
3226 ret
= LTTCOMM_SELECT_SESS
;
3230 /* Acquire lock for the session */
3231 session_lock(cmd_ctx
->session
);
3240 * Check domain type for specific "pre-action".
3242 switch (cmd_ctx
->lsm
->domain
.type
) {
3243 case LTTNG_DOMAIN_KERNEL
:
3245 ret
= LTTCOMM_KERN_NA
;
3249 /* Kernel tracer check */
3250 if (kernel_tracer_fd
== 0) {
3251 /* Basically, load kernel tracer modules */
3252 ret
= init_kernel_tracer();
3258 /* Need a session for kernel command */
3259 if (need_tracing_session
) {
3260 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3261 ret
= create_kernel_session(cmd_ctx
->session
);
3263 ret
= LTTCOMM_KERN_SESS_FAIL
;
3268 /* Start the kernel consumer daemon */
3269 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3270 if (kconsumer_data
.pid
== 0 &&
3271 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3272 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3273 ret
= start_consumerd(&kconsumer_data
);
3275 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3279 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3283 case LTTNG_DOMAIN_UST
:
3285 if (need_tracing_session
) {
3286 if (cmd_ctx
->session
->ust_session
== NULL
) {
3287 ret
= create_ust_session(cmd_ctx
->session
,
3288 &cmd_ctx
->lsm
->domain
);
3289 if (ret
!= LTTCOMM_OK
) {
3293 /* Start the UST consumer daemons */
3295 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3296 if (consumerd64_bin
[0] != '\0' &&
3297 ustconsumer64_data
.pid
== 0 &&
3298 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3299 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3300 ret
= start_consumerd(&ustconsumer64_data
);
3302 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3303 ust_consumerd64_fd
= -EINVAL
;
3307 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3309 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3312 if (consumerd32_bin
[0] != '\0' &&
3313 ustconsumer32_data
.pid
== 0 &&
3314 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3315 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3316 ret
= start_consumerd(&ustconsumer32_data
);
3318 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3319 ust_consumerd32_fd
= -EINVAL
;
3322 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3324 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3335 * Check that the UID or GID match that of the tracing session.
3336 * The root user can interact with all sessions.
3338 if (need_tracing_session
) {
3339 if (!session_access_ok(cmd_ctx
->session
,
3340 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3341 ret
= LTTCOMM_EPERM
;
3346 /* Process by command type */
3347 switch (cmd_ctx
->lsm
->cmd_type
) {
3348 case LTTNG_ADD_CONTEXT
:
3350 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3351 cmd_ctx
->lsm
->u
.context
.channel_name
,
3352 cmd_ctx
->lsm
->u
.context
.event_name
,
3353 &cmd_ctx
->lsm
->u
.context
.ctx
);
3356 case LTTNG_DISABLE_CHANNEL
:
3358 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3359 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3362 case LTTNG_DISABLE_EVENT
:
3364 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3365 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3366 cmd_ctx
->lsm
->u
.disable
.name
);
3369 case LTTNG_DISABLE_ALL_EVENT
:
3371 DBG("Disabling all events");
3373 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3374 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3377 case LTTNG_ENABLE_CHANNEL
:
3379 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3380 &cmd_ctx
->lsm
->u
.channel
.chan
);
3383 case LTTNG_ENABLE_EVENT
:
3385 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3386 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3387 &cmd_ctx
->lsm
->u
.enable
.event
);
3390 case LTTNG_ENABLE_ALL_EVENT
:
3392 DBG("Enabling all events");
3394 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3395 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3396 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3399 case LTTNG_LIST_TRACEPOINTS
:
3401 struct lttng_event
*events
;
3404 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3405 if (nb_events
< 0) {
3411 * Setup lttng message with payload size set to the event list size in
3412 * bytes and then copy list into the llm payload.
3414 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3420 /* Copy event list into message payload */
3421 memcpy(cmd_ctx
->llm
->payload
, events
,
3422 sizeof(struct lttng_event
) * nb_events
);
3429 case LTTNG_START_TRACE
:
3431 ret
= cmd_start_trace(cmd_ctx
->session
);
3434 case LTTNG_STOP_TRACE
:
3436 ret
= cmd_stop_trace(cmd_ctx
->session
);
3439 case LTTNG_CREATE_SESSION
:
3441 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3442 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3445 case LTTNG_DESTROY_SESSION
:
3447 ret
= cmd_destroy_session(cmd_ctx
->session
,
3448 cmd_ctx
->lsm
->session
.name
);
3451 case LTTNG_LIST_DOMAINS
:
3454 struct lttng_domain
*domains
;
3456 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3462 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3467 /* Copy event list into message payload */
3468 memcpy(cmd_ctx
->llm
->payload
, domains
,
3469 nb_dom
* sizeof(struct lttng_domain
));
3476 case LTTNG_LIST_CHANNELS
:
3479 struct lttng_channel
*channels
;
3481 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3482 cmd_ctx
->session
, &channels
);
3488 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3493 /* Copy event list into message payload */
3494 memcpy(cmd_ctx
->llm
->payload
, channels
,
3495 nb_chan
* sizeof(struct lttng_channel
));
3502 case LTTNG_LIST_EVENTS
:
3505 struct lttng_event
*events
= NULL
;
3507 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3508 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3514 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3519 /* Copy event list into message payload */
3520 memcpy(cmd_ctx
->llm
->payload
, events
,
3521 nb_event
* sizeof(struct lttng_event
));
3528 case LTTNG_LIST_SESSIONS
:
3530 unsigned int nr_sessions
;
3532 session_lock_list();
3533 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3535 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3537 session_unlock_list();
3541 /* Filled the session array */
3542 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3543 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3545 session_unlock_list();
3550 case LTTNG_CALIBRATE
:
3552 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3553 &cmd_ctx
->lsm
->u
.calibrate
);
3556 case LTTNG_REGISTER_CONSUMER
:
3558 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3559 cmd_ctx
->lsm
->u
.reg
.path
);
3568 if (cmd_ctx
->llm
== NULL
) {
3569 DBG("Missing llm structure. Allocating one.");
3570 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3574 /* Set return code */
3575 cmd_ctx
->llm
->ret_code
= ret
;
3577 if (cmd_ctx
->session
) {
3578 session_unlock(cmd_ctx
->session
);
3585 * This thread manage all clients request using the unix client socket for
3588 static void *thread_manage_clients(void *data
)
3590 int sock
= 0, ret
, i
, pollfd
;
3591 uint32_t revents
, nb_fd
;
3592 struct command_ctx
*cmd_ctx
= NULL
;
3593 struct lttng_poll_event events
;
3595 DBG("[thread] Manage client started");
3597 rcu_register_thread();
3599 ret
= lttcomm_listen_unix_sock(client_sock
);
3605 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3606 * more will be added to this poll set.
3608 ret
= create_thread_poll_set(&events
, 2);
3613 /* Add the application registration socket */
3614 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3620 * Notify parent pid that we are ready to accept command for client side.
3622 if (opt_sig_parent
) {
3623 kill(ppid
, SIGUSR1
);
3627 DBG("Accepting client command ...");
3629 nb_fd
= LTTNG_POLL_GETNB(&events
);
3631 /* Inifinite blocking call, waiting for transmission */
3633 ret
= lttng_poll_wait(&events
, -1);
3636 * Restart interrupted system call.
3638 if (errno
== EINTR
) {
3644 for (i
= 0; i
< nb_fd
; i
++) {
3645 /* Fetch once the poll data */
3646 revents
= LTTNG_POLL_GETEV(&events
, i
);
3647 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3649 /* Thread quit pipe has been closed. Killing thread. */
3650 ret
= check_thread_quit_pipe(pollfd
, revents
);
3655 /* Event on the registration socket */
3656 if (pollfd
== client_sock
) {
3657 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3658 ERR("Client socket poll error");
3664 DBG("Wait for client response");
3666 sock
= lttcomm_accept_unix_sock(client_sock
);
3671 /* Set socket option for credentials retrieval */
3672 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3677 /* Allocate context command to process the client request */
3678 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3679 if (cmd_ctx
== NULL
) {
3680 perror("zmalloc cmd_ctx");
3684 /* Allocate data buffer for reception */
3685 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3686 if (cmd_ctx
->lsm
== NULL
) {
3687 perror("zmalloc cmd_ctx->lsm");
3691 cmd_ctx
->llm
= NULL
;
3692 cmd_ctx
->session
= NULL
;
3695 * Data is received from the lttng client. The struct
3696 * lttcomm_session_msg (lsm) contains the command and data request of
3699 DBG("Receiving data from client ...");
3700 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3701 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3703 DBG("Nothing recv() from client... continuing");
3709 // TODO: Validate cmd_ctx including sanity check for
3710 // security purpose.
3712 rcu_thread_online();
3714 * This function dispatch the work to the kernel or userspace tracer
3715 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3716 * informations for the client. The command context struct contains
3717 * everything this function may needs.
3719 ret
= process_client_msg(cmd_ctx
);
3720 rcu_thread_offline();
3723 * TODO: Inform client somehow of the fatal error. At
3724 * this point, ret < 0 means that a zmalloc failed
3725 * (ENOMEM). Error detected but still accept command.
3727 clean_command_ctx(&cmd_ctx
);
3731 DBG("Sending response (size: %d, retcode: %s)",
3732 cmd_ctx
->lttng_msg_size
,
3733 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3734 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3736 ERR("Failed to send data back to client");
3739 /* End of transmission */
3742 clean_command_ctx(&cmd_ctx
);
3746 DBG("Client thread dying");
3747 unlink(client_unix_sock_path
);
3751 lttng_poll_clean(&events
);
3752 clean_command_ctx(&cmd_ctx
);
3754 rcu_unregister_thread();
3760 * usage function on stderr
3762 static void usage(void)
3764 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3765 fprintf(stderr
, " -h, --help Display this usage.\n");
3766 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3767 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3768 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3769 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3770 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3771 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3772 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3773 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3774 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3775 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3776 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3777 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3778 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3779 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3780 fprintf(stderr
, " -V, --version Show version number.\n");
3781 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3782 fprintf(stderr
, " -q, --quiet No output at all.\n");
3783 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3784 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3785 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3789 * daemon argument parsing
3791 static int parse_args(int argc
, char **argv
)
3795 static struct option long_options
[] = {
3796 { "client-sock", 1, 0, 'c' },
3797 { "apps-sock", 1, 0, 'a' },
3798 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3799 { "kconsumerd-err-sock", 1, 0, 'E' },
3800 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3801 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3802 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3803 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3804 { "consumerd32-path", 1, 0, 'u' },
3805 { "consumerd32-libdir", 1, 0, 'U' },
3806 { "consumerd64-path", 1, 0, 't' },
3807 { "consumerd64-libdir", 1, 0, 'T' },
3808 { "daemonize", 0, 0, 'd' },
3809 { "sig-parent", 0, 0, 'S' },
3810 { "help", 0, 0, 'h' },
3811 { "group", 1, 0, 'g' },
3812 { "version", 0, 0, 'V' },
3813 { "quiet", 0, 0, 'q' },
3814 { "verbose", 0, 0, 'v' },
3815 { "verbose-consumer", 0, 0, 'Z' },
3816 { "no-kernel", 0, 0, 'N' },
3821 int option_index
= 0;
3822 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3823 long_options
, &option_index
);
3830 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3832 fprintf(stderr
, " with arg %s\n", optarg
);
3836 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3839 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3845 opt_tracing_group
= optarg
;
3851 fprintf(stdout
, "%s\n", VERSION
);
3857 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3860 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3863 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3866 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3869 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3872 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3881 /* Verbose level can increase using multiple -v */
3885 opt_verbose_consumer
+= 1;
3888 consumerd32_bin
= optarg
;
3891 consumerd32_libdir
= optarg
;
3894 consumerd64_bin
= optarg
;
3897 consumerd64_libdir
= optarg
;
3900 /* Unknown option or other error.
3901 * Error is printed by getopt, just return */
3910 * Creates the two needed socket by the daemon.
3911 * apps_sock - The communication socket for all UST apps.
3912 * client_sock - The communication of the cli tool (lttng).
3914 static int init_daemon_socket(void)
3919 old_umask
= umask(0);
3921 /* Create client tool unix socket */
3922 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3923 if (client_sock
< 0) {
3924 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3929 /* File permission MUST be 660 */
3930 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3932 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3937 /* Create the application unix socket */
3938 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3939 if (apps_sock
< 0) {
3940 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3945 /* File permission MUST be 666 */
3946 ret
= chmod(apps_unix_sock_path
,
3947 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3949 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3960 * Check if the global socket is available, and if a daemon is answering at the
3961 * other side. If yes, error is returned.
3963 static int check_existing_daemon(void)
3965 /* Is there anybody out there ? */
3966 if (lttng_session_daemon_alive()) {
3974 * Set the tracing group gid onto the client socket.
3976 * Race window between mkdir and chown is OK because we are going from more
3977 * permissive (root.root) to less permissive (root.tracing).
3979 static int set_permissions(char *rundir
)
3984 gid
= allowed_group();
3986 WARN("No tracing group detected");
3991 /* Set lttng run dir */
3992 ret
= chown(rundir
, 0, gid
);
3994 ERR("Unable to set group on %s", rundir
);
3998 /* Ensure tracing group can search the run dir */
3999 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
);
4001 ERR("Unable to set permissions on %s", rundir
);
4005 /* lttng client socket path */
4006 ret
= chown(client_unix_sock_path
, 0, gid
);
4008 ERR("Unable to set group on %s", client_unix_sock_path
);
4012 /* kconsumer error socket path */
4013 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4015 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4019 /* 64-bit ustconsumer error socket path */
4020 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4022 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4026 /* 32-bit ustconsumer compat32 error socket path */
4027 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4029 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4033 DBG("All permissions are set");
4040 * Create the pipe used to wake up the kernel thread.
4042 static int create_kernel_poll_pipe(void)
4044 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4048 * Create the application command pipe to wake thread_manage_apps.
4050 static int create_apps_cmd_pipe(void)
4052 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4056 * Create the lttng run directory needed for all global sockets and pipe.
4058 static int create_lttng_rundir(const char *rundir
)
4062 DBG3("Creating LTTng run directory: %s", rundir
);
4064 ret
= mkdir(rundir
, S_IRWXU
);
4066 if (errno
!= EEXIST
) {
4067 ERR("Unable to create %s", rundir
);
4079 * Setup sockets and directory needed by the kconsumerd communication with the
4082 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4086 char path
[PATH_MAX
];
4088 switch (consumer_data
->type
) {
4089 case LTTNG_CONSUMER_KERNEL
:
4090 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4092 case LTTNG_CONSUMER64_UST
:
4093 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4095 case LTTNG_CONSUMER32_UST
:
4096 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4099 ERR("Consumer type unknown");
4104 DBG2("Creating consumer directory: %s", path
);
4106 ret
= mkdir(path
, S_IRWXU
);
4108 if (errno
!= EEXIST
) {
4109 ERR("Failed to create %s", path
);
4115 /* Create the kconsumerd error unix socket */
4116 consumer_data
->err_sock
=
4117 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4118 if (consumer_data
->err_sock
< 0) {
4119 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4124 /* File permission MUST be 660 */
4125 ret
= chmod(consumer_data
->err_unix_sock_path
,
4126 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4128 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4138 * Signal handler for the daemon
4140 * Simply stop all worker threads, leaving main() return gracefully after
4141 * joining all threads and calling cleanup().
4143 static void sighandler(int sig
)
4147 DBG("SIGPIPE caught");
4150 DBG("SIGINT caught");
4154 DBG("SIGTERM caught");
4163 * Setup signal handler for :
4164 * SIGINT, SIGTERM, SIGPIPE
4166 static int set_signal_handler(void)
4169 struct sigaction sa
;
4172 if ((ret
= sigemptyset(&sigset
)) < 0) {
4173 perror("sigemptyset");
4177 sa
.sa_handler
= sighandler
;
4178 sa
.sa_mask
= sigset
;
4180 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4181 perror("sigaction");
4185 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4186 perror("sigaction");
4190 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4191 perror("sigaction");
4195 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4201 * Set open files limit to unlimited. This daemon can open a large number of
4202 * file descriptors in order to consumer multiple kernel traces.
4204 static void set_ulimit(void)
4209 /* The kernel does not allowed an infinite limit for open files */
4210 lim
.rlim_cur
= 65535;
4211 lim
.rlim_max
= 65535;
4213 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4215 perror("failed to set open files limit");
4222 int main(int argc
, char **argv
)
4226 const char *home_path
;
4228 init_kernel_workarounds();
4230 rcu_register_thread();
4232 /* Create thread quit pipe */
4233 if ((ret
= init_thread_quit_pipe()) < 0) {
4237 setup_consumerd_path();
4239 /* Parse arguments */
4241 if ((ret
= parse_args(argc
, argv
) < 0)) {
4254 /* Check if daemon is UID = 0 */
4255 is_root
= !getuid();
4258 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4260 /* Create global run dir with root access */
4261 ret
= create_lttng_rundir(rundir
);
4266 if (strlen(apps_unix_sock_path
) == 0) {
4267 snprintf(apps_unix_sock_path
, PATH_MAX
,
4268 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4271 if (strlen(client_unix_sock_path
) == 0) {
4272 snprintf(client_unix_sock_path
, PATH_MAX
,
4273 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4276 /* Set global SHM for ust */
4277 if (strlen(wait_shm_path
) == 0) {
4278 snprintf(wait_shm_path
, PATH_MAX
,
4279 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4282 /* Setup kernel consumerd path */
4283 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4284 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4285 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4286 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4288 DBG2("Kernel consumer err path: %s",
4289 kconsumer_data
.err_unix_sock_path
);
4290 DBG2("Kernel consumer cmd path: %s",
4291 kconsumer_data
.cmd_unix_sock_path
);
4293 home_path
= get_home_dir();
4294 if (home_path
== NULL
) {
4295 /* TODO: Add --socket PATH option */
4296 ERR("Can't get HOME directory for sockets creation.");
4302 * Create rundir from home path. This will create something like
4305 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4311 ret
= create_lttng_rundir(rundir
);
4316 if (strlen(apps_unix_sock_path
) == 0) {
4317 snprintf(apps_unix_sock_path
, PATH_MAX
,
4318 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4321 /* Set the cli tool unix socket path */
4322 if (strlen(client_unix_sock_path
) == 0) {
4323 snprintf(client_unix_sock_path
, PATH_MAX
,
4324 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4327 /* Set global SHM for ust */
4328 if (strlen(wait_shm_path
) == 0) {
4329 snprintf(wait_shm_path
, PATH_MAX
,
4330 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4334 DBG("Client socket path %s", client_unix_sock_path
);
4335 DBG("Application socket path %s", apps_unix_sock_path
);
4336 DBG("LTTng run directory path: %s", rundir
);
4338 /* 32 bits consumerd path setup */
4339 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4340 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4341 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4342 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4344 DBG2("UST consumer 32 bits err path: %s",
4345 ustconsumer32_data
.err_unix_sock_path
);
4346 DBG2("UST consumer 32 bits cmd path: %s",
4347 ustconsumer32_data
.cmd_unix_sock_path
);
4349 /* 64 bits consumerd path setup */
4350 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4351 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4352 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4353 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4355 DBG2("UST consumer 64 bits err path: %s",
4356 ustconsumer64_data
.err_unix_sock_path
);
4357 DBG2("UST consumer 64 bits cmd path: %s",
4358 ustconsumer64_data
.cmd_unix_sock_path
);
4361 * See if daemon already exist.
4363 if ((ret
= check_existing_daemon()) < 0) {
4364 ERR("Already running daemon.\n");
4366 * We do not goto exit because we must not cleanup()
4367 * because a daemon is already running.
4372 /* After this point, we can safely call cleanup() with "goto exit" */
4375 * These actions must be executed as root. We do that *after* setting up
4376 * the sockets path because we MUST make the check for another daemon using
4377 * those paths *before* trying to set the kernel consumer sockets and init
4381 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4386 /* Setup kernel tracer */
4387 if (!opt_no_kernel
) {
4388 init_kernel_tracer();
4391 /* Set ulimit for open files */
4395 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4400 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4405 if ((ret
= set_signal_handler()) < 0) {
4409 /* Setup the needed unix socket */
4410 if ((ret
= init_daemon_socket()) < 0) {
4414 /* Set credentials to socket */
4415 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4419 /* Get parent pid if -S, --sig-parent is specified. */
4420 if (opt_sig_parent
) {
4424 /* Setup the kernel pipe for waking up the kernel thread */
4425 if ((ret
= create_kernel_poll_pipe()) < 0) {
4429 /* Setup the thread apps communication pipe. */
4430 if ((ret
= create_apps_cmd_pipe()) < 0) {
4434 /* Init UST command queue. */
4435 cds_wfq_init(&ust_cmd_queue
.queue
);
4437 /* Init UST app hash table */
4441 * Get session list pointer. This pointer MUST NOT be free(). This list is
4442 * statically declared in session.c
4444 session_list_ptr
= session_get_list();
4446 /* Set up max poll set size */
4447 lttng_poll_set_max_size();
4449 /* Create thread to manage the client socket */
4450 ret
= pthread_create(&client_thread
, NULL
,
4451 thread_manage_clients
, (void *) NULL
);
4453 perror("pthread_create clients");
4457 /* Create thread to dispatch registration */
4458 ret
= pthread_create(&dispatch_thread
, NULL
,
4459 thread_dispatch_ust_registration
, (void *) NULL
);
4461 perror("pthread_create dispatch");
4465 /* Create thread to manage application registration. */
4466 ret
= pthread_create(®_apps_thread
, NULL
,
4467 thread_registration_apps
, (void *) NULL
);
4469 perror("pthread_create registration");
4473 /* Create thread to manage application socket */
4474 ret
= pthread_create(&apps_thread
, NULL
,
4475 thread_manage_apps
, (void *) NULL
);
4477 perror("pthread_create apps");
4481 /* Create kernel thread to manage kernel event */
4482 ret
= pthread_create(&kernel_thread
, NULL
,
4483 thread_manage_kernel
, (void *) NULL
);
4485 perror("pthread_create kernel");
4489 ret
= pthread_join(kernel_thread
, &status
);
4491 perror("pthread_join");
4492 goto error
; /* join error, exit without cleanup */
4496 ret
= pthread_join(apps_thread
, &status
);
4498 perror("pthread_join");
4499 goto error
; /* join error, exit without cleanup */
4503 ret
= pthread_join(reg_apps_thread
, &status
);
4505 perror("pthread_join");
4506 goto error
; /* join error, exit without cleanup */
4510 ret
= pthread_join(dispatch_thread
, &status
);
4512 perror("pthread_join");
4513 goto error
; /* join error, exit without cleanup */
4517 ret
= pthread_join(client_thread
, &status
);
4519 perror("pthread_join");
4520 goto error
; /* join error, exit without cleanup */
4523 ret
= join_consumer_thread(&kconsumer_data
);
4525 perror("join_consumer");
4526 goto error
; /* join error, exit without cleanup */
4532 * cleanup() is called when no other thread is running.
4534 rcu_thread_online();
4536 rcu_thread_offline();
4537 rcu_unregister_thread();