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
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #include <semaphore.h>
33 #include <sys/mount.h>
34 #include <sys/resource.h>
35 #include <sys/socket.h>
37 #include <sys/types.h>
39 #include <urcu/futex.h>
42 #include <ltt-kconsumerd.h>
43 #include <lttng-sessiond-comm.h>
44 #include <lttng/lttng-kconsumerd.h>
49 #include "kernel-ctl.h"
50 #include "ltt-sessiond.h"
52 #include "traceable-app.h"
58 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
59 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
60 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
61 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
64 int opt_verbose
; /* Not static for lttngerr.h */
65 int opt_verbose_kconsumerd
; /* Not static for lttngerr.h */
66 int opt_quiet
; /* Not static for lttngerr.h */
69 const char *opt_tracing_group
;
70 static int opt_sig_parent
;
71 static int opt_daemon
;
72 static int is_root
; /* Set to 1 if the daemon is running as root */
73 static pid_t ppid
; /* Parent PID for --sig-parent option */
74 static pid_t kconsumerd_pid
;
75 static struct pollfd
*kernel_pollfd
;
76 static int dispatch_thread_exit
;
78 static char apps_unix_sock_path
[PATH_MAX
]; /* Global application Unix socket path */
79 static char client_unix_sock_path
[PATH_MAX
]; /* Global client Unix socket path */
80 static char kconsumerd_err_unix_sock_path
[PATH_MAX
]; /* kconsumerd error Unix socket path */
81 static char kconsumerd_cmd_unix_sock_path
[PATH_MAX
]; /* kconsumerd command Unix socket path */
82 static char wait_shm_path
[PATH_MAX
]; /* global wait shm path for UST */
85 static int client_sock
;
87 static int kconsumerd_err_sock
;
88 static int kconsumerd_cmd_sock
;
89 static int kernel_tracer_fd
;
90 static int kernel_poll_pipe
[2];
93 * Quit pipe for all threads. This permits a single cancellation point
94 * for all threads when receiving an event on the pipe.
96 static int thread_quit_pipe
[2];
99 * This pipe is used to inform the thread managing application communication
100 * that a command is queued and ready to be processed.
102 static int apps_cmd_pipe
[2];
104 /* Pthread, Mutexes and Semaphores */
105 static pthread_t kconsumerd_thread
;
106 static pthread_t apps_thread
;
107 static pthread_t reg_apps_thread
;
108 static pthread_t client_thread
;
109 static pthread_t kernel_thread
;
110 static pthread_t dispatch_thread
;
111 static sem_t kconsumerd_sem
;
113 static pthread_mutex_t kconsumerd_pid_mutex
; /* Mutex to control kconsumerd pid assignation */
116 * UST registration command queue. This queue is tied with a futex and uses a N
117 * wakers / 1 waiter implemented and detailed in futex.c/.h
119 * The thread_manage_apps and thread_dispatch_ust_registration interact with
120 * this queue and the wait/wake scheme.
122 static struct ust_cmd_queue ust_cmd_queue
;
125 * Pointer initialized before thread creation.
127 * This points to the tracing session list containing the session count and a
128 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
129 * MUST NOT be taken if you call a public function in session.c.
131 * The lock is nested inside the structure: session_list_ptr->lock. Please use
132 * lock_session_list and unlock_session_list for lock acquisition.
134 static struct ltt_session_list
*session_list_ptr
;
137 * Remove modules in reverse load order.
139 static int modprobe_remove_kernel_modules(void)
144 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
145 ret
= snprintf(modprobe
, sizeof(modprobe
),
146 "/sbin/modprobe --remove --quiet %s",
147 kernel_modules_list
[i
].name
);
149 perror("snprintf modprobe --remove");
152 modprobe
[sizeof(modprobe
) - 1] = '\0';
153 ret
= system(modprobe
);
155 ERR("Unable to launch modprobe --remove for module %s",
156 kernel_modules_list
[i
].name
);
157 } else if (kernel_modules_list
[i
].required
158 && WEXITSTATUS(ret
) != 0) {
159 ERR("Unable to remove module %s",
160 kernel_modules_list
[i
].name
);
162 DBG("Modprobe removal successful %s",
163 kernel_modules_list
[i
].name
);
172 * Return group ID of the tracing group or -1 if not found.
174 static gid_t
allowed_group(void)
178 if (opt_tracing_group
) {
179 grp
= getgrnam(opt_tracing_group
);
181 grp
= getgrnam(default_tracing_group
);
193 * Return -1 on error or 0 if all pipes are created.
195 static int init_thread_quit_pipe(void)
199 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
201 perror("thread quit pipe");
210 * Complete teardown of a kernel session. This free all data structure related
211 * to a kernel session and update counter.
213 static void teardown_kernel_session(struct ltt_session
*session
)
215 if (session
->kernel_session
!= NULL
) {
216 DBG("Tearing down kernel session");
219 * If a custom kernel consumer was registered, close the socket before
220 * tearing down the complete kernel session structure
222 if (session
->kernel_session
->consumer_fd
!= kconsumerd_cmd_sock
) {
223 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
226 trace_kernel_destroy_session(session
->kernel_session
);
227 /* Extra precaution */
228 session
->kernel_session
= NULL
;
233 * Stop all threads by closing the thread quit pipe.
235 static void stop_threads(void)
237 /* Stopping all threads */
238 DBG("Terminating all threads");
239 close(thread_quit_pipe
[0]);
240 close(thread_quit_pipe
[1]);
241 /* Dispatch thread */
242 dispatch_thread_exit
= 1;
243 futex_nto1_wake(&ust_cmd_queue
.futex
);
249 static void cleanup(void)
253 struct ltt_session
*sess
, *stmp
;
258 MSG("%c[%d;%dm*** assert failed *** ==> %c[%dm%c[%d;%dm"
259 "Matthew, BEET driven development works!%c[%dm",
260 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
263 DBG("Removing %s directory", LTTNG_RUNDIR
);
264 ret
= asprintf(&cmd
, "rm -rf " LTTNG_RUNDIR
);
266 ERR("asprintf failed. Something is really wrong!");
269 /* Remove lttng run directory */
272 ERR("Unable to clean " LTTNG_RUNDIR
);
275 DBG("Cleaning up all session");
277 /* Destroy session list mutex */
278 if (session_list_ptr
!= NULL
) {
279 pthread_mutex_destroy(&session_list_ptr
->lock
);
281 /* Cleanup ALL session */
282 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
283 teardown_kernel_session(sess
);
284 // TODO complete session cleanup (including UST)
288 DBG("Closing all UST sockets");
289 clean_traceable_apps_list();
291 pthread_mutex_destroy(&kconsumerd_pid_mutex
);
293 DBG("Closing kernel fd");
294 close(kernel_tracer_fd
);
297 DBG("Unloading kernel modules");
298 modprobe_remove_kernel_modules();
303 * Send data on a unix socket using the liblttsessiondcomm API.
305 * Return lttcomm error code.
307 static int send_unix_sock(int sock
, void *buf
, size_t len
)
309 /* Check valid length */
314 return lttcomm_send_unix_sock(sock
, buf
, len
);
318 * Free memory of a command context structure.
320 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
322 DBG("Clean command context structure");
324 if ((*cmd_ctx
)->llm
) {
325 free((*cmd_ctx
)->llm
);
327 if ((*cmd_ctx
)->lsm
) {
328 free((*cmd_ctx
)->lsm
);
336 * Send all stream fds of kernel channel to the consumer.
338 static int send_kconsumerd_channel_fds(int sock
, struct ltt_kernel_channel
*channel
)
342 struct ltt_kernel_stream
*stream
;
343 struct lttcomm_kconsumerd_header lkh
;
344 struct lttcomm_kconsumerd_msg lkm
;
346 DBG("Sending fds of channel %s to kernel consumer", channel
->channel
->name
);
348 nb_fd
= channel
->stream_count
;
351 lkh
.payload_size
= nb_fd
* sizeof(struct lttcomm_kconsumerd_msg
);
352 lkh
.cmd_type
= ADD_STREAM
;
354 DBG("Sending kconsumerd header");
356 ret
= lttcomm_send_unix_sock(sock
, &lkh
, sizeof(struct lttcomm_kconsumerd_header
));
358 perror("send kconsumerd header");
362 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
363 if (stream
->fd
!= 0) {
365 lkm
.state
= stream
->state
;
366 lkm
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
367 lkm
.output
= channel
->channel
->attr
.output
;
368 strncpy(lkm
.path_name
, stream
->pathname
, PATH_MAX
);
369 lkm
.path_name
[PATH_MAX
- 1] = '\0';
371 DBG("Sending fd %d to kconsumerd", lkm
.fd
);
373 ret
= lttcomm_send_fds_unix_sock(sock
, &lkm
, &lkm
.fd
, 1, sizeof(lkm
));
375 perror("send kconsumerd fd");
381 DBG("Kconsumerd channel fds sent");
390 * Send all stream fds of the kernel session to the consumer.
392 static int send_kconsumerd_fds(struct ltt_kernel_session
*session
)
395 struct ltt_kernel_channel
*chan
;
396 struct lttcomm_kconsumerd_header lkh
;
397 struct lttcomm_kconsumerd_msg lkm
;
400 lkh
.payload_size
= sizeof(struct lttcomm_kconsumerd_msg
);
401 lkh
.cmd_type
= ADD_STREAM
;
403 DBG("Sending kconsumerd header for metadata");
405 ret
= lttcomm_send_unix_sock(session
->consumer_fd
, &lkh
, sizeof(struct lttcomm_kconsumerd_header
));
407 perror("send kconsumerd header");
411 DBG("Sending metadata stream fd");
413 /* Extra protection. It's NOT suppose to be set to 0 at this point */
414 if (session
->consumer_fd
== 0) {
415 session
->consumer_fd
= kconsumerd_cmd_sock
;
418 if (session
->metadata_stream_fd
!= 0) {
419 /* Send metadata stream fd first */
420 lkm
.fd
= session
->metadata_stream_fd
;
421 lkm
.state
= ACTIVE_FD
;
422 lkm
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
423 lkm
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
424 strncpy(lkm
.path_name
, session
->metadata
->pathname
, PATH_MAX
);
425 lkm
.path_name
[PATH_MAX
- 1] = '\0';
427 ret
= lttcomm_send_fds_unix_sock(session
->consumer_fd
, &lkm
, &lkm
.fd
, 1, sizeof(lkm
));
429 perror("send kconsumerd fd");
434 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
435 ret
= send_kconsumerd_channel_fds(session
->consumer_fd
, chan
);
441 DBG("Kconsumerd fds (metadata and channel streams) sent");
450 * Notify UST applications using the shm mmap futex.
452 static int notify_ust_apps(int active
)
456 DBG("Notifying applications of session daemon state: %d", active
);
458 /* See shm.c for this call implying mmap, shm and futex calls */
459 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
460 if (wait_shm_mmap
== NULL
) {
464 /* Wake waiting process */
465 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
467 /* Apps notified successfully */
475 * Setup the outgoing data buffer for the response (llm) by allocating the
476 * right amount of memory and copying the original information from the lsm
479 * Return total size of the buffer pointed by buf.
481 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
487 cmd_ctx
->llm
= malloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
488 if (cmd_ctx
->llm
== NULL
) {
494 /* Copy common data */
495 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
496 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
498 cmd_ctx
->llm
->data_size
= size
;
499 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
508 * Update the kernel pollfd set of all channel fd available over all tracing
509 * session. Add the wakeup pipe at the end of the set.
511 static int update_kernel_pollfd(void)
515 * The wakup pipe and the quit pipe are needed so the number of fds starts
516 * at 2 for those pipes.
518 unsigned int nb_fd
= 2;
519 struct ltt_session
*session
;
520 struct ltt_kernel_channel
*channel
;
522 DBG("Updating kernel_pollfd");
524 /* Get the number of channel of all kernel session */
526 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
527 lock_session(session
);
528 if (session
->kernel_session
== NULL
) {
529 unlock_session(session
);
532 nb_fd
+= session
->kernel_session
->channel_count
;
533 unlock_session(session
);
536 DBG("Resizing kernel_pollfd to size %d", nb_fd
);
538 kernel_pollfd
= realloc(kernel_pollfd
, nb_fd
* sizeof(struct pollfd
));
539 if (kernel_pollfd
== NULL
) {
540 perror("malloc kernel_pollfd");
544 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
545 lock_session(session
);
546 if (session
->kernel_session
== NULL
) {
547 unlock_session(session
);
551 ERR("To much channel for kernel_pollfd size");
552 unlock_session(session
);
555 cds_list_for_each_entry(channel
, &session
->kernel_session
->channel_list
.head
, list
) {
556 kernel_pollfd
[i
].fd
= channel
->fd
;
557 kernel_pollfd
[i
].events
= POLLIN
| POLLRDNORM
;
560 unlock_session(session
);
562 unlock_session_list();
564 /* Adding wake up pipe */
565 kernel_pollfd
[nb_fd
- 2].fd
= kernel_poll_pipe
[0];
566 kernel_pollfd
[nb_fd
- 2].events
= POLLIN
;
568 /* Adding the quit pipe */
569 kernel_pollfd
[nb_fd
- 1].fd
= thread_quit_pipe
[0];
574 unlock_session_list();
579 * Find the channel fd from 'fd' over all tracing session. When found, check
580 * for new channel stream and send those stream fds to the kernel consumer.
582 * Useful for CPU hotplug feature.
584 static int update_kernel_stream(int fd
)
587 struct ltt_session
*session
;
588 struct ltt_kernel_channel
*channel
;
590 DBG("Updating kernel streams for channel fd %d", fd
);
593 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
594 lock_session(session
);
595 if (session
->kernel_session
== NULL
) {
596 unlock_session(session
);
600 /* This is not suppose to be 0 but this is an extra security check */
601 if (session
->kernel_session
->consumer_fd
== 0) {
602 session
->kernel_session
->consumer_fd
= kconsumerd_cmd_sock
;
605 cds_list_for_each_entry(channel
, &session
->kernel_session
->channel_list
.head
, list
) {
606 if (channel
->fd
== fd
) {
607 DBG("Channel found, updating kernel streams");
608 ret
= kernel_open_channel_stream(channel
);
614 * Have we already sent fds to the consumer? If yes, it means that
615 * tracing is started so it is safe to send our updated stream fds.
617 if (session
->kernel_session
->kconsumer_fds_sent
== 1) {
618 ret
= send_kconsumerd_channel_fds(session
->kernel_session
->consumer_fd
,
627 unlock_session(session
);
631 unlock_session_list();
633 unlock_session(session
);
639 * This thread manage event coming from the kernel.
641 * Features supported in this thread:
644 static void *thread_manage_kernel(void *data
)
646 int ret
, i
, nb_fd
= 0;
648 int update_poll_flag
= 1;
650 DBG("Thread manage kernel started");
653 if (update_poll_flag
== 1) {
654 nb_fd
= update_kernel_pollfd();
658 update_poll_flag
= 0;
661 DBG("Polling on %d fds", nb_fd
);
663 /* Poll infinite value of time */
664 ret
= poll(kernel_pollfd
, nb_fd
, -1);
666 perror("poll kernel thread");
668 } else if (ret
== 0) {
669 /* Should not happen since timeout is infinite */
673 /* Thread quit pipe has been closed. Killing thread. */
674 if (kernel_pollfd
[nb_fd
- 1].revents
== POLLNVAL
) {
678 DBG("Kernel poll event triggered");
681 * Check if the wake up pipe was triggered. If so, the kernel_pollfd
684 switch (kernel_pollfd
[nb_fd
- 2].revents
) {
686 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
687 update_poll_flag
= 1;
695 for (i
= 0; i
< nb_fd
; i
++) {
696 switch (kernel_pollfd
[i
].revents
) {
698 * New CPU detected by the kernel. Adding kernel stream to kernel
699 * session and updating the kernel consumer
701 case POLLIN
| POLLRDNORM
:
702 ret
= update_kernel_stream(kernel_pollfd
[i
].fd
);
712 DBG("Kernel thread dying");
717 close(kernel_poll_pipe
[0]);
718 close(kernel_poll_pipe
[1]);
723 * This thread manage the kconsumerd error sent back to the session daemon.
725 static void *thread_manage_kconsumerd(void *data
)
728 enum lttcomm_return_code code
;
729 struct pollfd pollfd
[2];
731 DBG("[thread] Manage kconsumerd started");
733 ret
= lttcomm_listen_unix_sock(kconsumerd_err_sock
);
738 /* First fd is always the quit pipe */
739 pollfd
[0].fd
= thread_quit_pipe
[0];
742 pollfd
[1].fd
= kconsumerd_err_sock
;
743 pollfd
[1].events
= POLLIN
;
745 /* Inifinite blocking call, waiting for transmission */
746 ret
= poll(pollfd
, 2, -1);
748 perror("poll kconsumerd thread");
752 /* Thread quit pipe has been closed. Killing thread. */
753 if (pollfd
[0].revents
== POLLNVAL
) {
755 } else if (pollfd
[1].revents
== POLLERR
) {
756 ERR("Kconsumerd err socket poll error");
760 sock
= lttcomm_accept_unix_sock(kconsumerd_err_sock
);
765 /* Getting status code from kconsumerd */
766 ret
= lttcomm_recv_unix_sock(sock
, &code
, sizeof(enum lttcomm_return_code
));
771 if (code
== KCONSUMERD_COMMAND_SOCK_READY
) {
772 kconsumerd_cmd_sock
= lttcomm_connect_unix_sock(kconsumerd_cmd_unix_sock_path
);
773 if (kconsumerd_cmd_sock
< 0) {
774 sem_post(&kconsumerd_sem
);
775 perror("kconsumerd connect");
778 /* Signal condition to tell that the kconsumerd is ready */
779 sem_post(&kconsumerd_sem
);
780 DBG("Kconsumerd command socket ready");
782 DBG("Kconsumerd error when waiting for SOCK_READY : %s",
783 lttcomm_get_readable_code(-code
));
787 /* Kconsumerd err socket */
789 pollfd
[1].events
= POLLIN
;
791 /* Inifinite blocking call, waiting for transmission */
792 ret
= poll(pollfd
, 2, -1);
794 perror("poll kconsumerd thread");
798 /* Thread quit pipe has been closed. Killing thread. */
799 if (pollfd
[0].revents
== POLLNVAL
) {
801 } else if (pollfd
[1].revents
== POLLERR
) {
802 ERR("Kconsumerd err socket second poll error");
806 /* Wait for any kconsumerd error */
807 ret
= lttcomm_recv_unix_sock(sock
, &code
, sizeof(enum lttcomm_return_code
));
809 ERR("Kconsumerd closed the command socket");
813 ERR("Kconsumerd return code : %s", lttcomm_get_readable_code(-code
));
816 DBG("Kconsumerd thread dying");
817 if (kconsumerd_err_sock
) {
818 close(kconsumerd_err_sock
);
820 if (kconsumerd_cmd_sock
) {
821 close(kconsumerd_cmd_sock
);
827 unlink(kconsumerd_err_unix_sock_path
);
828 unlink(kconsumerd_cmd_unix_sock_path
);
835 * Reallocate the apps command pollfd structure of nb_fd size.
837 * The first two fds must be there at all time.
839 static int update_apps_cmd_pollfd(unsigned int nb_fd
, unsigned int old_nb_fd
,
840 struct pollfd
**pollfd
)
843 struct pollfd
*old_pollfd
= NULL
;
845 /* Can't accept pollfd less than 2 */
852 old_pollfd
= *pollfd
;
855 *pollfd
= malloc(nb_fd
* sizeof(struct pollfd
));
856 if (*pollfd
== NULL
) {
857 perror("malloc manage apps pollfd");
861 /* First fd is always the quit pipe */
862 (*pollfd
)[0].fd
= thread_quit_pipe
[0];
863 /* Apps command pipe */
864 (*pollfd
)[1].fd
= apps_cmd_pipe
[0];
865 (*pollfd
)[1].events
= POLLIN
;
867 /* Start count after the two pipes below */
869 for (i
= 2; i
< old_nb_fd
; i
++) {
870 /* Add to new pollfd */
871 if (old_pollfd
[i
].fd
!= -1) {
872 (*pollfd
)[count
].fd
= old_pollfd
[i
].fd
;
873 (*pollfd
)[count
].events
= POLLHUP
| POLLNVAL
| POLLERR
;
878 ERR("Updating poll fd wrong size");
885 * There should *always* be at least two fds in the pollfd. This safety
886 * check make sure the poll() will actually try on those two pipes at
887 * best which are the thread_quit_pipe and apps_cmd_pipe.
892 /* Destroy old pollfd */
895 DBG("Apps cmd pollfd realloc of size %d", nb_fd
);
901 /* Destroy old pollfd */
907 * This thread manage application communication.
909 static void *thread_manage_apps(void *data
)
911 int i
, ret
, current_nb_fd
;
912 unsigned int nb_fd
= 2;
913 int update_poll_flag
= 1;
914 struct pollfd
*pollfd
= NULL
;
915 struct ust_command ust_cmd
;
917 DBG("[thread] Manage application started");
920 current_nb_fd
= nb_fd
;
923 /* See if we have a valid socket to add to pollfd */
924 if (ust_cmd
.sock
!= -1) {
926 update_poll_flag
= 1;
929 /* The pollfd struct must be updated */
930 if (update_poll_flag
) {
931 ret
= update_apps_cmd_pollfd(nb_fd
, current_nb_fd
, &pollfd
);
933 /* malloc failed so we quit */
937 if (ust_cmd
.sock
!= -1) {
938 /* Update pollfd with the new UST socket */
939 DBG("Adding sock %d to apps cmd pollfd", ust_cmd
.sock
);
940 pollfd
[nb_fd
- 1].fd
= ust_cmd
.sock
;
941 pollfd
[nb_fd
- 1].events
= POLLHUP
| POLLNVAL
| POLLERR
;
946 DBG("Apps thread polling on %d fds", nb_fd
);
948 /* Inifinite blocking call, waiting for transmission */
949 ret
= poll(pollfd
, nb_fd
, -1);
951 perror("poll apps thread");
955 /* Thread quit pipe has been closed. Killing thread. */
956 if (pollfd
[0].revents
== POLLNVAL
) {
959 /* apps_cmd_pipe pipe events */
960 switch (pollfd
[1].revents
) {
962 ERR("Apps command pipe poll error");
966 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
967 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
968 perror("read apps cmd pipe");
972 /* Register applicaton to the session daemon */
973 ret
= register_traceable_app(&ust_cmd
.reg_msg
, ust_cmd
.sock
);
975 /* Only critical ENOMEM error can be returned here */
979 ret
= ustctl_register_done(ust_cmd
.sock
);
982 * If the registration is not possible, we simply unregister
983 * the apps and continue
985 unregister_traceable_app(ust_cmd
.sock
);
991 current_nb_fd
= nb_fd
;
992 for (i
= 2; i
< current_nb_fd
; i
++) {
993 /* Apps socket is closed/hungup */
994 switch (pollfd
[i
].revents
) {
999 unregister_traceable_app(pollfd
[i
].fd
);
1000 /* Indicate to remove this fd from the pollfd */
1007 if (nb_fd
!= current_nb_fd
) {
1008 update_poll_flag
= 1;
1013 DBG("Application communication apps dying");
1014 close(apps_cmd_pipe
[0]);
1015 close(apps_cmd_pipe
[1]);
1023 * Dispatch request from the registration threads to the application
1024 * communication thread.
1026 static void *thread_dispatch_ust_registration(void *data
)
1029 struct cds_wfq_node
*node
;
1030 struct ust_command
*ust_cmd
= NULL
;
1032 DBG("[thread] Dispatch UST command started");
1034 while (!dispatch_thread_exit
) {
1035 /* Atomically prepare the queue futex */
1036 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1039 /* Dequeue command for registration */
1040 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1042 DBG("Waked up but nothing in the UST command queue");
1043 /* Continue thread execution */
1047 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1049 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1050 " gid:%d sock:%d name:%s (version %d.%d)",
1051 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1052 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1053 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1054 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1056 * Inform apps thread of the new application registration. This
1057 * call is blocking so we can be assured that the data will be read
1058 * at some point in time or wait to the end of the world :)
1060 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1061 sizeof(struct ust_command
));
1063 perror("write apps cmd pipe");
1064 if (errno
== EBADF
) {
1066 * We can't inform the application thread to process
1067 * registration. We will exit or else application
1068 * registration will not occur and tracing will never
1075 } while (node
!= NULL
);
1077 /* Futex wait on queue. Blocking call on futex() */
1078 futex_nto1_wait(&ust_cmd_queue
.futex
);
1082 DBG("Dispatch thread dying");
1087 * This thread manage application registration.
1089 static void *thread_registration_apps(void *data
)
1092 struct pollfd pollfd
[2];
1094 * Get allocated in this thread, enqueued to a global queue, dequeued and
1095 * freed in the manage apps thread.
1097 struct ust_command
*ust_cmd
= NULL
;
1099 DBG("[thread] Manage application registration started");
1101 ret
= lttcomm_listen_unix_sock(apps_sock
);
1106 /* First fd is always the quit pipe */
1107 pollfd
[0].fd
= thread_quit_pipe
[0];
1110 pollfd
[1].fd
= apps_sock
;
1111 pollfd
[1].events
= POLLIN
;
1113 /* Notify all applications to register */
1114 ret
= notify_ust_apps(1);
1116 ERR("Failed to notify applications or create the wait shared memory.\n"
1117 "Execution continues but there might be problem for already running\n"
1118 "applications that wishes to register.");
1122 DBG("Accepting application registration");
1124 /* Inifinite blocking call, waiting for transmission */
1125 ret
= poll(pollfd
, 2, -1);
1127 perror("poll register apps thread");
1131 /* Thread quit pipe has been closed. Killing thread. */
1132 if (pollfd
[0].revents
== POLLNVAL
) {
1134 } else if (pollfd
[1].revents
== POLLERR
) {
1135 ERR("Register apps socket poll error");
1139 sock
= lttcomm_accept_unix_sock(apps_sock
);
1144 /* Create UST registration command for enqueuing */
1145 ust_cmd
= malloc(sizeof(struct ust_command
));
1146 if (ust_cmd
== NULL
) {
1147 perror("ust command malloc");
1152 * Using message-based transmissions to ensure we don't have to deal
1153 * with partially received messages.
1155 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1156 sizeof(struct ust_register_msg
));
1157 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1159 perror("lttcomm_recv_unix_sock register apps");
1161 ERR("Wrong size received on apps register");
1168 ust_cmd
->sock
= sock
;
1170 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1171 " gid:%d sock:%d name:%s (version %d.%d)",
1172 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1173 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1174 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1175 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1177 * Lock free enqueue the registration request.
1178 * The red pill has been taken! This apps will be part of the *system*
1180 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1183 * Wake the registration queue futex.
1184 * Implicit memory barrier with the exchange in cds_wfq_enqueue.
1186 futex_nto1_wake(&ust_cmd_queue
.futex
);
1190 DBG("UST Registration thread dying");
1192 /* Notify that the registration thread is gone */
1198 unlink(apps_unix_sock_path
);
1204 * Start the thread_manage_kconsumerd. This must be done after a kconsumerd
1205 * exec or it will fails.
1207 static int spawn_kconsumerd_thread(void)
1211 /* Setup semaphore */
1212 sem_init(&kconsumerd_sem
, 0, 0);
1214 ret
= pthread_create(&kconsumerd_thread
, NULL
, thread_manage_kconsumerd
, (void *) NULL
);
1216 perror("pthread_create kconsumerd");
1220 /* Wait for the kconsumerd thread to be ready */
1221 sem_wait(&kconsumerd_sem
);
1223 if (kconsumerd_pid
== 0) {
1224 ERR("Kconsumerd did not start");
1231 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1236 * Join kernel consumer thread
1238 static int join_kconsumerd_thread(void)
1243 if (kconsumerd_pid
!= 0) {
1244 ret
= kill(kconsumerd_pid
, SIGTERM
);
1246 ERR("Error killing kconsumerd");
1249 return pthread_join(kconsumerd_thread
, &status
);
1256 * Fork and exec a kernel consumer daemon (kconsumerd).
1258 * Return pid if successful else -1.
1260 static pid_t
spawn_kconsumerd(void)
1264 const char *verbosity
;
1266 DBG("Spawning kconsumerd");
1273 if (opt_verbose
> 1 || opt_verbose_kconsumerd
) {
1274 verbosity
= "--verbose";
1276 verbosity
= "--quiet";
1278 execl(INSTALL_BIN_PATH
"/ltt-kconsumerd", "ltt-kconsumerd", verbosity
, NULL
);
1280 perror("kernel start consumer exec");
1283 } else if (pid
> 0) {
1287 perror("kernel start consumer fork");
1297 * Spawn the kconsumerd daemon and session daemon thread.
1299 static int start_kconsumerd(void)
1303 pthread_mutex_lock(&kconsumerd_pid_mutex
);
1304 if (kconsumerd_pid
!= 0) {
1305 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1309 ret
= spawn_kconsumerd();
1311 ERR("Spawning kconsumerd failed");
1312 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1313 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1317 /* Setting up the global kconsumerd_pid */
1318 kconsumerd_pid
= ret
;
1319 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1321 DBG("Kconsumerd pid %d", ret
);
1323 DBG("Spawning kconsumerd thread");
1324 ret
= spawn_kconsumerd_thread();
1326 ERR("Fatal error spawning kconsumerd thread");
1338 * modprobe_kernel_modules
1340 static int modprobe_kernel_modules(void)
1345 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1346 ret
= snprintf(modprobe
, sizeof(modprobe
),
1347 "/sbin/modprobe %s%s",
1348 kernel_modules_list
[i
].required
? "" : "--quiet ",
1349 kernel_modules_list
[i
].name
);
1351 perror("snprintf modprobe");
1354 modprobe
[sizeof(modprobe
) - 1] = '\0';
1355 ret
= system(modprobe
);
1357 ERR("Unable to launch modprobe for module %s",
1358 kernel_modules_list
[i
].name
);
1359 } else if (kernel_modules_list
[i
].required
1360 && WEXITSTATUS(ret
) != 0) {
1361 ERR("Unable to load module %s",
1362 kernel_modules_list
[i
].name
);
1364 DBG("Modprobe successfully %s",
1365 kernel_modules_list
[i
].name
);
1376 static int mount_debugfs(char *path
)
1379 char *type
= "debugfs";
1381 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1386 ret
= mount(type
, path
, type
, 0, NULL
);
1388 perror("mount debugfs");
1392 DBG("Mounted debugfs successfully at %s", path
);
1399 * Setup necessary data for kernel tracer action.
1401 static void init_kernel_tracer(void)
1404 char *proc_mounts
= "/proc/mounts";
1406 char *debugfs_path
= NULL
, *lttng_path
;
1409 /* Detect debugfs */
1410 fp
= fopen(proc_mounts
, "r");
1412 ERR("Unable to probe %s", proc_mounts
);
1416 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1417 if (strstr(line
, "debugfs") != NULL
) {
1418 /* Remove first string */
1420 /* Dup string here so we can reuse line later on */
1421 debugfs_path
= strdup(strtok(NULL
, " "));
1422 DBG("Got debugfs path : %s", debugfs_path
);
1429 /* Mount debugfs if needded */
1430 if (debugfs_path
== NULL
) {
1431 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1433 perror("asprintf debugfs path");
1436 ret
= mount_debugfs(debugfs_path
);
1442 /* Modprobe lttng kernel modules */
1443 ret
= modprobe_kernel_modules();
1448 /* Setup lttng kernel path */
1449 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1451 perror("asprintf lttng path");
1455 /* Open debugfs lttng */
1456 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1457 if (kernel_tracer_fd
< 0) {
1458 DBG("Failed to open %s", lttng_path
);
1464 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1474 WARN("No kernel tracer available");
1475 kernel_tracer_fd
= 0;
1480 * Start tracing by creating trace directory and sending FDs to the kernel
1483 static int start_kernel_trace(struct ltt_kernel_session
*session
)
1487 if (session
->kconsumer_fds_sent
== 0) {
1489 * Assign default kernel consumer if no consumer assigned to the kernel
1490 * session. At this point, it's NOT suppose to be 0 but this is an extra
1493 if (session
->consumer_fd
== 0) {
1494 session
->consumer_fd
= kconsumerd_cmd_sock
;
1497 ret
= send_kconsumerd_fds(session
);
1499 ERR("Send kconsumerd fds failed");
1500 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1504 session
->kconsumer_fds_sent
= 1;
1512 * Notify kernel thread to update it's pollfd.
1514 static int notify_kernel_pollfd(void)
1518 /* Inform kernel thread of the new kernel channel */
1519 ret
= write(kernel_poll_pipe
[1], "!", 1);
1521 perror("write kernel poll pipe");
1528 * Allocate a channel structure and fill it.
1530 static struct lttng_channel
*init_default_channel(enum lttng_domain_type domain_type
,
1533 struct lttng_channel
*chan
;
1535 chan
= malloc(sizeof(struct lttng_channel
));
1537 perror("init channel malloc");
1541 if (snprintf(chan
->name
, NAME_MAX
, "%s", name
) < 0) {
1542 perror("snprintf channel name");
1546 chan
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1547 chan
->attr
.switch_timer_interval
= DEFAULT_CHANNEL_SWITCH_TIMER
;
1548 chan
->attr
.read_timer_interval
= DEFAULT_CHANNEL_READ_TIMER
;
1550 switch (domain_type
) {
1551 case LTTNG_DOMAIN_KERNEL
:
1552 chan
->attr
.subbuf_size
= DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
;
1553 chan
->attr
.num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1554 chan
->attr
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1558 goto error
; /* Not implemented */
1569 * Create an UST session and add it to the session ust list.
1571 static int create_ust_session(pid_t pid
, struct ltt_session
*session
)
1574 struct ltt_ust_session
*lus
;
1576 DBG("Creating UST session");
1578 lus
= trace_ust_create_session(session
->path
, pid
);
1583 ret
= mkdir_recursive(lus
->path
, S_IRWXU
| S_IRWXG
,
1584 geteuid(), allowed_group());
1586 if (ret
!= -EEXIST
) {
1587 ERR("Trace directory creation error");
1592 /* Create session on the UST tracer */
1593 ret
= ustctl_create_session(lus
);
1606 * Create a kernel tracer session then create the default channel.
1608 static int create_kernel_session(struct ltt_session
*session
)
1612 DBG("Creating kernel session");
1614 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1616 ret
= LTTCOMM_KERN_SESS_FAIL
;
1620 /* Set kernel consumer socket fd */
1621 if (kconsumerd_cmd_sock
) {
1622 session
->kernel_session
->consumer_fd
= kconsumerd_cmd_sock
;
1625 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1626 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1628 if (ret
!= -EEXIST
) {
1629 ERR("Trace directory creation error");
1639 * Using the session list, filled a lttng_session array to send back to the
1640 * client for session listing.
1642 * The session list lock MUST be acquired before calling this function. Use
1643 * lock_session_list() and unlock_session_list().
1645 static void list_lttng_sessions(struct lttng_session
*sessions
)
1648 struct ltt_session
*session
;
1650 DBG("Getting all available session");
1652 * Iterate over session list and append data after the control struct in
1655 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1656 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1657 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1658 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1659 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1665 * Fill lttng_channel array of all channels.
1667 static void list_lttng_channels(struct ltt_session
*session
,
1668 struct lttng_channel
*channels
)
1671 struct ltt_kernel_channel
*kchan
;
1673 DBG("Listing channels for session %s", session
->name
);
1675 /* Kernel channels */
1676 if (session
->kernel_session
!= NULL
) {
1677 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
, list
) {
1678 /* Copy lttng_channel struct to array */
1679 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1680 channels
[i
].enabled
= kchan
->enabled
;
1685 /* TODO: Missing UST listing */
1689 * Fill lttng_event array of all events in the channel.
1691 static void list_lttng_events(struct ltt_kernel_channel
*kchan
,
1692 struct lttng_event
*events
)
1695 * TODO: This is ONLY kernel. Need UST support.
1698 struct ltt_kernel_event
*event
;
1700 DBG("Listing events for channel %s", kchan
->channel
->name
);
1702 /* Kernel channels */
1703 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
1704 strncpy(events
[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
1705 events
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1706 events
[i
].enabled
= event
->enabled
;
1707 switch (event
->event
->instrumentation
) {
1708 case LTTNG_KERNEL_TRACEPOINT
:
1709 events
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
1711 case LTTNG_KERNEL_KPROBE
:
1712 case LTTNG_KERNEL_KRETPROBE
:
1713 events
[i
].type
= LTTNG_EVENT_PROBE
;
1714 memcpy(&events
[i
].attr
.probe
, &event
->event
->u
.kprobe
,
1715 sizeof(struct lttng_kernel_kprobe
));
1717 case LTTNG_KERNEL_FUNCTION
:
1718 events
[i
].type
= LTTNG_EVENT_FUNCTION
;
1719 memcpy(&events
[i
].attr
.ftrace
, &event
->event
->u
.ftrace
,
1720 sizeof(struct lttng_kernel_function
));
1728 * Process the command requested by the lttng client within the command
1729 * context structure. This function make sure that the return structure (llm)
1730 * is set and ready for transmission before returning.
1732 * Return any error encountered or 0 for success.
1734 static int process_client_msg(struct command_ctx
*cmd_ctx
)
1736 int ret
= LTTCOMM_OK
;
1738 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
1741 * Commands that DO NOT need a session.
1743 switch (cmd_ctx
->lsm
->cmd_type
) {
1744 case LTTNG_CREATE_SESSION
:
1745 case LTTNG_LIST_SESSIONS
:
1746 case LTTNG_LIST_TRACEPOINTS
:
1747 case LTTNG_CALIBRATE
:
1750 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
1751 cmd_ctx
->session
= find_session_by_name(cmd_ctx
->lsm
->session
.name
);
1752 if (cmd_ctx
->session
== NULL
) {
1753 /* If session name not found */
1754 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
1755 ret
= LTTCOMM_SESS_NOT_FOUND
;
1756 } else { /* If no session name specified */
1757 ret
= LTTCOMM_SELECT_SESS
;
1761 /* Acquire lock for the session */
1762 lock_session(cmd_ctx
->session
);
1768 * Check domain type for specific "pre-action".
1770 switch (cmd_ctx
->lsm
->domain
.type
) {
1771 case LTTNG_DOMAIN_KERNEL
:
1772 /* Kernel tracer check */
1773 if (kernel_tracer_fd
== 0) {
1774 init_kernel_tracer();
1775 if (kernel_tracer_fd
== 0) {
1776 ret
= LTTCOMM_KERN_NA
;
1780 /* Need a session for kernel command */
1781 switch (cmd_ctx
->lsm
->cmd_type
) {
1782 case LTTNG_CALIBRATE
:
1783 case LTTNG_CREATE_SESSION
:
1784 case LTTNG_LIST_SESSIONS
:
1785 case LTTNG_LIST_TRACEPOINTS
:
1788 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1789 ret
= create_kernel_session(cmd_ctx
->session
);
1791 ret
= LTTCOMM_KERN_SESS_FAIL
;
1794 /* Start the kernel consumer daemon */
1795 if (kconsumerd_pid
== 0 &&
1796 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1797 ret
= start_kconsumerd();
1805 case LTTNG_DOMAIN_UST_PID
:
1811 /* Process by command type */
1812 switch (cmd_ctx
->lsm
->cmd_type
) {
1813 case LTTNG_ADD_CONTEXT
:
1815 struct lttng_kernel_context kctx
;
1817 /* Setup lttng message with no payload */
1818 ret
= setup_lttng_msg(cmd_ctx
, 0);
1823 switch (cmd_ctx
->lsm
->domain
.type
) {
1824 case LTTNG_DOMAIN_KERNEL
:
1825 /* Create Kernel context */
1826 kctx
.ctx
= cmd_ctx
->lsm
->u
.context
.ctx
.ctx
;
1827 kctx
.u
.perf_counter
.type
= cmd_ctx
->lsm
->u
.context
.ctx
.u
.perf_counter
.type
;
1828 kctx
.u
.perf_counter
.config
= cmd_ctx
->lsm
->u
.context
.ctx
.u
.perf_counter
.config
;
1829 strncpy(kctx
.u
.perf_counter
.name
,
1830 cmd_ctx
->lsm
->u
.context
.ctx
.u
.perf_counter
.name
,
1831 LTTNG_SYMBOL_NAME_LEN
);
1832 kctx
.u
.perf_counter
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1834 /* Add kernel context to kernel tracer. See context.c */
1835 ret
= add_kernel_context(cmd_ctx
->session
->kernel_session
, &kctx
,
1836 cmd_ctx
->lsm
->u
.context
.event_name
,
1837 cmd_ctx
->lsm
->u
.context
.channel_name
);
1838 if (ret
!= LTTCOMM_OK
) {
1843 /* TODO: Userspace tracing */
1844 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1851 case LTTNG_DISABLE_CHANNEL
:
1853 struct ltt_kernel_channel
*kchan
;
1855 /* Setup lttng message with no payload */
1856 ret
= setup_lttng_msg(cmd_ctx
, 0);
1861 switch (cmd_ctx
->lsm
->domain
.type
) {
1862 case LTTNG_DOMAIN_KERNEL
:
1863 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.disable
.channel_name
,
1864 cmd_ctx
->session
->kernel_session
);
1865 if (kchan
== NULL
) {
1866 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1868 } else if (kchan
->enabled
== 1) {
1869 ret
= kernel_disable_channel(kchan
);
1871 if (ret
!= EEXIST
) {
1872 ret
= LTTCOMM_KERN_CHAN_DISABLE_FAIL
;
1877 kernel_wait_quiescent(kernel_tracer_fd
);
1880 /* TODO: Userspace tracing */
1881 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1888 case LTTNG_DISABLE_EVENT
:
1890 struct ltt_kernel_channel
*kchan
;
1891 struct ltt_kernel_event
*kevent
;
1893 /* Setup lttng message with no payload */
1894 ret
= setup_lttng_msg(cmd_ctx
, 0);
1899 switch (cmd_ctx
->lsm
->domain
.type
) {
1900 case LTTNG_DOMAIN_KERNEL
:
1901 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.disable
.channel_name
,
1902 cmd_ctx
->session
->kernel_session
);
1903 if (kchan
== NULL
) {
1904 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1908 kevent
= trace_kernel_get_event_by_name(cmd_ctx
->lsm
->u
.disable
.name
, kchan
);
1909 if (kevent
!= NULL
) {
1910 DBG("Disabling kernel event %s for channel %s.", kevent
->event
->name
,
1911 kchan
->channel
->name
);
1912 ret
= kernel_disable_event(kevent
);
1914 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
1919 kernel_wait_quiescent(kernel_tracer_fd
);
1922 /* TODO: Userspace tracing */
1923 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1930 case LTTNG_DISABLE_ALL_EVENT
:
1932 struct ltt_kernel_channel
*kchan
;
1933 struct ltt_kernel_event
*kevent
;
1935 /* Setup lttng message with no payload */
1936 ret
= setup_lttng_msg(cmd_ctx
, 0);
1941 switch (cmd_ctx
->lsm
->domain
.type
) {
1942 case LTTNG_DOMAIN_KERNEL
:
1943 DBG("Disabling all enabled kernel events");
1944 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.disable
.channel_name
,
1945 cmd_ctx
->session
->kernel_session
);
1946 if (kchan
== NULL
) {
1947 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1951 /* For each event in the kernel session */
1952 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
1953 DBG("Disabling kernel event %s for channel %s.",
1954 kevent
->event
->name
, kchan
->channel
->name
);
1955 ret
= kernel_disable_event(kevent
);
1961 /* Quiescent wait after event disable */
1962 kernel_wait_quiescent(kernel_tracer_fd
);
1965 /* TODO: Userspace tracing */
1966 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1973 case LTTNG_ENABLE_CHANNEL
:
1975 struct ltt_kernel_channel
*kchan
;
1977 /* Setup lttng message with no payload */
1978 ret
= setup_lttng_msg(cmd_ctx
, 0);
1983 switch (cmd_ctx
->lsm
->domain
.type
) {
1984 case LTTNG_DOMAIN_KERNEL
:
1985 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.enable
.channel_name
,
1986 cmd_ctx
->session
->kernel_session
);
1987 if (kchan
== NULL
) {
1988 /* Channel not found, creating it */
1989 DBG("Creating kernel channel");
1991 ret
= kernel_create_channel(cmd_ctx
->session
->kernel_session
,
1992 &cmd_ctx
->lsm
->u
.channel
.chan
,
1993 cmd_ctx
->session
->kernel_session
->trace_path
);
1995 ret
= LTTCOMM_KERN_CHAN_FAIL
;
1999 /* Notify kernel thread that there is a new channel */
2000 ret
= notify_kernel_pollfd();
2002 ret
= LTTCOMM_FATAL
;
2005 } else if (kchan
->enabled
== 0) {
2006 ret
= kernel_enable_channel(kchan
);
2008 if (ret
!= EEXIST
) {
2009 ret
= LTTCOMM_KERN_CHAN_ENABLE_FAIL
;
2015 kernel_wait_quiescent(kernel_tracer_fd
);
2017 case LTTNG_DOMAIN_UST_PID
:
2021 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2028 case LTTNG_ENABLE_EVENT
:
2031 struct ltt_kernel_channel
*kchan
;
2032 struct ltt_kernel_event
*kevent
;
2033 struct lttng_channel
*chan
;
2035 /* Setup lttng message with no payload */
2036 ret
= setup_lttng_msg(cmd_ctx
, 0);
2041 channel_name
= cmd_ctx
->lsm
->u
.enable
.channel_name
;
2043 switch (cmd_ctx
->lsm
->domain
.type
) {
2044 case LTTNG_DOMAIN_KERNEL
:
2045 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2046 cmd_ctx
->session
->kernel_session
);
2047 if (kchan
== NULL
) {
2048 DBG("Channel not found. Creating channel %s", channel_name
);
2050 chan
= init_default_channel(cmd_ctx
->lsm
->domain
.type
, channel_name
);
2052 ret
= LTTCOMM_FATAL
;
2056 ret
= kernel_create_channel(cmd_ctx
->session
->kernel_session
,
2057 chan
, cmd_ctx
->session
->kernel_session
->trace_path
);
2059 ret
= LTTCOMM_KERN_CHAN_FAIL
;
2062 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2063 cmd_ctx
->session
->kernel_session
);
2064 if (kchan
== NULL
) {
2065 ERR("Channel %s not found after creation. Internal error, giving up.",
2067 ret
= LTTCOMM_FATAL
;
2072 kevent
= trace_kernel_get_event_by_name(cmd_ctx
->lsm
->u
.enable
.event
.name
, kchan
);
2073 if (kevent
== NULL
) {
2074 DBG("Creating kernel event %s for channel %s.",
2075 cmd_ctx
->lsm
->u
.enable
.event
.name
, channel_name
);
2076 ret
= kernel_create_event(&cmd_ctx
->lsm
->u
.enable
.event
, kchan
);
2078 DBG("Enabling kernel event %s for channel %s.",
2079 kevent
->event
->name
, channel_name
);
2080 ret
= kernel_enable_event(kevent
);
2081 if (ret
== -EEXIST
) {
2082 ret
= LTTCOMM_KERN_EVENT_EXIST
;
2088 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2092 kernel_wait_quiescent(kernel_tracer_fd
);
2095 /* TODO: Userspace tracing */
2096 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2102 case LTTNG_ENABLE_ALL_EVENT
:
2106 struct ltt_kernel_channel
*kchan
;
2107 struct ltt_kernel_event
*kevent
;
2108 struct lttng_event
*event_list
;
2109 struct lttng_channel
*chan
;
2111 /* Setup lttng message with no payload */
2112 ret
= setup_lttng_msg(cmd_ctx
, 0);
2117 DBG("Enabling all kernel event");
2119 channel_name
= cmd_ctx
->lsm
->u
.enable
.channel_name
;
2121 switch (cmd_ctx
->lsm
->domain
.type
) {
2122 case LTTNG_DOMAIN_KERNEL
:
2123 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2124 cmd_ctx
->session
->kernel_session
);
2125 if (kchan
== NULL
) {
2126 DBG("Channel not found. Creating channel %s", channel_name
);
2128 chan
= init_default_channel(cmd_ctx
->lsm
->domain
.type
, channel_name
);
2130 ret
= LTTCOMM_FATAL
;
2134 ret
= kernel_create_channel(cmd_ctx
->session
->kernel_session
,
2135 chan
, cmd_ctx
->session
->kernel_session
->trace_path
);
2137 ret
= LTTCOMM_KERN_CHAN_FAIL
;
2140 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2141 cmd_ctx
->session
->kernel_session
);
2142 if (kchan
== NULL
) {
2143 ERR("Channel %s not found after creation. Internal error, giving up.",
2145 ret
= LTTCOMM_FATAL
;
2150 /* For each event in the kernel session */
2151 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
2152 DBG("Enabling kernel event %s for channel %s.",
2153 kevent
->event
->name
, channel_name
);
2154 ret
= kernel_enable_event(kevent
);
2160 size
= kernel_list_events(kernel_tracer_fd
, &event_list
);
2162 ret
= LTTCOMM_KERN_LIST_FAIL
;
2166 for (i
= 0; i
< size
; i
++) {
2167 kevent
= trace_kernel_get_event_by_name(event_list
[i
].name
, kchan
);
2168 if (kevent
== NULL
) {
2169 /* Default event type for enable all */
2170 event_list
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2171 /* Enable each single tracepoint event */
2172 ret
= kernel_create_event(&event_list
[i
], kchan
);
2174 /* Ignore error here and continue */
2181 /* Quiescent wait after event enable */
2182 kernel_wait_quiescent(kernel_tracer_fd
);
2185 /* TODO: Userspace tracing */
2186 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2193 case LTTNG_LIST_TRACEPOINTS
:
2195 struct lttng_event
*events
;
2196 ssize_t nb_events
= 0;
2198 switch (cmd_ctx
->lsm
->domain
.type
) {
2199 case LTTNG_DOMAIN_KERNEL
:
2200 DBG("Listing kernel events");
2201 nb_events
= kernel_list_events(kernel_tracer_fd
, &events
);
2202 if (nb_events
< 0) {
2203 ret
= LTTCOMM_KERN_LIST_FAIL
;
2208 /* TODO: Userspace listing */
2209 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2214 * Setup lttng message with payload size set to the event list size in
2215 * bytes and then copy list into the llm payload.
2217 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
2223 /* Copy event list into message payload */
2224 memcpy(cmd_ctx
->llm
->payload
, events
,
2225 sizeof(struct lttng_event
) * nb_events
);
2232 case LTTNG_START_TRACE
:
2234 struct ltt_kernel_channel
*chan
;
2236 /* Setup lttng message with no payload */
2237 ret
= setup_lttng_msg(cmd_ctx
, 0);
2242 /* Kernel tracing */
2243 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2244 if (cmd_ctx
->session
->kernel_session
->metadata
== NULL
) {
2245 DBG("Open kernel metadata");
2246 ret
= kernel_open_metadata(cmd_ctx
->session
->kernel_session
,
2247 cmd_ctx
->session
->kernel_session
->trace_path
);
2249 ret
= LTTCOMM_KERN_META_FAIL
;
2254 if (cmd_ctx
->session
->kernel_session
->metadata_stream_fd
== 0) {
2255 DBG("Opening kernel metadata stream");
2256 if (cmd_ctx
->session
->kernel_session
->metadata_stream_fd
== 0) {
2257 ret
= kernel_open_metadata_stream(cmd_ctx
->session
->kernel_session
);
2259 ERR("Kernel create metadata stream failed");
2260 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2266 /* For each channel */
2267 cds_list_for_each_entry(chan
,
2268 &cmd_ctx
->session
->kernel_session
->channel_list
.head
, list
) {
2269 if (chan
->stream_count
== 0) {
2270 ret
= kernel_open_channel_stream(chan
);
2272 ERR("Kernel create channel stream failed");
2273 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2276 /* Update the stream global counter */
2277 cmd_ctx
->session
->kernel_session
->stream_count_global
+= ret
;
2281 ret
= start_kernel_trace(cmd_ctx
->session
->kernel_session
);
2283 ret
= LTTCOMM_KERN_START_FAIL
;
2287 DBG("Start kernel tracing");
2288 ret
= kernel_start_session(cmd_ctx
->session
->kernel_session
);
2290 ERR("Kernel start session failed");
2291 ret
= LTTCOMM_KERN_START_FAIL
;
2295 /* Quiescent wait after starting trace */
2296 kernel_wait_quiescent(kernel_tracer_fd
);
2299 /* TODO: Start all UST traces */
2304 case LTTNG_STOP_TRACE
:
2306 struct ltt_kernel_channel
*chan
;
2307 /* Setup lttng message with no payload */
2308 ret
= setup_lttng_msg(cmd_ctx
, 0);
2314 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2315 DBG("Stop kernel tracing");
2317 ret
= kernel_metadata_flush_buffer(cmd_ctx
->session
->kernel_session
->metadata_stream_fd
);
2319 ERR("Kernel metadata flush failed");
2322 cds_list_for_each_entry(chan
, &cmd_ctx
->session
->kernel_session
->channel_list
.head
, list
) {
2323 ret
= kernel_flush_buffer(chan
);
2325 ERR("Kernel flush buffer error");
2329 ret
= kernel_stop_session(cmd_ctx
->session
->kernel_session
);
2331 ERR("Kernel stop session failed");
2332 ret
= LTTCOMM_KERN_STOP_FAIL
;
2336 /* Quiescent wait after stopping trace */
2337 kernel_wait_quiescent(kernel_tracer_fd
);
2340 /* TODO : User-space tracer */
2345 case LTTNG_CREATE_SESSION
:
2347 /* Setup lttng message with no payload */
2348 ret
= setup_lttng_msg(cmd_ctx
, 0);
2353 ret
= create_session(cmd_ctx
->lsm
->session
.name
, cmd_ctx
->lsm
->session
.path
);
2355 if (ret
== -EEXIST
) {
2356 ret
= LTTCOMM_EXIST_SESS
;
2358 ret
= LTTCOMM_FATAL
;
2366 case LTTNG_DESTROY_SESSION
:
2368 /* Setup lttng message with no payload */
2369 ret
= setup_lttng_msg(cmd_ctx
, 0);
2374 /* Clean kernel session teardown */
2375 teardown_kernel_session(cmd_ctx
->session
);
2377 ret
= destroy_session(cmd_ctx
->lsm
->session
.name
);
2379 ret
= LTTCOMM_FATAL
;
2384 * Must notify the kernel thread here to update it's pollfd in order to
2385 * remove the channel(s)' fd just destroyed.
2387 ret
= notify_kernel_pollfd();
2389 ret
= LTTCOMM_FATAL
;
2396 case LTTNG_LIST_DOMAINS
:
2400 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2404 nb_dom
+= cmd_ctx
->session
->ust_session_list
.count
;
2406 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_domain
) * nb_dom
);
2411 ((struct lttng_domain
*)(cmd_ctx
->llm
->payload
))[0].type
=
2412 LTTNG_DOMAIN_KERNEL
;
2414 /* TODO: User-space tracer domain support */
2418 case LTTNG_LIST_CHANNELS
:
2421 * TODO: Only kernel channels are listed here. UST listing
2422 * is needed on lttng-ust 2.0 release.
2425 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2426 nb_chan
+= cmd_ctx
->session
->kernel_session
->channel_count
;
2429 ret
= setup_lttng_msg(cmd_ctx
,
2430 sizeof(struct lttng_channel
) * nb_chan
);
2435 list_lttng_channels(cmd_ctx
->session
,
2436 (struct lttng_channel
*)(cmd_ctx
->llm
->payload
));
2441 case LTTNG_LIST_EVENTS
:
2444 * TODO: Only kernel events are listed here. UST listing
2445 * is needed on lttng-ust 2.0 release.
2447 size_t nb_event
= 0;
2448 struct ltt_kernel_channel
*kchan
= NULL
;
2450 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2451 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.list
.channel_name
,
2452 cmd_ctx
->session
->kernel_session
);
2453 if (kchan
== NULL
) {
2454 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2457 nb_event
+= kchan
->event_count
;
2460 ret
= setup_lttng_msg(cmd_ctx
,
2461 sizeof(struct lttng_event
) * nb_event
);
2466 DBG("Listing events (%zu events)", nb_event
);
2468 list_lttng_events(kchan
,
2469 (struct lttng_event
*)(cmd_ctx
->llm
->payload
));
2474 case LTTNG_LIST_SESSIONS
:
2476 lock_session_list();
2478 if (session_list_ptr
->count
== 0) {
2479 ret
= LTTCOMM_NO_SESSION
;
2480 unlock_session_list();
2484 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
2485 session_list_ptr
->count
);
2487 unlock_session_list();
2491 /* Filled the session array */
2492 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
2494 unlock_session_list();
2499 case LTTNG_CALIBRATE
:
2501 /* Setup lttng message with no payload */
2502 ret
= setup_lttng_msg(cmd_ctx
, 0);
2507 switch (cmd_ctx
->lsm
->domain
.type
) {
2508 case LTTNG_DOMAIN_KERNEL
:
2510 struct lttng_kernel_calibrate kcalibrate
;
2512 kcalibrate
.type
= cmd_ctx
->lsm
->u
.calibrate
.type
;
2513 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2515 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2521 /* TODO: Userspace tracing */
2522 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2528 case LTTNG_REGISTER_CONSUMER
:
2532 /* Setup lttng message with no payload */
2533 ret
= setup_lttng_msg(cmd_ctx
, 0);
2538 switch (cmd_ctx
->lsm
->domain
.type
) {
2539 case LTTNG_DOMAIN_KERNEL
:
2541 /* Can't register a consumer if there is already one */
2542 if (cmd_ctx
->session
->kernel_session
->consumer_fd
!= 0) {
2543 ret
= LTTCOMM_CONNECT_FAIL
;
2547 sock
= lttcomm_connect_unix_sock(cmd_ctx
->lsm
->u
.reg
.path
);
2549 ret
= LTTCOMM_CONNECT_FAIL
;
2553 cmd_ctx
->session
->kernel_session
->consumer_fd
= sock
;
2557 /* TODO: Userspace tracing */
2558 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2567 /* Undefined command */
2568 ret
= setup_lttng_msg(cmd_ctx
, 0);
2577 /* Set return code */
2578 cmd_ctx
->llm
->ret_code
= ret
;
2580 if (cmd_ctx
->session
) {
2581 unlock_session(cmd_ctx
->session
);
2587 if (cmd_ctx
->llm
== NULL
) {
2588 DBG("Missing llm structure. Allocating one.");
2589 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
2593 /* Notify client of error */
2594 cmd_ctx
->llm
->ret_code
= ret
;
2597 if (cmd_ctx
->session
) {
2598 unlock_session(cmd_ctx
->session
);
2604 * This thread manage all clients request using the unix client socket for
2607 static void *thread_manage_clients(void *data
)
2610 struct command_ctx
*cmd_ctx
= NULL
;
2611 struct pollfd pollfd
[2];
2613 DBG("[thread] Manage client started");
2615 ret
= lttcomm_listen_unix_sock(client_sock
);
2620 /* First fd is always the quit pipe */
2621 pollfd
[0].fd
= thread_quit_pipe
[0];
2624 pollfd
[1].fd
= client_sock
;
2625 pollfd
[1].events
= POLLIN
;
2627 /* Notify parent pid that we are ready
2628 * to accept command for client side.
2630 if (opt_sig_parent
) {
2631 kill(ppid
, SIGCHLD
);
2635 DBG("Accepting client command ...");
2637 /* Inifinite blocking call, waiting for transmission */
2638 ret
= poll(pollfd
, 2, -1);
2640 perror("poll client thread");
2644 /* Thread quit pipe has been closed. Killing thread. */
2645 if (pollfd
[0].revents
== POLLNVAL
) {
2647 } else if (pollfd
[1].revents
== POLLERR
) {
2648 ERR("Client socket poll error");
2652 sock
= lttcomm_accept_unix_sock(client_sock
);
2657 /* Allocate context command to process the client request */
2658 cmd_ctx
= malloc(sizeof(struct command_ctx
));
2660 /* Allocate data buffer for reception */
2661 cmd_ctx
->lsm
= malloc(sizeof(struct lttcomm_session_msg
));
2662 cmd_ctx
->llm
= NULL
;
2663 cmd_ctx
->session
= NULL
;
2666 * Data is received from the lttng client. The struct
2667 * lttcomm_session_msg (lsm) contains the command and data request of
2670 DBG("Receiving data from client ...");
2671 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
, sizeof(struct lttcomm_session_msg
));
2676 // TODO: Validate cmd_ctx including sanity check for security purpose.
2679 * This function dispatch the work to the kernel or userspace tracer
2680 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2681 * informations for the client. The command context struct contains
2682 * everything this function may needs.
2684 ret
= process_client_msg(cmd_ctx
);
2686 /* TODO: Inform client somehow of the fatal error. At this point,
2687 * ret < 0 means that a malloc failed (ENOMEM). */
2688 /* Error detected but still accept command */
2689 clean_command_ctx(&cmd_ctx
);
2693 DBG("Sending response (size: %d, retcode: %d)",
2694 cmd_ctx
->lttng_msg_size
, cmd_ctx
->llm
->ret_code
);
2695 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
2697 ERR("Failed to send data back to client");
2700 clean_command_ctx(&cmd_ctx
);
2702 /* End of transmission */
2707 DBG("Client thread dying");
2715 unlink(client_unix_sock_path
);
2717 clean_command_ctx(&cmd_ctx
);
2723 * usage function on stderr
2725 static void usage(void)
2727 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
2728 fprintf(stderr
, " -h, --help Display this usage.\n");
2729 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
2730 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
2731 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
2732 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
2733 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
2734 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
2735 fprintf(stderr
, " -V, --version Show version number.\n");
2736 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
2737 fprintf(stderr
, " -q, --quiet No output at all.\n");
2738 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
2739 fprintf(stderr
, " --verbose-kconsumerd Verbose mode for kconsumerd. Activate DBG() macro.\n");
2743 * daemon argument parsing
2745 static int parse_args(int argc
, char **argv
)
2749 static struct option long_options
[] = {
2750 { "client-sock", 1, 0, 'c' },
2751 { "apps-sock", 1, 0, 'a' },
2752 { "kconsumerd-cmd-sock", 1, 0, 0 },
2753 { "kconsumerd-err-sock", 1, 0, 0 },
2754 { "daemonize", 0, 0, 'd' },
2755 { "sig-parent", 0, 0, 'S' },
2756 { "help", 0, 0, 'h' },
2757 { "group", 1, 0, 'g' },
2758 { "version", 0, 0, 'V' },
2759 { "quiet", 0, 0, 'q' },
2760 { "verbose", 0, 0, 'v' },
2761 { "verbose-kconsumerd", 0, 0, 'Z' },
2766 int option_index
= 0;
2767 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:E:C:Z", long_options
, &option_index
);
2774 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
2776 fprintf(stderr
, " with arg %s\n", optarg
);
2780 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2783 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2789 opt_tracing_group
= strdup(optarg
);
2795 fprintf(stdout
, "%s\n", VERSION
);
2801 snprintf(kconsumerd_err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2804 snprintf(kconsumerd_cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2810 /* Verbose level can increase using multiple -v */
2814 opt_verbose_kconsumerd
+= 1;
2817 /* Unknown option or other error.
2818 * Error is printed by getopt, just return */
2827 * Creates the two needed socket by the daemon.
2828 * apps_sock - The communication socket for all UST apps.
2829 * client_sock - The communication of the cli tool (lttng).
2831 static int init_daemon_socket(void)
2836 old_umask
= umask(0);
2838 /* Create client tool unix socket */
2839 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
2840 if (client_sock
< 0) {
2841 ERR("Create unix sock failed: %s", client_unix_sock_path
);
2846 /* File permission MUST be 660 */
2847 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2849 ERR("Set file permissions failed: %s", client_unix_sock_path
);
2854 /* Create the application unix socket */
2855 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
2856 if (apps_sock
< 0) {
2857 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
2862 /* File permission MUST be 666 */
2863 ret
= chmod(apps_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
2865 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
2876 * Check if the global socket is available, and if a daemon is answering
2877 * at the other side. If yes, error is returned.
2879 static int check_existing_daemon(void)
2881 if (access(client_unix_sock_path
, F_OK
) < 0 &&
2882 access(apps_unix_sock_path
, F_OK
) < 0) {
2885 /* Is there anybody out there ? */
2886 if (lttng_session_daemon_alive()) {
2894 * Set the tracing group gid onto the client socket.
2896 * Race window between mkdir and chown is OK because we are going from more
2897 * permissive (root.root) to les permissive (root.tracing).
2899 static int set_permissions(void)
2904 gid
= allowed_group();
2907 WARN("No tracing group detected");
2910 ERR("Missing tracing group. Aborting execution.");
2916 /* Set lttng run dir */
2917 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
2919 ERR("Unable to set group on " LTTNG_RUNDIR
);
2923 /* lttng client socket path */
2924 ret
= chown(client_unix_sock_path
, 0, gid
);
2926 ERR("Unable to set group on %s", client_unix_sock_path
);
2930 /* kconsumerd error socket path */
2931 ret
= chown(kconsumerd_err_unix_sock_path
, 0, gid
);
2933 ERR("Unable to set group on %s", kconsumerd_err_unix_sock_path
);
2937 DBG("All permissions are set");
2944 * Create the pipe used to wake up the kernel thread.
2946 static int create_kernel_poll_pipe(void)
2948 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
2952 * Create the application command pipe to wake thread_manage_apps.
2954 static int create_apps_cmd_pipe(void)
2956 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
2960 * Create the lttng run directory needed for all global sockets and pipe.
2962 static int create_lttng_rundir(void)
2966 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
2968 if (errno
!= EEXIST
) {
2969 ERR("Unable to create " LTTNG_RUNDIR
);
2981 * Setup sockets and directory needed by the kconsumerd communication with the
2984 static int set_kconsumerd_sockets(void)
2988 if (strlen(kconsumerd_err_unix_sock_path
) == 0) {
2989 snprintf(kconsumerd_err_unix_sock_path
, PATH_MAX
, KCONSUMERD_ERR_SOCK_PATH
);
2992 if (strlen(kconsumerd_cmd_unix_sock_path
) == 0) {
2993 snprintf(kconsumerd_cmd_unix_sock_path
, PATH_MAX
, KCONSUMERD_CMD_SOCK_PATH
);
2996 ret
= mkdir(KCONSUMERD_PATH
, S_IRWXU
| S_IRWXG
);
2998 if (errno
!= EEXIST
) {
2999 ERR("Failed to create " KCONSUMERD_PATH
);
3005 /* Create the kconsumerd error unix socket */
3006 kconsumerd_err_sock
= lttcomm_create_unix_sock(kconsumerd_err_unix_sock_path
);
3007 if (kconsumerd_err_sock
< 0) {
3008 ERR("Create unix sock failed: %s", kconsumerd_err_unix_sock_path
);
3013 /* File permission MUST be 660 */
3014 ret
= chmod(kconsumerd_err_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3016 ERR("Set file permissions failed: %s", kconsumerd_err_unix_sock_path
);
3026 * Signal handler for the daemon
3028 * Simply stop all worker threads, leaving main() return gracefully
3029 * after joining all threads and calling cleanup().
3031 static void sighandler(int sig
)
3035 DBG("SIGPIPE catched");
3038 DBG("SIGINT catched");
3042 DBG("SIGTERM catched");
3051 * Setup signal handler for :
3052 * SIGINT, SIGTERM, SIGPIPE
3054 static int set_signal_handler(void)
3057 struct sigaction sa
;
3060 if ((ret
= sigemptyset(&sigset
)) < 0) {
3061 perror("sigemptyset");
3065 sa
.sa_handler
= sighandler
;
3066 sa
.sa_mask
= sigset
;
3068 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
3069 perror("sigaction");
3073 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
3074 perror("sigaction");
3078 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
3079 perror("sigaction");
3083 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3089 * Set open files limit to unlimited. This daemon can open a large number of
3090 * file descriptors in order to consumer multiple kernel traces.
3092 static void set_ulimit(void)
3097 /* The kernel does not allowed an infinite limit for open files */
3098 lim
.rlim_cur
= 65535;
3099 lim
.rlim_max
= 65535;
3101 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
3103 perror("failed to set open files limit");
3110 int main(int argc
, char **argv
)
3114 const char *home_path
;
3116 /* Create thread quit pipe */
3117 if ((ret
= init_thread_quit_pipe()) < 0) {
3121 /* Parse arguments */
3123 if ((ret
= parse_args(argc
, argv
) < 0)) {
3136 /* Check if daemon is UID = 0 */
3137 is_root
= !getuid();
3140 ret
= create_lttng_rundir();
3145 if (strlen(apps_unix_sock_path
) == 0) {
3146 snprintf(apps_unix_sock_path
, PATH_MAX
,
3147 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
3150 if (strlen(client_unix_sock_path
) == 0) {
3151 snprintf(client_unix_sock_path
, PATH_MAX
,
3152 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
3155 /* Set global SHM for ust */
3156 if (strlen(wait_shm_path
) == 0) {
3157 snprintf(wait_shm_path
, PATH_MAX
,
3158 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
3161 home_path
= get_home_dir();
3162 if (home_path
== NULL
) {
3163 /* TODO: Add --socket PATH option */
3164 ERR("Can't get HOME directory for sockets creation.");
3169 if (strlen(apps_unix_sock_path
) == 0) {
3170 snprintf(apps_unix_sock_path
, PATH_MAX
,
3171 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
3174 /* Set the cli tool unix socket path */
3175 if (strlen(client_unix_sock_path
) == 0) {
3176 snprintf(client_unix_sock_path
, PATH_MAX
,
3177 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
3180 /* Set global SHM for ust */
3181 if (strlen(wait_shm_path
) == 0) {
3182 snprintf(wait_shm_path
, PATH_MAX
,
3183 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
3187 DBG("Client socket path %s", client_unix_sock_path
);
3188 DBG("Application socket path %s", apps_unix_sock_path
);
3191 * See if daemon already exist.
3193 if ((ret
= check_existing_daemon()) < 0) {
3194 ERR("Already running daemon.\n");
3196 * We do not goto exit because we must not cleanup()
3197 * because a daemon is already running.
3202 /* After this point, we can safely call cleanup() so goto error is used */
3205 * These actions must be executed as root. We do that *after* setting up
3206 * the sockets path because we MUST make the check for another daemon using
3207 * those paths *before* trying to set the kernel consumer sockets and init
3211 ret
= set_kconsumerd_sockets();
3216 /* Setup kernel tracer */
3217 init_kernel_tracer();
3219 /* Set ulimit for open files */
3223 if ((ret
= set_signal_handler()) < 0) {
3227 /* Setup the needed unix socket */
3228 if ((ret
= init_daemon_socket()) < 0) {
3232 /* Set credentials to socket */
3233 if (is_root
&& ((ret
= set_permissions()) < 0)) {
3237 /* Get parent pid if -S, --sig-parent is specified. */
3238 if (opt_sig_parent
) {
3242 /* Setup the kernel pipe for waking up the kernel thread */
3243 if ((ret
= create_kernel_poll_pipe()) < 0) {
3247 /* Setup the thread apps communication pipe. */
3248 if ((ret
= create_apps_cmd_pipe()) < 0) {
3252 /* Init UST command queue. */
3253 cds_wfq_init(&ust_cmd_queue
.queue
);
3256 * Get session list pointer. This pointer MUST NOT be free().
3257 * This list is statically declared in session.c
3259 session_list_ptr
= get_session_list();
3261 /* Create thread to manage the client socket */
3262 ret
= pthread_create(&client_thread
, NULL
,
3263 thread_manage_clients
, (void *) NULL
);
3265 perror("pthread_create clients");
3269 /* Create thread to dispatch registration */
3270 ret
= pthread_create(&dispatch_thread
, NULL
,
3271 thread_dispatch_ust_registration
, (void *) NULL
);
3273 perror("pthread_create dispatch");
3277 /* Create thread to manage application registration. */
3278 ret
= pthread_create(®_apps_thread
, NULL
,
3279 thread_registration_apps
, (void *) NULL
);
3281 perror("pthread_create registration");
3285 /* Create thread to manage application socket */
3286 ret
= pthread_create(&apps_thread
, NULL
, thread_manage_apps
, (void *) NULL
);
3288 perror("pthread_create apps");
3292 /* Create kernel thread to manage kernel event */
3293 ret
= pthread_create(&kernel_thread
, NULL
, thread_manage_kernel
, (void *) NULL
);
3295 perror("pthread_create kernel");
3299 ret
= pthread_join(kernel_thread
, &status
);
3301 perror("pthread_join");
3302 goto error
; /* join error, exit without cleanup */
3306 ret
= pthread_join(apps_thread
, &status
);
3308 perror("pthread_join");
3309 goto error
; /* join error, exit without cleanup */
3313 ret
= pthread_join(reg_apps_thread
, &status
);
3315 perror("pthread_join");
3316 goto error
; /* join error, exit without cleanup */
3320 ret
= pthread_join(dispatch_thread
, &status
);
3322 perror("pthread_join");
3323 goto error
; /* join error, exit without cleanup */
3327 ret
= pthread_join(client_thread
, &status
);
3329 perror("pthread_join");
3330 goto error
; /* join error, exit without cleanup */
3333 ret
= join_kconsumerd_thread();
3335 perror("join_kconsumerd");
3336 goto error
; /* join error, exit without cleanup */
3342 * cleanup() is called when no other thread is running.