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];
570 kernel_pollfd
[nb_fd
- 1].events
=
571 POLLHUP
| POLLNVAL
| POLLERR
| POLLIN
| POLLRDHUP
| POLLPRI
;
576 unlock_session_list();
581 * Find the channel fd from 'fd' over all tracing session. When found, check
582 * for new channel stream and send those stream fds to the kernel consumer.
584 * Useful for CPU hotplug feature.
586 static int update_kernel_stream(int fd
)
589 struct ltt_session
*session
;
590 struct ltt_kernel_channel
*channel
;
592 DBG("Updating kernel streams for channel fd %d", fd
);
595 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
596 lock_session(session
);
597 if (session
->kernel_session
== NULL
) {
598 unlock_session(session
);
602 /* This is not suppose to be 0 but this is an extra security check */
603 if (session
->kernel_session
->consumer_fd
== 0) {
604 session
->kernel_session
->consumer_fd
= kconsumerd_cmd_sock
;
607 cds_list_for_each_entry(channel
, &session
->kernel_session
->channel_list
.head
, list
) {
608 if (channel
->fd
== fd
) {
609 DBG("Channel found, updating kernel streams");
610 ret
= kernel_open_channel_stream(channel
);
616 * Have we already sent fds to the consumer? If yes, it means that
617 * tracing is started so it is safe to send our updated stream fds.
619 if (session
->kernel_session
->kconsumer_fds_sent
== 1) {
620 ret
= send_kconsumerd_channel_fds(session
->kernel_session
->consumer_fd
,
629 unlock_session(session
);
633 unlock_session_list();
635 unlock_session(session
);
641 * This thread manage event coming from the kernel.
643 * Features supported in this thread:
646 static void *thread_manage_kernel(void *data
)
648 int ret
, i
, nb_fd
= 0;
650 int update_poll_flag
= 1;
652 DBG("Thread manage kernel started");
655 if (update_poll_flag
== 1) {
656 nb_fd
= update_kernel_pollfd();
660 update_poll_flag
= 0;
663 DBG("Polling on %d fds", nb_fd
);
665 /* Poll infinite value of time */
666 ret
= poll(kernel_pollfd
, nb_fd
, -1);
668 perror("poll kernel thread");
670 } else if (ret
== 0) {
671 /* Should not happen since timeout is infinite */
672 ERR("Return value of poll is 0 with an infinite timeout.\n"
673 "This should not have happened! Continuing...");
677 /* Thread quit pipe has been closed. Killing thread. */
678 if (kernel_pollfd
[nb_fd
- 1].revents
== POLLNVAL
) {
682 DBG("Kernel poll event triggered");
685 * Check if the wake up pipe was triggered. If so, the kernel_pollfd
688 switch (kernel_pollfd
[nb_fd
- 2].revents
) {
690 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
691 update_poll_flag
= 1;
699 for (i
= 0; i
< nb_fd
; i
++) {
700 switch (kernel_pollfd
[i
].revents
) {
702 * New CPU detected by the kernel. Adding kernel stream to kernel
703 * session and updating the kernel consumer
705 case POLLIN
| POLLRDNORM
:
706 ret
= update_kernel_stream(kernel_pollfd
[i
].fd
);
716 DBG("Kernel thread dying");
721 close(kernel_poll_pipe
[0]);
722 close(kernel_poll_pipe
[1]);
727 * This thread manage the kconsumerd error sent back to the session daemon.
729 static void *thread_manage_kconsumerd(void *data
)
732 enum lttcomm_return_code code
;
733 struct pollfd pollfd
[2];
735 DBG("[thread] Manage kconsumerd started");
737 ret
= lttcomm_listen_unix_sock(kconsumerd_err_sock
);
742 /* First fd is always the quit pipe */
743 pollfd
[0].fd
= thread_quit_pipe
[0];
746 pollfd
[1].fd
= kconsumerd_err_sock
;
747 pollfd
[1].events
= POLLIN
;
749 /* Inifinite blocking call, waiting for transmission */
750 ret
= poll(pollfd
, 2, -1);
752 perror("poll kconsumerd thread");
756 /* Thread quit pipe has been closed. Killing thread. */
757 if (pollfd
[0].revents
== POLLNVAL
) {
759 } else if (pollfd
[1].revents
== POLLERR
) {
760 ERR("Kconsumerd err socket poll error");
764 sock
= lttcomm_accept_unix_sock(kconsumerd_err_sock
);
769 /* Getting status code from kconsumerd */
770 ret
= lttcomm_recv_unix_sock(sock
, &code
, sizeof(enum lttcomm_return_code
));
775 if (code
== KCONSUMERD_COMMAND_SOCK_READY
) {
776 kconsumerd_cmd_sock
= lttcomm_connect_unix_sock(kconsumerd_cmd_unix_sock_path
);
777 if (kconsumerd_cmd_sock
< 0) {
778 sem_post(&kconsumerd_sem
);
779 perror("kconsumerd connect");
782 /* Signal condition to tell that the kconsumerd is ready */
783 sem_post(&kconsumerd_sem
);
784 DBG("Kconsumerd command socket ready");
786 DBG("Kconsumerd error when waiting for SOCK_READY : %s",
787 lttcomm_get_readable_code(-code
));
791 /* Kconsumerd err socket */
793 pollfd
[1].events
= POLLIN
;
795 /* Inifinite blocking call, waiting for transmission */
796 ret
= poll(pollfd
, 2, -1);
798 perror("poll kconsumerd thread");
802 /* Thread quit pipe has been closed. Killing thread. */
803 if (pollfd
[0].revents
== POLLNVAL
) {
805 } else if (pollfd
[1].revents
== POLLERR
) {
806 ERR("Kconsumerd err socket second poll error");
810 /* Wait for any kconsumerd error */
811 ret
= lttcomm_recv_unix_sock(sock
, &code
, sizeof(enum lttcomm_return_code
));
813 ERR("Kconsumerd closed the command socket");
817 ERR("Kconsumerd return code : %s", lttcomm_get_readable_code(-code
));
820 DBG("Kconsumerd thread dying");
821 if (kconsumerd_err_sock
) {
822 close(kconsumerd_err_sock
);
824 if (kconsumerd_cmd_sock
) {
825 close(kconsumerd_cmd_sock
);
831 unlink(kconsumerd_err_unix_sock_path
);
832 unlink(kconsumerd_cmd_unix_sock_path
);
839 * Reallocate the apps command pollfd structure of nb_fd size.
841 * The first two fds must be there at all time.
843 static int update_apps_cmd_pollfd(unsigned int nb_fd
, unsigned int old_nb_fd
,
844 struct pollfd
**pollfd
)
847 struct pollfd
*old_pollfd
= NULL
;
849 /* Can't accept pollfd less than 2 */
856 old_pollfd
= *pollfd
;
859 *pollfd
= malloc(nb_fd
* sizeof(struct pollfd
));
860 if (*pollfd
== NULL
) {
861 perror("malloc manage apps pollfd");
865 /* First fd is always the quit pipe */
866 (*pollfd
)[0].fd
= thread_quit_pipe
[0];
867 (*pollfd
)[0].events
=
868 POLLHUP
| POLLNVAL
| POLLERR
| POLLIN
| POLLRDHUP
| POLLPRI
;
870 /* Apps command pipe */
871 (*pollfd
)[1].fd
= apps_cmd_pipe
[0];
872 (*pollfd
)[1].events
= POLLIN
;
874 /* Start count after the two pipes below */
876 for (i
= 2; i
< old_nb_fd
; i
++) {
877 /* Add to new pollfd */
878 if (old_pollfd
[i
].fd
!= -1) {
879 (*pollfd
)[count
].fd
= old_pollfd
[i
].fd
;
880 (*pollfd
)[count
].events
= POLLHUP
| POLLNVAL
| POLLERR
;
885 ERR("Updating poll fd wrong size");
892 * There should *always* be at least two fds in the pollfd. This safety
893 * check make sure the poll() will actually try on those two pipes at
894 * best which are the thread_quit_pipe and apps_cmd_pipe.
897 MSG("nb_fd < 2 --> Not good! Continuing...");
900 /* Destroy old pollfd */
903 DBG("Apps cmd pollfd realloc of size %d", nb_fd
);
909 /* Destroy old pollfd */
915 * This thread manage application communication.
917 static void *thread_manage_apps(void *data
)
919 int i
, ret
, current_nb_fd
;
920 unsigned int nb_fd
= 2;
921 int update_poll_flag
= 1;
922 struct pollfd
*pollfd
= NULL
;
923 struct ust_command ust_cmd
;
925 DBG("[thread] Manage application started");
928 current_nb_fd
= nb_fd
;
931 /* See if we have a valid socket to add to pollfd */
932 if (ust_cmd
.sock
!= -1) {
934 update_poll_flag
= 1;
937 /* The pollfd struct must be updated */
938 if (update_poll_flag
) {
939 ret
= update_apps_cmd_pollfd(nb_fd
, current_nb_fd
, &pollfd
);
941 /* malloc failed so we quit */
945 if (ust_cmd
.sock
!= -1) {
946 /* Update pollfd with the new UST socket */
947 DBG("Adding sock %d to apps cmd pollfd", ust_cmd
.sock
);
948 pollfd
[nb_fd
- 1].fd
= ust_cmd
.sock
;
949 pollfd
[nb_fd
- 1].events
= POLLHUP
| POLLNVAL
| POLLERR
;
954 DBG("Apps thread polling on %d fds", nb_fd
);
956 /* Inifinite blocking call, waiting for transmission */
957 ret
= poll(pollfd
, nb_fd
, -1);
959 perror("poll apps thread");
963 /* Thread quit pipe has been closed. Killing thread. */
964 if (pollfd
[0].revents
== POLLNVAL
) {
967 /* apps_cmd_pipe pipe events */
968 switch (pollfd
[1].revents
) {
970 ERR("Apps command pipe poll error");
974 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
975 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
976 perror("read apps cmd pipe");
980 /* Register applicaton to the session daemon */
981 ret
= register_traceable_app(&ust_cmd
.reg_msg
, ust_cmd
.sock
);
983 /* Only critical ENOMEM error can be returned here */
987 ret
= ustctl_register_done(ust_cmd
.sock
);
990 * If the registration is not possible, we simply unregister
991 * the apps and continue
993 unregister_traceable_app(ust_cmd
.sock
);
999 current_nb_fd
= nb_fd
;
1000 for (i
= 2; i
< current_nb_fd
; i
++) {
1001 /* Apps socket is closed/hungup */
1002 switch (pollfd
[i
].revents
) {
1007 unregister_traceable_app(pollfd
[i
].fd
);
1008 /* Indicate to remove this fd from the pollfd */
1015 if (nb_fd
!= current_nb_fd
) {
1016 update_poll_flag
= 1;
1021 DBG("Application communication apps dying");
1022 close(apps_cmd_pipe
[0]);
1023 close(apps_cmd_pipe
[1]);
1031 * Dispatch request from the registration threads to the application
1032 * communication thread.
1034 static void *thread_dispatch_ust_registration(void *data
)
1037 struct cds_wfq_node
*node
;
1038 struct ust_command
*ust_cmd
= NULL
;
1040 DBG("[thread] Dispatch UST command started");
1042 while (!dispatch_thread_exit
) {
1043 /* Atomically prepare the queue futex */
1044 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1047 /* Dequeue command for registration */
1048 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1050 DBG("Waked up but nothing in the UST command queue");
1051 /* Continue thread execution */
1055 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1057 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1058 " gid:%d sock:%d name:%s (version %d.%d)",
1059 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1060 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1061 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1062 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1064 * Inform apps thread of the new application registration. This
1065 * call is blocking so we can be assured that the data will be read
1066 * at some point in time or wait to the end of the world :)
1068 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1069 sizeof(struct ust_command
));
1071 perror("write apps cmd pipe");
1072 if (errno
== EBADF
) {
1074 * We can't inform the application thread to process
1075 * registration. We will exit or else application
1076 * registration will not occur and tracing will never
1083 } while (node
!= NULL
);
1085 /* Futex wait on queue. Blocking call on futex() */
1086 futex_nto1_wait(&ust_cmd_queue
.futex
);
1090 DBG("Dispatch thread dying");
1095 * This thread manage application registration.
1097 static void *thread_registration_apps(void *data
)
1100 struct pollfd pollfd
[2];
1102 * Get allocated in this thread, enqueued to a global queue, dequeued and
1103 * freed in the manage apps thread.
1105 struct ust_command
*ust_cmd
= NULL
;
1107 DBG("[thread] Manage application registration started");
1109 ret
= lttcomm_listen_unix_sock(apps_sock
);
1114 /* First fd is always the quit pipe */
1115 pollfd
[0].fd
= thread_quit_pipe
[0];
1117 POLLHUP
| POLLNVAL
| POLLERR
| POLLIN
| POLLRDHUP
| POLLPRI
;
1120 pollfd
[1].fd
= apps_sock
;
1121 pollfd
[1].events
= POLLIN
;
1123 /* Notify all applications to register */
1124 ret
= notify_ust_apps(1);
1126 ERR("Failed to notify applications or create the wait shared memory.\n"
1127 "Execution continues but there might be problem for already running\n"
1128 "applications that wishes to register.");
1132 DBG("Accepting application registration");
1134 /* Inifinite blocking call, waiting for transmission */
1135 ret
= poll(pollfd
, 2, -1);
1137 perror("poll register apps thread");
1141 /* Thread quit pipe has been closed. Killing thread. */
1142 if (pollfd
[0].revents
== POLLNVAL
) {
1146 switch (pollfd
[1].revents
) {
1151 ERR("Register apps socket poll error");
1154 sock
= lttcomm_accept_unix_sock(apps_sock
);
1159 /* Create UST registration command for enqueuing */
1160 ust_cmd
= malloc(sizeof(struct ust_command
));
1161 if (ust_cmd
== NULL
) {
1162 perror("ust command malloc");
1167 * Using message-based transmissions to ensure we don't have to deal
1168 * with partially received messages.
1170 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1171 sizeof(struct ust_register_msg
));
1172 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1174 perror("lttcomm_recv_unix_sock register apps");
1176 ERR("Wrong size received on apps register");
1183 ust_cmd
->sock
= sock
;
1185 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1186 " gid:%d sock:%d name:%s (version %d.%d)",
1187 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1188 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1189 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1190 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1192 * Lock free enqueue the registration request.
1193 * The red pill has been taken! This apps will be part of the *system*
1195 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1198 * Wake the registration queue futex.
1199 * Implicit memory barrier with the exchange in cds_wfq_enqueue.
1201 futex_nto1_wake(&ust_cmd_queue
.futex
);
1207 DBG("UST Registration thread dying");
1209 /* Notify that the registration thread is gone */
1215 unlink(apps_unix_sock_path
);
1221 * Start the thread_manage_kconsumerd. This must be done after a kconsumerd
1222 * exec or it will fails.
1224 static int spawn_kconsumerd_thread(void)
1228 /* Setup semaphore */
1229 sem_init(&kconsumerd_sem
, 0, 0);
1231 ret
= pthread_create(&kconsumerd_thread
, NULL
, thread_manage_kconsumerd
, (void *) NULL
);
1233 perror("pthread_create kconsumerd");
1237 /* Wait for the kconsumerd thread to be ready */
1238 sem_wait(&kconsumerd_sem
);
1240 if (kconsumerd_pid
== 0) {
1241 ERR("Kconsumerd did not start");
1248 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1253 * Join kernel consumer thread
1255 static int join_kconsumerd_thread(void)
1260 if (kconsumerd_pid
!= 0) {
1261 ret
= kill(kconsumerd_pid
, SIGTERM
);
1263 ERR("Error killing kconsumerd");
1266 return pthread_join(kconsumerd_thread
, &status
);
1273 * Fork and exec a kernel consumer daemon (kconsumerd).
1275 * Return pid if successful else -1.
1277 static pid_t
spawn_kconsumerd(void)
1281 const char *verbosity
;
1283 DBG("Spawning kconsumerd");
1290 if (opt_verbose
> 1 || opt_verbose_kconsumerd
) {
1291 verbosity
= "--verbose";
1293 verbosity
= "--quiet";
1295 execl(INSTALL_BIN_PATH
"/ltt-kconsumerd", "ltt-kconsumerd", verbosity
, NULL
);
1297 perror("kernel start consumer exec");
1300 } else if (pid
> 0) {
1304 perror("kernel start consumer fork");
1314 * Spawn the kconsumerd daemon and session daemon thread.
1316 static int start_kconsumerd(void)
1320 pthread_mutex_lock(&kconsumerd_pid_mutex
);
1321 if (kconsumerd_pid
!= 0) {
1322 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1326 ret
= spawn_kconsumerd();
1328 ERR("Spawning kconsumerd failed");
1329 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1330 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1334 /* Setting up the global kconsumerd_pid */
1335 kconsumerd_pid
= ret
;
1336 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1338 DBG("Kconsumerd pid %d", ret
);
1340 DBG("Spawning kconsumerd thread");
1341 ret
= spawn_kconsumerd_thread();
1343 ERR("Fatal error spawning kconsumerd thread");
1355 * modprobe_kernel_modules
1357 static int modprobe_kernel_modules(void)
1362 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1363 ret
= snprintf(modprobe
, sizeof(modprobe
),
1364 "/sbin/modprobe %s%s",
1365 kernel_modules_list
[i
].required
? "" : "--quiet ",
1366 kernel_modules_list
[i
].name
);
1368 perror("snprintf modprobe");
1371 modprobe
[sizeof(modprobe
) - 1] = '\0';
1372 ret
= system(modprobe
);
1374 ERR("Unable to launch modprobe for module %s",
1375 kernel_modules_list
[i
].name
);
1376 } else if (kernel_modules_list
[i
].required
1377 && WEXITSTATUS(ret
) != 0) {
1378 ERR("Unable to load module %s",
1379 kernel_modules_list
[i
].name
);
1381 DBG("Modprobe successfully %s",
1382 kernel_modules_list
[i
].name
);
1393 static int mount_debugfs(char *path
)
1396 char *type
= "debugfs";
1398 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1403 ret
= mount(type
, path
, type
, 0, NULL
);
1405 perror("mount debugfs");
1409 DBG("Mounted debugfs successfully at %s", path
);
1416 * Setup necessary data for kernel tracer action.
1418 static void init_kernel_tracer(void)
1421 char *proc_mounts
= "/proc/mounts";
1423 char *debugfs_path
= NULL
, *lttng_path
;
1426 /* Detect debugfs */
1427 fp
= fopen(proc_mounts
, "r");
1429 ERR("Unable to probe %s", proc_mounts
);
1433 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1434 if (strstr(line
, "debugfs") != NULL
) {
1435 /* Remove first string */
1437 /* Dup string here so we can reuse line later on */
1438 debugfs_path
= strdup(strtok(NULL
, " "));
1439 DBG("Got debugfs path : %s", debugfs_path
);
1446 /* Mount debugfs if needded */
1447 if (debugfs_path
== NULL
) {
1448 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1450 perror("asprintf debugfs path");
1453 ret
= mount_debugfs(debugfs_path
);
1459 /* Modprobe lttng kernel modules */
1460 ret
= modprobe_kernel_modules();
1465 /* Setup lttng kernel path */
1466 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1468 perror("asprintf lttng path");
1472 /* Open debugfs lttng */
1473 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1474 if (kernel_tracer_fd
< 0) {
1475 DBG("Failed to open %s", lttng_path
);
1481 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1491 WARN("No kernel tracer available");
1492 kernel_tracer_fd
= 0;
1497 * Start tracing by creating trace directory and sending FDs to the kernel
1500 static int start_kernel_trace(struct ltt_kernel_session
*session
)
1504 if (session
->kconsumer_fds_sent
== 0) {
1506 * Assign default kernel consumer if no consumer assigned to the kernel
1507 * session. At this point, it's NOT suppose to be 0 but this is an extra
1510 if (session
->consumer_fd
== 0) {
1511 session
->consumer_fd
= kconsumerd_cmd_sock
;
1514 ret
= send_kconsumerd_fds(session
);
1516 ERR("Send kconsumerd fds failed");
1517 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1521 session
->kconsumer_fds_sent
= 1;
1529 * Notify kernel thread to update it's pollfd.
1531 static int notify_kernel_pollfd(void)
1535 /* Inform kernel thread of the new kernel channel */
1536 ret
= write(kernel_poll_pipe
[1], "!", 1);
1538 perror("write kernel poll pipe");
1545 * Allocate a channel structure and fill it.
1547 static struct lttng_channel
*init_default_channel(enum lttng_domain_type domain_type
,
1550 struct lttng_channel
*chan
;
1552 chan
= malloc(sizeof(struct lttng_channel
));
1554 perror("init channel malloc");
1558 if (snprintf(chan
->name
, NAME_MAX
, "%s", name
) < 0) {
1559 perror("snprintf channel name");
1563 chan
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1564 chan
->attr
.switch_timer_interval
= DEFAULT_CHANNEL_SWITCH_TIMER
;
1565 chan
->attr
.read_timer_interval
= DEFAULT_CHANNEL_READ_TIMER
;
1567 switch (domain_type
) {
1568 case LTTNG_DOMAIN_KERNEL
:
1569 chan
->attr
.subbuf_size
= DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
;
1570 chan
->attr
.num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1571 chan
->attr
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1575 goto error
; /* Not implemented */
1586 * Create an UST session and add it to the session ust list.
1588 static int create_ust_session(pid_t pid
, struct ltt_session
*session
)
1591 struct ltt_ust_session
*lus
;
1593 DBG("Creating UST session");
1595 lus
= trace_ust_create_session(session
->path
, pid
);
1600 ret
= mkdir_recursive(lus
->path
, S_IRWXU
| S_IRWXG
,
1601 geteuid(), allowed_group());
1603 if (ret
!= -EEXIST
) {
1604 ERR("Trace directory creation error");
1609 /* Create session on the UST tracer */
1610 ret
= ustctl_create_session(lus
);
1623 * Create a kernel tracer session then create the default channel.
1625 static int create_kernel_session(struct ltt_session
*session
)
1629 DBG("Creating kernel session");
1631 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1633 ret
= LTTCOMM_KERN_SESS_FAIL
;
1637 /* Set kernel consumer socket fd */
1638 if (kconsumerd_cmd_sock
) {
1639 session
->kernel_session
->consumer_fd
= kconsumerd_cmd_sock
;
1642 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1643 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1645 if (ret
!= -EEXIST
) {
1646 ERR("Trace directory creation error");
1656 * Using the session list, filled a lttng_session array to send back to the
1657 * client for session listing.
1659 * The session list lock MUST be acquired before calling this function. Use
1660 * lock_session_list() and unlock_session_list().
1662 static void list_lttng_sessions(struct lttng_session
*sessions
)
1665 struct ltt_session
*session
;
1667 DBG("Getting all available session");
1669 * Iterate over session list and append data after the control struct in
1672 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1673 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1674 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1675 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1676 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1682 * Fill lttng_channel array of all channels.
1684 static void list_lttng_channels(struct ltt_session
*session
,
1685 struct lttng_channel
*channels
)
1688 struct ltt_kernel_channel
*kchan
;
1690 DBG("Listing channels for session %s", session
->name
);
1692 /* Kernel channels */
1693 if (session
->kernel_session
!= NULL
) {
1694 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
, list
) {
1695 /* Copy lttng_channel struct to array */
1696 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1697 channels
[i
].enabled
= kchan
->enabled
;
1702 /* TODO: Missing UST listing */
1706 * Fill lttng_event array of all events in the channel.
1708 static void list_lttng_events(struct ltt_kernel_channel
*kchan
,
1709 struct lttng_event
*events
)
1712 * TODO: This is ONLY kernel. Need UST support.
1715 struct ltt_kernel_event
*event
;
1717 DBG("Listing events for channel %s", kchan
->channel
->name
);
1719 /* Kernel channels */
1720 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
1721 strncpy(events
[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
1722 events
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1723 events
[i
].enabled
= event
->enabled
;
1724 switch (event
->event
->instrumentation
) {
1725 case LTTNG_KERNEL_TRACEPOINT
:
1726 events
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
1728 case LTTNG_KERNEL_KPROBE
:
1729 case LTTNG_KERNEL_KRETPROBE
:
1730 events
[i
].type
= LTTNG_EVENT_PROBE
;
1731 memcpy(&events
[i
].attr
.probe
, &event
->event
->u
.kprobe
,
1732 sizeof(struct lttng_kernel_kprobe
));
1734 case LTTNG_KERNEL_FUNCTION
:
1735 events
[i
].type
= LTTNG_EVENT_FUNCTION
;
1736 memcpy(&events
[i
].attr
.ftrace
, &event
->event
->u
.ftrace
,
1737 sizeof(struct lttng_kernel_function
));
1745 * Process the command requested by the lttng client within the command
1746 * context structure. This function make sure that the return structure (llm)
1747 * is set and ready for transmission before returning.
1749 * Return any error encountered or 0 for success.
1751 static int process_client_msg(struct command_ctx
*cmd_ctx
)
1753 int ret
= LTTCOMM_OK
;
1755 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
1758 * Commands that DO NOT need a session.
1760 switch (cmd_ctx
->lsm
->cmd_type
) {
1761 case LTTNG_CREATE_SESSION
:
1762 case LTTNG_LIST_SESSIONS
:
1763 case LTTNG_LIST_TRACEPOINTS
:
1764 case LTTNG_CALIBRATE
:
1767 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
1768 cmd_ctx
->session
= find_session_by_name(cmd_ctx
->lsm
->session
.name
);
1769 if (cmd_ctx
->session
== NULL
) {
1770 /* If session name not found */
1771 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
1772 ret
= LTTCOMM_SESS_NOT_FOUND
;
1773 } else { /* If no session name specified */
1774 ret
= LTTCOMM_SELECT_SESS
;
1778 /* Acquire lock for the session */
1779 lock_session(cmd_ctx
->session
);
1785 * Check domain type for specific "pre-action".
1787 switch (cmd_ctx
->lsm
->domain
.type
) {
1788 case LTTNG_DOMAIN_KERNEL
:
1789 /* Kernel tracer check */
1790 if (kernel_tracer_fd
== 0) {
1791 init_kernel_tracer();
1792 if (kernel_tracer_fd
== 0) {
1793 ret
= LTTCOMM_KERN_NA
;
1797 /* Need a session for kernel command */
1798 switch (cmd_ctx
->lsm
->cmd_type
) {
1799 case LTTNG_CALIBRATE
:
1800 case LTTNG_CREATE_SESSION
:
1801 case LTTNG_LIST_SESSIONS
:
1802 case LTTNG_LIST_TRACEPOINTS
:
1805 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1806 ret
= create_kernel_session(cmd_ctx
->session
);
1808 ret
= LTTCOMM_KERN_SESS_FAIL
;
1811 /* Start the kernel consumer daemon */
1812 if (kconsumerd_pid
== 0 &&
1813 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1814 ret
= start_kconsumerd();
1822 case LTTNG_DOMAIN_UST_PID
:
1828 /* Process by command type */
1829 switch (cmd_ctx
->lsm
->cmd_type
) {
1830 case LTTNG_ADD_CONTEXT
:
1832 struct lttng_kernel_context kctx
;
1834 /* Setup lttng message with no payload */
1835 ret
= setup_lttng_msg(cmd_ctx
, 0);
1840 switch (cmd_ctx
->lsm
->domain
.type
) {
1841 case LTTNG_DOMAIN_KERNEL
:
1842 /* Create Kernel context */
1843 kctx
.ctx
= cmd_ctx
->lsm
->u
.context
.ctx
.ctx
;
1844 kctx
.u
.perf_counter
.type
= cmd_ctx
->lsm
->u
.context
.ctx
.u
.perf_counter
.type
;
1845 kctx
.u
.perf_counter
.config
= cmd_ctx
->lsm
->u
.context
.ctx
.u
.perf_counter
.config
;
1846 strncpy(kctx
.u
.perf_counter
.name
,
1847 cmd_ctx
->lsm
->u
.context
.ctx
.u
.perf_counter
.name
,
1848 LTTNG_SYMBOL_NAME_LEN
);
1849 kctx
.u
.perf_counter
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1851 /* Add kernel context to kernel tracer. See context.c */
1852 ret
= add_kernel_context(cmd_ctx
->session
->kernel_session
, &kctx
,
1853 cmd_ctx
->lsm
->u
.context
.event_name
,
1854 cmd_ctx
->lsm
->u
.context
.channel_name
);
1855 if (ret
!= LTTCOMM_OK
) {
1860 /* TODO: Userspace tracing */
1861 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1868 case LTTNG_DISABLE_CHANNEL
:
1870 struct ltt_kernel_channel
*kchan
;
1872 /* Setup lttng message with no payload */
1873 ret
= setup_lttng_msg(cmd_ctx
, 0);
1878 switch (cmd_ctx
->lsm
->domain
.type
) {
1879 case LTTNG_DOMAIN_KERNEL
:
1880 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.disable
.channel_name
,
1881 cmd_ctx
->session
->kernel_session
);
1882 if (kchan
== NULL
) {
1883 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1885 } else if (kchan
->enabled
== 1) {
1886 ret
= kernel_disable_channel(kchan
);
1888 if (ret
!= EEXIST
) {
1889 ret
= LTTCOMM_KERN_CHAN_DISABLE_FAIL
;
1894 kernel_wait_quiescent(kernel_tracer_fd
);
1897 /* TODO: Userspace tracing */
1898 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1905 case LTTNG_DISABLE_EVENT
:
1907 struct ltt_kernel_channel
*kchan
;
1908 struct ltt_kernel_event
*kevent
;
1910 /* Setup lttng message with no payload */
1911 ret
= setup_lttng_msg(cmd_ctx
, 0);
1916 switch (cmd_ctx
->lsm
->domain
.type
) {
1917 case LTTNG_DOMAIN_KERNEL
:
1918 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.disable
.channel_name
,
1919 cmd_ctx
->session
->kernel_session
);
1920 if (kchan
== NULL
) {
1921 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1925 kevent
= trace_kernel_get_event_by_name(cmd_ctx
->lsm
->u
.disable
.name
, kchan
);
1926 if (kevent
!= NULL
) {
1927 DBG("Disabling kernel event %s for channel %s.", kevent
->event
->name
,
1928 kchan
->channel
->name
);
1929 ret
= kernel_disable_event(kevent
);
1931 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
1936 kernel_wait_quiescent(kernel_tracer_fd
);
1939 /* TODO: Userspace tracing */
1940 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1947 case LTTNG_DISABLE_ALL_EVENT
:
1949 struct ltt_kernel_channel
*kchan
;
1950 struct ltt_kernel_event
*kevent
;
1952 /* Setup lttng message with no payload */
1953 ret
= setup_lttng_msg(cmd_ctx
, 0);
1958 switch (cmd_ctx
->lsm
->domain
.type
) {
1959 case LTTNG_DOMAIN_KERNEL
:
1960 DBG("Disabling all enabled kernel events");
1961 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.disable
.channel_name
,
1962 cmd_ctx
->session
->kernel_session
);
1963 if (kchan
== NULL
) {
1964 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1968 /* For each event in the kernel session */
1969 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
1970 DBG("Disabling kernel event %s for channel %s.",
1971 kevent
->event
->name
, kchan
->channel
->name
);
1972 ret
= kernel_disable_event(kevent
);
1978 /* Quiescent wait after event disable */
1979 kernel_wait_quiescent(kernel_tracer_fd
);
1982 /* TODO: Userspace tracing */
1983 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1990 case LTTNG_ENABLE_CHANNEL
:
1992 struct ltt_kernel_channel
*kchan
;
1994 /* Setup lttng message with no payload */
1995 ret
= setup_lttng_msg(cmd_ctx
, 0);
2000 switch (cmd_ctx
->lsm
->domain
.type
) {
2001 case LTTNG_DOMAIN_KERNEL
:
2002 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.enable
.channel_name
,
2003 cmd_ctx
->session
->kernel_session
);
2004 if (kchan
== NULL
) {
2005 /* Channel not found, creating it */
2006 DBG("Creating kernel channel");
2008 ret
= kernel_create_channel(cmd_ctx
->session
->kernel_session
,
2009 &cmd_ctx
->lsm
->u
.channel
.chan
,
2010 cmd_ctx
->session
->kernel_session
->trace_path
);
2012 ret
= LTTCOMM_KERN_CHAN_FAIL
;
2016 /* Notify kernel thread that there is a new channel */
2017 ret
= notify_kernel_pollfd();
2019 ret
= LTTCOMM_FATAL
;
2022 } else if (kchan
->enabled
== 0) {
2023 ret
= kernel_enable_channel(kchan
);
2025 if (ret
!= EEXIST
) {
2026 ret
= LTTCOMM_KERN_CHAN_ENABLE_FAIL
;
2032 kernel_wait_quiescent(kernel_tracer_fd
);
2034 case LTTNG_DOMAIN_UST_PID
:
2038 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2045 case LTTNG_ENABLE_EVENT
:
2048 struct ltt_kernel_channel
*kchan
;
2049 struct ltt_kernel_event
*kevent
;
2050 struct lttng_channel
*chan
;
2052 /* Setup lttng message with no payload */
2053 ret
= setup_lttng_msg(cmd_ctx
, 0);
2058 channel_name
= cmd_ctx
->lsm
->u
.enable
.channel_name
;
2060 switch (cmd_ctx
->lsm
->domain
.type
) {
2061 case LTTNG_DOMAIN_KERNEL
:
2062 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2063 cmd_ctx
->session
->kernel_session
);
2064 if (kchan
== NULL
) {
2065 DBG("Channel not found. Creating channel %s", channel_name
);
2067 chan
= init_default_channel(cmd_ctx
->lsm
->domain
.type
, channel_name
);
2069 ret
= LTTCOMM_FATAL
;
2073 ret
= kernel_create_channel(cmd_ctx
->session
->kernel_session
,
2074 chan
, cmd_ctx
->session
->kernel_session
->trace_path
);
2076 ret
= LTTCOMM_KERN_CHAN_FAIL
;
2079 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2080 cmd_ctx
->session
->kernel_session
);
2081 if (kchan
== NULL
) {
2082 ERR("Channel %s not found after creation. Internal error, giving up.",
2084 ret
= LTTCOMM_FATAL
;
2089 kevent
= trace_kernel_get_event_by_name(cmd_ctx
->lsm
->u
.enable
.event
.name
, kchan
);
2090 if (kevent
== NULL
) {
2091 DBG("Creating kernel event %s for channel %s.",
2092 cmd_ctx
->lsm
->u
.enable
.event
.name
, channel_name
);
2093 ret
= kernel_create_event(&cmd_ctx
->lsm
->u
.enable
.event
, kchan
);
2095 DBG("Enabling kernel event %s for channel %s.",
2096 kevent
->event
->name
, channel_name
);
2097 ret
= kernel_enable_event(kevent
);
2098 if (ret
== -EEXIST
) {
2099 ret
= LTTCOMM_KERN_EVENT_EXIST
;
2105 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2109 kernel_wait_quiescent(kernel_tracer_fd
);
2112 /* TODO: Userspace tracing */
2113 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2119 case LTTNG_ENABLE_ALL_EVENT
:
2123 struct ltt_kernel_channel
*kchan
;
2124 struct ltt_kernel_event
*kevent
;
2125 struct lttng_event
*event_list
;
2126 struct lttng_channel
*chan
;
2128 /* Setup lttng message with no payload */
2129 ret
= setup_lttng_msg(cmd_ctx
, 0);
2134 DBG("Enabling all kernel event");
2136 channel_name
= cmd_ctx
->lsm
->u
.enable
.channel_name
;
2138 switch (cmd_ctx
->lsm
->domain
.type
) {
2139 case LTTNG_DOMAIN_KERNEL
:
2140 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2141 cmd_ctx
->session
->kernel_session
);
2142 if (kchan
== NULL
) {
2143 DBG("Channel not found. Creating channel %s", channel_name
);
2145 chan
= init_default_channel(cmd_ctx
->lsm
->domain
.type
, channel_name
);
2147 ret
= LTTCOMM_FATAL
;
2151 ret
= kernel_create_channel(cmd_ctx
->session
->kernel_session
,
2152 chan
, cmd_ctx
->session
->kernel_session
->trace_path
);
2154 ret
= LTTCOMM_KERN_CHAN_FAIL
;
2157 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2158 cmd_ctx
->session
->kernel_session
);
2159 if (kchan
== NULL
) {
2160 ERR("Channel %s not found after creation. Internal error, giving up.",
2162 ret
= LTTCOMM_FATAL
;
2167 /* For each event in the kernel session */
2168 cds_list_for_each_entry(kevent
, &kchan
->events_list
.head
, list
) {
2169 DBG("Enabling kernel event %s for channel %s.",
2170 kevent
->event
->name
, channel_name
);
2171 ret
= kernel_enable_event(kevent
);
2177 size
= kernel_list_events(kernel_tracer_fd
, &event_list
);
2179 ret
= LTTCOMM_KERN_LIST_FAIL
;
2183 for (i
= 0; i
< size
; i
++) {
2184 kevent
= trace_kernel_get_event_by_name(event_list
[i
].name
, kchan
);
2185 if (kevent
== NULL
) {
2186 /* Default event type for enable all */
2187 event_list
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2188 /* Enable each single tracepoint event */
2189 ret
= kernel_create_event(&event_list
[i
], kchan
);
2191 /* Ignore error here and continue */
2198 /* Quiescent wait after event enable */
2199 kernel_wait_quiescent(kernel_tracer_fd
);
2202 /* TODO: Userspace tracing */
2203 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2210 case LTTNG_LIST_TRACEPOINTS
:
2212 struct lttng_event
*events
;
2213 ssize_t nb_events
= 0;
2215 switch (cmd_ctx
->lsm
->domain
.type
) {
2216 case LTTNG_DOMAIN_KERNEL
:
2217 DBG("Listing kernel events");
2218 nb_events
= kernel_list_events(kernel_tracer_fd
, &events
);
2219 if (nb_events
< 0) {
2220 ret
= LTTCOMM_KERN_LIST_FAIL
;
2225 /* TODO: Userspace listing */
2226 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2231 * Setup lttng message with payload size set to the event list size in
2232 * bytes and then copy list into the llm payload.
2234 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
2240 /* Copy event list into message payload */
2241 memcpy(cmd_ctx
->llm
->payload
, events
,
2242 sizeof(struct lttng_event
) * nb_events
);
2249 case LTTNG_START_TRACE
:
2251 struct ltt_kernel_channel
*chan
;
2253 /* Setup lttng message with no payload */
2254 ret
= setup_lttng_msg(cmd_ctx
, 0);
2259 /* Kernel tracing */
2260 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2261 if (cmd_ctx
->session
->kernel_session
->metadata
== NULL
) {
2262 DBG("Open kernel metadata");
2263 ret
= kernel_open_metadata(cmd_ctx
->session
->kernel_session
,
2264 cmd_ctx
->session
->kernel_session
->trace_path
);
2266 ret
= LTTCOMM_KERN_META_FAIL
;
2271 if (cmd_ctx
->session
->kernel_session
->metadata_stream_fd
== 0) {
2272 DBG("Opening kernel metadata stream");
2273 if (cmd_ctx
->session
->kernel_session
->metadata_stream_fd
== 0) {
2274 ret
= kernel_open_metadata_stream(cmd_ctx
->session
->kernel_session
);
2276 ERR("Kernel create metadata stream failed");
2277 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2283 /* For each channel */
2284 cds_list_for_each_entry(chan
,
2285 &cmd_ctx
->session
->kernel_session
->channel_list
.head
, list
) {
2286 if (chan
->stream_count
== 0) {
2287 ret
= kernel_open_channel_stream(chan
);
2289 ERR("Kernel create channel stream failed");
2290 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2293 /* Update the stream global counter */
2294 cmd_ctx
->session
->kernel_session
->stream_count_global
+= ret
;
2298 ret
= start_kernel_trace(cmd_ctx
->session
->kernel_session
);
2300 ret
= LTTCOMM_KERN_START_FAIL
;
2304 DBG("Start kernel tracing");
2305 ret
= kernel_start_session(cmd_ctx
->session
->kernel_session
);
2307 ERR("Kernel start session failed");
2308 ret
= LTTCOMM_KERN_START_FAIL
;
2312 /* Quiescent wait after starting trace */
2313 kernel_wait_quiescent(kernel_tracer_fd
);
2316 /* TODO: Start all UST traces */
2321 case LTTNG_STOP_TRACE
:
2323 struct ltt_kernel_channel
*chan
;
2324 /* Setup lttng message with no payload */
2325 ret
= setup_lttng_msg(cmd_ctx
, 0);
2331 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2332 DBG("Stop kernel tracing");
2334 ret
= kernel_metadata_flush_buffer(cmd_ctx
->session
->kernel_session
->metadata_stream_fd
);
2336 ERR("Kernel metadata flush failed");
2339 cds_list_for_each_entry(chan
, &cmd_ctx
->session
->kernel_session
->channel_list
.head
, list
) {
2340 ret
= kernel_flush_buffer(chan
);
2342 ERR("Kernel flush buffer error");
2346 ret
= kernel_stop_session(cmd_ctx
->session
->kernel_session
);
2348 ERR("Kernel stop session failed");
2349 ret
= LTTCOMM_KERN_STOP_FAIL
;
2353 /* Quiescent wait after stopping trace */
2354 kernel_wait_quiescent(kernel_tracer_fd
);
2357 /* TODO : User-space tracer */
2362 case LTTNG_CREATE_SESSION
:
2364 /* Setup lttng message with no payload */
2365 ret
= setup_lttng_msg(cmd_ctx
, 0);
2370 ret
= create_session(cmd_ctx
->lsm
->session
.name
, cmd_ctx
->lsm
->session
.path
);
2372 if (ret
== -EEXIST
) {
2373 ret
= LTTCOMM_EXIST_SESS
;
2375 ret
= LTTCOMM_FATAL
;
2383 case LTTNG_DESTROY_SESSION
:
2385 /* Setup lttng message with no payload */
2386 ret
= setup_lttng_msg(cmd_ctx
, 0);
2391 /* Clean kernel session teardown */
2392 teardown_kernel_session(cmd_ctx
->session
);
2394 ret
= destroy_session(cmd_ctx
->lsm
->session
.name
);
2396 ret
= LTTCOMM_FATAL
;
2401 * Must notify the kernel thread here to update it's pollfd in order to
2402 * remove the channel(s)' fd just destroyed.
2404 ret
= notify_kernel_pollfd();
2406 ret
= LTTCOMM_FATAL
;
2413 case LTTNG_LIST_DOMAINS
:
2417 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2421 nb_dom
+= cmd_ctx
->session
->ust_session_list
.count
;
2423 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_domain
) * nb_dom
);
2428 ((struct lttng_domain
*)(cmd_ctx
->llm
->payload
))[0].type
=
2429 LTTNG_DOMAIN_KERNEL
;
2431 /* TODO: User-space tracer domain support */
2435 case LTTNG_LIST_CHANNELS
:
2438 * TODO: Only kernel channels are listed here. UST listing
2439 * is needed on lttng-ust 2.0 release.
2442 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2443 nb_chan
+= cmd_ctx
->session
->kernel_session
->channel_count
;
2446 ret
= setup_lttng_msg(cmd_ctx
,
2447 sizeof(struct lttng_channel
) * nb_chan
);
2452 list_lttng_channels(cmd_ctx
->session
,
2453 (struct lttng_channel
*)(cmd_ctx
->llm
->payload
));
2458 case LTTNG_LIST_EVENTS
:
2461 * TODO: Only kernel events are listed here. UST listing
2462 * is needed on lttng-ust 2.0 release.
2464 size_t nb_event
= 0;
2465 struct ltt_kernel_channel
*kchan
= NULL
;
2467 if (cmd_ctx
->session
->kernel_session
!= NULL
) {
2468 kchan
= trace_kernel_get_channel_by_name(cmd_ctx
->lsm
->u
.list
.channel_name
,
2469 cmd_ctx
->session
->kernel_session
);
2470 if (kchan
== NULL
) {
2471 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2474 nb_event
+= kchan
->event_count
;
2477 ret
= setup_lttng_msg(cmd_ctx
,
2478 sizeof(struct lttng_event
) * nb_event
);
2483 DBG("Listing events (%zu events)", nb_event
);
2485 list_lttng_events(kchan
,
2486 (struct lttng_event
*)(cmd_ctx
->llm
->payload
));
2491 case LTTNG_LIST_SESSIONS
:
2493 lock_session_list();
2495 if (session_list_ptr
->count
== 0) {
2496 ret
= LTTCOMM_NO_SESSION
;
2497 unlock_session_list();
2501 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
2502 session_list_ptr
->count
);
2504 unlock_session_list();
2508 /* Filled the session array */
2509 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
2511 unlock_session_list();
2516 case LTTNG_CALIBRATE
:
2518 /* Setup lttng message with no payload */
2519 ret
= setup_lttng_msg(cmd_ctx
, 0);
2524 switch (cmd_ctx
->lsm
->domain
.type
) {
2525 case LTTNG_DOMAIN_KERNEL
:
2527 struct lttng_kernel_calibrate kcalibrate
;
2529 kcalibrate
.type
= cmd_ctx
->lsm
->u
.calibrate
.type
;
2530 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2532 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2538 /* TODO: Userspace tracing */
2539 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2545 case LTTNG_REGISTER_CONSUMER
:
2549 /* Setup lttng message with no payload */
2550 ret
= setup_lttng_msg(cmd_ctx
, 0);
2555 switch (cmd_ctx
->lsm
->domain
.type
) {
2556 case LTTNG_DOMAIN_KERNEL
:
2558 /* Can't register a consumer if there is already one */
2559 if (cmd_ctx
->session
->kernel_session
->consumer_fd
!= 0) {
2560 ret
= LTTCOMM_CONNECT_FAIL
;
2564 sock
= lttcomm_connect_unix_sock(cmd_ctx
->lsm
->u
.reg
.path
);
2566 ret
= LTTCOMM_CONNECT_FAIL
;
2570 cmd_ctx
->session
->kernel_session
->consumer_fd
= sock
;
2574 /* TODO: Userspace tracing */
2575 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2584 /* Undefined command */
2585 ret
= setup_lttng_msg(cmd_ctx
, 0);
2594 /* Set return code */
2595 cmd_ctx
->llm
->ret_code
= ret
;
2597 if (cmd_ctx
->session
) {
2598 unlock_session(cmd_ctx
->session
);
2604 if (cmd_ctx
->llm
== NULL
) {
2605 DBG("Missing llm structure. Allocating one.");
2606 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
2610 /* Notify client of error */
2611 cmd_ctx
->llm
->ret_code
= ret
;
2614 if (cmd_ctx
->session
) {
2615 unlock_session(cmd_ctx
->session
);
2621 * This thread manage all clients request using the unix client socket for
2624 static void *thread_manage_clients(void *data
)
2627 struct command_ctx
*cmd_ctx
= NULL
;
2628 struct pollfd pollfd
[2];
2630 DBG("[thread] Manage client started");
2632 ret
= lttcomm_listen_unix_sock(client_sock
);
2637 /* First fd is always the quit pipe */
2638 pollfd
[0].fd
= thread_quit_pipe
[0];
2640 POLLHUP
| POLLNVAL
| POLLERR
| POLLIN
| POLLRDHUP
| POLLPRI
;
2643 pollfd
[1].fd
= client_sock
;
2644 pollfd
[1].events
= POLLIN
;
2647 * Notify parent pid that we are ready to accept command for client side.
2649 if (opt_sig_parent
) {
2650 kill(ppid
, SIGCHLD
);
2654 DBG("Accepting client command ...");
2656 /* Inifinite blocking call, waiting for transmission */
2657 ret
= poll(pollfd
, 2, -1);
2659 perror("poll client thread");
2663 /* Thread quit pipe has been closed. Killing thread. */
2664 if (pollfd
[0].revents
== POLLNVAL
) {
2668 switch (pollfd
[1].revents
) {
2672 ERR("Client socket poll error");
2675 sock
= lttcomm_accept_unix_sock(client_sock
);
2680 /* Allocate context command to process the client request */
2681 cmd_ctx
= malloc(sizeof(struct command_ctx
));
2683 /* Allocate data buffer for reception */
2684 cmd_ctx
->lsm
= malloc(sizeof(struct lttcomm_session_msg
));
2685 cmd_ctx
->llm
= NULL
;
2686 cmd_ctx
->session
= NULL
;
2689 * Data is received from the lttng client. The struct
2690 * lttcomm_session_msg (lsm) contains the command and data request of
2693 DBG("Receiving data from client ...");
2694 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
, sizeof(struct lttcomm_session_msg
));
2699 // TODO: Validate cmd_ctx including sanity check for security purpose.
2702 * This function dispatch the work to the kernel or userspace tracer
2703 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2704 * informations for the client. The command context struct contains
2705 * everything this function may needs.
2707 ret
= process_client_msg(cmd_ctx
);
2709 /* TODO: Inform client somehow of the fatal error. At this point,
2710 * ret < 0 means that a malloc failed (ENOMEM). */
2711 /* Error detected but still accept command */
2712 clean_command_ctx(&cmd_ctx
);
2716 DBG("Sending response (size: %d, retcode: %d)",
2717 cmd_ctx
->lttng_msg_size
, cmd_ctx
->llm
->ret_code
);
2718 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
2720 ERR("Failed to send data back to client");
2723 clean_command_ctx(&cmd_ctx
);
2725 /* End of transmission */
2732 DBG("Client thread dying");
2740 unlink(client_unix_sock_path
);
2742 clean_command_ctx(&cmd_ctx
);
2748 * usage function on stderr
2750 static void usage(void)
2752 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
2753 fprintf(stderr
, " -h, --help Display this usage.\n");
2754 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
2755 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
2756 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
2757 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
2758 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
2759 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
2760 fprintf(stderr
, " -V, --version Show version number.\n");
2761 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
2762 fprintf(stderr
, " -q, --quiet No output at all.\n");
2763 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
2764 fprintf(stderr
, " --verbose-kconsumerd Verbose mode for kconsumerd. Activate DBG() macro.\n");
2768 * daemon argument parsing
2770 static int parse_args(int argc
, char **argv
)
2774 static struct option long_options
[] = {
2775 { "client-sock", 1, 0, 'c' },
2776 { "apps-sock", 1, 0, 'a' },
2777 { "kconsumerd-cmd-sock", 1, 0, 0 },
2778 { "kconsumerd-err-sock", 1, 0, 0 },
2779 { "daemonize", 0, 0, 'd' },
2780 { "sig-parent", 0, 0, 'S' },
2781 { "help", 0, 0, 'h' },
2782 { "group", 1, 0, 'g' },
2783 { "version", 0, 0, 'V' },
2784 { "quiet", 0, 0, 'q' },
2785 { "verbose", 0, 0, 'v' },
2786 { "verbose-kconsumerd", 0, 0, 'Z' },
2791 int option_index
= 0;
2792 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:E:C:Z", long_options
, &option_index
);
2799 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
2801 fprintf(stderr
, " with arg %s\n", optarg
);
2805 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2808 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2814 opt_tracing_group
= strdup(optarg
);
2820 fprintf(stdout
, "%s\n", VERSION
);
2826 snprintf(kconsumerd_err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2829 snprintf(kconsumerd_cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
2835 /* Verbose level can increase using multiple -v */
2839 opt_verbose_kconsumerd
+= 1;
2842 /* Unknown option or other error.
2843 * Error is printed by getopt, just return */
2852 * Creates the two needed socket by the daemon.
2853 * apps_sock - The communication socket for all UST apps.
2854 * client_sock - The communication of the cli tool (lttng).
2856 static int init_daemon_socket(void)
2861 old_umask
= umask(0);
2863 /* Create client tool unix socket */
2864 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
2865 if (client_sock
< 0) {
2866 ERR("Create unix sock failed: %s", client_unix_sock_path
);
2871 /* File permission MUST be 660 */
2872 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2874 ERR("Set file permissions failed: %s", client_unix_sock_path
);
2879 /* Create the application unix socket */
2880 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
2881 if (apps_sock
< 0) {
2882 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
2887 /* File permission MUST be 666 */
2888 ret
= chmod(apps_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
2890 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
2901 * Check if the global socket is available, and if a daemon is answering
2902 * at the other side. If yes, error is returned.
2904 static int check_existing_daemon(void)
2906 if (access(client_unix_sock_path
, F_OK
) < 0 &&
2907 access(apps_unix_sock_path
, F_OK
) < 0) {
2910 /* Is there anybody out there ? */
2911 if (lttng_session_daemon_alive()) {
2919 * Set the tracing group gid onto the client socket.
2921 * Race window between mkdir and chown is OK because we are going from more
2922 * permissive (root.root) to les permissive (root.tracing).
2924 static int set_permissions(void)
2929 gid
= allowed_group();
2932 WARN("No tracing group detected");
2935 ERR("Missing tracing group. Aborting execution.");
2941 /* Set lttng run dir */
2942 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
2944 ERR("Unable to set group on " LTTNG_RUNDIR
);
2948 /* lttng client socket path */
2949 ret
= chown(client_unix_sock_path
, 0, gid
);
2951 ERR("Unable to set group on %s", client_unix_sock_path
);
2955 /* kconsumerd error socket path */
2956 ret
= chown(kconsumerd_err_unix_sock_path
, 0, gid
);
2958 ERR("Unable to set group on %s", kconsumerd_err_unix_sock_path
);
2962 DBG("All permissions are set");
2969 * Create the pipe used to wake up the kernel thread.
2971 static int create_kernel_poll_pipe(void)
2973 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
2977 * Create the application command pipe to wake thread_manage_apps.
2979 static int create_apps_cmd_pipe(void)
2981 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
2985 * Create the lttng run directory needed for all global sockets and pipe.
2987 static int create_lttng_rundir(void)
2991 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
2993 if (errno
!= EEXIST
) {
2994 ERR("Unable to create " LTTNG_RUNDIR
);
3006 * Setup sockets and directory needed by the kconsumerd communication with the
3009 static int set_kconsumerd_sockets(void)
3013 if (strlen(kconsumerd_err_unix_sock_path
) == 0) {
3014 snprintf(kconsumerd_err_unix_sock_path
, PATH_MAX
, KCONSUMERD_ERR_SOCK_PATH
);
3017 if (strlen(kconsumerd_cmd_unix_sock_path
) == 0) {
3018 snprintf(kconsumerd_cmd_unix_sock_path
, PATH_MAX
, KCONSUMERD_CMD_SOCK_PATH
);
3021 ret
= mkdir(KCONSUMERD_PATH
, S_IRWXU
| S_IRWXG
);
3023 if (errno
!= EEXIST
) {
3024 ERR("Failed to create " KCONSUMERD_PATH
);
3030 /* Create the kconsumerd error unix socket */
3031 kconsumerd_err_sock
= lttcomm_create_unix_sock(kconsumerd_err_unix_sock_path
);
3032 if (kconsumerd_err_sock
< 0) {
3033 ERR("Create unix sock failed: %s", kconsumerd_err_unix_sock_path
);
3038 /* File permission MUST be 660 */
3039 ret
= chmod(kconsumerd_err_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3041 ERR("Set file permissions failed: %s", kconsumerd_err_unix_sock_path
);
3051 * Signal handler for the daemon
3053 * Simply stop all worker threads, leaving main() return gracefully
3054 * after joining all threads and calling cleanup().
3056 static void sighandler(int sig
)
3060 DBG("SIGPIPE catched");
3063 DBG("SIGINT catched");
3067 DBG("SIGTERM catched");
3076 * Setup signal handler for :
3077 * SIGINT, SIGTERM, SIGPIPE
3079 static int set_signal_handler(void)
3082 struct sigaction sa
;
3085 if ((ret
= sigemptyset(&sigset
)) < 0) {
3086 perror("sigemptyset");
3090 sa
.sa_handler
= sighandler
;
3091 sa
.sa_mask
= sigset
;
3093 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
3094 perror("sigaction");
3098 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
3099 perror("sigaction");
3103 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
3104 perror("sigaction");
3108 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3114 * Set open files limit to unlimited. This daemon can open a large number of
3115 * file descriptors in order to consumer multiple kernel traces.
3117 static void set_ulimit(void)
3122 /* The kernel does not allowed an infinite limit for open files */
3123 lim
.rlim_cur
= 65535;
3124 lim
.rlim_max
= 65535;
3126 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
3128 perror("failed to set open files limit");
3135 int main(int argc
, char **argv
)
3139 const char *home_path
;
3141 /* Create thread quit pipe */
3142 if ((ret
= init_thread_quit_pipe()) < 0) {
3146 /* Parse arguments */
3148 if ((ret
= parse_args(argc
, argv
) < 0)) {
3161 /* Check if daemon is UID = 0 */
3162 is_root
= !getuid();
3165 ret
= create_lttng_rundir();
3170 if (strlen(apps_unix_sock_path
) == 0) {
3171 snprintf(apps_unix_sock_path
, PATH_MAX
,
3172 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
3175 if (strlen(client_unix_sock_path
) == 0) {
3176 snprintf(client_unix_sock_path
, PATH_MAX
,
3177 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
3180 /* Set global SHM for ust */
3181 if (strlen(wait_shm_path
) == 0) {
3182 snprintf(wait_shm_path
, PATH_MAX
,
3183 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
3186 home_path
= get_home_dir();
3187 if (home_path
== NULL
) {
3188 /* TODO: Add --socket PATH option */
3189 ERR("Can't get HOME directory for sockets creation.");
3194 if (strlen(apps_unix_sock_path
) == 0) {
3195 snprintf(apps_unix_sock_path
, PATH_MAX
,
3196 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
3199 /* Set the cli tool unix socket path */
3200 if (strlen(client_unix_sock_path
) == 0) {
3201 snprintf(client_unix_sock_path
, PATH_MAX
,
3202 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
3205 /* Set global SHM for ust */
3206 if (strlen(wait_shm_path
) == 0) {
3207 snprintf(wait_shm_path
, PATH_MAX
,
3208 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
3212 DBG("Client socket path %s", client_unix_sock_path
);
3213 DBG("Application socket path %s", apps_unix_sock_path
);
3216 * See if daemon already exist.
3218 if ((ret
= check_existing_daemon()) < 0) {
3219 ERR("Already running daemon.\n");
3221 * We do not goto exit because we must not cleanup()
3222 * because a daemon is already running.
3227 /* After this point, we can safely call cleanup() so goto error is used */
3230 * These actions must be executed as root. We do that *after* setting up
3231 * the sockets path because we MUST make the check for another daemon using
3232 * those paths *before* trying to set the kernel consumer sockets and init
3236 ret
= set_kconsumerd_sockets();
3241 /* Setup kernel tracer */
3242 init_kernel_tracer();
3244 /* Set ulimit for open files */
3248 if ((ret
= set_signal_handler()) < 0) {
3252 /* Setup the needed unix socket */
3253 if ((ret
= init_daemon_socket()) < 0) {
3257 /* Set credentials to socket */
3258 if (is_root
&& ((ret
= set_permissions()) < 0)) {
3262 /* Get parent pid if -S, --sig-parent is specified. */
3263 if (opt_sig_parent
) {
3267 /* Setup the kernel pipe for waking up the kernel thread */
3268 if ((ret
= create_kernel_poll_pipe()) < 0) {
3272 /* Setup the thread apps communication pipe. */
3273 if ((ret
= create_apps_cmd_pipe()) < 0) {
3277 /* Init UST command queue. */
3278 cds_wfq_init(&ust_cmd_queue
.queue
);
3281 * Get session list pointer. This pointer MUST NOT be free().
3282 * This list is statically declared in session.c
3284 session_list_ptr
= get_session_list();
3286 /* Create thread to manage the client socket */
3287 ret
= pthread_create(&client_thread
, NULL
,
3288 thread_manage_clients
, (void *) NULL
);
3290 perror("pthread_create clients");
3294 /* Create thread to dispatch registration */
3295 ret
= pthread_create(&dispatch_thread
, NULL
,
3296 thread_dispatch_ust_registration
, (void *) NULL
);
3298 perror("pthread_create dispatch");
3302 /* Create thread to manage application registration. */
3303 ret
= pthread_create(®_apps_thread
, NULL
,
3304 thread_registration_apps
, (void *) NULL
);
3306 perror("pthread_create registration");
3310 /* Create thread to manage application socket */
3311 ret
= pthread_create(&apps_thread
, NULL
, thread_manage_apps
, (void *) NULL
);
3313 perror("pthread_create apps");
3317 /* Create kernel thread to manage kernel event */
3318 ret
= pthread_create(&kernel_thread
, NULL
, thread_manage_kernel
, (void *) NULL
);
3320 perror("pthread_create kernel");
3324 ret
= pthread_join(kernel_thread
, &status
);
3326 perror("pthread_join");
3327 goto error
; /* join error, exit without cleanup */
3331 ret
= pthread_join(apps_thread
, &status
);
3333 perror("pthread_join");
3334 goto error
; /* join error, exit without cleanup */
3338 ret
= pthread_join(reg_apps_thread
, &status
);
3340 perror("pthread_join");
3341 goto error
; /* join error, exit without cleanup */
3345 ret
= pthread_join(dispatch_thread
, &status
);
3347 perror("pthread_join");
3348 goto error
; /* join error, exit without cleanup */
3352 ret
= pthread_join(client_thread
, &status
);
3354 perror("pthread_join");
3355 goto error
; /* join error, exit without cleanup */
3358 ret
= join_kconsumerd_thread();
3360 perror("join_kconsumerd");
3361 goto error
; /* join error, exit without cleanup */
3367 * cleanup() is called when no other thread is running.