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.
24 #include <semaphore.h>
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
36 #include <urcu/futex.h>
40 #include <common/common.h>
41 #include <common/compat/poll.h>
42 #include <common/defaults.h>
43 #include <common/kernel-consumer/kernel-consumer.h>
44 #include <common/ust-consumer/ust-consumer.h>
46 #include "lttng-sessiond.h"
57 #define CONSUMERD_FILE "lttng-consumerd"
59 struct consumer_data
{
60 enum lttng_consumer_type type
;
62 pthread_t thread
; /* Worker thread interacting with the consumer */
65 /* Mutex to control consumerd pid assignation */
66 pthread_mutex_t pid_mutex
;
72 /* consumer error and command Unix socket path */
73 char err_unix_sock_path
[PATH_MAX
];
74 char cmd_unix_sock_path
[PATH_MAX
];
78 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
79 const char default_tracing_group
[] = DEFAULT_TRACING_GROUP
;
80 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
81 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
84 int opt_verbose
; /* Not static for lttngerr.h */
85 int opt_verbose_consumer
; /* Not static for lttngerr.h */
86 int opt_quiet
; /* Not static for lttngerr.h */
89 const char *opt_tracing_group
;
90 static int opt_sig_parent
;
91 static int opt_daemon
;
92 static int opt_no_kernel
;
93 static int is_root
; /* Set to 1 if the daemon is running as root */
94 static pid_t ppid
; /* Parent PID for --sig-parent option */
97 /* Consumer daemon specific control data */
98 static struct consumer_data kconsumer_data
= {
99 .type
= LTTNG_CONSUMER_KERNEL
,
100 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
101 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
103 static struct consumer_data ustconsumer64_data
= {
104 .type
= LTTNG_CONSUMER64_UST
,
105 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
106 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
108 static struct consumer_data ustconsumer32_data
= {
109 .type
= LTTNG_CONSUMER32_UST
,
110 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
111 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
114 static int dispatch_thread_exit
;
116 /* Global application Unix socket path */
117 static char apps_unix_sock_path
[PATH_MAX
];
118 /* Global client Unix socket path */
119 static char client_unix_sock_path
[PATH_MAX
];
120 /* global wait shm path for UST */
121 static char wait_shm_path
[PATH_MAX
];
123 /* Sockets and FDs */
124 static int client_sock
;
125 static int apps_sock
;
126 static int kernel_tracer_fd
;
127 static int kernel_poll_pipe
[2];
130 * Quit pipe for all threads. This permits a single cancellation point
131 * for all threads when receiving an event on the pipe.
133 static int thread_quit_pipe
[2];
136 * This pipe is used to inform the thread managing application communication
137 * that a command is queued and ready to be processed.
139 static int apps_cmd_pipe
[2];
141 /* Pthread, Mutexes and Semaphores */
142 static pthread_t apps_thread
;
143 static pthread_t reg_apps_thread
;
144 static pthread_t client_thread
;
145 static pthread_t kernel_thread
;
146 static pthread_t dispatch_thread
;
150 * UST registration command queue. This queue is tied with a futex and uses a N
151 * wakers / 1 waiter implemented and detailed in futex.c/.h
153 * The thread_manage_apps and thread_dispatch_ust_registration interact with
154 * this queue and the wait/wake scheme.
156 static struct ust_cmd_queue ust_cmd_queue
;
159 * Pointer initialized before thread creation.
161 * This points to the tracing session list containing the session count and a
162 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
163 * MUST NOT be taken if you call a public function in session.c.
165 * The lock is nested inside the structure: session_list_ptr->lock. Please use
166 * session_lock_list and session_unlock_list for lock acquisition.
168 static struct ltt_session_list
*session_list_ptr
;
170 int ust_consumerd64_fd
= -1;
171 int ust_consumerd32_fd
= -1;
173 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
174 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
175 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
176 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
179 void setup_consumerd_path(void)
181 const char *bin
, *libdir
;
184 * Allow INSTALL_BIN_PATH to be used as a target path for the
185 * native architecture size consumer if CONFIG_CONSUMER*_PATH
186 * has not been defined.
188 #if (CAA_BITS_PER_LONG == 32)
189 if (!consumerd32_bin
[0]) {
190 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
192 if (!consumerd32_libdir
[0]) {
193 consumerd32_libdir
= INSTALL_LIB_PATH
;
195 #elif (CAA_BITS_PER_LONG == 64)
196 if (!consumerd64_bin
[0]) {
197 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
199 if (!consumerd64_libdir
[0]) {
200 consumerd64_libdir
= INSTALL_LIB_PATH
;
203 #error "Unknown bitness"
207 * runtime env. var. overrides the build default.
209 bin
= getenv("LTTNG_CONSUMERD32_BIN");
211 consumerd32_bin
= bin
;
213 bin
= getenv("LTTNG_CONSUMERD64_BIN");
215 consumerd64_bin
= bin
;
217 libdir
= getenv("LTTNG_CONSUMERD32_LIBDIR");
219 consumerd32_libdir
= libdir
;
221 libdir
= getenv("LTTNG_CONSUMERD64_LIBDIR");
223 consumerd64_libdir
= libdir
;
228 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
230 static int create_thread_poll_set(struct lttng_poll_event
*events
,
235 if (events
== NULL
|| size
== 0) {
240 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
246 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
258 * Check if the thread quit pipe was triggered.
260 * Return 1 if it was triggered else 0;
262 static int check_thread_quit_pipe(int fd
, uint32_t events
)
264 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
272 * Return group ID of the tracing group or -1 if not found.
274 static gid_t
allowed_group(void)
278 if (opt_tracing_group
) {
279 grp
= getgrnam(opt_tracing_group
);
281 grp
= getgrnam(default_tracing_group
);
291 * Init thread quit pipe.
293 * Return -1 on error or 0 if all pipes are created.
295 static int init_thread_quit_pipe(void)
299 ret
= pipe(thread_quit_pipe
);
301 PERROR("thread quit pipe");
305 for (i
= 0; i
< 2; i
++) {
306 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
318 * Complete teardown of a kernel session. This free all data structure related
319 * to a kernel session and update counter.
321 static void teardown_kernel_session(struct ltt_session
*session
)
323 if (!session
->kernel_session
) {
324 DBG3("No kernel session when tearing down session");
328 DBG("Tearing down kernel session");
331 * If a custom kernel consumer was registered, close the socket before
332 * tearing down the complete kernel session structure
334 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
335 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
338 trace_kernel_destroy_session(session
->kernel_session
);
342 * Complete teardown of all UST sessions. This will free everything on his path
343 * and destroy the core essence of all ust sessions :)
345 static void teardown_ust_session(struct ltt_session
*session
)
349 if (!session
->ust_session
) {
350 DBG3("No UST session when tearing down session");
354 DBG("Tearing down UST session(s)");
356 ret
= ust_app_destroy_trace_all(session
->ust_session
);
358 ERR("Error in ust_app_destroy_trace_all");
361 trace_ust_destroy_session(session
->ust_session
);
365 * Stop all threads by closing the thread quit pipe.
367 static void stop_threads(void)
371 /* Stopping all threads */
372 DBG("Terminating all threads");
373 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
375 ERR("write error on thread quit pipe");
378 /* Dispatch thread */
379 dispatch_thread_exit
= 1;
380 futex_nto1_wake(&ust_cmd_queue
.futex
);
386 static void cleanup(void)
390 struct ltt_session
*sess
, *stmp
;
394 DBG("Removing %s directory", rundir
);
395 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
397 ERR("asprintf failed. Something is really wrong!");
400 /* Remove lttng run directory */
403 ERR("Unable to clean %s", rundir
);
407 DBG("Cleaning up all sessions");
409 /* Destroy session list mutex */
410 if (session_list_ptr
!= NULL
) {
411 pthread_mutex_destroy(&session_list_ptr
->lock
);
413 /* Cleanup ALL session */
414 cds_list_for_each_entry_safe(sess
, stmp
,
415 &session_list_ptr
->head
, list
) {
416 teardown_kernel_session(sess
);
417 teardown_ust_session(sess
);
422 DBG("Closing all UST sockets");
423 ust_app_clean_list();
425 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
427 if (is_root
&& !opt_no_kernel
) {
428 DBG2("Closing kernel fd");
429 close(kernel_tracer_fd
);
430 DBG("Unloading kernel modules");
431 modprobe_remove_lttng_all();
434 close(thread_quit_pipe
[0]);
435 close(thread_quit_pipe
[1]);
438 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
439 "Matthew, BEET driven development works!%c[%dm",
440 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
445 * Send data on a unix socket using the liblttsessiondcomm API.
447 * Return lttcomm error code.
449 static int send_unix_sock(int sock
, void *buf
, size_t len
)
451 /* Check valid length */
456 return lttcomm_send_unix_sock(sock
, buf
, len
);
460 * Free memory of a command context structure.
462 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
464 DBG("Clean command context structure");
466 if ((*cmd_ctx
)->llm
) {
467 free((*cmd_ctx
)->llm
);
469 if ((*cmd_ctx
)->lsm
) {
470 free((*cmd_ctx
)->lsm
);
478 * Send all stream fds of kernel channel to the consumer.
480 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
481 int sock
, struct ltt_kernel_channel
*channel
,
482 uid_t uid
, gid_t gid
)
485 struct ltt_kernel_stream
*stream
;
486 struct lttcomm_consumer_msg lkm
;
488 DBG("Sending streams of channel %s to kernel consumer",
489 channel
->channel
->name
);
492 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
493 lkm
.u
.channel
.channel_key
= channel
->fd
;
494 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
495 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
496 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
497 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
499 perror("send consumer channel");
504 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
508 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
509 lkm
.u
.stream
.channel_key
= channel
->fd
;
510 lkm
.u
.stream
.stream_key
= stream
->fd
;
511 lkm
.u
.stream
.state
= stream
->state
;
512 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
513 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
514 lkm
.u
.stream
.uid
= uid
;
515 lkm
.u
.stream
.gid
= gid
;
516 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
517 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
518 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
519 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
521 perror("send consumer stream");
524 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
526 perror("send consumer stream ancillary data");
531 DBG("consumer channel streams sent");
540 * Send all stream fds of the kernel session to the consumer.
542 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
543 struct ltt_kernel_session
*session
)
546 struct ltt_kernel_channel
*chan
;
547 struct lttcomm_consumer_msg lkm
;
548 int sock
= session
->consumer_fd
;
550 DBG("Sending metadata stream fd");
552 /* Extra protection. It's NOT supposed to be set to 0 at this point */
553 if (session
->consumer_fd
== 0) {
554 session
->consumer_fd
= consumer_data
->cmd_sock
;
557 if (session
->metadata_stream_fd
!= 0) {
558 /* Send metadata channel fd */
559 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
560 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
561 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
562 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
563 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
564 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
566 perror("send consumer channel");
570 /* Send metadata stream fd */
571 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
572 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
573 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
574 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
575 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
576 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
577 lkm
.u
.stream
.uid
= session
->uid
;
578 lkm
.u
.stream
.gid
= session
->gid
;
579 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
580 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
581 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
582 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
584 perror("send consumer stream");
587 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
589 perror("send consumer stream");
594 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
595 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
596 session
->uid
, session
->gid
);
602 DBG("consumer fds (metadata and channel streams) sent");
611 * Notify UST applications using the shm mmap futex.
613 static int notify_ust_apps(int active
)
617 DBG("Notifying applications of session daemon state: %d", active
);
619 /* See shm.c for this call implying mmap, shm and futex calls */
620 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
621 if (wait_shm_mmap
== NULL
) {
625 /* Wake waiting process */
626 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
628 /* Apps notified successfully */
636 * Setup the outgoing data buffer for the response (llm) by allocating the
637 * right amount of memory and copying the original information from the lsm
640 * Return total size of the buffer pointed by buf.
642 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
648 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
649 if (cmd_ctx
->llm
== NULL
) {
655 /* Copy common data */
656 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
657 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
659 cmd_ctx
->llm
->data_size
= size
;
660 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
669 * Update the kernel poll set of all channel fd available over all tracing
670 * session. Add the wakeup pipe at the end of the set.
672 static int update_kernel_poll(struct lttng_poll_event
*events
)
675 struct ltt_session
*session
;
676 struct ltt_kernel_channel
*channel
;
678 DBG("Updating kernel poll set");
681 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
682 session_lock(session
);
683 if (session
->kernel_session
== NULL
) {
684 session_unlock(session
);
688 cds_list_for_each_entry(channel
,
689 &session
->kernel_session
->channel_list
.head
, list
) {
690 /* Add channel fd to the kernel poll set */
691 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
693 session_unlock(session
);
696 DBG("Channel fd %d added to kernel set", channel
->fd
);
698 session_unlock(session
);
700 session_unlock_list();
705 session_unlock_list();
710 * Find the channel fd from 'fd' over all tracing session. When found, check
711 * for new channel stream and send those stream fds to the kernel consumer.
713 * Useful for CPU hotplug feature.
715 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
718 struct ltt_session
*session
;
719 struct ltt_kernel_channel
*channel
;
721 DBG("Updating kernel streams for channel fd %d", fd
);
724 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
725 session_lock(session
);
726 if (session
->kernel_session
== NULL
) {
727 session_unlock(session
);
731 /* This is not suppose to be 0 but this is an extra security check */
732 if (session
->kernel_session
->consumer_fd
== 0) {
733 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
736 cds_list_for_each_entry(channel
,
737 &session
->kernel_session
->channel_list
.head
, list
) {
738 if (channel
->fd
== fd
) {
739 DBG("Channel found, updating kernel streams");
740 ret
= kernel_open_channel_stream(channel
);
746 * Have we already sent fds to the consumer? If yes, it means
747 * that tracing is started so it is safe to send our updated
750 if (session
->kernel_session
->consumer_fds_sent
== 1) {
751 ret
= send_kconsumer_channel_streams(consumer_data
,
752 session
->kernel_session
->consumer_fd
, channel
,
753 session
->uid
, session
->gid
);
761 session_unlock(session
);
763 session_unlock_list();
767 session_unlock(session
);
768 session_unlock_list();
773 * For each tracing session, update newly registered apps.
775 static void update_ust_app(int app_sock
)
777 struct ltt_session
*sess
, *stmp
;
781 /* For all tracing session(s) */
782 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
784 if (sess
->ust_session
) {
785 ust_app_global_update(sess
->ust_session
, app_sock
);
787 session_unlock(sess
);
790 session_unlock_list();
794 * This thread manage event coming from the kernel.
796 * Features supported in this thread:
799 static void *thread_manage_kernel(void *data
)
801 int ret
, i
, pollfd
, update_poll_flag
= 1;
802 uint32_t revents
, nb_fd
;
804 struct lttng_poll_event events
;
806 DBG("Thread manage kernel started");
808 ret
= create_thread_poll_set(&events
, 2);
813 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
819 if (update_poll_flag
== 1) {
821 * Reset number of fd in the poll set. Always 2 since there is the thread
822 * quit pipe and the kernel pipe.
826 ret
= update_kernel_poll(&events
);
830 update_poll_flag
= 0;
833 nb_fd
= LTTNG_POLL_GETNB(&events
);
835 DBG("Thread kernel polling on %d fds", nb_fd
);
837 /* Zeroed the poll events */
838 lttng_poll_reset(&events
);
840 /* Poll infinite value of time */
841 ret
= lttng_poll_wait(&events
, -1);
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 */
932 ret
= lttng_poll_wait(&events
, -1);
937 for (i
= 0; i
< nb_fd
; i
++) {
938 /* Fetch once the poll data */
939 revents
= LTTNG_POLL_GETEV(&events
, i
);
940 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
942 /* Thread quit pipe has been closed. Killing thread. */
943 ret
= check_thread_quit_pipe(pollfd
, revents
);
948 /* Event on the registration socket */
949 if (pollfd
== consumer_data
->err_sock
) {
950 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
951 ERR("consumer err socket poll error");
957 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
962 DBG2("Receiving code from consumer err_sock");
964 /* Getting status code from kconsumerd */
965 ret
= lttcomm_recv_unix_sock(sock
, &code
,
966 sizeof(enum lttcomm_return_code
));
971 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
972 consumer_data
->cmd_sock
=
973 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
974 if (consumer_data
->cmd_sock
< 0) {
975 sem_post(&consumer_data
->sem
);
976 PERROR("consumer connect");
979 /* Signal condition to tell that the kconsumerd is ready */
980 sem_post(&consumer_data
->sem
);
981 DBG("consumer command socket ready");
983 ERR("consumer error when waiting for SOCK_READY : %s",
984 lttcomm_get_readable_code(-code
));
988 /* Remove the kconsumerd error sock since we've established a connexion */
989 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
994 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
999 /* Update number of fd */
1000 nb_fd
= LTTNG_POLL_GETNB(&events
);
1002 /* Inifinite blocking call, waiting for transmission */
1003 ret
= lttng_poll_wait(&events
, -1);
1008 for (i
= 0; i
< nb_fd
; i
++) {
1009 /* Fetch once the poll data */
1010 revents
= LTTNG_POLL_GETEV(&events
, i
);
1011 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1013 /* Thread quit pipe has been closed. Killing thread. */
1014 ret
= check_thread_quit_pipe(pollfd
, revents
);
1019 /* Event on the kconsumerd socket */
1020 if (pollfd
== sock
) {
1021 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1022 ERR("consumer err socket second poll error");
1028 /* Wait for any kconsumerd error */
1029 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1030 sizeof(enum lttcomm_return_code
));
1032 ERR("consumer closed the command socket");
1036 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1039 DBG("consumer thread dying");
1040 close(consumer_data
->err_sock
);
1041 close(consumer_data
->cmd_sock
);
1044 unlink(consumer_data
->err_unix_sock_path
);
1045 unlink(consumer_data
->cmd_unix_sock_path
);
1046 consumer_data
->pid
= 0;
1048 lttng_poll_clean(&events
);
1054 * This thread manage application communication.
1056 static void *thread_manage_apps(void *data
)
1059 uint32_t revents
, nb_fd
;
1060 struct ust_command ust_cmd
;
1061 struct lttng_poll_event events
;
1063 DBG("[thread] Manage application started");
1065 rcu_register_thread();
1066 rcu_thread_online();
1068 ret
= create_thread_poll_set(&events
, 2);
1073 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1079 /* Zeroed the events structure */
1080 lttng_poll_reset(&events
);
1082 nb_fd
= LTTNG_POLL_GETNB(&events
);
1084 DBG("Apps thread polling on %d fds", nb_fd
);
1086 /* Inifinite blocking call, waiting for transmission */
1087 ret
= lttng_poll_wait(&events
, -1);
1092 for (i
= 0; i
< nb_fd
; i
++) {
1093 /* Fetch once the poll data */
1094 revents
= LTTNG_POLL_GETEV(&events
, i
);
1095 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1097 /* Thread quit pipe has been closed. Killing thread. */
1098 ret
= check_thread_quit_pipe(pollfd
, revents
);
1103 /* Inspect the apps cmd pipe */
1104 if (pollfd
== apps_cmd_pipe
[0]) {
1105 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1106 ERR("Apps command pipe error");
1108 } else if (revents
& LPOLLIN
) {
1110 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1111 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1112 perror("read apps cmd pipe");
1116 /* Register applicaton to the session daemon */
1117 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1119 if (ret
== -ENOMEM
) {
1121 } else if (ret
< 0) {
1126 * Validate UST version compatibility.
1128 ret
= ust_app_validate_version(ust_cmd
.sock
);
1131 * Add channel(s) and event(s) to newly registered apps
1132 * from lttng global UST domain.
1134 update_ust_app(ust_cmd
.sock
);
1137 ret
= ust_app_register_done(ust_cmd
.sock
);
1140 * If the registration is not possible, we simply
1141 * unregister the apps and continue
1143 ust_app_unregister(ust_cmd
.sock
);
1146 * We just need here to monitor the close of the UST
1147 * socket and poll set monitor those by default.
1149 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1154 DBG("Apps with sock %d added to poll set",
1162 * At this point, we know that a registered application made
1163 * the event at poll_wait.
1165 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1166 /* Removing from the poll set */
1167 ret
= lttng_poll_del(&events
, pollfd
);
1172 /* Socket closed on remote end. */
1173 ust_app_unregister(pollfd
);
1181 DBG("Application communication apps dying");
1182 close(apps_cmd_pipe
[0]);
1183 close(apps_cmd_pipe
[1]);
1185 lttng_poll_clean(&events
);
1187 rcu_thread_offline();
1188 rcu_unregister_thread();
1193 * Dispatch request from the registration threads to the application
1194 * communication thread.
1196 static void *thread_dispatch_ust_registration(void *data
)
1199 struct cds_wfq_node
*node
;
1200 struct ust_command
*ust_cmd
= NULL
;
1202 DBG("[thread] Dispatch UST command started");
1204 while (!dispatch_thread_exit
) {
1205 /* Atomically prepare the queue futex */
1206 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1209 /* Dequeue command for registration */
1210 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1212 DBG("Woken up but nothing in the UST command queue");
1213 /* Continue thread execution */
1217 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1219 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1220 " gid:%d sock:%d name:%s (version %d.%d)",
1221 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1222 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1223 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1224 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1226 * Inform apps thread of the new application registration. This
1227 * call is blocking so we can be assured that the data will be read
1228 * at some point in time or wait to the end of the world :)
1230 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1231 sizeof(struct ust_command
));
1233 perror("write apps cmd pipe");
1234 if (errno
== EBADF
) {
1236 * We can't inform the application thread to process
1237 * registration. We will exit or else application
1238 * registration will not occur and tracing will never
1245 } while (node
!= NULL
);
1247 /* Futex wait on queue. Blocking call on futex() */
1248 futex_nto1_wait(&ust_cmd_queue
.futex
);
1252 DBG("Dispatch thread dying");
1257 * This thread manage application registration.
1259 static void *thread_registration_apps(void *data
)
1261 int sock
= 0, i
, ret
, pollfd
;
1262 uint32_t revents
, nb_fd
;
1263 struct lttng_poll_event events
;
1265 * Get allocated in this thread, enqueued to a global queue, dequeued and
1266 * freed in the manage apps thread.
1268 struct ust_command
*ust_cmd
= NULL
;
1270 DBG("[thread] Manage application registration started");
1272 ret
= lttcomm_listen_unix_sock(apps_sock
);
1278 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1279 * more will be added to this poll set.
1281 ret
= create_thread_poll_set(&events
, 2);
1286 /* Add the application registration socket */
1287 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1292 /* Notify all applications to register */
1293 ret
= notify_ust_apps(1);
1295 ERR("Failed to notify applications or create the wait shared memory.\n"
1296 "Execution continues but there might be problem for already\n"
1297 "running applications that wishes to register.");
1301 DBG("Accepting application registration");
1303 nb_fd
= LTTNG_POLL_GETNB(&events
);
1305 /* Inifinite blocking call, waiting for transmission */
1306 ret
= lttng_poll_wait(&events
, -1);
1311 for (i
= 0; i
< nb_fd
; i
++) {
1312 /* Fetch once the poll data */
1313 revents
= LTTNG_POLL_GETEV(&events
, i
);
1314 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1316 /* Thread quit pipe has been closed. Killing thread. */
1317 ret
= check_thread_quit_pipe(pollfd
, revents
);
1322 /* Event on the registration socket */
1323 if (pollfd
== apps_sock
) {
1324 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1325 ERR("Register apps socket poll error");
1327 } else if (revents
& LPOLLIN
) {
1328 sock
= lttcomm_accept_unix_sock(apps_sock
);
1333 /* Create UST registration command for enqueuing */
1334 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1335 if (ust_cmd
== NULL
) {
1336 perror("ust command zmalloc");
1341 * Using message-based transmissions to ensure we don't
1342 * have to deal with partially received messages.
1344 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1345 sizeof(struct ust_register_msg
));
1346 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1348 perror("lttcomm_recv_unix_sock register apps");
1350 ERR("Wrong size received on apps register");
1357 ust_cmd
->sock
= sock
;
1359 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1360 " gid:%d sock:%d name:%s (version %d.%d)",
1361 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1362 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1363 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1364 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1367 * Lock free enqueue the registration request. The red pill
1368 * has been taken! This apps will be part of the *system*.
1370 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1373 * Wake the registration queue futex. Implicit memory
1374 * barrier with the exchange in cds_wfq_enqueue.
1376 futex_nto1_wake(&ust_cmd_queue
.futex
);
1383 DBG("UST Registration thread dying");
1385 /* Notify that the registration thread is gone */
1390 unlink(apps_unix_sock_path
);
1392 lttng_poll_clean(&events
);
1398 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1399 * exec or it will fails.
1401 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1404 struct timespec timeout
;
1406 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1407 timeout
.tv_nsec
= 0;
1409 /* Setup semaphore */
1410 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1412 PERROR("sem_init consumer semaphore");
1416 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1417 thread_manage_consumer
, consumer_data
);
1419 PERROR("pthread_create consumer");
1424 /* Get time for sem_timedwait absolute timeout */
1425 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1427 PERROR("clock_gettime spawn consumer");
1428 /* Infinite wait for the kconsumerd thread to be ready */
1429 ret
= sem_wait(&consumer_data
->sem
);
1431 /* Normal timeout if the gettime was successful */
1432 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1433 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1437 if (errno
== ETIMEDOUT
) {
1439 * Call has timed out so we kill the kconsumerd_thread and return
1442 ERR("The consumer thread was never ready. Killing it");
1443 ret
= pthread_cancel(consumer_data
->thread
);
1445 PERROR("pthread_cancel consumer thread");
1448 PERROR("semaphore wait failed consumer thread");
1453 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1454 if (consumer_data
->pid
== 0) {
1455 ERR("Kconsumerd did not start");
1456 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1459 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1468 * Join consumer thread
1470 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1475 if (consumer_data
->pid
!= 0) {
1476 ret
= kill(consumer_data
->pid
, SIGTERM
);
1478 ERR("Error killing consumer daemon");
1481 return pthread_join(consumer_data
->thread
, &status
);
1488 * Fork and exec a consumer daemon (consumerd).
1490 * Return pid if successful else -1.
1492 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1496 const char *consumer_to_use
;
1497 const char *verbosity
;
1500 DBG("Spawning consumerd");
1507 if (opt_verbose_consumer
) {
1508 verbosity
= "--verbose";
1510 verbosity
= "--quiet";
1512 switch (consumer_data
->type
) {
1513 case LTTNG_CONSUMER_KERNEL
:
1515 * Find out which consumerd to execute. We will first try the
1516 * 64-bit path, then the sessiond's installation directory, and
1517 * fallback on the 32-bit one,
1519 DBG3("Looking for a kernel consumer at these locations:");
1520 DBG3(" 1) %s", consumerd64_bin
);
1521 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1522 DBG3(" 3) %s", consumerd32_bin
);
1523 if (stat(consumerd64_bin
, &st
) == 0) {
1524 DBG3("Found location #1");
1525 consumer_to_use
= consumerd64_bin
;
1526 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1527 DBG3("Found location #2");
1528 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1529 } else if (stat(consumerd32_bin
, &st
) == 0) {
1530 DBG3("Found location #3");
1531 consumer_to_use
= consumerd32_bin
;
1533 DBG("Could not find any valid consumerd executable");
1536 DBG("Using kernel consumer at: %s", consumer_to_use
);
1537 execl(consumer_to_use
,
1538 "lttng-consumerd", verbosity
, "-k",
1539 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1540 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1543 case LTTNG_CONSUMER64_UST
:
1545 char *tmpnew
= NULL
;
1547 if (consumerd64_libdir
[0] != '\0') {
1551 tmp
= getenv("LD_LIBRARY_PATH");
1555 tmplen
= strlen("LD_LIBRARY_PATH=")
1556 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1557 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1562 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1563 strcat(tmpnew
, consumerd64_libdir
);
1564 if (tmp
[0] != '\0') {
1565 strcat(tmpnew
, ":");
1566 strcat(tmpnew
, tmp
);
1568 ret
= putenv(tmpnew
);
1574 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1575 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1576 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1577 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1579 if (consumerd64_libdir
[0] != '\0') {
1587 case LTTNG_CONSUMER32_UST
:
1589 char *tmpnew
= NULL
;
1591 if (consumerd32_libdir
[0] != '\0') {
1595 tmp
= getenv("LD_LIBRARY_PATH");
1599 tmplen
= strlen("LD_LIBRARY_PATH=")
1600 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1601 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1606 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1607 strcat(tmpnew
, consumerd32_libdir
);
1608 if (tmp
[0] != '\0') {
1609 strcat(tmpnew
, ":");
1610 strcat(tmpnew
, tmp
);
1612 ret
= putenv(tmpnew
);
1618 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1619 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1620 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1621 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1623 if (consumerd32_libdir
[0] != '\0') {
1632 perror("unknown consumer type");
1636 perror("kernel start consumer exec");
1639 } else if (pid
> 0) {
1642 perror("start consumer fork");
1650 * Spawn the consumerd daemon and session daemon thread.
1652 static int start_consumerd(struct consumer_data
*consumer_data
)
1656 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1657 if (consumer_data
->pid
!= 0) {
1658 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1662 ret
= spawn_consumerd(consumer_data
);
1664 ERR("Spawning consumerd failed");
1665 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1669 /* Setting up the consumer_data pid */
1670 consumer_data
->pid
= ret
;
1671 DBG2("Consumer pid %d", consumer_data
->pid
);
1672 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1674 DBG2("Spawning consumer control thread");
1675 ret
= spawn_consumer_thread(consumer_data
);
1677 ERR("Fatal error spawning consumer control thread");
1689 * Check version of the lttng-modules.
1691 static int validate_lttng_modules_version(void)
1693 return kernel_validate_version(kernel_tracer_fd
);
1697 * Setup necessary data for kernel tracer action.
1699 static int init_kernel_tracer(void)
1703 /* Modprobe lttng kernel modules */
1704 ret
= modprobe_lttng_control();
1709 /* Open debugfs lttng */
1710 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1711 if (kernel_tracer_fd
< 0) {
1712 DBG("Failed to open %s", module_proc_lttng
);
1717 /* Validate kernel version */
1718 ret
= validate_lttng_modules_version();
1723 ret
= modprobe_lttng_data();
1728 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1732 modprobe_remove_lttng_control();
1733 close(kernel_tracer_fd
);
1734 kernel_tracer_fd
= 0;
1735 return LTTCOMM_KERN_VERSION
;
1738 close(kernel_tracer_fd
);
1741 modprobe_remove_lttng_control();
1744 WARN("No kernel tracer available");
1745 kernel_tracer_fd
= 0;
1746 return LTTCOMM_KERN_NA
;
1750 * Init tracing by creating trace directory and sending fds kernel consumer.
1752 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1756 if (session
->consumer_fds_sent
== 0) {
1758 * Assign default kernel consumer socket if no consumer assigned to the
1759 * kernel session. At this point, it's NOT suppose to be 0 but this is
1760 * an extra security check.
1762 if (session
->consumer_fd
== 0) {
1763 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1766 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1768 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1772 session
->consumer_fds_sent
= 1;
1780 * Create an UST session and add it to the session ust list.
1782 static int create_ust_session(struct ltt_session
*session
,
1783 struct lttng_domain
*domain
)
1785 struct ltt_ust_session
*lus
= NULL
;
1788 switch (domain
->type
) {
1789 case LTTNG_DOMAIN_UST
:
1792 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1796 DBG("Creating UST session");
1798 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1800 ret
= LTTCOMM_UST_SESS_FAIL
;
1804 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1805 session
->uid
, session
->gid
);
1807 if (ret
!= -EEXIST
) {
1808 ERR("Trace directory creation error");
1809 ret
= LTTCOMM_UST_SESS_FAIL
;
1814 /* The domain type dictate different actions on session creation */
1815 switch (domain
->type
) {
1816 case LTTNG_DOMAIN_UST
:
1817 /* No ustctl for the global UST domain */
1820 ERR("Unknown UST domain on create session %d", domain
->type
);
1823 lus
->uid
= session
->uid
;
1824 lus
->gid
= session
->gid
;
1825 session
->ust_session
= lus
;
1835 * Create a kernel tracer session then create the default channel.
1837 static int create_kernel_session(struct ltt_session
*session
)
1841 DBG("Creating kernel session");
1843 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1845 ret
= LTTCOMM_KERN_SESS_FAIL
;
1849 /* Set kernel consumer socket fd */
1850 if (kconsumer_data
.cmd_sock
) {
1851 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1854 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1855 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1857 if (ret
!= -EEXIST
) {
1858 ERR("Trace directory creation error");
1862 session
->kernel_session
->uid
= session
->uid
;
1863 session
->kernel_session
->gid
= session
->gid
;
1870 * Check if the UID or GID match the session. Root user has access to all
1873 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1875 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1882 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1885 struct ltt_session
*session
;
1887 DBG("Counting number of available session for UID %d GID %d",
1889 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1891 * Only list the sessions the user can control.
1893 if (!session_access_ok(session
, uid
, gid
)) {
1902 * Using the session list, filled a lttng_session array to send back to the
1903 * client for session listing.
1905 * The session list lock MUST be acquired before calling this function. Use
1906 * session_lock_list() and session_unlock_list().
1908 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
1912 struct ltt_session
*session
;
1914 DBG("Getting all available session for UID %d GID %d",
1917 * Iterate over session list and append data after the control struct in
1920 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1922 * Only list the sessions the user can control.
1924 if (!session_access_ok(session
, uid
, gid
)) {
1927 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1928 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1929 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1930 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1931 sessions
[i
].enabled
= session
->enabled
;
1937 * Fill lttng_channel array of all channels.
1939 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1940 struct lttng_channel
*channels
)
1943 struct ltt_kernel_channel
*kchan
;
1945 DBG("Listing channels for session %s", session
->name
);
1948 case LTTNG_DOMAIN_KERNEL
:
1949 /* Kernel channels */
1950 if (session
->kernel_session
!= NULL
) {
1951 cds_list_for_each_entry(kchan
,
1952 &session
->kernel_session
->channel_list
.head
, list
) {
1953 /* Copy lttng_channel struct to array */
1954 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1955 channels
[i
].enabled
= kchan
->enabled
;
1960 case LTTNG_DOMAIN_UST
:
1962 struct lttng_ht_iter iter
;
1963 struct ltt_ust_channel
*uchan
;
1965 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1966 &iter
.iter
, uchan
, node
.node
) {
1967 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1968 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1969 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1970 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1971 channels
[i
].attr
.switch_timer_interval
=
1972 uchan
->attr
.switch_timer_interval
;
1973 channels
[i
].attr
.read_timer_interval
=
1974 uchan
->attr
.read_timer_interval
;
1975 channels
[i
].enabled
= uchan
->enabled
;
1976 switch (uchan
->attr
.output
) {
1977 case LTTNG_UST_MMAP
:
1979 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
1992 * Create a list of ust global domain events.
1994 static int list_lttng_ust_global_events(char *channel_name
,
1995 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
1998 unsigned int nb_event
= 0;
1999 struct lttng_ht_iter iter
;
2000 struct lttng_ht_node_str
*node
;
2001 struct ltt_ust_channel
*uchan
;
2002 struct ltt_ust_event
*uevent
;
2003 struct lttng_event
*tmp
;
2005 DBG("Listing UST global events for channel %s", channel_name
);
2009 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2010 node
= lttng_ht_iter_get_node_str(&iter
);
2012 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2016 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2018 nb_event
+= lttng_ht_get_count(uchan
->events
);
2020 if (nb_event
== 0) {
2025 DBG3("Listing UST global %d events", nb_event
);
2027 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2029 ret
= -LTTCOMM_FATAL
;
2033 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2034 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2035 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2036 tmp
[i
].enabled
= uevent
->enabled
;
2037 switch (uevent
->attr
.instrumentation
) {
2038 case LTTNG_UST_TRACEPOINT
:
2039 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2041 case LTTNG_UST_PROBE
:
2042 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2044 case LTTNG_UST_FUNCTION
:
2045 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2048 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2049 switch (uevent
->attr
.loglevel_type
) {
2050 case LTTNG_UST_LOGLEVEL_ALL
:
2051 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2053 case LTTNG_UST_LOGLEVEL_RANGE
:
2054 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2056 case LTTNG_UST_LOGLEVEL_SINGLE
:
2057 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2072 * Fill lttng_event array of all kernel events in the channel.
2074 static int list_lttng_kernel_events(char *channel_name
,
2075 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2078 unsigned int nb_event
;
2079 struct ltt_kernel_event
*event
;
2080 struct ltt_kernel_channel
*kchan
;
2082 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2083 if (kchan
== NULL
) {
2084 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2088 nb_event
= kchan
->event_count
;
2090 DBG("Listing events for channel %s", kchan
->channel
->name
);
2092 if (nb_event
== 0) {
2097 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2098 if (*events
== NULL
) {
2099 ret
= LTTCOMM_FATAL
;
2103 /* Kernel channels */
2104 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2105 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2106 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2107 (*events
)[i
].enabled
= event
->enabled
;
2108 switch (event
->event
->instrumentation
) {
2109 case LTTNG_KERNEL_TRACEPOINT
:
2110 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2112 case LTTNG_KERNEL_KPROBE
:
2113 case LTTNG_KERNEL_KRETPROBE
:
2114 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2115 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2116 sizeof(struct lttng_kernel_kprobe
));
2118 case LTTNG_KERNEL_FUNCTION
:
2119 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2120 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2121 sizeof(struct lttng_kernel_function
));
2123 case LTTNG_KERNEL_NOOP
:
2124 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2126 case LTTNG_KERNEL_SYSCALL
:
2127 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2129 case LTTNG_KERNEL_ALL
:
2143 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2145 static int cmd_disable_channel(struct ltt_session
*session
,
2146 int domain
, char *channel_name
)
2149 struct ltt_ust_session
*usess
;
2151 usess
= session
->ust_session
;
2154 case LTTNG_DOMAIN_KERNEL
:
2156 ret
= channel_kernel_disable(session
->kernel_session
,
2158 if (ret
!= LTTCOMM_OK
) {
2162 kernel_wait_quiescent(kernel_tracer_fd
);
2165 case LTTNG_DOMAIN_UST
:
2167 struct ltt_ust_channel
*uchan
;
2168 struct lttng_ht
*chan_ht
;
2170 chan_ht
= usess
->domain_global
.channels
;
2172 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2173 if (uchan
== NULL
) {
2174 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2178 ret
= channel_ust_disable(usess
, domain
, uchan
);
2179 if (ret
!= LTTCOMM_OK
) {
2185 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2186 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2187 case LTTNG_DOMAIN_UST_PID
:
2190 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2201 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2203 static int cmd_enable_channel(struct ltt_session
*session
,
2204 int domain
, struct lttng_channel
*attr
)
2207 struct ltt_ust_session
*usess
= session
->ust_session
;
2208 struct lttng_ht
*chan_ht
;
2210 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2213 case LTTNG_DOMAIN_KERNEL
:
2215 struct ltt_kernel_channel
*kchan
;
2217 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2218 session
->kernel_session
);
2219 if (kchan
== NULL
) {
2220 ret
= channel_kernel_create(session
->kernel_session
,
2221 attr
, kernel_poll_pipe
[1]);
2223 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2226 if (ret
!= LTTCOMM_OK
) {
2230 kernel_wait_quiescent(kernel_tracer_fd
);
2233 case LTTNG_DOMAIN_UST
:
2235 struct ltt_ust_channel
*uchan
;
2237 chan_ht
= usess
->domain_global
.channels
;
2239 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2240 if (uchan
== NULL
) {
2241 ret
= channel_ust_create(usess
, domain
, attr
);
2243 ret
= channel_ust_enable(usess
, domain
, uchan
);
2248 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2249 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2250 case LTTNG_DOMAIN_UST_PID
:
2253 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2262 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2264 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2265 char *channel_name
, char *event_name
)
2270 case LTTNG_DOMAIN_KERNEL
:
2272 struct ltt_kernel_channel
*kchan
;
2273 struct ltt_kernel_session
*ksess
;
2275 ksess
= session
->kernel_session
;
2277 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2278 if (kchan
== NULL
) {
2279 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2283 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2284 if (ret
!= LTTCOMM_OK
) {
2288 kernel_wait_quiescent(kernel_tracer_fd
);
2291 case LTTNG_DOMAIN_UST
:
2293 struct ltt_ust_channel
*uchan
;
2294 struct ltt_ust_session
*usess
;
2296 usess
= session
->ust_session
;
2298 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2300 if (uchan
== NULL
) {
2301 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2305 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2306 if (ret
!= LTTCOMM_OK
) {
2310 DBG3("Disable UST event %s in channel %s completed", event_name
,
2315 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2316 case LTTNG_DOMAIN_UST_PID
:
2317 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2331 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2333 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2339 case LTTNG_DOMAIN_KERNEL
:
2341 struct ltt_kernel_session
*ksess
;
2342 struct ltt_kernel_channel
*kchan
;
2344 ksess
= session
->kernel_session
;
2346 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2347 if (kchan
== NULL
) {
2348 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2352 ret
= event_kernel_disable_all(ksess
, kchan
);
2353 if (ret
!= LTTCOMM_OK
) {
2357 kernel_wait_quiescent(kernel_tracer_fd
);
2360 case LTTNG_DOMAIN_UST
:
2362 struct ltt_ust_session
*usess
;
2363 struct ltt_ust_channel
*uchan
;
2365 usess
= session
->ust_session
;
2367 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2369 if (uchan
== NULL
) {
2370 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2374 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2379 DBG3("Disable all UST events in channel %s completed", channel_name
);
2384 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2385 case LTTNG_DOMAIN_UST_PID
:
2386 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2400 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2402 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2403 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2408 case LTTNG_DOMAIN_KERNEL
:
2409 /* Add kernel context to kernel tracer */
2410 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2411 event_name
, channel_name
);
2412 if (ret
!= LTTCOMM_OK
) {
2416 case LTTNG_DOMAIN_UST
:
2418 struct ltt_ust_session
*usess
= session
->ust_session
;
2420 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2421 if (ret
!= LTTCOMM_OK
) {
2427 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2428 case LTTNG_DOMAIN_UST_PID
:
2429 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2443 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2445 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2446 char *channel_name
, struct lttng_event
*event
)
2449 struct lttng_channel
*attr
;
2450 struct ltt_ust_session
*usess
= session
->ust_session
;
2453 case LTTNG_DOMAIN_KERNEL
:
2455 struct ltt_kernel_channel
*kchan
;
2457 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2458 session
->kernel_session
);
2459 if (kchan
== NULL
) {
2460 attr
= channel_new_default_attr(domain
);
2462 ret
= LTTCOMM_FATAL
;
2465 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2467 /* This call will notify the kernel thread */
2468 ret
= channel_kernel_create(session
->kernel_session
,
2469 attr
, kernel_poll_pipe
[1]);
2470 if (ret
!= LTTCOMM_OK
) {
2477 /* Get the newly created kernel channel pointer */
2478 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2479 session
->kernel_session
);
2480 if (kchan
== NULL
) {
2481 /* This sould not happen... */
2482 ret
= LTTCOMM_FATAL
;
2486 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2488 if (ret
!= LTTCOMM_OK
) {
2492 kernel_wait_quiescent(kernel_tracer_fd
);
2495 case LTTNG_DOMAIN_UST
:
2497 struct lttng_channel
*attr
;
2498 struct ltt_ust_channel
*uchan
;
2500 /* Get channel from global UST domain */
2501 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2503 if (uchan
== NULL
) {
2504 /* Create default channel */
2505 attr
= channel_new_default_attr(domain
);
2507 ret
= LTTCOMM_FATAL
;
2510 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2511 attr
->name
[NAME_MAX
- 1] = '\0';
2513 ret
= channel_ust_create(usess
, domain
, attr
);
2514 if (ret
!= LTTCOMM_OK
) {
2520 /* Get the newly created channel reference back */
2521 uchan
= trace_ust_find_channel_by_name(
2522 usess
->domain_global
.channels
, channel_name
);
2523 if (uchan
== NULL
) {
2524 /* Something is really wrong */
2525 ret
= LTTCOMM_FATAL
;
2530 /* At this point, the session and channel exist on the tracer */
2531 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2532 if (ret
!= LTTCOMM_OK
) {
2538 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2539 case LTTNG_DOMAIN_UST_PID
:
2540 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2554 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2556 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2557 char *channel_name
, int event_type
)
2560 struct ltt_kernel_channel
*kchan
;
2563 case LTTNG_DOMAIN_KERNEL
:
2564 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2565 session
->kernel_session
);
2566 if (kchan
== NULL
) {
2567 /* This call will notify the kernel thread */
2568 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2569 kernel_poll_pipe
[1]);
2570 if (ret
!= LTTCOMM_OK
) {
2574 /* Get the newly created kernel channel pointer */
2575 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2576 session
->kernel_session
);
2577 if (kchan
== NULL
) {
2578 /* This sould not happen... */
2579 ret
= LTTCOMM_FATAL
;
2585 switch (event_type
) {
2586 case LTTNG_EVENT_SYSCALL
:
2587 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2588 kchan
, kernel_tracer_fd
);
2590 case LTTNG_EVENT_TRACEPOINT
:
2592 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2593 * events already registered to the channel.
2595 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2596 kchan
, kernel_tracer_fd
);
2598 case LTTNG_EVENT_ALL
:
2599 /* Enable syscalls and tracepoints */
2600 ret
= event_kernel_enable_all(session
->kernel_session
,
2601 kchan
, kernel_tracer_fd
);
2604 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2608 /* Manage return value */
2609 if (ret
!= LTTCOMM_OK
) {
2613 kernel_wait_quiescent(kernel_tracer_fd
);
2615 case LTTNG_DOMAIN_UST
:
2617 struct lttng_channel
*attr
;
2618 struct ltt_ust_channel
*uchan
;
2619 struct ltt_ust_session
*usess
= session
->ust_session
;
2621 /* Get channel from global UST domain */
2622 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2624 if (uchan
== NULL
) {
2625 /* Create default channel */
2626 attr
= channel_new_default_attr(domain
);
2628 ret
= LTTCOMM_FATAL
;
2631 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2632 attr
->name
[NAME_MAX
- 1] = '\0';
2634 /* Use the internal command enable channel */
2635 ret
= channel_ust_create(usess
, domain
, attr
);
2636 if (ret
!= LTTCOMM_OK
) {
2642 /* Get the newly created channel reference back */
2643 uchan
= trace_ust_find_channel_by_name(
2644 usess
->domain_global
.channels
, channel_name
);
2645 if (uchan
== NULL
) {
2646 /* Something is really wrong */
2647 ret
= LTTCOMM_FATAL
;
2652 /* At this point, the session and channel exist on the tracer */
2654 switch (event_type
) {
2655 case LTTNG_EVENT_ALL
:
2656 case LTTNG_EVENT_TRACEPOINT
:
2657 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2658 if (ret
!= LTTCOMM_OK
) {
2663 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2667 /* Manage return value */
2668 if (ret
!= LTTCOMM_OK
) {
2675 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2676 case LTTNG_DOMAIN_UST_PID
:
2677 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2691 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2693 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2696 ssize_t nb_events
= 0;
2699 case LTTNG_DOMAIN_KERNEL
:
2700 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2701 if (nb_events
< 0) {
2702 ret
= LTTCOMM_KERN_LIST_FAIL
;
2706 case LTTNG_DOMAIN_UST
:
2707 nb_events
= ust_app_list_events(events
);
2708 if (nb_events
< 0) {
2709 ret
= LTTCOMM_UST_LIST_FAIL
;
2721 /* Return negative value to differentiate return code */
2726 * Command LTTNG_START_TRACE processed by the client thread.
2728 static int cmd_start_trace(struct ltt_session
*session
)
2731 struct ltt_kernel_session
*ksession
;
2732 struct ltt_ust_session
*usess
;
2735 ksession
= session
->kernel_session
;
2736 usess
= session
->ust_session
;
2738 if (session
->enabled
) {
2739 ret
= LTTCOMM_UST_START_FAIL
;
2743 session
->enabled
= 1;
2745 /* Kernel tracing */
2746 if (ksession
!= NULL
) {
2747 struct ltt_kernel_channel
*kchan
;
2749 /* Open kernel metadata */
2750 if (ksession
->metadata
== NULL
) {
2751 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2753 ret
= LTTCOMM_KERN_META_FAIL
;
2758 /* Open kernel metadata stream */
2759 if (ksession
->metadata_stream_fd
== 0) {
2760 ret
= kernel_open_metadata_stream(ksession
);
2762 ERR("Kernel create metadata stream failed");
2763 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2768 /* For each channel */
2769 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2770 if (kchan
->stream_count
== 0) {
2771 ret
= kernel_open_channel_stream(kchan
);
2773 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2776 /* Update the stream global counter */
2777 ksession
->stream_count_global
+= ret
;
2781 /* Setup kernel consumer socket and send fds to it */
2782 ret
= init_kernel_tracing(ksession
);
2784 ret
= LTTCOMM_KERN_START_FAIL
;
2788 /* This start the kernel tracing */
2789 ret
= kernel_start_session(ksession
);
2791 ret
= LTTCOMM_KERN_START_FAIL
;
2795 /* Quiescent wait after starting trace */
2796 kernel_wait_quiescent(kernel_tracer_fd
);
2799 /* Flag session that trace should start automatically */
2801 usess
->start_trace
= 1;
2803 ret
= ust_app_start_trace_all(usess
);
2805 ret
= LTTCOMM_UST_START_FAIL
;
2817 * Command LTTNG_STOP_TRACE processed by the client thread.
2819 static int cmd_stop_trace(struct ltt_session
*session
)
2822 struct ltt_kernel_channel
*kchan
;
2823 struct ltt_kernel_session
*ksession
;
2824 struct ltt_ust_session
*usess
;
2827 ksession
= session
->kernel_session
;
2828 usess
= session
->ust_session
;
2830 if (!session
->enabled
) {
2831 ret
= LTTCOMM_UST_STOP_FAIL
;
2835 session
->enabled
= 0;
2838 if (ksession
!= NULL
) {
2839 DBG("Stop kernel tracing");
2841 /* Flush all buffers before stopping */
2842 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2844 ERR("Kernel metadata flush failed");
2847 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2848 ret
= kernel_flush_buffer(kchan
);
2850 ERR("Kernel flush buffer error");
2854 ret
= kernel_stop_session(ksession
);
2856 ret
= LTTCOMM_KERN_STOP_FAIL
;
2860 kernel_wait_quiescent(kernel_tracer_fd
);
2864 usess
->start_trace
= 0;
2866 ret
= ust_app_stop_trace_all(usess
);
2868 ret
= LTTCOMM_UST_STOP_FAIL
;
2880 * Command LTTNG_CREATE_SESSION processed by the client thread.
2882 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2886 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2887 LTTNG_SOCK_GET_GID_CRED(creds
));
2888 if (ret
!= LTTCOMM_OK
) {
2899 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2901 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2905 /* Clean kernel session teardown */
2906 teardown_kernel_session(session
);
2907 /* UST session teardown */
2908 teardown_ust_session(session
);
2911 * Must notify the kernel thread here to update it's poll setin order
2912 * to remove the channel(s)' fd just destroyed.
2914 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2916 perror("write kernel poll pipe");
2919 ret
= session_destroy(session
);
2925 * Command LTTNG_CALIBRATE processed by the client thread.
2927 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2932 case LTTNG_DOMAIN_KERNEL
:
2934 struct lttng_kernel_calibrate kcalibrate
;
2936 kcalibrate
.type
= calibrate
->type
;
2937 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2939 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2944 case LTTNG_DOMAIN_UST
:
2946 struct lttng_ust_calibrate ucalibrate
;
2948 ucalibrate
.type
= calibrate
->type
;
2949 ret
= ust_app_calibrate_glb(&ucalibrate
);
2951 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
2968 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2970 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2976 case LTTNG_DOMAIN_KERNEL
:
2977 /* Can't register a consumer if there is already one */
2978 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
2979 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2983 sock
= lttcomm_connect_unix_sock(sock_path
);
2985 ret
= LTTCOMM_CONNECT_FAIL
;
2989 session
->kernel_session
->consumer_fd
= sock
;
2992 /* TODO: Userspace tracing */
3004 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3006 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3007 struct lttng_domain
**domains
)
3012 if (session
->kernel_session
!= NULL
) {
3013 DBG3("Listing domains found kernel domain");
3017 if (session
->ust_session
!= NULL
) {
3018 DBG3("Listing domains found UST global domain");
3022 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3023 if (*domains
== NULL
) {
3024 ret
= -LTTCOMM_FATAL
;
3028 if (session
->kernel_session
!= NULL
) {
3029 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3033 if (session
->ust_session
!= NULL
) {
3034 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3045 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3047 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3048 struct lttng_channel
**channels
)
3051 ssize_t nb_chan
= 0;
3054 case LTTNG_DOMAIN_KERNEL
:
3055 if (session
->kernel_session
!= NULL
) {
3056 nb_chan
= session
->kernel_session
->channel_count
;
3058 DBG3("Number of kernel channels %zd", nb_chan
);
3060 case LTTNG_DOMAIN_UST
:
3061 if (session
->ust_session
!= NULL
) {
3062 nb_chan
= lttng_ht_get_count(
3063 session
->ust_session
->domain_global
.channels
);
3065 DBG3("Number of UST global channels %zd", nb_chan
);
3074 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3075 if (*channels
== NULL
) {
3076 ret
= -LTTCOMM_FATAL
;
3080 list_lttng_channels(domain
, session
, *channels
);
3092 * Command LTTNG_LIST_EVENTS processed by the client thread.
3094 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3095 char *channel_name
, struct lttng_event
**events
)
3098 ssize_t nb_event
= 0;
3101 case LTTNG_DOMAIN_KERNEL
:
3102 if (session
->kernel_session
!= NULL
) {
3103 nb_event
= list_lttng_kernel_events(channel_name
,
3104 session
->kernel_session
, events
);
3107 case LTTNG_DOMAIN_UST
:
3109 if (session
->ust_session
!= NULL
) {
3110 nb_event
= list_lttng_ust_global_events(channel_name
,
3111 &session
->ust_session
->domain_global
, events
);
3127 * Process the command requested by the lttng client within the command
3128 * context structure. This function make sure that the return structure (llm)
3129 * is set and ready for transmission before returning.
3131 * Return any error encountered or 0 for success.
3133 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3135 int ret
= LTTCOMM_OK
;
3136 int need_tracing_session
= 1;
3138 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3140 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3141 ret
= LTTCOMM_KERN_NA
;
3146 * Check for command that don't needs to allocate a returned payload. We do
3147 * this here so we don't have to make the call for no payload at each
3150 switch(cmd_ctx
->lsm
->cmd_type
) {
3151 case LTTNG_LIST_SESSIONS
:
3152 case LTTNG_LIST_TRACEPOINTS
:
3153 case LTTNG_LIST_DOMAINS
:
3154 case LTTNG_LIST_CHANNELS
:
3155 case LTTNG_LIST_EVENTS
:
3158 /* Setup lttng message with no payload */
3159 ret
= setup_lttng_msg(cmd_ctx
, 0);
3161 /* This label does not try to unlock the session */
3162 goto init_setup_error
;
3166 /* Commands that DO NOT need a session. */
3167 switch (cmd_ctx
->lsm
->cmd_type
) {
3168 case LTTNG_CALIBRATE
:
3169 case LTTNG_CREATE_SESSION
:
3170 case LTTNG_LIST_SESSIONS
:
3171 case LTTNG_LIST_TRACEPOINTS
:
3172 need_tracing_session
= 0;
3175 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3176 session_lock_list();
3177 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3178 session_unlock_list();
3179 if (cmd_ctx
->session
== NULL
) {
3180 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3181 ret
= LTTCOMM_SESS_NOT_FOUND
;
3183 /* If no session name specified */
3184 ret
= LTTCOMM_SELECT_SESS
;
3188 /* Acquire lock for the session */
3189 session_lock(cmd_ctx
->session
);
3195 * Check domain type for specific "pre-action".
3197 switch (cmd_ctx
->lsm
->domain
.type
) {
3198 case LTTNG_DOMAIN_KERNEL
:
3200 ret
= LTTCOMM_KERN_NA
;
3204 /* Kernel tracer check */
3205 if (kernel_tracer_fd
== 0) {
3206 /* Basically, load kernel tracer modules */
3207 ret
= init_kernel_tracer();
3213 /* Need a session for kernel command */
3214 if (need_tracing_session
) {
3215 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3216 ret
= create_kernel_session(cmd_ctx
->session
);
3218 ret
= LTTCOMM_KERN_SESS_FAIL
;
3223 /* Start the kernel consumer daemon */
3224 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3225 if (kconsumer_data
.pid
== 0 &&
3226 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3227 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3228 ret
= start_consumerd(&kconsumer_data
);
3230 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3234 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3238 case LTTNG_DOMAIN_UST
:
3240 if (need_tracing_session
) {
3241 if (cmd_ctx
->session
->ust_session
== NULL
) {
3242 ret
= create_ust_session(cmd_ctx
->session
,
3243 &cmd_ctx
->lsm
->domain
);
3244 if (ret
!= LTTCOMM_OK
) {
3248 /* Start the UST consumer daemons */
3250 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3251 if (consumerd64_bin
[0] != '\0' &&
3252 ustconsumer64_data
.pid
== 0 &&
3253 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3254 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3255 ret
= start_consumerd(&ustconsumer64_data
);
3257 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3258 ust_consumerd64_fd
= -EINVAL
;
3262 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3264 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3267 if (consumerd32_bin
[0] != '\0' &&
3268 ustconsumer32_data
.pid
== 0 &&
3269 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3270 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3271 ret
= start_consumerd(&ustconsumer32_data
);
3273 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3274 ust_consumerd32_fd
= -EINVAL
;
3277 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3279 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3289 * Check that the UID or GID match that of the tracing session.
3290 * The root user can interact with all sessions.
3292 if (need_tracing_session
) {
3293 if (!session_access_ok(cmd_ctx
->session
,
3294 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3295 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3296 ret
= LTTCOMM_EPERM
;
3301 /* Process by command type */
3302 switch (cmd_ctx
->lsm
->cmd_type
) {
3303 case LTTNG_ADD_CONTEXT
:
3305 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3306 cmd_ctx
->lsm
->u
.context
.channel_name
,
3307 cmd_ctx
->lsm
->u
.context
.event_name
,
3308 &cmd_ctx
->lsm
->u
.context
.ctx
);
3311 case LTTNG_DISABLE_CHANNEL
:
3313 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3314 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3317 case LTTNG_DISABLE_EVENT
:
3319 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3320 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3321 cmd_ctx
->lsm
->u
.disable
.name
);
3324 case LTTNG_DISABLE_ALL_EVENT
:
3326 DBG("Disabling all events");
3328 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3329 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3332 case LTTNG_ENABLE_CHANNEL
:
3334 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3335 &cmd_ctx
->lsm
->u
.channel
.chan
);
3338 case LTTNG_ENABLE_EVENT
:
3340 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3341 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3342 &cmd_ctx
->lsm
->u
.enable
.event
);
3345 case LTTNG_ENABLE_ALL_EVENT
:
3347 DBG("Enabling all events");
3349 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3350 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3351 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3354 case LTTNG_LIST_TRACEPOINTS
:
3356 struct lttng_event
*events
;
3359 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3360 if (nb_events
< 0) {
3366 * Setup lttng message with payload size set to the event list size in
3367 * bytes and then copy list into the llm payload.
3369 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3375 /* Copy event list into message payload */
3376 memcpy(cmd_ctx
->llm
->payload
, events
,
3377 sizeof(struct lttng_event
) * nb_events
);
3384 case LTTNG_START_TRACE
:
3386 ret
= cmd_start_trace(cmd_ctx
->session
);
3389 case LTTNG_STOP_TRACE
:
3391 ret
= cmd_stop_trace(cmd_ctx
->session
);
3394 case LTTNG_CREATE_SESSION
:
3396 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3397 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3400 case LTTNG_DESTROY_SESSION
:
3402 ret
= cmd_destroy_session(cmd_ctx
->session
,
3403 cmd_ctx
->lsm
->session
.name
);
3406 case LTTNG_LIST_DOMAINS
:
3409 struct lttng_domain
*domains
;
3411 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3417 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3422 /* Copy event list into message payload */
3423 memcpy(cmd_ctx
->llm
->payload
, domains
,
3424 nb_dom
* sizeof(struct lttng_domain
));
3431 case LTTNG_LIST_CHANNELS
:
3434 struct lttng_channel
*channels
;
3436 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3437 cmd_ctx
->session
, &channels
);
3443 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3448 /* Copy event list into message payload */
3449 memcpy(cmd_ctx
->llm
->payload
, channels
,
3450 nb_chan
* sizeof(struct lttng_channel
));
3457 case LTTNG_LIST_EVENTS
:
3460 struct lttng_event
*events
= NULL
;
3462 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3463 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3469 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3474 /* Copy event list into message payload */
3475 memcpy(cmd_ctx
->llm
->payload
, events
,
3476 nb_event
* sizeof(struct lttng_event
));
3483 case LTTNG_LIST_SESSIONS
:
3485 unsigned int nr_sessions
;
3487 session_lock_list();
3488 nr_sessions
= lttng_sessions_count(
3489 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3490 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3492 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3494 session_unlock_list();
3498 /* Filled the session array */
3499 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3500 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3501 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3503 session_unlock_list();
3508 case LTTNG_CALIBRATE
:
3510 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3511 &cmd_ctx
->lsm
->u
.calibrate
);
3514 case LTTNG_REGISTER_CONSUMER
:
3516 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3517 cmd_ctx
->lsm
->u
.reg
.path
);
3526 if (cmd_ctx
->llm
== NULL
) {
3527 DBG("Missing llm structure. Allocating one.");
3528 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3532 /* Set return code */
3533 cmd_ctx
->llm
->ret_code
= ret
;
3535 if (cmd_ctx
->session
) {
3536 session_unlock(cmd_ctx
->session
);
3543 * This thread manage all clients request using the unix client socket for
3546 static void *thread_manage_clients(void *data
)
3548 int sock
= 0, ret
, i
, pollfd
;
3549 uint32_t revents
, nb_fd
;
3550 struct command_ctx
*cmd_ctx
= NULL
;
3551 struct lttng_poll_event events
;
3553 DBG("[thread] Manage client started");
3555 rcu_register_thread();
3557 ret
= lttcomm_listen_unix_sock(client_sock
);
3563 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3564 * more will be added to this poll set.
3566 ret
= create_thread_poll_set(&events
, 2);
3571 /* Add the application registration socket */
3572 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3578 * Notify parent pid that we are ready to accept command for client side.
3580 if (opt_sig_parent
) {
3581 kill(ppid
, SIGUSR1
);
3585 DBG("Accepting client command ...");
3587 nb_fd
= LTTNG_POLL_GETNB(&events
);
3589 /* Inifinite blocking call, waiting for transmission */
3590 ret
= lttng_poll_wait(&events
, -1);
3595 for (i
= 0; i
< nb_fd
; i
++) {
3596 /* Fetch once the poll data */
3597 revents
= LTTNG_POLL_GETEV(&events
, i
);
3598 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3600 /* Thread quit pipe has been closed. Killing thread. */
3601 ret
= check_thread_quit_pipe(pollfd
, revents
);
3606 /* Event on the registration socket */
3607 if (pollfd
== client_sock
) {
3608 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3609 ERR("Client socket poll error");
3615 DBG("Wait for client response");
3617 sock
= lttcomm_accept_unix_sock(client_sock
);
3622 /* Set socket option for credentials retrieval */
3623 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3628 /* Allocate context command to process the client request */
3629 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3630 if (cmd_ctx
== NULL
) {
3631 perror("zmalloc cmd_ctx");
3635 /* Allocate data buffer for reception */
3636 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3637 if (cmd_ctx
->lsm
== NULL
) {
3638 perror("zmalloc cmd_ctx->lsm");
3642 cmd_ctx
->llm
= NULL
;
3643 cmd_ctx
->session
= NULL
;
3646 * Data is received from the lttng client. The struct
3647 * lttcomm_session_msg (lsm) contains the command and data request of
3650 DBG("Receiving data from client ...");
3651 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3652 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3654 DBG("Nothing recv() from client... continuing");
3660 // TODO: Validate cmd_ctx including sanity check for
3661 // security purpose.
3663 rcu_thread_online();
3665 * This function dispatch the work to the kernel or userspace tracer
3666 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3667 * informations for the client. The command context struct contains
3668 * everything this function may needs.
3670 ret
= process_client_msg(cmd_ctx
);
3671 rcu_thread_offline();
3674 * TODO: Inform client somehow of the fatal error. At
3675 * this point, ret < 0 means that a zmalloc failed
3676 * (ENOMEM). Error detected but still accept command.
3678 clean_command_ctx(&cmd_ctx
);
3682 DBG("Sending response (size: %d, retcode: %s)",
3683 cmd_ctx
->lttng_msg_size
,
3684 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3685 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3687 ERR("Failed to send data back to client");
3690 /* End of transmission */
3693 clean_command_ctx(&cmd_ctx
);
3697 DBG("Client thread dying");
3698 unlink(client_unix_sock_path
);
3702 lttng_poll_clean(&events
);
3703 clean_command_ctx(&cmd_ctx
);
3705 rcu_unregister_thread();
3711 * usage function on stderr
3713 static void usage(void)
3715 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3716 fprintf(stderr
, " -h, --help Display this usage.\n");
3717 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3718 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3719 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3720 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3721 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3722 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3723 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3724 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3725 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3726 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3727 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3728 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3729 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3730 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3731 fprintf(stderr
, " -V, --version Show version number.\n");
3732 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3733 fprintf(stderr
, " -q, --quiet No output at all.\n");
3734 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3735 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3736 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3740 * daemon argument parsing
3742 static int parse_args(int argc
, char **argv
)
3746 static struct option long_options
[] = {
3747 { "client-sock", 1, 0, 'c' },
3748 { "apps-sock", 1, 0, 'a' },
3749 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3750 { "kconsumerd-err-sock", 1, 0, 'E' },
3751 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3752 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3753 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3754 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3755 { "consumerd32-path", 1, 0, 'u' },
3756 { "consumerd32-libdir", 1, 0, 'U' },
3757 { "consumerd64-path", 1, 0, 't' },
3758 { "consumerd64-libdir", 1, 0, 'T' },
3759 { "daemonize", 0, 0, 'd' },
3760 { "sig-parent", 0, 0, 'S' },
3761 { "help", 0, 0, 'h' },
3762 { "group", 1, 0, 'g' },
3763 { "version", 0, 0, 'V' },
3764 { "quiet", 0, 0, 'q' },
3765 { "verbose", 0, 0, 'v' },
3766 { "verbose-consumer", 0, 0, 'Z' },
3767 { "no-kernel", 0, 0, 'N' },
3772 int option_index
= 0;
3773 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3774 long_options
, &option_index
);
3781 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3783 fprintf(stderr
, " with arg %s\n", optarg
);
3787 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3790 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3796 opt_tracing_group
= optarg
;
3802 fprintf(stdout
, "%s\n", VERSION
);
3808 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3811 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3814 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3817 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3820 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3823 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3832 /* Verbose level can increase using multiple -v */
3836 opt_verbose_consumer
+= 1;
3839 consumerd32_bin
= optarg
;
3842 consumerd32_libdir
= optarg
;
3845 consumerd64_bin
= optarg
;
3848 consumerd64_libdir
= optarg
;
3851 /* Unknown option or other error.
3852 * Error is printed by getopt, just return */
3861 * Creates the two needed socket by the daemon.
3862 * apps_sock - The communication socket for all UST apps.
3863 * client_sock - The communication of the cli tool (lttng).
3865 static int init_daemon_socket(void)
3870 old_umask
= umask(0);
3872 /* Create client tool unix socket */
3873 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3874 if (client_sock
< 0) {
3875 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3880 /* File permission MUST be 660 */
3881 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3883 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3888 /* Create the application unix socket */
3889 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3890 if (apps_sock
< 0) {
3891 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3896 /* File permission MUST be 666 */
3897 ret
= chmod(apps_unix_sock_path
,
3898 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3900 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3911 * Check if the global socket is available, and if a daemon is answering at the
3912 * other side. If yes, error is returned.
3914 static int check_existing_daemon(void)
3916 /* Is there anybody out there ? */
3917 if (lttng_session_daemon_alive()) {
3925 * Set the tracing group gid onto the client socket.
3927 * Race window between mkdir and chown is OK because we are going from more
3928 * permissive (root.root) to less permissive (root.tracing).
3930 static int set_permissions(char *rundir
)
3935 gid
= allowed_group();
3937 WARN("No tracing group detected");
3942 /* Set lttng run dir */
3943 ret
= chown(rundir
, 0, gid
);
3945 ERR("Unable to set group on %s", rundir
);
3949 /* Ensure tracing group can search the run dir */
3950 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
);
3952 ERR("Unable to set permissions on %s", rundir
);
3956 /* lttng client socket path */
3957 ret
= chown(client_unix_sock_path
, 0, gid
);
3959 ERR("Unable to set group on %s", client_unix_sock_path
);
3963 /* kconsumer error socket path */
3964 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3966 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3970 /* 64-bit ustconsumer error socket path */
3971 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3973 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3977 /* 32-bit ustconsumer compat32 error socket path */
3978 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3980 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
3984 DBG("All permissions are set");
3991 * Create the pipe used to wake up the kernel thread.
3993 static int create_kernel_poll_pipe(void)
3997 ret
= pipe(kernel_poll_pipe
);
3999 PERROR("kernel poll pipe");
4003 for (i
= 0; i
< 2; i
++) {
4004 ret
= fcntl(kernel_poll_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4006 PERROR("fcntl kernel_poll_pipe");
4016 * Create the application command pipe to wake thread_manage_apps.
4018 static int create_apps_cmd_pipe(void)
4022 ret
= pipe(apps_cmd_pipe
);
4024 PERROR("apps cmd pipe");
4028 for (i
= 0; i
< 2; i
++) {
4029 ret
= fcntl(apps_cmd_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4031 PERROR("fcntl apps_cmd_pipe");
4041 * Create the lttng run directory needed for all global sockets and pipe.
4043 static int create_lttng_rundir(const char *rundir
)
4047 DBG3("Creating LTTng run directory: %s", rundir
);
4049 ret
= mkdir(rundir
, S_IRWXU
);
4051 if (errno
!= EEXIST
) {
4052 ERR("Unable to create %s", rundir
);
4064 * Setup sockets and directory needed by the kconsumerd communication with the
4067 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4071 char path
[PATH_MAX
];
4073 switch (consumer_data
->type
) {
4074 case LTTNG_CONSUMER_KERNEL
:
4075 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4077 case LTTNG_CONSUMER64_UST
:
4078 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4080 case LTTNG_CONSUMER32_UST
:
4081 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4084 ERR("Consumer type unknown");
4089 DBG2("Creating consumer directory: %s", path
);
4091 ret
= mkdir(path
, S_IRWXU
);
4093 if (errno
!= EEXIST
) {
4094 ERR("Failed to create %s", path
);
4100 /* Create the kconsumerd error unix socket */
4101 consumer_data
->err_sock
=
4102 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4103 if (consumer_data
->err_sock
< 0) {
4104 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4109 /* File permission MUST be 660 */
4110 ret
= chmod(consumer_data
->err_unix_sock_path
,
4111 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4113 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4123 * Signal handler for the daemon
4125 * Simply stop all worker threads, leaving main() return gracefully after
4126 * joining all threads and calling cleanup().
4128 static void sighandler(int sig
)
4132 DBG("SIGPIPE caught");
4135 DBG("SIGINT caught");
4139 DBG("SIGTERM caught");
4148 * Setup signal handler for :
4149 * SIGINT, SIGTERM, SIGPIPE
4151 static int set_signal_handler(void)
4154 struct sigaction sa
;
4157 if ((ret
= sigemptyset(&sigset
)) < 0) {
4158 perror("sigemptyset");
4162 sa
.sa_handler
= sighandler
;
4163 sa
.sa_mask
= sigset
;
4165 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4166 perror("sigaction");
4170 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4171 perror("sigaction");
4175 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4176 perror("sigaction");
4180 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4186 * Set open files limit to unlimited. This daemon can open a large number of
4187 * file descriptors in order to consumer multiple kernel traces.
4189 static void set_ulimit(void)
4194 /* The kernel does not allowed an infinite limit for open files */
4195 lim
.rlim_cur
= 65535;
4196 lim
.rlim_max
= 65535;
4198 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4200 perror("failed to set open files limit");
4207 int main(int argc
, char **argv
)
4211 const char *home_path
;
4213 init_kernel_workarounds();
4215 rcu_register_thread();
4217 /* Create thread quit pipe */
4218 if ((ret
= init_thread_quit_pipe()) < 0) {
4222 setup_consumerd_path();
4224 /* Parse arguments */
4226 if ((ret
= parse_args(argc
, argv
) < 0)) {
4239 /* Check if daemon is UID = 0 */
4240 is_root
= !getuid();
4243 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4245 /* Create global run dir with root access */
4246 ret
= create_lttng_rundir(rundir
);
4251 if (strlen(apps_unix_sock_path
) == 0) {
4252 snprintf(apps_unix_sock_path
, PATH_MAX
,
4253 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4256 if (strlen(client_unix_sock_path
) == 0) {
4257 snprintf(client_unix_sock_path
, PATH_MAX
,
4258 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4261 /* Set global SHM for ust */
4262 if (strlen(wait_shm_path
) == 0) {
4263 snprintf(wait_shm_path
, PATH_MAX
,
4264 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4267 /* Setup kernel consumerd path */
4268 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4269 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4270 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4271 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4273 DBG2("Kernel consumer err path: %s",
4274 kconsumer_data
.err_unix_sock_path
);
4275 DBG2("Kernel consumer cmd path: %s",
4276 kconsumer_data
.cmd_unix_sock_path
);
4278 home_path
= get_home_dir();
4279 if (home_path
== NULL
) {
4280 /* TODO: Add --socket PATH option */
4281 ERR("Can't get HOME directory for sockets creation.");
4287 * Create rundir from home path. This will create something like
4290 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4296 ret
= create_lttng_rundir(rundir
);
4301 if (strlen(apps_unix_sock_path
) == 0) {
4302 snprintf(apps_unix_sock_path
, PATH_MAX
,
4303 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4306 /* Set the cli tool unix socket path */
4307 if (strlen(client_unix_sock_path
) == 0) {
4308 snprintf(client_unix_sock_path
, PATH_MAX
,
4309 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4312 /* Set global SHM for ust */
4313 if (strlen(wait_shm_path
) == 0) {
4314 snprintf(wait_shm_path
, PATH_MAX
,
4315 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4319 DBG("Client socket path %s", client_unix_sock_path
);
4320 DBG("Application socket path %s", apps_unix_sock_path
);
4321 DBG("LTTng run directory path: %s", rundir
);
4323 /* 32 bits consumerd path setup */
4324 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4325 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4326 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4327 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4329 DBG2("UST consumer 32 bits err path: %s",
4330 ustconsumer32_data
.err_unix_sock_path
);
4331 DBG2("UST consumer 32 bits cmd path: %s",
4332 ustconsumer32_data
.cmd_unix_sock_path
);
4334 /* 64 bits consumerd path setup */
4335 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4336 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4337 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4338 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4340 DBG2("UST consumer 64 bits err path: %s",
4341 ustconsumer64_data
.err_unix_sock_path
);
4342 DBG2("UST consumer 64 bits cmd path: %s",
4343 ustconsumer64_data
.cmd_unix_sock_path
);
4346 * See if daemon already exist.
4348 if ((ret
= check_existing_daemon()) < 0) {
4349 ERR("Already running daemon.\n");
4351 * We do not goto exit because we must not cleanup()
4352 * because a daemon is already running.
4357 /* After this point, we can safely call cleanup() with "goto exit" */
4360 * These actions must be executed as root. We do that *after* setting up
4361 * the sockets path because we MUST make the check for another daemon using
4362 * those paths *before* trying to set the kernel consumer sockets and init
4366 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4371 /* Setup kernel tracer */
4372 if (!opt_no_kernel
) {
4373 init_kernel_tracer();
4376 /* Set ulimit for open files */
4380 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4385 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4390 if ((ret
= set_signal_handler()) < 0) {
4394 /* Setup the needed unix socket */
4395 if ((ret
= init_daemon_socket()) < 0) {
4399 /* Set credentials to socket */
4400 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4404 /* Get parent pid if -S, --sig-parent is specified. */
4405 if (opt_sig_parent
) {
4409 /* Setup the kernel pipe for waking up the kernel thread */
4410 if ((ret
= create_kernel_poll_pipe()) < 0) {
4414 /* Setup the thread apps communication pipe. */
4415 if ((ret
= create_apps_cmd_pipe()) < 0) {
4419 /* Init UST command queue. */
4420 cds_wfq_init(&ust_cmd_queue
.queue
);
4422 /* Init UST app hash table */
4426 * Get session list pointer. This pointer MUST NOT be free(). This list is
4427 * statically declared in session.c
4429 session_list_ptr
= session_get_list();
4431 /* Set up max poll set size */
4432 lttng_poll_set_max_size();
4434 /* Create thread to manage the client socket */
4435 ret
= pthread_create(&client_thread
, NULL
,
4436 thread_manage_clients
, (void *) NULL
);
4438 perror("pthread_create clients");
4442 /* Create thread to dispatch registration */
4443 ret
= pthread_create(&dispatch_thread
, NULL
,
4444 thread_dispatch_ust_registration
, (void *) NULL
);
4446 perror("pthread_create dispatch");
4450 /* Create thread to manage application registration. */
4451 ret
= pthread_create(®_apps_thread
, NULL
,
4452 thread_registration_apps
, (void *) NULL
);
4454 perror("pthread_create registration");
4458 /* Create thread to manage application socket */
4459 ret
= pthread_create(&apps_thread
, NULL
,
4460 thread_manage_apps
, (void *) NULL
);
4462 perror("pthread_create apps");
4466 /* Create kernel thread to manage kernel event */
4467 ret
= pthread_create(&kernel_thread
, NULL
,
4468 thread_manage_kernel
, (void *) NULL
);
4470 perror("pthread_create kernel");
4474 ret
= pthread_join(kernel_thread
, &status
);
4476 perror("pthread_join");
4477 goto error
; /* join error, exit without cleanup */
4481 ret
= pthread_join(apps_thread
, &status
);
4483 perror("pthread_join");
4484 goto error
; /* join error, exit without cleanup */
4488 ret
= pthread_join(reg_apps_thread
, &status
);
4490 perror("pthread_join");
4491 goto error
; /* join error, exit without cleanup */
4495 ret
= pthread_join(dispatch_thread
, &status
);
4497 perror("pthread_join");
4498 goto error
; /* join error, exit without cleanup */
4502 ret
= pthread_join(client_thread
, &status
);
4504 perror("pthread_join");
4505 goto error
; /* join error, exit without cleanup */
4508 ret
= join_consumer_thread(&kconsumer_data
);
4510 perror("join_consumer");
4511 goto error
; /* join error, exit without cleanup */
4517 * cleanup() is called when no other thread is running.
4519 rcu_thread_online();
4521 rcu_thread_offline();
4522 rcu_unregister_thread();