2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <lttng-consumerd.h>
42 #include <lttng-sessiond-comm.h>
43 #include <lttng/lttng-consumer.h>
47 #include "compat/poll.h"
51 #include "kernel-ctl.h"
52 #include "ltt-sessiond.h"
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
[] = LTTNG_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 is_root
; /* Set to 1 if the daemon is running as root */
93 static pid_t ppid
; /* Parent PID for --sig-parent option */
95 /* Consumer daemon specific control data */
96 static struct consumer_data kconsumer_data
= {
97 .type
= LTTNG_CONSUMER_KERNEL
,
99 static struct consumer_data ustconsumer_data
= {
100 .type
= LTTNG_CONSUMER_UST
,
103 static int dispatch_thread_exit
;
105 /* Global application Unix socket path */
106 static char apps_unix_sock_path
[PATH_MAX
];
107 /* Global client Unix socket path */
108 static char client_unix_sock_path
[PATH_MAX
];
109 /* global wait shm path for UST */
110 static char wait_shm_path
[PATH_MAX
];
112 /* Sockets and FDs */
113 static int client_sock
;
114 static int apps_sock
;
115 static int kernel_tracer_fd
;
116 static int kernel_poll_pipe
[2];
119 * Quit pipe for all threads. This permits a single cancellation point
120 * for all threads when receiving an event on the pipe.
122 static int thread_quit_pipe
[2];
125 * This pipe is used to inform the thread managing application communication
126 * that a command is queued and ready to be processed.
128 static int apps_cmd_pipe
[2];
130 /* Pthread, Mutexes and Semaphores */
131 static pthread_t apps_thread
;
132 static pthread_t reg_apps_thread
;
133 static pthread_t client_thread
;
134 static pthread_t kernel_thread
;
135 static pthread_t dispatch_thread
;
139 * UST registration command queue. This queue is tied with a futex and uses a N
140 * wakers / 1 waiter implemented and detailed in futex.c/.h
142 * The thread_manage_apps and thread_dispatch_ust_registration interact with
143 * this queue and the wait/wake scheme.
145 static struct ust_cmd_queue ust_cmd_queue
;
148 * Pointer initialized before thread creation.
150 * This points to the tracing session list containing the session count and a
151 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
152 * MUST NOT be taken if you call a public function in session.c.
154 * The lock is nested inside the structure: session_list_ptr->lock. Please use
155 * session_lock_list and session_unlock_list for lock acquisition.
157 static struct ltt_session_list
*session_list_ptr
;
160 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
162 static int create_thread_poll_set(struct lttng_poll_event
*events
,
167 if (events
== NULL
|| size
== 0) {
172 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
178 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
190 * Check if the thread quit pipe was triggered.
192 * Return 1 if it was triggered else 0;
194 static int check_thread_quit_pipe(int fd
, uint32_t events
)
196 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
204 * Remove modules in reverse load order.
206 static int modprobe_remove_kernel_modules(void)
211 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
212 ret
= snprintf(modprobe
, sizeof(modprobe
),
213 "/sbin/modprobe --remove --quiet %s",
214 kernel_modules_list
[i
].name
);
216 perror("snprintf modprobe --remove");
219 modprobe
[sizeof(modprobe
) - 1] = '\0';
220 ret
= system(modprobe
);
222 ERR("Unable to launch modprobe --remove for module %s",
223 kernel_modules_list
[i
].name
);
224 } else if (kernel_modules_list
[i
].required
225 && WEXITSTATUS(ret
) != 0) {
226 ERR("Unable to remove module %s",
227 kernel_modules_list
[i
].name
);
229 DBG("Modprobe removal successful %s",
230 kernel_modules_list
[i
].name
);
239 * Return group ID of the tracing group or -1 if not found.
241 static gid_t
allowed_group(void)
245 if (opt_tracing_group
) {
246 grp
= getgrnam(opt_tracing_group
);
248 grp
= getgrnam(default_tracing_group
);
258 * Init thread quit pipe.
260 * Return -1 on error or 0 if all pipes are created.
262 static int init_thread_quit_pipe(void)
266 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
268 perror("thread quit pipe");
277 * Complete teardown of a kernel session. This free all data structure related
278 * to a kernel session and update counter.
280 static void teardown_kernel_session(struct ltt_session
*session
)
282 if (session
->kernel_session
!= NULL
) {
283 DBG("Tearing down kernel session");
286 * If a custom kernel consumer was registered, close the socket before
287 * tearing down the complete kernel session structure
289 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
290 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
293 trace_kernel_destroy_session(session
->kernel_session
);
294 /* Extra precaution */
295 session
->kernel_session
= NULL
;
300 * Stop all threads by closing the thread quit pipe.
302 static void stop_threads(void)
306 /* Stopping all threads */
307 DBG("Terminating all threads");
308 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
310 ERR("write error on thread quit pipe");
313 /* Dispatch thread */
314 dispatch_thread_exit
= 1;
315 futex_nto1_wake(&ust_cmd_queue
.futex
);
321 static void cleanup(void)
325 struct ltt_session
*sess
, *stmp
;
330 MSG("%c[%d;%dm*** assert failed *** ==> %c[%dm%c[%d;%dm"
331 "Matthew, BEET driven development works!%c[%dm",
332 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
336 DBG("Removing %s directory", LTTNG_RUNDIR
);
337 ret
= asprintf(&cmd
, "rm -rf " LTTNG_RUNDIR
);
339 ERR("asprintf failed. Something is really wrong!");
342 /* Remove lttng run directory */
345 ERR("Unable to clean " LTTNG_RUNDIR
);
349 DBG("Cleaning up all session");
351 /* Destroy session list mutex */
352 if (session_list_ptr
!= NULL
) {
353 pthread_mutex_destroy(&session_list_ptr
->lock
);
355 /* Cleanup ALL session */
356 cds_list_for_each_entry_safe(sess
, stmp
,
357 &session_list_ptr
->head
, list
) {
358 teardown_kernel_session(sess
);
359 // TODO complete session cleanup (including UST)
363 DBG("Closing all UST sockets");
364 ust_app_clean_list();
366 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
368 DBG("Closing kernel fd");
369 close(kernel_tracer_fd
);
372 DBG("Unloading kernel modules");
373 modprobe_remove_kernel_modules();
376 close(thread_quit_pipe
[0]);
377 close(thread_quit_pipe
[1]);
381 * Send data on a unix socket using the liblttsessiondcomm API.
383 * Return lttcomm error code.
385 static int send_unix_sock(int sock
, void *buf
, size_t len
)
387 /* Check valid length */
392 return lttcomm_send_unix_sock(sock
, buf
, len
);
396 * Free memory of a command context structure.
398 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
400 DBG("Clean command context structure");
402 if ((*cmd_ctx
)->llm
) {
403 free((*cmd_ctx
)->llm
);
405 if ((*cmd_ctx
)->lsm
) {
406 free((*cmd_ctx
)->lsm
);
414 * Send all stream fds of kernel channel to the consumer.
416 static int send_consumer_channel_streams(struct consumer_data
*consumer_data
,
417 int sock
, struct ltt_kernel_channel
*channel
)
421 struct ltt_kernel_stream
*stream
;
422 struct lttcomm_consumer_msg lkm
;
424 DBG("Sending streams of channel %s to kernel consumer",
425 channel
->channel
->name
);
426 nb_fd
= channel
->stream_count
;
429 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
430 lkm
.u
.channel
.channel_key
= channel
->fd
;
431 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
432 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
433 DBG("Sending channel %d to consumer", lkm
.u
.stream
.stream_key
);
434 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
436 perror("send consumer channel");
441 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
445 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
446 lkm
.u
.stream
.channel_key
= channel
->fd
;
447 lkm
.u
.stream
.stream_key
= stream
->fd
;
448 lkm
.u
.stream
.state
= stream
->state
;
449 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
450 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
451 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
452 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
453 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
454 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
456 perror("send consumer stream");
459 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
461 perror("send consumer stream ancillary data");
466 DBG("consumer channel streams sent");
475 * Send all stream fds of the kernel session to the consumer.
477 static int send_consumer_session_streams(struct consumer_data
*consumer_data
,
478 struct ltt_kernel_session
*session
)
481 struct ltt_kernel_channel
*chan
;
482 struct lttcomm_consumer_msg lkm
;
483 int sock
= session
->consumer_fd
;
485 DBG("Sending metadata stream fd");
487 /* Extra protection. It's NOT suppose to be set to 0 at this point */
488 if (session
->consumer_fd
== 0) {
489 session
->consumer_fd
= consumer_data
->cmd_sock
;
492 if (session
->metadata_stream_fd
!= 0) {
493 /* Send metadata channel fd */
494 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
495 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
496 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
497 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
498 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
499 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
501 perror("send consumer channel");
505 /* Send metadata stream fd */
506 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
507 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
508 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
509 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
510 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
511 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
512 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
513 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
514 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
515 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
517 perror("send consumer stream");
520 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
522 perror("send consumer stream");
527 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
528 ret
= send_consumer_channel_streams(consumer_data
, sock
, chan
);
534 DBG("consumer fds (metadata and channel streams) sent");
543 * Notify UST applications using the shm mmap futex.
545 static int notify_ust_apps(int active
)
549 DBG("Notifying applications of session daemon state: %d", active
);
551 /* See shm.c for this call implying mmap, shm and futex calls */
552 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
553 if (wait_shm_mmap
== NULL
) {
557 /* Wake waiting process */
558 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
560 /* Apps notified successfully */
568 * Setup the outgoing data buffer for the response (llm) by allocating the
569 * right amount of memory and copying the original information from the lsm
572 * Return total size of the buffer pointed by buf.
574 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
580 cmd_ctx
->llm
= malloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
581 if (cmd_ctx
->llm
== NULL
) {
587 /* Copy common data */
588 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
589 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
591 cmd_ctx
->llm
->data_size
= size
;
592 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
601 * Update the kernel poll set of all channel fd available over all tracing
602 * session. Add the wakeup pipe at the end of the set.
604 static int update_kernel_poll(struct lttng_poll_event
*events
)
607 struct ltt_session
*session
;
608 struct ltt_kernel_channel
*channel
;
610 DBG("Updating kernel poll set");
613 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
614 session_lock(session
);
615 if (session
->kernel_session
== NULL
) {
616 session_unlock(session
);
620 cds_list_for_each_entry(channel
,
621 &session
->kernel_session
->channel_list
.head
, list
) {
622 /* Add channel fd to the kernel poll set */
623 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
625 session_unlock(session
);
628 DBG("Channel fd %d added to kernel set", channel
->fd
);
630 session_unlock(session
);
632 session_unlock_list();
637 session_unlock_list();
642 * Find the channel fd from 'fd' over all tracing session. When found, check
643 * for new channel stream and send those stream fds to the kernel consumer.
645 * Useful for CPU hotplug feature.
647 static int update_stream(struct consumer_data
*consumer_data
, int fd
)
650 struct ltt_session
*session
;
651 struct ltt_kernel_channel
*channel
;
653 DBG("Updating kernel streams for channel fd %d", fd
);
656 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
657 session_lock(session
);
658 if (session
->kernel_session
== NULL
) {
659 session_unlock(session
);
663 /* This is not suppose to be 0 but this is an extra security check */
664 if (session
->kernel_session
->consumer_fd
== 0) {
665 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
668 cds_list_for_each_entry(channel
,
669 &session
->kernel_session
->channel_list
.head
, list
) {
670 if (channel
->fd
== fd
) {
671 DBG("Channel found, updating kernel streams");
672 ret
= kernel_open_channel_stream(channel
);
678 * Have we already sent fds to the consumer? If yes, it means
679 * that tracing is started so it is safe to send our updated
682 if (session
->kernel_session
->consumer_fds_sent
== 1) {
683 ret
= send_consumer_channel_streams(consumer_data
,
684 session
->kernel_session
->consumer_fd
, channel
);
692 session_unlock(session
);
694 session_unlock_list();
698 session_unlock(session
);
699 session_unlock_list();
704 * This thread manage event coming from the kernel.
706 * Features supported in this thread:
709 static void *thread_manage_kernel(void *data
)
711 int ret
, i
, pollfd
, update_poll_flag
= 1;
712 uint32_t revents
, nb_fd
;
714 struct lttng_poll_event events
;
716 DBG("Thread manage kernel started");
718 ret
= create_thread_poll_set(&events
, 2);
723 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
729 if (update_poll_flag
== 1) {
731 * Reset number of fd in the poll set. Always 2 since there is the thread
732 * quit pipe and the kernel pipe.
736 ret
= update_kernel_poll(&events
);
740 update_poll_flag
= 0;
743 nb_fd
= LTTNG_POLL_GETNB(&events
);
745 DBG("Thread kernel polling on %d fds", nb_fd
);
747 /* Zeroed the poll events */
748 lttng_poll_reset(&events
);
750 /* Poll infinite value of time */
751 ret
= lttng_poll_wait(&events
, -1);
754 } else if (ret
== 0) {
755 /* Should not happen since timeout is infinite */
756 ERR("Return value of poll is 0 with an infinite timeout.\n"
757 "This should not have happened! Continuing...");
761 for (i
= 0; i
< nb_fd
; i
++) {
762 /* Fetch once the poll data */
763 revents
= LTTNG_POLL_GETEV(&events
, i
);
764 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
766 /* Thread quit pipe has been closed. Killing thread. */
767 ret
= check_thread_quit_pipe(pollfd
, revents
);
772 /* Check for data on kernel pipe */
773 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
774 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
775 update_poll_flag
= 1;
779 * New CPU detected by the kernel. Adding kernel stream to
780 * kernel session and updating the kernel consumer
782 if (revents
& LPOLLIN
) {
783 ret
= update_stream(&kconsumer_data
, pollfd
);
789 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
790 * and unregister kernel stream at this point.
798 DBG("Kernel thread dying");
799 close(kernel_poll_pipe
[0]);
800 close(kernel_poll_pipe
[1]);
802 lttng_poll_clean(&events
);
808 * This thread manage the consumer error sent back to the session daemon.
810 static void *thread_manage_consumer(void *data
)
812 int sock
= 0, i
, ret
, pollfd
;
813 uint32_t revents
, nb_fd
;
814 enum lttcomm_return_code code
;
815 struct lttng_poll_event events
;
816 struct consumer_data
*consumer_data
= data
;
818 DBG("[thread] Manage consumer started");
820 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
826 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
827 * Nothing more will be added to this poll set.
829 ret
= create_thread_poll_set(&events
, 2);
834 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
839 nb_fd
= LTTNG_POLL_GETNB(&events
);
841 /* Inifinite blocking call, waiting for transmission */
842 ret
= lttng_poll_wait(&events
, -1);
847 for (i
= 0; i
< nb_fd
; i
++) {
848 /* Fetch once the poll data */
849 revents
= LTTNG_POLL_GETEV(&events
, i
);
850 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
852 /* Thread quit pipe has been closed. Killing thread. */
853 ret
= check_thread_quit_pipe(pollfd
, revents
);
858 /* Event on the registration socket */
859 if (pollfd
== consumer_data
->err_sock
) {
860 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
861 ERR("consumer err socket poll error");
867 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
872 DBG2("Receiving code from consumer err_sock");
874 /* Getting status code from kconsumerd */
875 ret
= lttcomm_recv_unix_sock(sock
, &code
,
876 sizeof(enum lttcomm_return_code
));
881 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
882 consumer_data
->cmd_sock
=
883 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
884 if (consumer_data
->cmd_sock
< 0) {
885 sem_post(&consumer_data
->sem
);
886 perror("consumer connect");
889 /* Signal condition to tell that the kconsumerd is ready */
890 sem_post(&consumer_data
->sem
);
891 DBG("consumer command socket ready");
893 ERR("consumer error when waiting for SOCK_READY : %s",
894 lttcomm_get_readable_code(-code
));
898 /* Remove the kconsumerd error sock since we've established a connexion */
899 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
904 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
909 /* Update number of fd */
910 nb_fd
= LTTNG_POLL_GETNB(&events
);
912 /* Inifinite blocking call, waiting for transmission */
913 ret
= lttng_poll_wait(&events
, -1);
918 for (i
= 0; i
< nb_fd
; i
++) {
919 /* Fetch once the poll data */
920 revents
= LTTNG_POLL_GETEV(&events
, i
);
921 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
923 /* Thread quit pipe has been closed. Killing thread. */
924 ret
= check_thread_quit_pipe(pollfd
, revents
);
929 /* Event on the kconsumerd socket */
930 if (pollfd
== sock
) {
931 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
932 ERR("consumer err socket second poll error");
938 /* Wait for any kconsumerd error */
939 ret
= lttcomm_recv_unix_sock(sock
, &code
,
940 sizeof(enum lttcomm_return_code
));
942 ERR("consumer closed the command socket");
946 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
949 DBG("consumer thread dying");
950 close(consumer_data
->err_sock
);
951 close(consumer_data
->cmd_sock
);
954 unlink(consumer_data
->err_unix_sock_path
);
955 unlink(consumer_data
->cmd_unix_sock_path
);
956 consumer_data
->pid
= 0;
958 lttng_poll_clean(&events
);
964 * This thread manage application communication.
966 static void *thread_manage_apps(void *data
)
969 uint32_t revents
, nb_fd
;
970 struct ust_command ust_cmd
;
971 struct lttng_poll_event events
;
973 DBG("[thread] Manage application started");
975 ret
= create_thread_poll_set(&events
, 2);
980 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
986 /* Zeroed the events structure */
987 lttng_poll_reset(&events
);
989 nb_fd
= LTTNG_POLL_GETNB(&events
);
991 DBG("Apps thread polling on %d fds", nb_fd
);
993 /* Inifinite blocking call, waiting for transmission */
994 ret
= lttng_poll_wait(&events
, -1);
999 for (i
= 0; i
< nb_fd
; i
++) {
1000 /* Fetch once the poll data */
1001 revents
= LTTNG_POLL_GETEV(&events
, i
);
1002 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1004 /* Thread quit pipe has been closed. Killing thread. */
1005 ret
= check_thread_quit_pipe(pollfd
, revents
);
1010 /* Inspect the apps cmd pipe */
1011 if (pollfd
== apps_cmd_pipe
[0]) {
1012 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1013 ERR("Apps command pipe error");
1015 } else if (revents
& LPOLLIN
) {
1017 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1018 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1019 perror("read apps cmd pipe");
1023 /* Register applicaton to the session daemon */
1024 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1027 /* Only critical ENOMEM error can be returned here */
1031 ret
= ustctl_register_done(ust_cmd
.sock
);
1034 * If the registration is not possible, we simply
1035 * unregister the apps and continue
1037 ust_app_unregister(ust_cmd
.sock
);
1040 * We just need here to monitor the close of the UST
1041 * socket and poll set monitor those by default.
1043 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1048 DBG("Apps with sock %d added to poll set",
1055 * At this point, we know that a registered application made
1056 * the event at poll_wait.
1058 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1059 /* Removing from the poll set */
1060 ret
= lttng_poll_del(&events
, pollfd
);
1066 ust_app_unregister(pollfd
);
1074 DBG("Application communication apps dying");
1075 close(apps_cmd_pipe
[0]);
1076 close(apps_cmd_pipe
[1]);
1078 lttng_poll_clean(&events
);
1084 * Dispatch request from the registration threads to the application
1085 * communication thread.
1087 static void *thread_dispatch_ust_registration(void *data
)
1090 struct cds_wfq_node
*node
;
1091 struct ust_command
*ust_cmd
= NULL
;
1093 DBG("[thread] Dispatch UST command started");
1095 while (!dispatch_thread_exit
) {
1096 /* Atomically prepare the queue futex */
1097 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1100 /* Dequeue command for registration */
1101 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1103 DBG("Waked up but nothing in the UST command queue");
1104 /* Continue thread execution */
1108 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1110 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1111 " gid:%d sock:%d name:%s (version %d.%d)",
1112 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1113 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1114 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1115 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1117 * Inform apps thread of the new application registration. This
1118 * call is blocking so we can be assured that the data will be read
1119 * at some point in time or wait to the end of the world :)
1121 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1122 sizeof(struct ust_command
));
1124 perror("write apps cmd pipe");
1125 if (errno
== EBADF
) {
1127 * We can't inform the application thread to process
1128 * registration. We will exit or else application
1129 * registration will not occur and tracing will never
1136 } while (node
!= NULL
);
1138 /* Futex wait on queue. Blocking call on futex() */
1139 futex_nto1_wait(&ust_cmd_queue
.futex
);
1143 DBG("Dispatch thread dying");
1148 * This thread manage application registration.
1150 static void *thread_registration_apps(void *data
)
1152 int sock
= 0, i
, ret
, pollfd
;
1153 uint32_t revents
, nb_fd
;
1154 struct lttng_poll_event events
;
1156 * Get allocated in this thread, enqueued to a global queue, dequeued and
1157 * freed in the manage apps thread.
1159 struct ust_command
*ust_cmd
= NULL
;
1161 DBG("[thread] Manage application registration started");
1163 ret
= lttcomm_listen_unix_sock(apps_sock
);
1169 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1170 * more will be added to this poll set.
1172 ret
= create_thread_poll_set(&events
, 2);
1177 /* Add the application registration socket */
1178 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1183 /* Notify all applications to register */
1184 ret
= notify_ust_apps(1);
1186 ERR("Failed to notify applications or create the wait shared memory.\n"
1187 "Execution continues but there might be problem for already\n"
1188 "running applications that wishes to register.");
1192 DBG("Accepting application registration");
1194 nb_fd
= LTTNG_POLL_GETNB(&events
);
1196 /* Inifinite blocking call, waiting for transmission */
1197 ret
= lttng_poll_wait(&events
, -1);
1202 for (i
= 0; i
< nb_fd
; i
++) {
1203 /* Fetch once the poll data */
1204 revents
= LTTNG_POLL_GETEV(&events
, i
);
1205 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1207 /* Thread quit pipe has been closed. Killing thread. */
1208 ret
= check_thread_quit_pipe(pollfd
, revents
);
1213 /* Event on the registration socket */
1214 if (pollfd
== apps_sock
) {
1215 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1216 ERR("Register apps socket poll error");
1218 } else if (revents
& LPOLLIN
) {
1219 sock
= lttcomm_accept_unix_sock(apps_sock
);
1224 /* Create UST registration command for enqueuing */
1225 ust_cmd
= malloc(sizeof(struct ust_command
));
1226 if (ust_cmd
== NULL
) {
1227 perror("ust command malloc");
1232 * Using message-based transmissions to ensure we don't
1233 * have to deal with partially received messages.
1235 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1236 sizeof(struct ust_register_msg
));
1237 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1239 perror("lttcomm_recv_unix_sock register apps");
1241 ERR("Wrong size received on apps register");
1248 ust_cmd
->sock
= sock
;
1250 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1251 " gid:%d sock:%d name:%s (version %d.%d)",
1252 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1253 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1254 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1255 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1258 * Lock free enqueue the registration request. The red pill
1259 * has been taken! This apps will be part of the *system*.
1261 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1264 * Wake the registration queue futex. Implicit memory
1265 * barrier with the exchange in cds_wfq_enqueue.
1267 futex_nto1_wake(&ust_cmd_queue
.futex
);
1274 DBG("UST Registration thread dying");
1276 /* Notify that the registration thread is gone */
1281 unlink(apps_unix_sock_path
);
1283 lttng_poll_clean(&events
);
1289 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1290 * exec or it will fails.
1292 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1295 struct timespec timeout
;
1297 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1298 timeout
.tv_nsec
= 0;
1300 /* Setup semaphore */
1301 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1303 PERROR("sem_init consumer semaphore");
1307 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1308 thread_manage_consumer
, consumer_data
);
1310 PERROR("pthread_create consumer");
1315 /* Get time for sem_timedwait absolute timeout */
1316 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1318 PERROR("clock_gettime spawn consumer");
1319 /* Infinite wait for the kconsumerd thread to be ready */
1320 ret
= sem_wait(&consumer_data
->sem
);
1322 /* Normal timeout if the gettime was successful */
1323 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1324 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1328 if (errno
== ETIMEDOUT
) {
1330 * Call has timed out so we kill the kconsumerd_thread and return
1333 ERR("The consumer thread was never ready. Killing it");
1334 ret
= pthread_cancel(consumer_data
->thread
);
1336 PERROR("pthread_cancel consumer thread");
1339 PERROR("semaphore wait failed consumer thread");
1344 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1345 if (consumer_data
->pid
== 0) {
1346 ERR("Kconsumerd did not start");
1347 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1350 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1359 * Join consumer thread
1361 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1366 if (consumer_data
->pid
!= 0) {
1367 ret
= kill(consumer_data
->pid
, SIGTERM
);
1369 ERR("Error killing consumer daemon");
1372 return pthread_join(consumer_data
->thread
, &status
);
1379 * Fork and exec a consumer daemon (consumerd).
1381 * Return pid if successful else -1.
1383 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1387 const char *verbosity
;
1389 DBG("Spawning consumerd");
1396 if (opt_verbose
> 1 || opt_verbose_consumer
) {
1397 verbosity
= "--verbose";
1399 verbosity
= "--quiet";
1401 switch (consumer_data
->type
) {
1402 case LTTNG_CONSUMER_KERNEL
:
1403 execl(INSTALL_BIN_PATH
"/lttng-consumerd",
1404 "lttng-consumerd", verbosity
, "-k", NULL
);
1406 case LTTNG_CONSUMER_UST
:
1407 execl(INSTALL_BIN_PATH
"/lttng-consumerd",
1408 "lttng-consumerd", verbosity
, "-u", NULL
);
1411 perror("unknown consumer type");
1415 perror("kernel start consumer exec");
1418 } else if (pid
> 0) {
1421 perror("start consumer fork");
1428 * Spawn the consumerd daemon and session daemon thread.
1430 static int start_consumerd(struct consumer_data
*consumer_data
)
1434 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1435 if (consumer_data
->pid
!= 0) {
1436 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1440 ret
= spawn_consumerd(consumer_data
);
1442 ERR("Spawning consumerd failed");
1443 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1447 /* Setting up the consumer_data pid */
1448 consumer_data
->pid
= ret
;
1449 DBG2("consumer pid %d", consumer_data
->pid
);
1450 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1452 DBG2("Spawning consumer control thread");
1453 ret
= spawn_consumer_thread(consumer_data
);
1455 ERR("Fatal error spawning consumer control thread");
1467 * modprobe_kernel_modules
1469 static int modprobe_kernel_modules(void)
1474 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1475 ret
= snprintf(modprobe
, sizeof(modprobe
),
1476 "/sbin/modprobe %s%s",
1477 kernel_modules_list
[i
].required
? "" : "--quiet ",
1478 kernel_modules_list
[i
].name
);
1480 perror("snprintf modprobe");
1483 modprobe
[sizeof(modprobe
) - 1] = '\0';
1484 ret
= system(modprobe
);
1486 ERR("Unable to launch modprobe for module %s",
1487 kernel_modules_list
[i
].name
);
1488 } else if (kernel_modules_list
[i
].required
1489 && WEXITSTATUS(ret
) != 0) {
1490 ERR("Unable to load module %s",
1491 kernel_modules_list
[i
].name
);
1493 DBG("Modprobe successfully %s",
1494 kernel_modules_list
[i
].name
);
1505 static int mount_debugfs(char *path
)
1508 char *type
= "debugfs";
1510 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1512 PERROR("Cannot create debugfs path");
1516 ret
= mount(type
, path
, type
, 0, NULL
);
1518 PERROR("Cannot mount debugfs");
1522 DBG("Mounted debugfs successfully at %s", path
);
1529 * Setup necessary data for kernel tracer action.
1531 static void init_kernel_tracer(void)
1534 char *proc_mounts
= "/proc/mounts";
1536 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1539 /* Detect debugfs */
1540 fp
= fopen(proc_mounts
, "r");
1542 ERR("Unable to probe %s", proc_mounts
);
1546 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1547 if (strstr(line
, "debugfs") != NULL
) {
1548 /* Remove first string */
1550 /* Dup string here so we can reuse line later on */
1551 debugfs_path
= strdup(strtok(NULL
, " "));
1552 DBG("Got debugfs path : %s", debugfs_path
);
1559 /* Mount debugfs if needded */
1560 if (debugfs_path
== NULL
) {
1561 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1563 perror("asprintf debugfs path");
1566 ret
= mount_debugfs(debugfs_path
);
1568 perror("Cannot mount debugfs");
1573 /* Modprobe lttng kernel modules */
1574 ret
= modprobe_kernel_modules();
1579 /* Setup lttng kernel path */
1580 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1582 perror("asprintf lttng path");
1586 /* Open debugfs lttng */
1587 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1588 if (kernel_tracer_fd
< 0) {
1589 DBG("Failed to open %s", lttng_path
);
1595 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1605 WARN("No kernel tracer available");
1606 kernel_tracer_fd
= 0;
1611 * Init tracing by creating trace directory and sending fds kernel consumer.
1613 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1617 if (session
->consumer_fds_sent
== 0) {
1619 * Assign default kernel consumer socket if no consumer assigned to the
1620 * kernel session. At this point, it's NOT suppose to be 0 but this is
1621 * an extra security check.
1623 if (session
->consumer_fd
== 0) {
1624 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1627 ret
= send_consumer_session_streams(&kconsumer_data
, session
);
1629 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1633 session
->consumer_fds_sent
= 1;
1641 * Create an UST session and add it to the session ust list.
1643 static int create_ust_session(struct ltt_session
*session
,
1644 struct lttng_domain
*domain
)
1647 struct ltt_ust_session
*lus
= NULL
;
1648 struct ust_app
*app
;
1650 switch (domain
->type
) {
1651 case LTTNG_DOMAIN_UST_PID
:
1652 app
= ust_app_get_by_pid(domain
->attr
.pid
);
1654 ret
= LTTCOMM_APP_NOT_FOUND
;
1659 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1663 DBG("Creating UST session");
1665 lus
= trace_ust_create_session(session
->path
, domain
->attr
.pid
, domain
);
1667 ret
= LTTCOMM_UST_SESS_FAIL
;
1671 ret
= mkdir_recursive(lus
->path
, S_IRWXU
| S_IRWXG
,
1672 geteuid(), allowed_group());
1674 if (ret
!= -EEXIST
) {
1675 ERR("Trace directory creation error");
1676 ret
= LTTCOMM_UST_SESS_FAIL
;
1681 /* Create session on the UST tracer */
1682 ret
= ustctl_create_session(app
->sock
, lus
);
1684 ret
= LTTCOMM_UST_SESS_FAIL
;
1688 cds_list_add(&lus
->list
, &session
->ust_session_list
.head
);
1689 session
->ust_session_list
.count
++;
1699 * Create a kernel tracer session then create the default channel.
1701 static int create_kernel_session(struct ltt_session
*session
)
1705 DBG("Creating kernel session");
1707 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1709 ret
= LTTCOMM_KERN_SESS_FAIL
;
1713 /* Set kernel consumer socket fd */
1714 if (kconsumer_data
.cmd_sock
) {
1715 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1718 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1719 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1721 if (ret
!= -EEXIST
) {
1722 ERR("Trace directory creation error");
1732 * Using the session list, filled a lttng_session array to send back to the
1733 * client for session listing.
1735 * The session list lock MUST be acquired before calling this function. Use
1736 * session_lock_list() and session_unlock_list().
1738 static void list_lttng_sessions(struct lttng_session
*sessions
)
1741 struct ltt_session
*session
;
1743 DBG("Getting all available session");
1745 * Iterate over session list and append data after the control struct in
1748 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1749 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1750 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1751 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1752 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1758 * Fill lttng_channel array of all channels.
1760 static void list_lttng_channels(struct ltt_session
*session
,
1761 struct lttng_channel
*channels
)
1764 struct ltt_kernel_channel
*kchan
;
1766 DBG("Listing channels for session %s", session
->name
);
1768 /* Kernel channels */
1769 if (session
->kernel_session
!= NULL
) {
1770 cds_list_for_each_entry(kchan
,
1771 &session
->kernel_session
->channel_list
.head
, list
) {
1772 /* Copy lttng_channel struct to array */
1773 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1774 channels
[i
].enabled
= kchan
->enabled
;
1779 /* TODO: Missing UST listing */
1783 * Fill lttng_event array of all events in the channel.
1785 static void list_lttng_events(struct ltt_kernel_channel
*kchan
,
1786 struct lttng_event
*events
)
1789 * TODO: This is ONLY kernel. Need UST support.
1792 struct ltt_kernel_event
*event
;
1794 DBG("Listing events for channel %s", kchan
->channel
->name
);
1796 /* Kernel channels */
1797 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
1798 strncpy(events
[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
1799 events
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1800 events
[i
].enabled
= event
->enabled
;
1801 switch (event
->event
->instrumentation
) {
1802 case LTTNG_KERNEL_TRACEPOINT
:
1803 events
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
1805 case LTTNG_KERNEL_KPROBE
:
1806 case LTTNG_KERNEL_KRETPROBE
:
1807 events
[i
].type
= LTTNG_EVENT_PROBE
;
1808 memcpy(&events
[i
].attr
.probe
, &event
->event
->u
.kprobe
,
1809 sizeof(struct lttng_kernel_kprobe
));
1811 case LTTNG_KERNEL_FUNCTION
:
1812 events
[i
].type
= LTTNG_EVENT_FUNCTION
;
1813 memcpy(&events
[i
].attr
.ftrace
, &event
->event
->u
.ftrace
,
1814 sizeof(struct lttng_kernel_function
));
1816 case LTTNG_KERNEL_NOOP
:
1817 events
[i
].type
= LTTNG_EVENT_NOOP
;
1819 case LTTNG_KERNEL_SYSCALL
:
1820 events
[i
].type
= LTTNG_EVENT_SYSCALL
;
1822 case LTTNG_KERNEL_ALL
:
1831 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1833 static int cmd_disable_channel(struct ltt_session
*session
,
1834 int domain
, char *channel_name
)
1839 case LTTNG_DOMAIN_KERNEL
:
1840 ret
= channel_kernel_disable(session
->kernel_session
,
1842 if (ret
!= LTTCOMM_OK
) {
1846 kernel_wait_quiescent(kernel_tracer_fd
);
1848 case LTTNG_DOMAIN_UST_PID
:
1851 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1862 * Copy channel from attributes and set it in the application channel list.
1864 static int copy_ust_channel_to_app(struct ltt_ust_session
*usess
,
1865 struct lttng_channel
*attr
, struct ust_app
*app
)
1868 struct ltt_ust_channel
*uchan
, *new_chan
;
1870 uchan
= trace_ust_get_channel_by_name(attr
->name
, usess
);
1871 if (uchan
== NULL
) {
1872 ret
= LTTCOMM_FATAL
;
1876 new_chan
= trace_ust_create_channel(attr
, usess
->path
);
1877 if (new_chan
== NULL
) {
1878 PERROR("malloc ltt_ust_channel");
1879 ret
= LTTCOMM_FATAL
;
1883 ret
= channel_ust_copy(new_chan
, uchan
);
1885 ret
= LTTCOMM_FATAL
;
1889 /* Add channel to the ust app channel list */
1890 cds_list_add(&new_chan
->list
, &app
->channels
.head
);
1891 app
->channels
.count
++;
1898 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1900 static int cmd_enable_channel(struct ltt_session
*session
,
1901 struct lttng_domain
*domain
, struct lttng_channel
*attr
)
1905 switch (domain
->type
) {
1906 case LTTNG_DOMAIN_KERNEL
:
1908 struct ltt_kernel_channel
*kchan
;
1910 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1911 session
->kernel_session
);
1912 if (kchan
== NULL
) {
1913 ret
= channel_kernel_create(session
->kernel_session
,
1914 attr
, kernel_poll_pipe
[1]);
1916 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1919 if (ret
!= LTTCOMM_OK
) {
1923 kernel_wait_quiescent(kernel_tracer_fd
);
1926 case LTTNG_DOMAIN_UST_PID
:
1929 struct ltt_ust_channel
*uchan
;
1930 struct ltt_ust_session
*usess
;
1931 struct ust_app
*app
;
1933 usess
= trace_ust_get_session_by_pid(&session
->ust_session_list
,
1935 if (usess
== NULL
) {
1936 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
1940 app
= ust_app_get_by_pid(domain
->attr
.pid
);
1942 ret
= LTTCOMM_APP_NOT_FOUND
;
1947 uchan
= trace_ust_get_channel_by_name(attr
->name
, usess
);
1948 if (uchan
== NULL
) {
1949 ret
= channel_ust_create(usess
, attr
, sock
);
1951 ret
= channel_ust_enable(usess
, uchan
, sock
);
1954 if (ret
!= LTTCOMM_OK
) {
1958 ret
= copy_ust_channel_to_app(usess
, attr
, app
);
1959 if (ret
!= LTTCOMM_OK
) {
1963 DBG("UST channel %s created for app sock %d with pid %d",
1964 attr
->name
, app
->sock
, domain
->attr
.pid
);
1968 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1979 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1981 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
1982 char *channel_name
, char *event_name
)
1985 struct ltt_kernel_channel
*kchan
;
1988 case LTTNG_DOMAIN_KERNEL
:
1989 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1990 session
->kernel_session
);
1991 if (kchan
== NULL
) {
1992 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1996 ret
= event_kernel_disable_tracepoint(session
->kernel_session
, kchan
, event_name
);
1997 if (ret
!= LTTCOMM_OK
) {
2001 kernel_wait_quiescent(kernel_tracer_fd
);
2004 /* TODO: Userspace tracing */
2005 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2016 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2018 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2022 struct ltt_kernel_channel
*kchan
;
2025 case LTTNG_DOMAIN_KERNEL
:
2026 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2027 session
->kernel_session
);
2028 if (kchan
== NULL
) {
2029 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2033 ret
= event_kernel_disable_all(session
->kernel_session
, kchan
);
2034 if (ret
!= LTTCOMM_OK
) {
2038 kernel_wait_quiescent(kernel_tracer_fd
);
2041 /* TODO: Userspace tracing */
2042 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2053 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2055 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2056 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2061 case LTTNG_DOMAIN_KERNEL
:
2062 /* Add kernel context to kernel tracer */
2063 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2064 event_name
, channel_name
);
2065 if (ret
!= LTTCOMM_OK
) {
2071 /* TODO: Userspace tracing */
2072 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2083 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2085 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2086 char *channel_name
, struct lttng_event
*event
)
2089 struct ltt_kernel_channel
*kchan
;
2090 struct lttng_channel
*attr
;
2093 case LTTNG_DOMAIN_KERNEL
:
2094 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2095 session
->kernel_session
);
2096 if (kchan
== NULL
) {
2097 attr
= channel_new_default_attr(domain
);
2099 ret
= LTTCOMM_FATAL
;
2102 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2104 /* This call will notify the kernel thread */
2105 ret
= channel_kernel_create(session
->kernel_session
,
2106 attr
, kernel_poll_pipe
[1]);
2107 if (ret
!= LTTCOMM_OK
) {
2112 /* Get the newly created kernel channel pointer */
2113 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2114 session
->kernel_session
);
2115 if (kchan
== NULL
) {
2116 /* This sould not happen... */
2117 ret
= LTTCOMM_FATAL
;
2121 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
, event
);
2122 if (ret
!= LTTCOMM_OK
) {
2126 kernel_wait_quiescent(kernel_tracer_fd
);
2129 /* TODO: Userspace tracing */
2130 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2141 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2143 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2144 char *channel_name
, int event_type
)
2147 struct ltt_kernel_channel
*kchan
;
2150 case LTTNG_DOMAIN_KERNEL
:
2151 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2152 session
->kernel_session
);
2153 if (kchan
== NULL
) {
2154 /* This call will notify the kernel thread */
2155 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2156 kernel_poll_pipe
[1]);
2157 if (ret
!= LTTCOMM_OK
) {
2162 /* Get the newly created kernel channel pointer */
2163 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2164 session
->kernel_session
);
2165 if (kchan
== NULL
) {
2166 /* This sould not happen... */
2167 ret
= LTTCOMM_FATAL
;
2171 switch (event_type
) {
2172 case LTTNG_KERNEL_SYSCALL
:
2173 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2174 kchan
, kernel_tracer_fd
);
2176 case LTTNG_KERNEL_TRACEPOINT
:
2178 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2179 * events already registered to the channel.
2181 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2182 kchan
, kernel_tracer_fd
);
2184 case LTTNG_KERNEL_ALL
:
2185 /* Enable syscalls and tracepoints */
2186 ret
= event_kernel_enable_all(session
->kernel_session
,
2187 kchan
, kernel_tracer_fd
);
2190 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2193 if (ret
!= LTTCOMM_OK
) {
2197 kernel_wait_quiescent(kernel_tracer_fd
);
2200 /* TODO: Userspace tracing */
2201 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2212 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2214 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2217 ssize_t nb_events
= 0;
2220 case LTTNG_DOMAIN_KERNEL
:
2221 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2222 if (nb_events
< 0) {
2223 ret
= LTTCOMM_KERN_LIST_FAIL
;
2228 /* TODO: Userspace listing */
2229 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2236 /* Return negative value to differentiate return code */
2241 * Command LTTNG_START_TRACE processed by the client thread.
2243 static int cmd_start_trace(struct ltt_session
*session
)
2246 struct ltt_kernel_channel
*kchan
;
2247 struct ltt_kernel_session
*ksession
;
2250 ksession
= session
->kernel_session
;
2252 /* Kernel tracing */
2253 if (ksession
!= NULL
) {
2254 /* Open kernel metadata */
2255 if (ksession
->metadata
== NULL
) {
2256 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2258 ret
= LTTCOMM_KERN_META_FAIL
;
2263 /* Open kernel metadata stream */
2264 if (ksession
->metadata_stream_fd
== 0) {
2265 ret
= kernel_open_metadata_stream(ksession
);
2267 ERR("Kernel create metadata stream failed");
2268 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2273 /* For each channel */
2274 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2275 if (kchan
->stream_count
== 0) {
2276 ret
= kernel_open_channel_stream(kchan
);
2278 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2281 /* Update the stream global counter */
2282 ksession
->stream_count_global
+= ret
;
2286 /* Setup kernel consumer socket and send fds to it */
2287 ret
= init_kernel_tracing(ksession
);
2289 ret
= LTTCOMM_KERN_START_FAIL
;
2293 /* This start the kernel tracing */
2294 ret
= kernel_start_session(ksession
);
2296 ret
= LTTCOMM_KERN_START_FAIL
;
2300 /* Quiescent wait after starting trace */
2301 kernel_wait_quiescent(kernel_tracer_fd
);
2304 /* TODO: Start all UST traces */
2313 * Command LTTNG_STOP_TRACE processed by the client thread.
2315 static int cmd_stop_trace(struct ltt_session
*session
)
2318 struct ltt_kernel_channel
*kchan
;
2319 struct ltt_kernel_session
*ksession
;
2322 ksession
= session
->kernel_session
;
2325 if (ksession
!= NULL
) {
2326 DBG("Stop kernel tracing");
2328 /* Flush all buffers before stopping */
2329 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2331 ERR("Kernel metadata flush failed");
2334 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2335 ret
= kernel_flush_buffer(kchan
);
2337 ERR("Kernel flush buffer error");
2341 ret
= kernel_stop_session(ksession
);
2343 ret
= LTTCOMM_KERN_STOP_FAIL
;
2347 kernel_wait_quiescent(kernel_tracer_fd
);
2350 /* TODO : User-space tracer */
2359 * Command LTTNG_CREATE_SESSION processed by the client thread.
2361 static int cmd_create_session(char *name
, char *path
)
2365 ret
= session_create(name
, path
);
2366 if (ret
!= LTTCOMM_OK
) {
2377 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2379 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2383 /* Clean kernel session teardown */
2384 teardown_kernel_session(session
);
2387 * Must notify the kernel thread here to update it's poll setin order
2388 * to remove the channel(s)' fd just destroyed.
2390 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2392 perror("write kernel poll pipe");
2395 ret
= session_destroy(session
);
2401 * Command LTTNG_CALIBRATE processed by the client thread.
2403 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2408 case LTTNG_DOMAIN_KERNEL
:
2410 struct lttng_kernel_calibrate kcalibrate
;
2412 kcalibrate
.type
= calibrate
->type
;
2413 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2415 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2421 /* TODO: Userspace tracing */
2422 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2433 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2435 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2441 case LTTNG_DOMAIN_KERNEL
:
2442 /* Can't register a consumer if there is already one */
2443 if (session
->kernel_session
->consumer_fd
!= 0) {
2444 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2448 sock
= lttcomm_connect_unix_sock(sock_path
);
2450 ret
= LTTCOMM_CONNECT_FAIL
;
2454 session
->kernel_session
->consumer_fd
= sock
;
2457 /* TODO: Userspace tracing */
2458 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2469 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2471 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
2472 struct lttng_domain
**domains
)
2477 if (session
->kernel_session
!= NULL
) {
2481 nb_dom
+= session
->ust_session_list
.count
;
2483 *domains
= malloc(nb_dom
* sizeof(struct lttng_domain
));
2484 if (*domains
== NULL
) {
2485 ret
= -LTTCOMM_FATAL
;
2489 (*domains
)[0].type
= LTTNG_DOMAIN_KERNEL
;
2491 /* TODO: User-space tracer domain support */
2500 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2502 static ssize_t
cmd_list_channels(struct ltt_session
*session
,
2503 struct lttng_channel
**channels
)
2506 ssize_t nb_chan
= 0;
2508 if (session
->kernel_session
!= NULL
) {
2509 nb_chan
+= session
->kernel_session
->channel_count
;
2512 *channels
= malloc(nb_chan
* sizeof(struct lttng_channel
));
2513 if (*channels
== NULL
) {
2514 ret
= -LTTCOMM_FATAL
;
2518 list_lttng_channels(session
, *channels
);
2527 * Command LTTNG_LIST_EVENTS processed by the client thread.
2529 static ssize_t
cmd_list_events(struct ltt_session
*session
,
2530 char *channel_name
, struct lttng_event
**events
)
2533 ssize_t nb_event
= 0;
2534 struct ltt_kernel_channel
*kchan
= NULL
;
2536 if (session
->kernel_session
!= NULL
) {
2537 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2538 session
->kernel_session
);
2539 if (kchan
== NULL
) {
2540 ret
= -LTTCOMM_KERN_CHAN_NOT_FOUND
;
2543 nb_event
+= kchan
->event_count
;
2546 *events
= malloc(nb_event
* sizeof(struct lttng_event
));
2547 if (*events
== NULL
) {
2548 ret
= -LTTCOMM_FATAL
;
2552 list_lttng_events(kchan
, *events
);
2554 /* TODO: User-space tracer support */
2563 * Process the command requested by the lttng client within the command
2564 * context structure. This function make sure that the return structure (llm)
2565 * is set and ready for transmission before returning.
2567 * Return any error encountered or 0 for success.
2569 static int process_client_msg(struct command_ctx
*cmd_ctx
)
2571 int ret
= LTTCOMM_OK
;
2572 int need_tracing_session
= 1;
2574 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2577 * Check for command that don't needs to allocate a returned payload. We do
2578 * this here so we don't have to make the call for no payload at each
2581 switch(cmd_ctx
->lsm
->cmd_type
) {
2582 case LTTNG_LIST_SESSIONS
:
2583 case LTTNG_LIST_TRACEPOINTS
:
2584 case LTTNG_LIST_DOMAINS
:
2585 case LTTNG_LIST_CHANNELS
:
2586 case LTTNG_LIST_EVENTS
:
2589 /* Setup lttng message with no payload */
2590 ret
= setup_lttng_msg(cmd_ctx
, 0);
2592 /* This label does not try to unlock the session */
2593 goto init_setup_error
;
2597 /* Commands that DO NOT need a session. */
2598 switch (cmd_ctx
->lsm
->cmd_type
) {
2599 case LTTNG_CALIBRATE
:
2600 case LTTNG_CREATE_SESSION
:
2601 case LTTNG_LIST_SESSIONS
:
2602 case LTTNG_LIST_TRACEPOINTS
:
2603 need_tracing_session
= 0;
2606 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
2607 session_lock_list();
2608 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
2609 session_unlock_list();
2610 if (cmd_ctx
->session
== NULL
) {
2611 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
2612 ret
= LTTCOMM_SESS_NOT_FOUND
;
2614 /* If no session name specified */
2615 ret
= LTTCOMM_SELECT_SESS
;
2619 /* Acquire lock for the session */
2620 session_lock(cmd_ctx
->session
);
2626 * Check domain type for specific "pre-action".
2628 switch (cmd_ctx
->lsm
->domain
.type
) {
2629 case LTTNG_DOMAIN_KERNEL
:
2630 /* Kernel tracer check */
2631 if (kernel_tracer_fd
== 0) {
2632 /* Basically, load kernel tracer modules */
2633 init_kernel_tracer();
2634 if (kernel_tracer_fd
== 0) {
2635 ret
= LTTCOMM_KERN_NA
;
2640 /* Need a session for kernel command */
2641 if (need_tracing_session
) {
2642 if (cmd_ctx
->session
->kernel_session
== NULL
) {
2643 ret
= create_kernel_session(cmd_ctx
->session
);
2645 ret
= LTTCOMM_KERN_SESS_FAIL
;
2650 /* Start the kernel consumer daemon */
2651 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
2652 if (kconsumer_data
.pid
== 0 &&
2653 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
2654 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2655 ret
= start_consumerd(&kconsumer_data
);
2657 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2661 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
2664 case LTTNG_DOMAIN_UST_PID
:
2666 struct ltt_ust_session
*usess
;
2668 if (need_tracing_session
) {
2669 usess
= trace_ust_get_session_by_pid(
2670 &cmd_ctx
->session
->ust_session_list
,
2671 cmd_ctx
->lsm
->domain
.attr
.pid
);
2672 if (usess
== NULL
) {
2673 ret
= create_ust_session(cmd_ctx
->session
,
2674 &cmd_ctx
->lsm
->domain
);
2675 if (ret
!= LTTCOMM_OK
) {
2683 /* TODO Userspace tracer */
2687 /* Process by command type */
2688 switch (cmd_ctx
->lsm
->cmd_type
) {
2689 case LTTNG_ADD_CONTEXT
:
2691 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2692 cmd_ctx
->lsm
->u
.context
.channel_name
,
2693 cmd_ctx
->lsm
->u
.context
.event_name
,
2694 &cmd_ctx
->lsm
->u
.context
.ctx
);
2697 case LTTNG_DISABLE_CHANNEL
:
2699 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2700 cmd_ctx
->lsm
->u
.disable
.channel_name
);
2703 case LTTNG_DISABLE_EVENT
:
2705 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2706 cmd_ctx
->lsm
->u
.disable
.channel_name
,
2707 cmd_ctx
->lsm
->u
.disable
.name
);
2711 case LTTNG_DISABLE_ALL_EVENT
:
2713 DBG("Disabling all kernel event");
2715 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2716 cmd_ctx
->lsm
->u
.disable
.channel_name
);
2719 case LTTNG_ENABLE_CHANNEL
:
2721 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
2722 &cmd_ctx
->lsm
->u
.channel
.chan
);
2725 case LTTNG_ENABLE_EVENT
:
2727 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2728 cmd_ctx
->lsm
->u
.enable
.channel_name
,
2729 &cmd_ctx
->lsm
->u
.enable
.event
);
2732 case LTTNG_ENABLE_ALL_EVENT
:
2734 DBG("Enabling all kernel event");
2736 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2737 cmd_ctx
->lsm
->u
.enable
.channel_name
,
2738 cmd_ctx
->lsm
->u
.enable
.event
.type
);
2741 case LTTNG_LIST_TRACEPOINTS
:
2743 struct lttng_event
*events
;
2746 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
2747 if (nb_events
< 0) {
2753 * Setup lttng message with payload size set to the event list size in
2754 * bytes and then copy list into the llm payload.
2756 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
2762 /* Copy event list into message payload */
2763 memcpy(cmd_ctx
->llm
->payload
, events
,
2764 sizeof(struct lttng_event
) * nb_events
);
2771 case LTTNG_START_TRACE
:
2773 ret
= cmd_start_trace(cmd_ctx
->session
);
2776 case LTTNG_STOP_TRACE
:
2778 ret
= cmd_stop_trace(cmd_ctx
->session
);
2781 case LTTNG_CREATE_SESSION
:
2783 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
2784 cmd_ctx
->lsm
->session
.path
);
2787 case LTTNG_DESTROY_SESSION
:
2789 ret
= cmd_destroy_session(cmd_ctx
->session
,
2790 cmd_ctx
->lsm
->session
.name
);
2793 case LTTNG_LIST_DOMAINS
:
2796 struct lttng_domain
*domains
;
2798 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
2804 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
2809 /* Copy event list into message payload */
2810 memcpy(cmd_ctx
->llm
->payload
, domains
,
2811 nb_dom
* sizeof(struct lttng_domain
));
2818 case LTTNG_LIST_CHANNELS
:
2821 struct lttng_channel
*channels
;
2823 nb_chan
= cmd_list_channels(cmd_ctx
->session
, &channels
);
2829 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
2834 /* Copy event list into message payload */
2835 memcpy(cmd_ctx
->llm
->payload
, channels
,
2836 nb_chan
* sizeof(struct lttng_channel
));
2843 case LTTNG_LIST_EVENTS
:
2846 struct lttng_event
*events
= NULL
;
2848 nb_event
= cmd_list_events(cmd_ctx
->session
,
2849 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
2855 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
2860 /* Copy event list into message payload */
2861 memcpy(cmd_ctx
->llm
->payload
, events
,
2862 nb_event
* sizeof(struct lttng_event
));
2869 case LTTNG_LIST_SESSIONS
:
2871 session_lock_list();
2873 if (session_list_ptr
->count
== 0) {
2874 ret
= LTTCOMM_NO_SESSION
;
2875 session_unlock_list();
2879 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
2880 session_list_ptr
->count
);
2882 session_unlock_list();
2886 /* Filled the session array */
2887 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
2889 session_unlock_list();
2894 case LTTNG_CALIBRATE
:
2896 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
2897 &cmd_ctx
->lsm
->u
.calibrate
);
2900 case LTTNG_REGISTER_CONSUMER
:
2902 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2903 cmd_ctx
->lsm
->u
.reg
.path
);
2912 if (cmd_ctx
->llm
== NULL
) {
2913 DBG("Missing llm structure. Allocating one.");
2914 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
2918 /* Set return code */
2919 cmd_ctx
->llm
->ret_code
= ret
;
2921 if (cmd_ctx
->session
) {
2922 session_unlock(cmd_ctx
->session
);
2929 * This thread manage all clients request using the unix client socket for
2932 static void *thread_manage_clients(void *data
)
2934 int sock
= 0, ret
, i
, pollfd
;
2935 uint32_t revents
, nb_fd
;
2936 struct command_ctx
*cmd_ctx
= NULL
;
2937 struct lttng_poll_event events
;
2939 DBG("[thread] Manage client started");
2941 ret
= lttcomm_listen_unix_sock(client_sock
);
2947 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2948 * more will be added to this poll set.
2950 ret
= create_thread_poll_set(&events
, 2);
2955 /* Add the application registration socket */
2956 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2962 * Notify parent pid that we are ready to accept command for client side.
2964 if (opt_sig_parent
) {
2965 kill(ppid
, SIGCHLD
);
2969 DBG("Accepting client command ...");
2971 nb_fd
= LTTNG_POLL_GETNB(&events
);
2973 /* Inifinite blocking call, waiting for transmission */
2974 ret
= lttng_poll_wait(&events
, -1);
2979 for (i
= 0; i
< nb_fd
; i
++) {
2980 /* Fetch once the poll data */
2981 revents
= LTTNG_POLL_GETEV(&events
, i
);
2982 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2984 /* Thread quit pipe has been closed. Killing thread. */
2985 ret
= check_thread_quit_pipe(pollfd
, revents
);
2990 /* Event on the registration socket */
2991 if (pollfd
== client_sock
) {
2992 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2993 ERR("Client socket poll error");
2999 DBG("Wait for client response");
3001 sock
= lttcomm_accept_unix_sock(client_sock
);
3006 /* Allocate context command to process the client request */
3007 cmd_ctx
= malloc(sizeof(struct command_ctx
));
3008 if (cmd_ctx
== NULL
) {
3009 perror("malloc cmd_ctx");
3013 /* Allocate data buffer for reception */
3014 cmd_ctx
->lsm
= malloc(sizeof(struct lttcomm_session_msg
));
3015 if (cmd_ctx
->lsm
== NULL
) {
3016 perror("malloc cmd_ctx->lsm");
3020 cmd_ctx
->llm
= NULL
;
3021 cmd_ctx
->session
= NULL
;
3024 * Data is received from the lttng client. The struct
3025 * lttcomm_session_msg (lsm) contains the command and data request of
3028 DBG("Receiving data from client ...");
3029 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
,
3030 sizeof(struct lttcomm_session_msg
));
3032 DBG("Nothing recv() from client... continuing");
3038 // TODO: Validate cmd_ctx including sanity check for
3039 // security purpose.
3042 * This function dispatch the work to the kernel or userspace tracer
3043 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3044 * informations for the client. The command context struct contains
3045 * everything this function may needs.
3047 ret
= process_client_msg(cmd_ctx
);
3050 * TODO: Inform client somehow of the fatal error. At
3051 * this point, ret < 0 means that a malloc failed
3052 * (ENOMEM). Error detected but still accept command.
3054 clean_command_ctx(&cmd_ctx
);
3058 DBG("Sending response (size: %d, retcode: %s)",
3059 cmd_ctx
->lttng_msg_size
,
3060 lttng_get_readable_code(-cmd_ctx
->llm
->ret_code
));
3061 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3063 ERR("Failed to send data back to client");
3066 clean_command_ctx(&cmd_ctx
);
3068 /* End of transmission */
3073 DBG("Client thread dying");
3074 unlink(client_unix_sock_path
);
3078 lttng_poll_clean(&events
);
3079 clean_command_ctx(&cmd_ctx
);
3085 * usage function on stderr
3087 static void usage(void)
3089 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3090 fprintf(stderr
, " -h, --help Display this usage.\n");
3091 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3092 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3093 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3094 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3095 fprintf(stderr
, " --ustconsumerd-err-sock PATH Specify path for the UST consumer error socket\n");
3096 fprintf(stderr
, " --ustconsumerd-cmd-sock PATH Specify path for the UST consumer command socket\n");
3097 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3098 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3099 fprintf(stderr
, " -V, --version Show version number.\n");
3100 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3101 fprintf(stderr
, " -q, --quiet No output at all.\n");
3102 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3103 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3107 * daemon argument parsing
3109 static int parse_args(int argc
, char **argv
)
3113 static struct option long_options
[] = {
3114 { "client-sock", 1, 0, 'c' },
3115 { "apps-sock", 1, 0, 'a' },
3116 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3117 { "kconsumerd-err-sock", 1, 0, 'E' },
3118 { "ustconsumerd-cmd-sock", 1, 0, 'D' },
3119 { "ustconsumerd-err-sock", 1, 0, 'F' },
3120 { "daemonize", 0, 0, 'd' },
3121 { "sig-parent", 0, 0, 'S' },
3122 { "help", 0, 0, 'h' },
3123 { "group", 1, 0, 'g' },
3124 { "version", 0, 0, 'V' },
3125 { "quiet", 0, 0, 'q' },
3126 { "verbose", 0, 0, 'v' },
3127 { "verbose-consumer", 0, 0, 'Z' },
3132 int option_index
= 0;
3133 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:C:E:D:F:Z",
3134 long_options
, &option_index
);
3141 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3143 fprintf(stderr
, " with arg %s\n", optarg
);
3147 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3150 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3156 opt_tracing_group
= strdup(optarg
);
3162 fprintf(stdout
, "%s\n", VERSION
);
3168 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3171 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3174 snprintf(ustconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3177 snprintf(ustconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3183 /* Verbose level can increase using multiple -v */
3187 opt_verbose_consumer
+= 1;
3190 /* Unknown option or other error.
3191 * Error is printed by getopt, just return */
3200 * Creates the two needed socket by the daemon.
3201 * apps_sock - The communication socket for all UST apps.
3202 * client_sock - The communication of the cli tool (lttng).
3204 static int init_daemon_socket(void)
3209 old_umask
= umask(0);
3211 /* Create client tool unix socket */
3212 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3213 if (client_sock
< 0) {
3214 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3219 /* File permission MUST be 660 */
3220 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3222 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3227 /* Create the application unix socket */
3228 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3229 if (apps_sock
< 0) {
3230 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3235 /* File permission MUST be 666 */
3236 ret
= chmod(apps_unix_sock_path
,
3237 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3239 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3250 * Check if the global socket is available, and if a daemon is answering at the
3251 * other side. If yes, error is returned.
3253 static int check_existing_daemon(void)
3255 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3256 access(apps_unix_sock_path
, F_OK
) < 0) {
3260 /* Is there anybody out there ? */
3261 if (lttng_session_daemon_alive()) {
3269 * Set the tracing group gid onto the client socket.
3271 * Race window between mkdir and chown is OK because we are going from more
3272 * permissive (root.root) to les permissive (root.tracing).
3274 static int set_permissions(void)
3279 gid
= allowed_group();
3282 WARN("No tracing group detected");
3285 ERR("Missing tracing group. Aborting execution.");
3291 /* Set lttng run dir */
3292 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
3294 ERR("Unable to set group on " LTTNG_RUNDIR
);
3298 /* lttng client socket path */
3299 ret
= chown(client_unix_sock_path
, 0, gid
);
3301 ERR("Unable to set group on %s", client_unix_sock_path
);
3305 /* kconsumer error socket path */
3306 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3308 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3312 /* ustconsumer error socket path */
3313 ret
= chown(ustconsumer_data
.err_unix_sock_path
, 0, gid
);
3315 ERR("Unable to set group on %s", ustconsumer_data
.err_unix_sock_path
);
3319 DBG("All permissions are set");
3326 * Create the pipe used to wake up the kernel thread.
3328 static int create_kernel_poll_pipe(void)
3330 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
3334 * Create the application command pipe to wake thread_manage_apps.
3336 static int create_apps_cmd_pipe(void)
3338 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
3342 * Create the lttng run directory needed for all global sockets and pipe.
3344 static int create_lttng_rundir(void)
3348 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
3350 if (errno
!= EEXIST
) {
3351 ERR("Unable to create " LTTNG_RUNDIR
);
3363 * Setup sockets and directory needed by the kconsumerd communication with the
3366 static int set_consumer_sockets(struct consumer_data
*consumer_data
)
3369 const char *path
= consumer_data
->type
== LTTNG_CONSUMER_KERNEL
?
3370 KCONSUMERD_PATH
: USTCONSUMERD_PATH
;
3372 if (strlen(consumer_data
->err_unix_sock_path
) == 0) {
3373 snprintf(consumer_data
->err_unix_sock_path
, PATH_MAX
,
3374 consumer_data
->type
== LTTNG_CONSUMER_KERNEL
?
3375 KCONSUMERD_ERR_SOCK_PATH
:
3376 USTCONSUMERD_ERR_SOCK_PATH
);
3379 if (strlen(consumer_data
->cmd_unix_sock_path
) == 0) {
3380 snprintf(consumer_data
->cmd_unix_sock_path
, PATH_MAX
,
3381 consumer_data
->type
== LTTNG_CONSUMER_KERNEL
?
3382 KCONSUMERD_CMD_SOCK_PATH
:
3383 USTCONSUMERD_CMD_SOCK_PATH
);
3386 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
3388 if (errno
!= EEXIST
) {
3389 ERR("Failed to create %s", path
);
3395 /* Create the kconsumerd error unix socket */
3396 consumer_data
->err_sock
=
3397 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
3398 if (consumer_data
->err_sock
< 0) {
3399 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
3404 /* File permission MUST be 660 */
3405 ret
= chmod(consumer_data
->err_unix_sock_path
,
3406 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3408 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
3418 * Signal handler for the daemon
3420 * Simply stop all worker threads, leaving main() return gracefully after
3421 * joining all threads and calling cleanup().
3423 static void sighandler(int sig
)
3427 DBG("SIGPIPE catched");
3430 DBG("SIGINT catched");
3434 DBG("SIGTERM catched");
3443 * Setup signal handler for :
3444 * SIGINT, SIGTERM, SIGPIPE
3446 static int set_signal_handler(void)
3449 struct sigaction sa
;
3452 if ((ret
= sigemptyset(&sigset
)) < 0) {
3453 perror("sigemptyset");
3457 sa
.sa_handler
= sighandler
;
3458 sa
.sa_mask
= sigset
;
3460 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
3461 perror("sigaction");
3465 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
3466 perror("sigaction");
3470 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
3471 perror("sigaction");
3475 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3481 * Set open files limit to unlimited. This daemon can open a large number of
3482 * file descriptors in order to consumer multiple kernel traces.
3484 static void set_ulimit(void)
3489 /* The kernel does not allowed an infinite limit for open files */
3490 lim
.rlim_cur
= 65535;
3491 lim
.rlim_max
= 65535;
3493 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
3495 perror("failed to set open files limit");
3502 int main(int argc
, char **argv
)
3506 const char *home_path
;
3508 /* Create thread quit pipe */
3509 if ((ret
= init_thread_quit_pipe()) < 0) {
3513 /* Parse arguments */
3515 if ((ret
= parse_args(argc
, argv
) < 0)) {
3528 /* Check if daemon is UID = 0 */
3529 is_root
= !getuid();
3532 ret
= create_lttng_rundir();
3537 if (strlen(apps_unix_sock_path
) == 0) {
3538 snprintf(apps_unix_sock_path
, PATH_MAX
,
3539 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
3542 if (strlen(client_unix_sock_path
) == 0) {
3543 snprintf(client_unix_sock_path
, PATH_MAX
,
3544 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
3547 /* Set global SHM for ust */
3548 if (strlen(wait_shm_path
) == 0) {
3549 snprintf(wait_shm_path
, PATH_MAX
,
3550 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
3553 home_path
= get_home_dir();
3554 if (home_path
== NULL
) {
3555 /* TODO: Add --socket PATH option */
3556 ERR("Can't get HOME directory for sockets creation.");
3561 if (strlen(apps_unix_sock_path
) == 0) {
3562 snprintf(apps_unix_sock_path
, PATH_MAX
,
3563 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
3566 /* Set the cli tool unix socket path */
3567 if (strlen(client_unix_sock_path
) == 0) {
3568 snprintf(client_unix_sock_path
, PATH_MAX
,
3569 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
3572 /* Set global SHM for ust */
3573 if (strlen(wait_shm_path
) == 0) {
3574 snprintf(wait_shm_path
, PATH_MAX
,
3575 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
3579 DBG("Client socket path %s", client_unix_sock_path
);
3580 DBG("Application socket path %s", apps_unix_sock_path
);
3583 * See if daemon already exist.
3585 if ((ret
= check_existing_daemon()) < 0) {
3586 ERR("Already running daemon.\n");
3588 * We do not goto exit because we must not cleanup()
3589 * because a daemon is already running.
3594 /* After this point, we can safely call cleanup() with "goto exit" */
3597 * These actions must be executed as root. We do that *after* setting up
3598 * the sockets path because we MUST make the check for another daemon using
3599 * those paths *before* trying to set the kernel consumer sockets and init
3603 ret
= set_consumer_sockets(&kconsumer_data
);
3607 ret
= set_consumer_sockets(&ustconsumer_data
);
3611 /* Setup kernel tracer */
3612 init_kernel_tracer();
3614 /* Set ulimit for open files */
3618 if ((ret
= set_signal_handler()) < 0) {
3622 /* Setup the needed unix socket */
3623 if ((ret
= init_daemon_socket()) < 0) {
3627 /* Set credentials to socket */
3628 if (is_root
&& ((ret
= set_permissions()) < 0)) {
3632 /* Get parent pid if -S, --sig-parent is specified. */
3633 if (opt_sig_parent
) {
3637 /* Setup the kernel pipe for waking up the kernel thread */
3638 if ((ret
= create_kernel_poll_pipe()) < 0) {
3642 /* Setup the thread apps communication pipe. */
3643 if ((ret
= create_apps_cmd_pipe()) < 0) {
3647 /* Init UST command queue. */
3648 cds_wfq_init(&ust_cmd_queue
.queue
);
3651 * Get session list pointer. This pointer MUST NOT be free(). This list is
3652 * statically declared in session.c
3654 session_list_ptr
= session_get_list();
3656 /* Set up max poll set size */
3657 lttng_poll_set_max_size();
3659 /* Create thread to manage the client socket */
3660 ret
= pthread_create(&client_thread
, NULL
,
3661 thread_manage_clients
, (void *) NULL
);
3663 perror("pthread_create clients");
3667 /* Create thread to dispatch registration */
3668 ret
= pthread_create(&dispatch_thread
, NULL
,
3669 thread_dispatch_ust_registration
, (void *) NULL
);
3671 perror("pthread_create dispatch");
3675 /* Create thread to manage application registration. */
3676 ret
= pthread_create(®_apps_thread
, NULL
,
3677 thread_registration_apps
, (void *) NULL
);
3679 perror("pthread_create registration");
3683 /* Create thread to manage application socket */
3684 ret
= pthread_create(&apps_thread
, NULL
,
3685 thread_manage_apps
, (void *) NULL
);
3687 perror("pthread_create apps");
3691 /* Create kernel thread to manage kernel event */
3692 ret
= pthread_create(&kernel_thread
, NULL
,
3693 thread_manage_kernel
, (void *) NULL
);
3695 perror("pthread_create kernel");
3699 ret
= pthread_join(kernel_thread
, &status
);
3701 perror("pthread_join");
3702 goto error
; /* join error, exit without cleanup */
3706 ret
= pthread_join(apps_thread
, &status
);
3708 perror("pthread_join");
3709 goto error
; /* join error, exit without cleanup */
3713 ret
= pthread_join(reg_apps_thread
, &status
);
3715 perror("pthread_join");
3716 goto error
; /* join error, exit without cleanup */
3720 ret
= pthread_join(dispatch_thread
, &status
);
3722 perror("pthread_join");
3723 goto error
; /* join error, exit without cleanup */
3727 ret
= pthread_join(client_thread
, &status
);
3729 perror("pthread_join");
3730 goto error
; /* join error, exit without cleanup */
3733 ret
= join_consumer_thread(&kconsumer_data
);
3735 perror("join_consumer");
3736 goto error
; /* join error, exit without cleanup */
3742 * cleanup() is called when no other thread is running.