2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
40 #include <ltt-kconsumerd.h>
41 #include <lttng-sessiond-comm.h>
42 #include <lttng/lttng-kconsumerd.h>
46 #include "compat/poll.h"
50 #include "kernel-ctl.h"
51 #include "ltt-sessiond.h"
59 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
60 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
61 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
62 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
65 int opt_verbose
; /* Not static for lttngerr.h */
66 int opt_verbose_kconsumerd
; /* Not static for lttngerr.h */
67 int opt_quiet
; /* Not static for lttngerr.h */
70 const char *opt_tracing_group
;
71 static int opt_sig_parent
;
72 static int opt_daemon
;
73 static int is_root
; /* Set to 1 if the daemon is running as root */
74 static pid_t ppid
; /* Parent PID for --sig-parent option */
75 static pid_t kconsumerd_pid
;
76 static int dispatch_thread_exit
;
78 /* Global application Unix socket path */
79 static char apps_unix_sock_path
[PATH_MAX
];
80 /* Global client Unix socket path */
81 static char client_unix_sock_path
[PATH_MAX
];
82 /* kconsumerd error and command Unix socket path */
83 static char kconsumerd_err_unix_sock_path
[PATH_MAX
];
84 static char kconsumerd_cmd_unix_sock_path
[PATH_MAX
];
85 /* global wait shm path for UST */
86 static char wait_shm_path
[PATH_MAX
];
89 static int client_sock
;
91 static int kconsumerd_err_sock
;
92 static int kconsumerd_cmd_sock
;
93 static int kernel_tracer_fd
;
94 static int kernel_poll_pipe
[2];
97 * Quit pipe for all threads. This permits a single cancellation point
98 * for all threads when receiving an event on the pipe.
100 static int thread_quit_pipe
[2];
103 * This pipe is used to inform the thread managing application communication
104 * that a command is queued and ready to be processed.
106 static int apps_cmd_pipe
[2];
108 /* Pthread, Mutexes and Semaphores */
109 static pthread_t kconsumerd_thread
;
110 static pthread_t apps_thread
;
111 static pthread_t reg_apps_thread
;
112 static pthread_t client_thread
;
113 static pthread_t kernel_thread
;
114 static pthread_t dispatch_thread
;
115 static sem_t kconsumerd_sem
;
118 /* Mutex to control kconsumerd pid assignation */
119 static pthread_mutex_t kconsumerd_pid_mutex
;
122 * UST registration command queue. This queue is tied with a futex and uses a N
123 * wakers / 1 waiter implemented and detailed in futex.c/.h
125 * The thread_manage_apps and thread_dispatch_ust_registration interact with
126 * this queue and the wait/wake scheme.
128 static struct ust_cmd_queue ust_cmd_queue
;
131 * Pointer initialized before thread creation.
133 * This points to the tracing session list containing the session count and a
134 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
135 * MUST NOT be taken if you call a public function in session.c.
137 * The lock is nested inside the structure: session_list_ptr->lock. Please use
138 * session_lock_list and session_unlock_list for lock acquisition.
140 static struct ltt_session_list
*session_list_ptr
;
143 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
145 static int create_thread_poll_set(struct lttng_poll_event
*events
,
150 if (events
== NULL
|| size
== 0) {
155 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
161 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
173 * Check if the thread quit pipe was triggered.
175 * Return 1 if it was triggered else 0;
177 static int check_thread_quit_pipe(int fd
, uint32_t events
)
179 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
187 * Remove modules in reverse load order.
189 static int modprobe_remove_kernel_modules(void)
194 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
195 ret
= snprintf(modprobe
, sizeof(modprobe
),
196 "/sbin/modprobe --remove --quiet %s",
197 kernel_modules_list
[i
].name
);
199 perror("snprintf modprobe --remove");
202 modprobe
[sizeof(modprobe
) - 1] = '\0';
203 ret
= system(modprobe
);
205 ERR("Unable to launch modprobe --remove for module %s",
206 kernel_modules_list
[i
].name
);
207 } else if (kernel_modules_list
[i
].required
208 && WEXITSTATUS(ret
) != 0) {
209 ERR("Unable to remove module %s",
210 kernel_modules_list
[i
].name
);
212 DBG("Modprobe removal successful %s",
213 kernel_modules_list
[i
].name
);
222 * Return group ID of the tracing group or -1 if not found.
224 static gid_t
allowed_group(void)
228 if (opt_tracing_group
) {
229 grp
= getgrnam(opt_tracing_group
);
231 grp
= getgrnam(default_tracing_group
);
241 * Init thread quit pipe.
243 * Return -1 on error or 0 if all pipes are created.
245 static int init_thread_quit_pipe(void)
249 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
251 perror("thread quit pipe");
260 * Complete teardown of a kernel session. This free all data structure related
261 * to a kernel session and update counter.
263 static void teardown_kernel_session(struct ltt_session
*session
)
265 if (session
->kernel_session
!= NULL
) {
266 DBG("Tearing down kernel session");
269 * If a custom kernel consumer was registered, close the socket before
270 * tearing down the complete kernel session structure
272 if (session
->kernel_session
->consumer_fd
!= kconsumerd_cmd_sock
) {
273 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
276 trace_kernel_destroy_session(session
->kernel_session
);
277 /* Extra precaution */
278 session
->kernel_session
= NULL
;
283 * Stop all threads by closing the thread quit pipe.
285 static void stop_threads(void)
289 /* Stopping all threads */
290 DBG("Terminating all threads");
291 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
293 ERR("write error on thread quit pipe");
296 /* Dispatch thread */
297 dispatch_thread_exit
= 1;
298 futex_nto1_wake(&ust_cmd_queue
.futex
);
304 static void cleanup(void)
308 struct ltt_session
*sess
, *stmp
;
313 MSG("%c[%d;%dm*** assert failed *** ==> %c[%dm%c[%d;%dm"
314 "Matthew, BEET driven development works!%c[%dm",
315 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
319 DBG("Removing %s directory", LTTNG_RUNDIR
);
320 ret
= asprintf(&cmd
, "rm -rf " LTTNG_RUNDIR
);
322 ERR("asprintf failed. Something is really wrong!");
325 /* Remove lttng run directory */
328 ERR("Unable to clean " LTTNG_RUNDIR
);
332 DBG("Cleaning up all session");
334 /* Destroy session list mutex */
335 if (session_list_ptr
!= NULL
) {
336 pthread_mutex_destroy(&session_list_ptr
->lock
);
338 /* Cleanup ALL session */
339 cds_list_for_each_entry_safe(sess
, stmp
,
340 &session_list_ptr
->head
, list
) {
341 teardown_kernel_session(sess
);
342 // TODO complete session cleanup (including UST)
346 DBG("Closing all UST sockets");
347 ust_app_clean_list();
349 pthread_mutex_destroy(&kconsumerd_pid_mutex
);
351 DBG("Closing kernel fd");
352 close(kernel_tracer_fd
);
355 DBG("Unloading kernel modules");
356 modprobe_remove_kernel_modules();
359 close(thread_quit_pipe
[0]);
360 close(thread_quit_pipe
[1]);
364 * Send data on a unix socket using the liblttsessiondcomm API.
366 * Return lttcomm error code.
368 static int send_unix_sock(int sock
, void *buf
, size_t len
)
370 /* Check valid length */
375 return lttcomm_send_unix_sock(sock
, buf
, len
);
379 * Free memory of a command context structure.
381 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
383 DBG("Clean command context structure");
385 if ((*cmd_ctx
)->llm
) {
386 free((*cmd_ctx
)->llm
);
388 if ((*cmd_ctx
)->lsm
) {
389 free((*cmd_ctx
)->lsm
);
397 * Send all stream fds of kernel channel to the consumer.
399 static int send_kconsumerd_channel_fds(int sock
,
400 struct ltt_kernel_channel
*channel
)
404 struct ltt_kernel_stream
*stream
;
405 struct lttcomm_kconsumerd_header lkh
;
406 struct lttcomm_kconsumerd_msg lkm
;
408 DBG("Sending fds of channel %s to kernel consumer",
409 channel
->channel
->name
);
411 nb_fd
= channel
->stream_count
;
414 lkh
.payload_size
= nb_fd
* sizeof(struct lttcomm_kconsumerd_msg
);
415 lkh
.cmd_type
= ADD_STREAM
;
417 DBG("Sending kconsumerd header");
419 ret
= lttcomm_send_unix_sock(sock
, &lkh
,
420 sizeof(struct lttcomm_kconsumerd_header
));
422 perror("send kconsumerd header");
426 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
427 if (stream
->fd
!= 0) {
429 lkm
.state
= stream
->state
;
430 lkm
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
431 lkm
.output
= channel
->channel
->attr
.output
;
432 strncpy(lkm
.path_name
, stream
->pathname
, PATH_MAX
);
433 lkm
.path_name
[PATH_MAX
- 1] = '\0';
435 DBG("Sending fd %d to kconsumerd", lkm
.fd
);
437 ret
= lttcomm_send_fds_unix_sock(sock
, &lkm
,
438 &lkm
.fd
, 1, sizeof(lkm
));
440 perror("send kconsumerd fd");
446 DBG("Kconsumerd channel fds sent");
455 * Send all stream fds of the kernel session to the consumer.
457 static int send_kconsumerd_fds(struct ltt_kernel_session
*session
)
460 struct ltt_kernel_channel
*chan
;
461 struct lttcomm_kconsumerd_header lkh
;
462 struct lttcomm_kconsumerd_msg lkm
;
465 lkh
.payload_size
= sizeof(struct lttcomm_kconsumerd_msg
);
466 lkh
.cmd_type
= ADD_STREAM
;
468 DBG("Sending kconsumerd header for metadata");
470 ret
= lttcomm_send_unix_sock(session
->consumer_fd
, &lkh
,
471 sizeof(struct lttcomm_kconsumerd_header
));
473 perror("send kconsumerd header");
477 DBG("Sending metadata stream fd");
479 /* Extra protection. It's NOT suppose to be set to 0 at this point */
480 if (session
->consumer_fd
== 0) {
481 session
->consumer_fd
= kconsumerd_cmd_sock
;
484 if (session
->metadata_stream_fd
!= 0) {
485 /* Send metadata stream fd first */
486 lkm
.fd
= session
->metadata_stream_fd
;
487 lkm
.state
= ACTIVE_FD
;
488 lkm
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
489 lkm
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
490 strncpy(lkm
.path_name
, session
->metadata
->pathname
, PATH_MAX
);
491 lkm
.path_name
[PATH_MAX
- 1] = '\0';
493 ret
= lttcomm_send_fds_unix_sock(session
->consumer_fd
, &lkm
,
494 &lkm
.fd
, 1, sizeof(lkm
));
496 perror("send kconsumerd fd");
501 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
502 ret
= send_kconsumerd_channel_fds(session
->consumer_fd
, chan
);
508 DBG("Kconsumerd fds (metadata and channel streams) sent");
517 * Notify UST applications using the shm mmap futex.
519 static int notify_ust_apps(int active
)
523 DBG("Notifying applications of session daemon state: %d", active
);
525 /* See shm.c for this call implying mmap, shm and futex calls */
526 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
527 if (wait_shm_mmap
== NULL
) {
531 /* Wake waiting process */
532 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
534 /* Apps notified successfully */
542 * Setup the outgoing data buffer for the response (llm) by allocating the
543 * right amount of memory and copying the original information from the lsm
546 * Return total size of the buffer pointed by buf.
548 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
554 cmd_ctx
->llm
= malloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
555 if (cmd_ctx
->llm
== NULL
) {
561 /* Copy common data */
562 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
563 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
565 cmd_ctx
->llm
->data_size
= size
;
566 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
575 * Update the kernel poll set of all channel fd available over all tracing
576 * session. Add the wakeup pipe at the end of the set.
578 static int update_kernel_poll(struct lttng_poll_event
*events
)
581 struct ltt_session
*session
;
582 struct ltt_kernel_channel
*channel
;
584 DBG("Updating kernel poll set");
587 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
588 session_lock(session
);
589 if (session
->kernel_session
== NULL
) {
590 session_unlock(session
);
594 cds_list_for_each_entry(channel
,
595 &session
->kernel_session
->channel_list
.head
, list
) {
596 /* Add channel fd to the kernel poll set */
597 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
599 session_unlock(session
);
602 DBG("Channel fd %d added to kernel set", channel
->fd
);
604 session_unlock(session
);
606 session_unlock_list();
611 session_unlock_list();
616 * Find the channel fd from 'fd' over all tracing session. When found, check
617 * for new channel stream and send those stream fds to the kernel consumer.
619 * Useful for CPU hotplug feature.
621 static int update_kernel_stream(int fd
)
624 struct ltt_session
*session
;
625 struct ltt_kernel_channel
*channel
;
627 DBG("Updating kernel streams for channel fd %d", fd
);
630 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
631 session_lock(session
);
632 if (session
->kernel_session
== NULL
) {
633 session_unlock(session
);
637 /* This is not suppose to be 0 but this is an extra security check */
638 if (session
->kernel_session
->consumer_fd
== 0) {
639 session
->kernel_session
->consumer_fd
= kconsumerd_cmd_sock
;
642 cds_list_for_each_entry(channel
,
643 &session
->kernel_session
->channel_list
.head
, list
) {
644 if (channel
->fd
== fd
) {
645 DBG("Channel found, updating kernel streams");
646 ret
= kernel_open_channel_stream(channel
);
652 * Have we already sent fds to the consumer? If yes, it means
653 * that tracing is started so it is safe to send our updated
656 if (session
->kernel_session
->kconsumer_fds_sent
== 1) {
657 ret
= send_kconsumerd_channel_fds(
658 session
->kernel_session
->consumer_fd
, channel
);
666 session_unlock(session
);
668 session_unlock_list();
672 session_unlock(session
);
673 session_unlock_list();
678 * This thread manage event coming from the kernel.
680 * Features supported in this thread:
683 static void *thread_manage_kernel(void *data
)
685 int ret
, i
, pollfd
, update_poll_flag
= 1;
686 uint32_t revents
, nb_fd
;
688 struct lttng_poll_event events
;
690 DBG("Thread manage kernel started");
692 ret
= create_thread_poll_set(&events
, 2);
697 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
703 if (update_poll_flag
== 1) {
705 * Reset number of fd in the poll set. Always 2 since there is the thread
706 * quit pipe and the kernel pipe.
710 ret
= update_kernel_poll(&events
);
714 update_poll_flag
= 0;
717 nb_fd
= LTTNG_POLL_GETNB(&events
);
719 DBG("Thread kernel polling on %d fds", nb_fd
);
721 /* Zeroed the poll events */
722 lttng_poll_reset(&events
);
724 /* Poll infinite value of time */
725 ret
= lttng_poll_wait(&events
, -1);
728 } else if (ret
== 0) {
729 /* Should not happen since timeout is infinite */
730 ERR("Return value of poll is 0 with an infinite timeout.\n"
731 "This should not have happened! Continuing...");
735 for (i
= 0; i
< nb_fd
; i
++) {
736 /* Fetch once the poll data */
737 revents
= LTTNG_POLL_GETEV(&events
, i
);
738 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
740 /* Thread quit pipe has been closed. Killing thread. */
741 ret
= check_thread_quit_pipe(pollfd
, revents
);
746 /* Check for data on kernel pipe */
747 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
748 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
749 update_poll_flag
= 1;
753 * New CPU detected by the kernel. Adding kernel stream to
754 * kernel session and updating the kernel consumer
756 if (revents
& LPOLLIN
) {
757 ret
= update_kernel_stream(pollfd
);
763 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
764 * and unregister kernel stream at this point.
772 DBG("Kernel thread dying");
773 close(kernel_poll_pipe
[0]);
774 close(kernel_poll_pipe
[1]);
776 lttng_poll_clean(&events
);
782 * This thread manage the kconsumerd error sent back to the session daemon.
784 static void *thread_manage_kconsumerd(void *data
)
786 int sock
= 0, i
, ret
, pollfd
;
787 uint32_t revents
, nb_fd
;
788 enum lttcomm_return_code code
;
789 struct lttng_poll_event events
;
791 DBG("[thread] Manage kconsumerd started");
793 ret
= lttcomm_listen_unix_sock(kconsumerd_err_sock
);
799 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
800 * Nothing more will be added to this poll set.
802 ret
= create_thread_poll_set(&events
, 2);
807 ret
= lttng_poll_add(&events
, kconsumerd_err_sock
, LPOLLIN
| LPOLLRDHUP
);
812 nb_fd
= LTTNG_POLL_GETNB(&events
);
814 /* Inifinite blocking call, waiting for transmission */
815 ret
= lttng_poll_wait(&events
, -1);
820 for (i
= 0; i
< nb_fd
; i
++) {
821 /* Fetch once the poll data */
822 revents
= LTTNG_POLL_GETEV(&events
, i
);
823 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
825 /* Thread quit pipe has been closed. Killing thread. */
826 ret
= check_thread_quit_pipe(pollfd
, revents
);
831 /* Event on the registration socket */
832 if (pollfd
== kconsumerd_err_sock
) {
833 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
834 ERR("Kconsumerd err socket poll error");
840 sock
= lttcomm_accept_unix_sock(kconsumerd_err_sock
);
845 DBG2("Receiving code from kconsumerd_err_sock");
847 /* Getting status code from kconsumerd */
848 ret
= lttcomm_recv_unix_sock(sock
, &code
,
849 sizeof(enum lttcomm_return_code
));
854 if (code
== KCONSUMERD_COMMAND_SOCK_READY
) {
855 kconsumerd_cmd_sock
=
856 lttcomm_connect_unix_sock(kconsumerd_cmd_unix_sock_path
);
857 if (kconsumerd_cmd_sock
< 0) {
858 sem_post(&kconsumerd_sem
);
859 perror("kconsumerd connect");
862 /* Signal condition to tell that the kconsumerd is ready */
863 sem_post(&kconsumerd_sem
);
864 DBG("Kconsumerd command socket ready");
866 ERR("Kconsumerd error when waiting for SOCK_READY : %s",
867 lttcomm_get_readable_code(-code
));
871 /* Remove the kconsumerd error sock since we've established a connexion */
872 ret
= lttng_poll_del(&events
, kconsumerd_err_sock
);
877 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
882 /* Update number of fd */
883 nb_fd
= LTTNG_POLL_GETNB(&events
);
885 /* Inifinite blocking call, waiting for transmission */
886 ret
= lttng_poll_wait(&events
, -1);
891 for (i
= 0; i
< nb_fd
; i
++) {
892 /* Fetch once the poll data */
893 revents
= LTTNG_POLL_GETEV(&events
, i
);
894 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
896 /* Thread quit pipe has been closed. Killing thread. */
897 ret
= check_thread_quit_pipe(pollfd
, revents
);
902 /* Event on the kconsumerd socket */
903 if (pollfd
== sock
) {
904 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
905 ERR("Kconsumerd err socket second poll error");
911 /* Wait for any kconsumerd error */
912 ret
= lttcomm_recv_unix_sock(sock
, &code
,
913 sizeof(enum lttcomm_return_code
));
915 ERR("Kconsumerd closed the command socket");
919 ERR("Kconsumerd return code : %s", lttcomm_get_readable_code(-code
));
922 DBG("Kconsumerd thread dying");
923 close(kconsumerd_err_sock
);
924 close(kconsumerd_cmd_sock
);
927 unlink(kconsumerd_err_unix_sock_path
);
928 unlink(kconsumerd_cmd_unix_sock_path
);
931 lttng_poll_clean(&events
);
937 * This thread manage application communication.
939 static void *thread_manage_apps(void *data
)
942 uint32_t revents
, nb_fd
;
943 struct ust_command ust_cmd
;
944 struct lttng_poll_event events
;
946 DBG("[thread] Manage application started");
948 ret
= create_thread_poll_set(&events
, 2);
953 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
959 /* Zeroed the events structure */
960 lttng_poll_reset(&events
);
962 nb_fd
= LTTNG_POLL_GETNB(&events
);
964 DBG("Apps thread polling on %d fds", nb_fd
);
966 /* Inifinite blocking call, waiting for transmission */
967 ret
= lttng_poll_wait(&events
, -1);
972 for (i
= 0; i
< nb_fd
; i
++) {
973 /* Fetch once the poll data */
974 revents
= LTTNG_POLL_GETEV(&events
, i
);
975 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
977 /* Thread quit pipe has been closed. Killing thread. */
978 ret
= check_thread_quit_pipe(pollfd
, revents
);
983 /* Inspect the apps cmd pipe */
984 if (pollfd
== apps_cmd_pipe
[0]) {
985 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
986 ERR("Apps command pipe error");
988 } else if (revents
& LPOLLIN
) {
990 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
991 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
992 perror("read apps cmd pipe");
996 /* Register applicaton to the session daemon */
997 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1000 /* Only critical ENOMEM error can be returned here */
1004 ret
= ustctl_register_done(ust_cmd
.sock
);
1007 * If the registration is not possible, we simply
1008 * unregister the apps and continue
1010 ust_app_unregister(ust_cmd
.sock
);
1013 * We just need here to monitor the close of the UST
1014 * socket and poll set monitor those by default.
1016 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1021 DBG("Apps with sock %d added to poll set",
1028 * At this point, we know that a registered application made
1029 * the event at poll_wait.
1031 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1032 /* Removing from the poll set */
1033 ret
= lttng_poll_del(&events
, pollfd
);
1039 ust_app_unregister(pollfd
);
1047 DBG("Application communication apps dying");
1048 close(apps_cmd_pipe
[0]);
1049 close(apps_cmd_pipe
[1]);
1051 lttng_poll_clean(&events
);
1057 * Dispatch request from the registration threads to the application
1058 * communication thread.
1060 static void *thread_dispatch_ust_registration(void *data
)
1063 struct cds_wfq_node
*node
;
1064 struct ust_command
*ust_cmd
= NULL
;
1066 DBG("[thread] Dispatch UST command started");
1068 while (!dispatch_thread_exit
) {
1069 /* Atomically prepare the queue futex */
1070 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1073 /* Dequeue command for registration */
1074 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1076 DBG("Waked up but nothing in the UST command queue");
1077 /* Continue thread execution */
1081 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1083 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1084 " gid:%d sock:%d name:%s (version %d.%d)",
1085 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1086 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1087 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1088 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1090 * Inform apps thread of the new application registration. This
1091 * call is blocking so we can be assured that the data will be read
1092 * at some point in time or wait to the end of the world :)
1094 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1095 sizeof(struct ust_command
));
1097 perror("write apps cmd pipe");
1098 if (errno
== EBADF
) {
1100 * We can't inform the application thread to process
1101 * registration. We will exit or else application
1102 * registration will not occur and tracing will never
1109 } while (node
!= NULL
);
1111 /* Futex wait on queue. Blocking call on futex() */
1112 futex_nto1_wait(&ust_cmd_queue
.futex
);
1116 DBG("Dispatch thread dying");
1121 * This thread manage application registration.
1123 static void *thread_registration_apps(void *data
)
1125 int sock
= 0, i
, ret
, pollfd
;
1126 uint32_t revents
, nb_fd
;
1127 struct lttng_poll_event events
;
1129 * Get allocated in this thread, enqueued to a global queue, dequeued and
1130 * freed in the manage apps thread.
1132 struct ust_command
*ust_cmd
= NULL
;
1134 DBG("[thread] Manage application registration started");
1136 ret
= lttcomm_listen_unix_sock(apps_sock
);
1142 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1143 * more will be added to this poll set.
1145 ret
= create_thread_poll_set(&events
, 2);
1150 /* Add the application registration socket */
1151 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1156 /* Notify all applications to register */
1157 ret
= notify_ust_apps(1);
1159 ERR("Failed to notify applications or create the wait shared memory.\n"
1160 "Execution continues but there might be problem for already\n"
1161 "running applications that wishes to register.");
1165 DBG("Accepting application registration");
1167 nb_fd
= LTTNG_POLL_GETNB(&events
);
1169 /* Inifinite blocking call, waiting for transmission */
1170 ret
= lttng_poll_wait(&events
, -1);
1175 for (i
= 0; i
< nb_fd
; i
++) {
1176 /* Fetch once the poll data */
1177 revents
= LTTNG_POLL_GETEV(&events
, i
);
1178 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1180 /* Thread quit pipe has been closed. Killing thread. */
1181 ret
= check_thread_quit_pipe(pollfd
, revents
);
1186 /* Event on the registration socket */
1187 if (pollfd
== apps_sock
) {
1188 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1189 ERR("Register apps socket poll error");
1191 } else if (revents
& LPOLLIN
) {
1192 sock
= lttcomm_accept_unix_sock(apps_sock
);
1197 /* Create UST registration command for enqueuing */
1198 ust_cmd
= malloc(sizeof(struct ust_command
));
1199 if (ust_cmd
== NULL
) {
1200 perror("ust command malloc");
1205 * Using message-based transmissions to ensure we don't
1206 * have to deal with partially received messages.
1208 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1209 sizeof(struct ust_register_msg
));
1210 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1212 perror("lttcomm_recv_unix_sock register apps");
1214 ERR("Wrong size received on apps register");
1221 ust_cmd
->sock
= sock
;
1223 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1224 " gid:%d sock:%d name:%s (version %d.%d)",
1225 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1226 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1227 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1228 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1231 * Lock free enqueue the registration request. The red pill
1232 * has been taken! This apps will be part of the *system*.
1234 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1237 * Wake the registration queue futex. Implicit memory
1238 * barrier with the exchange in cds_wfq_enqueue.
1240 futex_nto1_wake(&ust_cmd_queue
.futex
);
1247 DBG("UST Registration thread dying");
1249 /* Notify that the registration thread is gone */
1254 unlink(apps_unix_sock_path
);
1256 lttng_poll_clean(&events
);
1262 * Start the thread_manage_kconsumerd. This must be done after a kconsumerd
1263 * exec or it will fails.
1265 static int spawn_kconsumerd_thread(void)
1268 struct timespec timeout
;
1270 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1271 timeout
.tv_nsec
= 0;
1273 /* Setup semaphore */
1274 ret
= sem_init(&kconsumerd_sem
, 0, 0);
1276 PERROR("sem_init kconsumerd_sem");
1280 ret
= pthread_create(&kconsumerd_thread
, NULL
,
1281 thread_manage_kconsumerd
, (void *) NULL
);
1283 PERROR("pthread_create kconsumerd");
1288 /* Get time for sem_timedwait absolute timeout */
1289 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1291 PERROR("clock_gettime spawn kconsumerd");
1292 /* Infinite wait for the kconsumerd thread to be ready */
1293 ret
= sem_wait(&kconsumerd_sem
);
1295 /* Normal timeout if the gettime was successful */
1296 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1297 ret
= sem_timedwait(&kconsumerd_sem
, &timeout
);
1301 if (errno
== ETIMEDOUT
) {
1303 * Call has timed out so we kill the kconsumerd_thread and return
1306 ERR("The kconsumerd thread was never ready. Killing it");
1307 ret
= pthread_cancel(kconsumerd_thread
);
1309 PERROR("pthread_cancel kconsumerd_thread");
1312 PERROR("semaphore wait failed kconsumerd thread");
1317 pthread_mutex_lock(&kconsumerd_pid_mutex
);
1318 if (kconsumerd_pid
== 0) {
1319 ERR("Kconsumerd did not start");
1320 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1323 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1332 * Join kernel consumer thread
1334 static int join_kconsumerd_thread(void)
1339 if (kconsumerd_pid
!= 0) {
1340 ret
= kill(kconsumerd_pid
, SIGTERM
);
1342 ERR("Error killing kconsumerd");
1345 return pthread_join(kconsumerd_thread
, &status
);
1352 * Fork and exec a kernel consumer daemon (kconsumerd).
1354 * Return pid if successful else -1.
1356 static pid_t
spawn_kconsumerd(void)
1360 const char *verbosity
;
1362 DBG("Spawning kconsumerd");
1369 if (opt_verbose
> 1 || opt_verbose_kconsumerd
) {
1370 verbosity
= "--verbose";
1372 verbosity
= "--quiet";
1374 execl(INSTALL_BIN_PATH
"/ltt-kconsumerd",
1375 "ltt-kconsumerd", verbosity
, NULL
);
1377 perror("kernel start consumer exec");
1380 } else if (pid
> 0) {
1384 perror("kernel start consumer fork");
1394 * Spawn the kconsumerd daemon and session daemon thread.
1396 static int start_kconsumerd(void)
1400 pthread_mutex_lock(&kconsumerd_pid_mutex
);
1401 if (kconsumerd_pid
!= 0) {
1402 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1406 ret
= spawn_kconsumerd();
1408 ERR("Spawning kconsumerd failed");
1409 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1413 /* Setting up the global kconsumerd_pid */
1414 kconsumerd_pid
= ret
;
1415 DBG2("Kconsumerd pid %d", kconsumerd_pid
);
1416 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
1418 DBG2("Spawning kconsumerd thread");
1419 ret
= spawn_kconsumerd_thread();
1421 ERR("Fatal error spawning kconsumerd thread");
1433 * modprobe_kernel_modules
1435 static int modprobe_kernel_modules(void)
1440 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1441 ret
= snprintf(modprobe
, sizeof(modprobe
),
1442 "/sbin/modprobe %s%s",
1443 kernel_modules_list
[i
].required
? "" : "--quiet ",
1444 kernel_modules_list
[i
].name
);
1446 perror("snprintf modprobe");
1449 modprobe
[sizeof(modprobe
) - 1] = '\0';
1450 ret
= system(modprobe
);
1452 ERR("Unable to launch modprobe for module %s",
1453 kernel_modules_list
[i
].name
);
1454 } else if (kernel_modules_list
[i
].required
1455 && WEXITSTATUS(ret
) != 0) {
1456 ERR("Unable to load module %s",
1457 kernel_modules_list
[i
].name
);
1459 DBG("Modprobe successfully %s",
1460 kernel_modules_list
[i
].name
);
1471 static int mount_debugfs(char *path
)
1474 char *type
= "debugfs";
1476 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1478 PERROR("Cannot create debugfs path");
1482 ret
= mount(type
, path
, type
, 0, NULL
);
1484 PERROR("Cannot mount debugfs");
1488 DBG("Mounted debugfs successfully at %s", path
);
1495 * Setup necessary data for kernel tracer action.
1497 static void init_kernel_tracer(void)
1500 char *proc_mounts
= "/proc/mounts";
1502 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1505 /* Detect debugfs */
1506 fp
= fopen(proc_mounts
, "r");
1508 ERR("Unable to probe %s", proc_mounts
);
1512 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1513 if (strstr(line
, "debugfs") != NULL
) {
1514 /* Remove first string */
1516 /* Dup string here so we can reuse line later on */
1517 debugfs_path
= strdup(strtok(NULL
, " "));
1518 DBG("Got debugfs path : %s", debugfs_path
);
1525 /* Mount debugfs if needded */
1526 if (debugfs_path
== NULL
) {
1527 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1529 perror("asprintf debugfs path");
1532 ret
= mount_debugfs(debugfs_path
);
1534 perror("Cannot mount debugfs");
1539 /* Modprobe lttng kernel modules */
1540 ret
= modprobe_kernel_modules();
1545 /* Setup lttng kernel path */
1546 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1548 perror("asprintf lttng path");
1552 /* Open debugfs lttng */
1553 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1554 if (kernel_tracer_fd
< 0) {
1555 DBG("Failed to open %s", lttng_path
);
1561 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1571 WARN("No kernel tracer available");
1572 kernel_tracer_fd
= 0;
1577 * Init tracing by creating trace directory and sending fds kernel consumer.
1579 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1583 if (session
->kconsumer_fds_sent
== 0) {
1585 * Assign default kernel consumer socket if no consumer assigned to the
1586 * kernel session. At this point, it's NOT suppose to be 0 but this is
1587 * an extra security check.
1589 if (session
->consumer_fd
== 0) {
1590 session
->consumer_fd
= kconsumerd_cmd_sock
;
1593 ret
= send_kconsumerd_fds(session
);
1595 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1599 session
->kconsumer_fds_sent
= 1;
1607 * Create an UST session and add it to the session ust list.
1609 static int create_ust_session(struct ltt_session
*session
,
1610 struct lttng_domain
*domain
)
1613 struct ltt_ust_session
*lus
= NULL
;
1614 struct ust_app
*app
;
1616 switch (domain
->type
) {
1617 case LTTNG_DOMAIN_UST_PID
:
1618 app
= ust_app_get_by_pid(domain
->attr
.pid
);
1620 ret
= LTTCOMM_APP_NOT_FOUND
;
1625 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1629 DBG("Creating UST session");
1631 lus
= trace_ust_create_session(session
->path
, domain
->attr
.pid
, domain
);
1633 ret
= LTTCOMM_UST_SESS_FAIL
;
1637 ret
= mkdir_recursive(lus
->path
, S_IRWXU
| S_IRWXG
,
1638 geteuid(), allowed_group());
1640 if (ret
!= -EEXIST
) {
1641 ERR("Trace directory creation error");
1642 ret
= LTTCOMM_UST_SESS_FAIL
;
1647 /* Create session on the UST tracer */
1648 ret
= ustctl_create_session(app
->sock
, lus
);
1650 ret
= LTTCOMM_UST_SESS_FAIL
;
1654 cds_list_add(&lus
->list
, &session
->ust_session_list
.head
);
1655 session
->ust_session_list
.count
++;
1665 * Create a kernel tracer session then create the default channel.
1667 static int create_kernel_session(struct ltt_session
*session
)
1671 DBG("Creating kernel session");
1673 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1675 ret
= LTTCOMM_KERN_SESS_FAIL
;
1679 /* Set kernel consumer socket fd */
1680 if (kconsumerd_cmd_sock
) {
1681 session
->kernel_session
->consumer_fd
= kconsumerd_cmd_sock
;
1684 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1685 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1687 if (ret
!= -EEXIST
) {
1688 ERR("Trace directory creation error");
1698 * Using the session list, filled a lttng_session array to send back to the
1699 * client for session listing.
1701 * The session list lock MUST be acquired before calling this function. Use
1702 * session_lock_list() and session_unlock_list().
1704 static void list_lttng_sessions(struct lttng_session
*sessions
)
1707 struct ltt_session
*session
;
1709 DBG("Getting all available session");
1711 * Iterate over session list and append data after the control struct in
1714 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1715 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1716 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1717 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1718 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1724 * Fill lttng_channel array of all channels.
1726 static void list_lttng_channels(struct ltt_session
*session
,
1727 struct lttng_channel
*channels
)
1730 struct ltt_kernel_channel
*kchan
;
1732 DBG("Listing channels for session %s", session
->name
);
1734 /* Kernel channels */
1735 if (session
->kernel_session
!= NULL
) {
1736 cds_list_for_each_entry(kchan
,
1737 &session
->kernel_session
->channel_list
.head
, list
) {
1738 /* Copy lttng_channel struct to array */
1739 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1740 channels
[i
].enabled
= kchan
->enabled
;
1745 /* TODO: Missing UST listing */
1749 * Fill lttng_event array of all events in the channel.
1751 static void list_lttng_events(struct ltt_kernel_channel
*kchan
,
1752 struct lttng_event
*events
)
1755 * TODO: This is ONLY kernel. Need UST support.
1758 struct ltt_kernel_event
*event
;
1760 DBG("Listing events for channel %s", kchan
->channel
->name
);
1762 /* Kernel channels */
1763 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
1764 strncpy(events
[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
1765 events
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1766 events
[i
].enabled
= event
->enabled
;
1767 switch (event
->event
->instrumentation
) {
1768 case LTTNG_KERNEL_TRACEPOINT
:
1769 events
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
1771 case LTTNG_KERNEL_KPROBE
:
1772 case LTTNG_KERNEL_KRETPROBE
:
1773 events
[i
].type
= LTTNG_EVENT_PROBE
;
1774 memcpy(&events
[i
].attr
.probe
, &event
->event
->u
.kprobe
,
1775 sizeof(struct lttng_kernel_kprobe
));
1777 case LTTNG_KERNEL_FUNCTION
:
1778 events
[i
].type
= LTTNG_EVENT_FUNCTION
;
1779 memcpy(&events
[i
].attr
.ftrace
, &event
->event
->u
.ftrace
,
1780 sizeof(struct lttng_kernel_function
));
1782 case LTTNG_KERNEL_NOOP
:
1783 events
[i
].type
= LTTNG_EVENT_NOOP
;
1785 case LTTNG_KERNEL_SYSCALL
:
1786 events
[i
].type
= LTTNG_EVENT_SYSCALL
;
1788 case LTTNG_KERNEL_ALL
:
1797 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1799 static int cmd_disable_channel(struct ltt_session
*session
,
1800 int domain
, char *channel_name
)
1805 case LTTNG_DOMAIN_KERNEL
:
1806 ret
= channel_kernel_disable(session
->kernel_session
,
1808 if (ret
!= LTTCOMM_OK
) {
1812 kernel_wait_quiescent(kernel_tracer_fd
);
1814 case LTTNG_DOMAIN_UST_PID
:
1817 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1828 * Copy channel from attributes and set it in the application channel list.
1830 static int copy_ust_channel_to_app(struct ltt_ust_session
*usess
,
1831 struct lttng_channel
*attr
, struct ust_app
*app
)
1834 struct ltt_ust_channel
*uchan
, *new_chan
;
1836 uchan
= trace_ust_get_channel_by_name(attr
->name
, usess
);
1837 if (uchan
== NULL
) {
1838 ret
= LTTCOMM_FATAL
;
1842 new_chan
= trace_ust_create_channel(attr
, usess
->path
);
1843 if (new_chan
== NULL
) {
1844 PERROR("malloc ltt_ust_channel");
1845 ret
= LTTCOMM_FATAL
;
1849 ret
= channel_ust_copy(new_chan
, uchan
);
1851 ret
= LTTCOMM_FATAL
;
1855 /* Add channel to the ust app channel list */
1856 cds_list_add(&new_chan
->list
, &app
->channels
.head
);
1857 app
->channels
.count
++;
1864 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1866 static int cmd_enable_channel(struct ltt_session
*session
,
1867 struct lttng_domain
*domain
, struct lttng_channel
*attr
)
1871 switch (domain
->type
) {
1872 case LTTNG_DOMAIN_KERNEL
:
1874 struct ltt_kernel_channel
*kchan
;
1876 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1877 session
->kernel_session
);
1878 if (kchan
== NULL
) {
1879 ret
= channel_kernel_create(session
->kernel_session
,
1880 attr
, kernel_poll_pipe
[1]);
1882 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1885 if (ret
!= LTTCOMM_OK
) {
1889 kernel_wait_quiescent(kernel_tracer_fd
);
1892 case LTTNG_DOMAIN_UST_PID
:
1895 struct ltt_ust_channel
*uchan
;
1896 struct ltt_ust_session
*usess
;
1897 struct ust_app
*app
;
1899 usess
= trace_ust_get_session_by_pid(&session
->ust_session_list
,
1901 if (usess
== NULL
) {
1902 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
1906 app
= ust_app_get_by_pid(domain
->attr
.pid
);
1908 ret
= LTTCOMM_APP_NOT_FOUND
;
1913 uchan
= trace_ust_get_channel_by_name(attr
->name
, usess
);
1914 if (uchan
== NULL
) {
1915 ret
= channel_ust_create(usess
, attr
, sock
);
1917 ret
= channel_ust_enable(usess
, uchan
, sock
);
1920 if (ret
!= LTTCOMM_OK
) {
1924 ret
= copy_ust_channel_to_app(usess
, attr
, app
);
1925 if (ret
!= LTTCOMM_OK
) {
1929 DBG("UST channel %s created for app sock %d with pid %d",
1930 attr
->name
, app
->sock
, domain
->attr
.pid
);
1934 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1945 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1947 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
1948 char *channel_name
, char *event_name
)
1951 struct ltt_kernel_channel
*kchan
;
1954 case LTTNG_DOMAIN_KERNEL
:
1955 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1956 session
->kernel_session
);
1957 if (kchan
== NULL
) {
1958 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1962 ret
= event_kernel_disable_tracepoint(session
->kernel_session
, kchan
, event_name
);
1963 if (ret
!= LTTCOMM_OK
) {
1967 kernel_wait_quiescent(kernel_tracer_fd
);
1970 /* TODO: Userspace tracing */
1971 ret
= LTTCOMM_NOT_IMPLEMENTED
;
1982 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
1984 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
1988 struct ltt_kernel_channel
*kchan
;
1991 case LTTNG_DOMAIN_KERNEL
:
1992 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1993 session
->kernel_session
);
1994 if (kchan
== NULL
) {
1995 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
1999 ret
= event_kernel_disable_all(session
->kernel_session
, kchan
);
2000 if (ret
!= LTTCOMM_OK
) {
2004 kernel_wait_quiescent(kernel_tracer_fd
);
2007 /* TODO: Userspace tracing */
2008 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2019 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2021 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2022 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2027 case LTTNG_DOMAIN_KERNEL
:
2028 /* Add kernel context to kernel tracer */
2029 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2030 event_name
, channel_name
);
2031 if (ret
!= LTTCOMM_OK
) {
2037 /* TODO: Userspace tracing */
2038 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2049 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2051 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2052 char *channel_name
, struct lttng_event
*event
)
2055 struct ltt_kernel_channel
*kchan
;
2056 struct lttng_channel
*attr
;
2059 case LTTNG_DOMAIN_KERNEL
:
2060 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2061 session
->kernel_session
);
2062 if (kchan
== NULL
) {
2063 attr
= channel_new_default_attr(domain
);
2065 ret
= LTTCOMM_FATAL
;
2068 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2070 /* This call will notify the kernel thread */
2071 ret
= channel_kernel_create(session
->kernel_session
,
2072 attr
, kernel_poll_pipe
[1]);
2073 if (ret
!= LTTCOMM_OK
) {
2078 /* Get the newly created kernel channel pointer */
2079 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2080 session
->kernel_session
);
2081 if (kchan
== NULL
) {
2082 /* This sould not happen... */
2083 ret
= LTTCOMM_FATAL
;
2087 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
, event
);
2088 if (ret
!= LTTCOMM_OK
) {
2092 kernel_wait_quiescent(kernel_tracer_fd
);
2095 /* TODO: Userspace tracing */
2096 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2107 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2109 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2110 char *channel_name
, int event_type
)
2113 struct ltt_kernel_channel
*kchan
;
2116 case LTTNG_DOMAIN_KERNEL
:
2117 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2118 session
->kernel_session
);
2119 if (kchan
== NULL
) {
2120 /* This call will notify the kernel thread */
2121 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2122 kernel_poll_pipe
[1]);
2123 if (ret
!= LTTCOMM_OK
) {
2128 /* Get the newly created kernel channel pointer */
2129 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2130 session
->kernel_session
);
2131 if (kchan
== NULL
) {
2132 /* This sould not happen... */
2133 ret
= LTTCOMM_FATAL
;
2137 switch (event_type
) {
2138 case LTTNG_KERNEL_SYSCALL
:
2139 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2140 kchan
, kernel_tracer_fd
);
2142 case LTTNG_KERNEL_TRACEPOINT
:
2144 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2145 * events already registered to the channel.
2147 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2148 kchan
, kernel_tracer_fd
);
2150 case LTTNG_KERNEL_ALL
:
2151 /* Enable syscalls and tracepoints */
2152 ret
= event_kernel_enable_all(session
->kernel_session
,
2153 kchan
, kernel_tracer_fd
);
2156 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2159 if (ret
!= LTTCOMM_OK
) {
2163 kernel_wait_quiescent(kernel_tracer_fd
);
2166 /* TODO: Userspace tracing */
2167 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2178 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2180 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2183 ssize_t nb_events
= 0;
2186 case LTTNG_DOMAIN_KERNEL
:
2187 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2188 if (nb_events
< 0) {
2189 ret
= LTTCOMM_KERN_LIST_FAIL
;
2194 /* TODO: Userspace listing */
2195 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2202 /* Return negative value to differentiate return code */
2207 * Command LTTNG_START_TRACE processed by the client thread.
2209 static int cmd_start_trace(struct ltt_session
*session
)
2212 struct ltt_kernel_channel
*kchan
;
2213 struct ltt_kernel_session
*ksession
;
2216 ksession
= session
->kernel_session
;
2218 /* Kernel tracing */
2219 if (ksession
!= NULL
) {
2220 /* Open kernel metadata */
2221 if (ksession
->metadata
== NULL
) {
2222 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2224 ret
= LTTCOMM_KERN_META_FAIL
;
2229 /* Open kernel metadata stream */
2230 if (ksession
->metadata_stream_fd
== 0) {
2231 ret
= kernel_open_metadata_stream(ksession
);
2233 ERR("Kernel create metadata stream failed");
2234 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2239 /* For each channel */
2240 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2241 if (kchan
->stream_count
== 0) {
2242 ret
= kernel_open_channel_stream(kchan
);
2244 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2247 /* Update the stream global counter */
2248 ksession
->stream_count_global
+= ret
;
2252 /* Setup kernel consumer socket and send fds to it */
2253 ret
= init_kernel_tracing(ksession
);
2255 ret
= LTTCOMM_KERN_START_FAIL
;
2259 /* This start the kernel tracing */
2260 ret
= kernel_start_session(ksession
);
2262 ret
= LTTCOMM_KERN_START_FAIL
;
2266 /* Quiescent wait after starting trace */
2267 kernel_wait_quiescent(kernel_tracer_fd
);
2270 /* TODO: Start all UST traces */
2279 * Command LTTNG_STOP_TRACE processed by the client thread.
2281 static int cmd_stop_trace(struct ltt_session
*session
)
2284 struct ltt_kernel_channel
*kchan
;
2285 struct ltt_kernel_session
*ksession
;
2288 ksession
= session
->kernel_session
;
2291 if (ksession
!= NULL
) {
2292 DBG("Stop kernel tracing");
2294 /* Flush all buffers before stopping */
2295 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2297 ERR("Kernel metadata flush failed");
2300 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2301 ret
= kernel_flush_buffer(kchan
);
2303 ERR("Kernel flush buffer error");
2307 ret
= kernel_stop_session(ksession
);
2309 ret
= LTTCOMM_KERN_STOP_FAIL
;
2313 kernel_wait_quiescent(kernel_tracer_fd
);
2316 /* TODO : User-space tracer */
2325 * Command LTTNG_CREATE_SESSION processed by the client thread.
2327 static int cmd_create_session(char *name
, char *path
)
2331 ret
= session_create(name
, path
);
2332 if (ret
!= LTTCOMM_OK
) {
2343 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2345 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2349 /* Clean kernel session teardown */
2350 teardown_kernel_session(session
);
2353 * Must notify the kernel thread here to update it's poll setin order
2354 * to remove the channel(s)' fd just destroyed.
2356 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2358 perror("write kernel poll pipe");
2361 ret
= session_destroy(session
);
2367 * Command LTTNG_CALIBRATE processed by the client thread.
2369 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2374 case LTTNG_DOMAIN_KERNEL
:
2376 struct lttng_kernel_calibrate kcalibrate
;
2378 kcalibrate
.type
= calibrate
->type
;
2379 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2381 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2387 /* TODO: Userspace tracing */
2388 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2399 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2401 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2407 case LTTNG_DOMAIN_KERNEL
:
2408 /* Can't register a consumer if there is already one */
2409 if (session
->kernel_session
->consumer_fd
!= 0) {
2410 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2414 sock
= lttcomm_connect_unix_sock(sock_path
);
2416 ret
= LTTCOMM_CONNECT_FAIL
;
2420 session
->kernel_session
->consumer_fd
= sock
;
2423 /* TODO: Userspace tracing */
2424 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2435 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2437 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
2438 struct lttng_domain
**domains
)
2443 if (session
->kernel_session
!= NULL
) {
2447 nb_dom
+= session
->ust_session_list
.count
;
2449 *domains
= malloc(nb_dom
* sizeof(struct lttng_domain
));
2450 if (*domains
== NULL
) {
2451 ret
= -LTTCOMM_FATAL
;
2455 (*domains
)[0].type
= LTTNG_DOMAIN_KERNEL
;
2457 /* TODO: User-space tracer domain support */
2466 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2468 static ssize_t
cmd_list_channels(struct ltt_session
*session
,
2469 struct lttng_channel
**channels
)
2472 ssize_t nb_chan
= 0;
2474 if (session
->kernel_session
!= NULL
) {
2475 nb_chan
+= session
->kernel_session
->channel_count
;
2478 *channels
= malloc(nb_chan
* sizeof(struct lttng_channel
));
2479 if (*channels
== NULL
) {
2480 ret
= -LTTCOMM_FATAL
;
2484 list_lttng_channels(session
, *channels
);
2493 * Command LTTNG_LIST_EVENTS processed by the client thread.
2495 static ssize_t
cmd_list_events(struct ltt_session
*session
,
2496 char *channel_name
, struct lttng_event
**events
)
2499 ssize_t nb_event
= 0;
2500 struct ltt_kernel_channel
*kchan
= NULL
;
2502 if (session
->kernel_session
!= NULL
) {
2503 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2504 session
->kernel_session
);
2505 if (kchan
== NULL
) {
2506 ret
= -LTTCOMM_KERN_CHAN_NOT_FOUND
;
2509 nb_event
+= kchan
->event_count
;
2512 *events
= malloc(nb_event
* sizeof(struct lttng_event
));
2513 if (*events
== NULL
) {
2514 ret
= -LTTCOMM_FATAL
;
2518 list_lttng_events(kchan
, *events
);
2520 /* TODO: User-space tracer support */
2529 * Process the command requested by the lttng client within the command
2530 * context structure. This function make sure that the return structure (llm)
2531 * is set and ready for transmission before returning.
2533 * Return any error encountered or 0 for success.
2535 static int process_client_msg(struct command_ctx
*cmd_ctx
)
2537 int ret
= LTTCOMM_OK
;
2538 int need_tracing_session
= 1;
2540 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
2543 * Check for command that don't needs to allocate a returned payload. We do
2544 * this here so we don't have to make the call for no payload at each
2547 switch(cmd_ctx
->lsm
->cmd_type
) {
2548 case LTTNG_LIST_SESSIONS
:
2549 case LTTNG_LIST_TRACEPOINTS
:
2550 case LTTNG_LIST_DOMAINS
:
2551 case LTTNG_LIST_CHANNELS
:
2552 case LTTNG_LIST_EVENTS
:
2555 /* Setup lttng message with no payload */
2556 ret
= setup_lttng_msg(cmd_ctx
, 0);
2558 /* This label does not try to unlock the session */
2559 goto init_setup_error
;
2563 /* Commands that DO NOT need a session. */
2564 switch (cmd_ctx
->lsm
->cmd_type
) {
2565 case LTTNG_CALIBRATE
:
2566 case LTTNG_CREATE_SESSION
:
2567 case LTTNG_LIST_SESSIONS
:
2568 case LTTNG_LIST_TRACEPOINTS
:
2569 need_tracing_session
= 0;
2572 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
2573 session_lock_list();
2574 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
2575 session_unlock_list();
2576 if (cmd_ctx
->session
== NULL
) {
2577 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
2578 ret
= LTTCOMM_SESS_NOT_FOUND
;
2580 /* If no session name specified */
2581 ret
= LTTCOMM_SELECT_SESS
;
2585 /* Acquire lock for the session */
2586 session_lock(cmd_ctx
->session
);
2592 * Check domain type for specific "pre-action".
2594 switch (cmd_ctx
->lsm
->domain
.type
) {
2595 case LTTNG_DOMAIN_KERNEL
:
2596 /* Kernel tracer check */
2597 if (kernel_tracer_fd
== 0) {
2598 /* Basically, load kernel tracer modules */
2599 init_kernel_tracer();
2600 if (kernel_tracer_fd
== 0) {
2601 ret
= LTTCOMM_KERN_NA
;
2606 /* Need a session for kernel command */
2607 if (need_tracing_session
) {
2608 if (cmd_ctx
->session
->kernel_session
== NULL
) {
2609 ret
= create_kernel_session(cmd_ctx
->session
);
2611 ret
= LTTCOMM_KERN_SESS_FAIL
;
2616 /* Start the kernel consumer daemon */
2617 pthread_mutex_lock(&kconsumerd_pid_mutex
);
2618 if (kconsumerd_pid
== 0 &&
2619 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
2620 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
2621 ret
= start_kconsumerd();
2623 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2627 pthread_mutex_unlock(&kconsumerd_pid_mutex
);
2630 case LTTNG_DOMAIN_UST_PID
:
2632 struct ltt_ust_session
*usess
;
2634 if (need_tracing_session
) {
2635 usess
= trace_ust_get_session_by_pid(
2636 &cmd_ctx
->session
->ust_session_list
,
2637 cmd_ctx
->lsm
->domain
.attr
.pid
);
2638 if (usess
== NULL
) {
2639 ret
= create_ust_session(cmd_ctx
->session
,
2640 &cmd_ctx
->lsm
->domain
);
2641 if (ret
!= LTTCOMM_OK
) {
2649 /* TODO Userspace tracer */
2653 /* Process by command type */
2654 switch (cmd_ctx
->lsm
->cmd_type
) {
2655 case LTTNG_ADD_CONTEXT
:
2657 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2658 cmd_ctx
->lsm
->u
.context
.channel_name
,
2659 cmd_ctx
->lsm
->u
.context
.event_name
,
2660 &cmd_ctx
->lsm
->u
.context
.ctx
);
2663 case LTTNG_DISABLE_CHANNEL
:
2665 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2666 cmd_ctx
->lsm
->u
.disable
.channel_name
);
2669 case LTTNG_DISABLE_EVENT
:
2671 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2672 cmd_ctx
->lsm
->u
.disable
.channel_name
,
2673 cmd_ctx
->lsm
->u
.disable
.name
);
2677 case LTTNG_DISABLE_ALL_EVENT
:
2679 DBG("Disabling all kernel event");
2681 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2682 cmd_ctx
->lsm
->u
.disable
.channel_name
);
2685 case LTTNG_ENABLE_CHANNEL
:
2687 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
2688 &cmd_ctx
->lsm
->u
.channel
.chan
);
2691 case LTTNG_ENABLE_EVENT
:
2693 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2694 cmd_ctx
->lsm
->u
.enable
.channel_name
,
2695 &cmd_ctx
->lsm
->u
.enable
.event
);
2698 case LTTNG_ENABLE_ALL_EVENT
:
2700 DBG("Enabling all kernel event");
2702 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2703 cmd_ctx
->lsm
->u
.enable
.channel_name
,
2704 cmd_ctx
->lsm
->u
.enable
.event
.type
);
2707 case LTTNG_LIST_TRACEPOINTS
:
2709 struct lttng_event
*events
;
2712 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
2713 if (nb_events
< 0) {
2719 * Setup lttng message with payload size set to the event list size in
2720 * bytes and then copy list into the llm payload.
2722 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
2728 /* Copy event list into message payload */
2729 memcpy(cmd_ctx
->llm
->payload
, events
,
2730 sizeof(struct lttng_event
) * nb_events
);
2737 case LTTNG_START_TRACE
:
2739 ret
= cmd_start_trace(cmd_ctx
->session
);
2742 case LTTNG_STOP_TRACE
:
2744 ret
= cmd_stop_trace(cmd_ctx
->session
);
2747 case LTTNG_CREATE_SESSION
:
2749 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
2750 cmd_ctx
->lsm
->session
.path
);
2753 case LTTNG_DESTROY_SESSION
:
2755 ret
= cmd_destroy_session(cmd_ctx
->session
,
2756 cmd_ctx
->lsm
->session
.name
);
2759 case LTTNG_LIST_DOMAINS
:
2762 struct lttng_domain
*domains
;
2764 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
2770 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
2775 /* Copy event list into message payload */
2776 memcpy(cmd_ctx
->llm
->payload
, domains
,
2777 nb_dom
* sizeof(struct lttng_domain
));
2784 case LTTNG_LIST_CHANNELS
:
2787 struct lttng_channel
*channels
;
2789 nb_chan
= cmd_list_channels(cmd_ctx
->session
, &channels
);
2795 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
2800 /* Copy event list into message payload */
2801 memcpy(cmd_ctx
->llm
->payload
, channels
,
2802 nb_chan
* sizeof(struct lttng_channel
));
2809 case LTTNG_LIST_EVENTS
:
2812 struct lttng_event
*events
= NULL
;
2814 nb_event
= cmd_list_events(cmd_ctx
->session
,
2815 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
2821 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
2826 /* Copy event list into message payload */
2827 memcpy(cmd_ctx
->llm
->payload
, events
,
2828 nb_event
* sizeof(struct lttng_event
));
2835 case LTTNG_LIST_SESSIONS
:
2837 session_lock_list();
2839 if (session_list_ptr
->count
== 0) {
2840 ret
= LTTCOMM_NO_SESSION
;
2841 session_unlock_list();
2845 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
2846 session_list_ptr
->count
);
2848 session_unlock_list();
2852 /* Filled the session array */
2853 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
2855 session_unlock_list();
2860 case LTTNG_CALIBRATE
:
2862 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
2863 &cmd_ctx
->lsm
->u
.calibrate
);
2866 case LTTNG_REGISTER_CONSUMER
:
2868 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
2869 cmd_ctx
->lsm
->u
.reg
.path
);
2878 if (cmd_ctx
->llm
== NULL
) {
2879 DBG("Missing llm structure. Allocating one.");
2880 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
2884 /* Set return code */
2885 cmd_ctx
->llm
->ret_code
= ret
;
2887 if (cmd_ctx
->session
) {
2888 session_unlock(cmd_ctx
->session
);
2895 * This thread manage all clients request using the unix client socket for
2898 static void *thread_manage_clients(void *data
)
2900 int sock
= 0, ret
, i
, pollfd
;
2901 uint32_t revents
, nb_fd
;
2902 struct command_ctx
*cmd_ctx
= NULL
;
2903 struct lttng_poll_event events
;
2905 DBG("[thread] Manage client started");
2907 ret
= lttcomm_listen_unix_sock(client_sock
);
2913 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2914 * more will be added to this poll set.
2916 ret
= create_thread_poll_set(&events
, 2);
2921 /* Add the application registration socket */
2922 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2928 * Notify parent pid that we are ready to accept command for client side.
2930 if (opt_sig_parent
) {
2931 kill(ppid
, SIGCHLD
);
2935 DBG("Accepting client command ...");
2937 nb_fd
= LTTNG_POLL_GETNB(&events
);
2939 /* Inifinite blocking call, waiting for transmission */
2940 ret
= lttng_poll_wait(&events
, -1);
2945 for (i
= 0; i
< nb_fd
; i
++) {
2946 /* Fetch once the poll data */
2947 revents
= LTTNG_POLL_GETEV(&events
, i
);
2948 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2950 /* Thread quit pipe has been closed. Killing thread. */
2951 ret
= check_thread_quit_pipe(pollfd
, revents
);
2956 /* Event on the registration socket */
2957 if (pollfd
== client_sock
) {
2958 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2959 ERR("Client socket poll error");
2965 DBG("Wait for client response");
2967 sock
= lttcomm_accept_unix_sock(client_sock
);
2972 /* Allocate context command to process the client request */
2973 cmd_ctx
= malloc(sizeof(struct command_ctx
));
2974 if (cmd_ctx
== NULL
) {
2975 perror("malloc cmd_ctx");
2979 /* Allocate data buffer for reception */
2980 cmd_ctx
->lsm
= malloc(sizeof(struct lttcomm_session_msg
));
2981 if (cmd_ctx
->lsm
== NULL
) {
2982 perror("malloc cmd_ctx->lsm");
2986 cmd_ctx
->llm
= NULL
;
2987 cmd_ctx
->session
= NULL
;
2990 * Data is received from the lttng client. The struct
2991 * lttcomm_session_msg (lsm) contains the command and data request of
2994 DBG("Receiving data from client ...");
2995 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
,
2996 sizeof(struct lttcomm_session_msg
));
2998 DBG("Nothing recv() from client... continuing");
3004 // TODO: Validate cmd_ctx including sanity check for
3005 // security purpose.
3008 * This function dispatch the work to the kernel or userspace tracer
3009 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3010 * informations for the client. The command context struct contains
3011 * everything this function may needs.
3013 ret
= process_client_msg(cmd_ctx
);
3016 * TODO: Inform client somehow of the fatal error. At
3017 * this point, ret < 0 means that a malloc failed
3018 * (ENOMEM). Error detected but still accept command.
3020 clean_command_ctx(&cmd_ctx
);
3024 DBG("Sending response (size: %d, retcode: %s)",
3025 cmd_ctx
->lttng_msg_size
,
3026 lttng_get_readable_code(-cmd_ctx
->llm
->ret_code
));
3027 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3029 ERR("Failed to send data back to client");
3032 clean_command_ctx(&cmd_ctx
);
3034 /* End of transmission */
3039 DBG("Client thread dying");
3040 unlink(client_unix_sock_path
);
3044 lttng_poll_clean(&events
);
3045 clean_command_ctx(&cmd_ctx
);
3051 * usage function on stderr
3053 static void usage(void)
3055 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3056 fprintf(stderr
, " -h, --help Display this usage.\n");
3057 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3058 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3059 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3060 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3061 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3062 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3063 fprintf(stderr
, " -V, --version Show version number.\n");
3064 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3065 fprintf(stderr
, " -q, --quiet No output at all.\n");
3066 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3067 fprintf(stderr
, " --verbose-kconsumerd Verbose mode for kconsumerd. Activate DBG() macro.\n");
3071 * daemon argument parsing
3073 static int parse_args(int argc
, char **argv
)
3077 static struct option long_options
[] = {
3078 { "client-sock", 1, 0, 'c' },
3079 { "apps-sock", 1, 0, 'a' },
3080 { "kconsumerd-cmd-sock", 1, 0, 0 },
3081 { "kconsumerd-err-sock", 1, 0, 0 },
3082 { "daemonize", 0, 0, 'd' },
3083 { "sig-parent", 0, 0, 'S' },
3084 { "help", 0, 0, 'h' },
3085 { "group", 1, 0, 'g' },
3086 { "version", 0, 0, 'V' },
3087 { "quiet", 0, 0, 'q' },
3088 { "verbose", 0, 0, 'v' },
3089 { "verbose-kconsumerd", 0, 0, 'Z' },
3094 int option_index
= 0;
3095 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:E:C:Z",
3096 long_options
, &option_index
);
3103 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3105 fprintf(stderr
, " with arg %s\n", optarg
);
3109 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3112 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3118 opt_tracing_group
= strdup(optarg
);
3124 fprintf(stdout
, "%s\n", VERSION
);
3130 snprintf(kconsumerd_err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3133 snprintf(kconsumerd_cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3139 /* Verbose level can increase using multiple -v */
3143 opt_verbose_kconsumerd
+= 1;
3146 /* Unknown option or other error.
3147 * Error is printed by getopt, just return */
3156 * Creates the two needed socket by the daemon.
3157 * apps_sock - The communication socket for all UST apps.
3158 * client_sock - The communication of the cli tool (lttng).
3160 static int init_daemon_socket(void)
3165 old_umask
= umask(0);
3167 /* Create client tool unix socket */
3168 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3169 if (client_sock
< 0) {
3170 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3175 /* File permission MUST be 660 */
3176 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3178 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3183 /* Create the application unix socket */
3184 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3185 if (apps_sock
< 0) {
3186 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3191 /* File permission MUST be 666 */
3192 ret
= chmod(apps_unix_sock_path
,
3193 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3195 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3206 * Check if the global socket is available, and if a daemon is answering at the
3207 * other side. If yes, error is returned.
3209 static int check_existing_daemon(void)
3211 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3212 access(apps_unix_sock_path
, F_OK
) < 0) {
3216 /* Is there anybody out there ? */
3217 if (lttng_session_daemon_alive()) {
3225 * Set the tracing group gid onto the client socket.
3227 * Race window between mkdir and chown is OK because we are going from more
3228 * permissive (root.root) to les permissive (root.tracing).
3230 static int set_permissions(void)
3235 gid
= allowed_group();
3238 WARN("No tracing group detected");
3241 ERR("Missing tracing group. Aborting execution.");
3247 /* Set lttng run dir */
3248 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
3250 ERR("Unable to set group on " LTTNG_RUNDIR
);
3254 /* lttng client socket path */
3255 ret
= chown(client_unix_sock_path
, 0, gid
);
3257 ERR("Unable to set group on %s", client_unix_sock_path
);
3261 /* kconsumerd error socket path */
3262 ret
= chown(kconsumerd_err_unix_sock_path
, 0, gid
);
3264 ERR("Unable to set group on %s", kconsumerd_err_unix_sock_path
);
3268 DBG("All permissions are set");
3275 * Create the pipe used to wake up the kernel thread.
3277 static int create_kernel_poll_pipe(void)
3279 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
3283 * Create the application command pipe to wake thread_manage_apps.
3285 static int create_apps_cmd_pipe(void)
3287 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
3291 * Create the lttng run directory needed for all global sockets and pipe.
3293 static int create_lttng_rundir(void)
3297 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
3299 if (errno
!= EEXIST
) {
3300 ERR("Unable to create " LTTNG_RUNDIR
);
3312 * Setup sockets and directory needed by the kconsumerd communication with the
3315 static int set_kconsumerd_sockets(void)
3319 if (strlen(kconsumerd_err_unix_sock_path
) == 0) {
3320 snprintf(kconsumerd_err_unix_sock_path
, PATH_MAX
,
3321 KCONSUMERD_ERR_SOCK_PATH
);
3324 if (strlen(kconsumerd_cmd_unix_sock_path
) == 0) {
3325 snprintf(kconsumerd_cmd_unix_sock_path
, PATH_MAX
,
3326 KCONSUMERD_CMD_SOCK_PATH
);
3329 ret
= mkdir(KCONSUMERD_PATH
, S_IRWXU
| S_IRWXG
);
3331 if (errno
!= EEXIST
) {
3332 ERR("Failed to create " KCONSUMERD_PATH
);
3338 /* Create the kconsumerd error unix socket */
3339 kconsumerd_err_sock
=
3340 lttcomm_create_unix_sock(kconsumerd_err_unix_sock_path
);
3341 if (kconsumerd_err_sock
< 0) {
3342 ERR("Create unix sock failed: %s", kconsumerd_err_unix_sock_path
);
3347 /* File permission MUST be 660 */
3348 ret
= chmod(kconsumerd_err_unix_sock_path
,
3349 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3351 ERR("Set file permissions failed: %s", kconsumerd_err_unix_sock_path
);
3361 * Signal handler for the daemon
3363 * Simply stop all worker threads, leaving main() return gracefully after
3364 * joining all threads and calling cleanup().
3366 static void sighandler(int sig
)
3370 DBG("SIGPIPE catched");
3373 DBG("SIGINT catched");
3377 DBG("SIGTERM catched");
3386 * Setup signal handler for :
3387 * SIGINT, SIGTERM, SIGPIPE
3389 static int set_signal_handler(void)
3392 struct sigaction sa
;
3395 if ((ret
= sigemptyset(&sigset
)) < 0) {
3396 perror("sigemptyset");
3400 sa
.sa_handler
= sighandler
;
3401 sa
.sa_mask
= sigset
;
3403 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
3404 perror("sigaction");
3408 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
3409 perror("sigaction");
3413 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
3414 perror("sigaction");
3418 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3424 * Set open files limit to unlimited. This daemon can open a large number of
3425 * file descriptors in order to consumer multiple kernel traces.
3427 static void set_ulimit(void)
3432 /* The kernel does not allowed an infinite limit for open files */
3433 lim
.rlim_cur
= 65535;
3434 lim
.rlim_max
= 65535;
3436 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
3438 perror("failed to set open files limit");
3445 int main(int argc
, char **argv
)
3449 const char *home_path
;
3451 /* Create thread quit pipe */
3452 if ((ret
= init_thread_quit_pipe()) < 0) {
3456 /* Parse arguments */
3458 if ((ret
= parse_args(argc
, argv
) < 0)) {
3471 /* Check if daemon is UID = 0 */
3472 is_root
= !getuid();
3475 ret
= create_lttng_rundir();
3480 if (strlen(apps_unix_sock_path
) == 0) {
3481 snprintf(apps_unix_sock_path
, PATH_MAX
,
3482 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
3485 if (strlen(client_unix_sock_path
) == 0) {
3486 snprintf(client_unix_sock_path
, PATH_MAX
,
3487 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
3490 /* Set global SHM for ust */
3491 if (strlen(wait_shm_path
) == 0) {
3492 snprintf(wait_shm_path
, PATH_MAX
,
3493 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
3496 home_path
= get_home_dir();
3497 if (home_path
== NULL
) {
3498 /* TODO: Add --socket PATH option */
3499 ERR("Can't get HOME directory for sockets creation.");
3504 if (strlen(apps_unix_sock_path
) == 0) {
3505 snprintf(apps_unix_sock_path
, PATH_MAX
,
3506 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
3509 /* Set the cli tool unix socket path */
3510 if (strlen(client_unix_sock_path
) == 0) {
3511 snprintf(client_unix_sock_path
, PATH_MAX
,
3512 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
3515 /* Set global SHM for ust */
3516 if (strlen(wait_shm_path
) == 0) {
3517 snprintf(wait_shm_path
, PATH_MAX
,
3518 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
3522 DBG("Client socket path %s", client_unix_sock_path
);
3523 DBG("Application socket path %s", apps_unix_sock_path
);
3526 * See if daemon already exist.
3528 if ((ret
= check_existing_daemon()) < 0) {
3529 ERR("Already running daemon.\n");
3531 * We do not goto exit because we must not cleanup()
3532 * because a daemon is already running.
3537 /* After this point, we can safely call cleanup() with "goto exit" */
3540 * These actions must be executed as root. We do that *after* setting up
3541 * the sockets path because we MUST make the check for another daemon using
3542 * those paths *before* trying to set the kernel consumer sockets and init
3546 ret
= set_kconsumerd_sockets();
3551 /* Setup kernel tracer */
3552 init_kernel_tracer();
3554 /* Set ulimit for open files */
3558 if ((ret
= set_signal_handler()) < 0) {
3562 /* Setup the needed unix socket */
3563 if ((ret
= init_daemon_socket()) < 0) {
3567 /* Set credentials to socket */
3568 if (is_root
&& ((ret
= set_permissions()) < 0)) {
3572 /* Get parent pid if -S, --sig-parent is specified. */
3573 if (opt_sig_parent
) {
3577 /* Setup the kernel pipe for waking up the kernel thread */
3578 if ((ret
= create_kernel_poll_pipe()) < 0) {
3582 /* Setup the thread apps communication pipe. */
3583 if ((ret
= create_apps_cmd_pipe()) < 0) {
3587 /* Init UST command queue. */
3588 cds_wfq_init(&ust_cmd_queue
.queue
);
3591 * Get session list pointer. This pointer MUST NOT be free(). This list is
3592 * statically declared in session.c
3594 session_list_ptr
= session_get_list();
3596 /* Set up max poll set size */
3597 lttng_poll_set_max_size();
3599 /* Create thread to manage the client socket */
3600 ret
= pthread_create(&client_thread
, NULL
,
3601 thread_manage_clients
, (void *) NULL
);
3603 perror("pthread_create clients");
3607 /* Create thread to dispatch registration */
3608 ret
= pthread_create(&dispatch_thread
, NULL
,
3609 thread_dispatch_ust_registration
, (void *) NULL
);
3611 perror("pthread_create dispatch");
3615 /* Create thread to manage application registration. */
3616 ret
= pthread_create(®_apps_thread
, NULL
,
3617 thread_registration_apps
, (void *) NULL
);
3619 perror("pthread_create registration");
3623 /* Create thread to manage application socket */
3624 ret
= pthread_create(&apps_thread
, NULL
,
3625 thread_manage_apps
, (void *) NULL
);
3627 perror("pthread_create apps");
3631 /* Create kernel thread to manage kernel event */
3632 ret
= pthread_create(&kernel_thread
, NULL
,
3633 thread_manage_kernel
, (void *) NULL
);
3635 perror("pthread_create kernel");
3639 ret
= pthread_join(kernel_thread
, &status
);
3641 perror("pthread_join");
3642 goto error
; /* join error, exit without cleanup */
3646 ret
= pthread_join(apps_thread
, &status
);
3648 perror("pthread_join");
3649 goto error
; /* join error, exit without cleanup */
3653 ret
= pthread_join(reg_apps_thread
, &status
);
3655 perror("pthread_join");
3656 goto error
; /* join error, exit without cleanup */
3660 ret
= pthread_join(dispatch_thread
, &status
);
3662 perror("pthread_join");
3663 goto error
; /* join error, exit without cleanup */
3667 ret
= pthread_join(client_thread
, &status
);
3669 perror("pthread_join");
3670 goto error
; /* join error, exit without cleanup */
3673 ret
= join_kconsumerd_thread();
3675 perror("join_kconsumerd");
3676 goto error
; /* join error, exit without cleanup */
3682 * cleanup() is called when no other thread is running.