2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <common/common.h>
42 #include <common/compat/poll.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
57 #define CONSUMERD_FILE "lttng-consumerd"
59 struct consumer_data
{
60 enum lttng_consumer_type type
;
62 pthread_t thread
; /* Worker thread interacting with the consumer */
65 /* Mutex to control consumerd pid assignation */
66 pthread_mutex_t pid_mutex
;
72 /* consumer error and command Unix socket path */
73 char err_unix_sock_path
[PATH_MAX
];
74 char cmd_unix_sock_path
[PATH_MAX
];
78 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
79 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
80 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
81 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
84 int opt_verbose
; /* Not static for lttngerr.h */
85 int opt_verbose_consumer
; /* Not static for lttngerr.h */
86 int opt_quiet
; /* Not static for lttngerr.h */
89 const char *opt_tracing_group
;
90 static int opt_sig_parent
;
91 static int opt_daemon
;
92 static int opt_no_kernel
;
93 static int is_root
; /* Set to 1 if the daemon is running as root */
94 static pid_t ppid
; /* Parent PID for --sig-parent option */
97 /* Consumer daemon specific control data */
98 static struct consumer_data kconsumer_data
= {
99 .type
= LTTNG_CONSUMER_KERNEL
,
100 .err_unix_sock_path
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
101 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
103 static struct consumer_data ustconsumer64_data
= {
104 .type
= LTTNG_CONSUMER64_UST
,
105 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
106 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
108 static struct consumer_data ustconsumer32_data
= {
109 .type
= LTTNG_CONSUMER32_UST
,
110 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
111 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
,
114 static int dispatch_thread_exit
;
116 /* Global application Unix socket path */
117 static char apps_unix_sock_path
[PATH_MAX
];
118 /* Global client Unix socket path */
119 static char client_unix_sock_path
[PATH_MAX
];
120 /* global wait shm path for UST */
121 static char wait_shm_path
[PATH_MAX
];
123 /* Sockets and FDs */
124 static int client_sock
;
125 static int apps_sock
;
126 static int kernel_tracer_fd
;
127 static int kernel_poll_pipe
[2];
130 * Quit pipe for all threads. This permits a single cancellation point
131 * for all threads when receiving an event on the pipe.
133 static int thread_quit_pipe
[2];
136 * This pipe is used to inform the thread managing application communication
137 * that a command is queued and ready to be processed.
139 static int apps_cmd_pipe
[2];
141 /* Pthread, Mutexes and Semaphores */
142 static pthread_t apps_thread
;
143 static pthread_t reg_apps_thread
;
144 static pthread_t client_thread
;
145 static pthread_t kernel_thread
;
146 static pthread_t dispatch_thread
;
150 * UST registration command queue. This queue is tied with a futex and uses a N
151 * wakers / 1 waiter implemented and detailed in futex.c/.h
153 * The thread_manage_apps and thread_dispatch_ust_registration interact with
154 * this queue and the wait/wake scheme.
156 static struct ust_cmd_queue ust_cmd_queue
;
159 * Pointer initialized before thread creation.
161 * This points to the tracing session list containing the session count and a
162 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
163 * MUST NOT be taken if you call a public function in session.c.
165 * The lock is nested inside the structure: session_list_ptr->lock. Please use
166 * session_lock_list and session_unlock_list for lock acquisition.
168 static struct ltt_session_list
*session_list_ptr
;
170 int ust_consumerd64_fd
= -1;
171 int ust_consumerd32_fd
= -1;
173 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
174 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
175 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
176 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
179 void setup_consumerd_path(void)
181 const char *bin
, *libdir
;
184 * Allow INSTALL_BIN_PATH to be used as a target path for the
185 * native architecture size consumer if CONFIG_CONSUMER*_PATH
186 * has not been defined.
188 #if (CAA_BITS_PER_LONG == 32)
189 if (!consumerd32_bin
[0]) {
190 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
192 if (!consumerd32_libdir
[0]) {
193 consumerd32_libdir
= INSTALL_LIB_PATH
;
195 #elif (CAA_BITS_PER_LONG == 64)
196 if (!consumerd64_bin
[0]) {
197 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
199 if (!consumerd64_libdir
[0]) {
200 consumerd64_libdir
= INSTALL_LIB_PATH
;
203 #error "Unknown bitness"
207 * runtime env. var. overrides the build default.
209 bin
= getenv("LTTNG_CONSUMERD32_BIN");
211 consumerd32_bin
= bin
;
213 bin
= getenv("LTTNG_CONSUMERD64_BIN");
215 consumerd64_bin
= bin
;
217 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
219 consumerd32_libdir
= libdir
;
221 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
223 consumerd64_libdir
= libdir
;
228 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
230 static int create_thread_poll_set(struct lttng_poll_event
*events
,
235 if (events
== NULL
|| size
== 0) {
240 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
246 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
258 * Check if the thread quit pipe was triggered.
260 * Return 1 if it was triggered else 0;
262 static int check_thread_quit_pipe(int fd
, uint32_t events
)
264 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
272 * Remove modules in reverse load order.
274 static int modprobe_remove_kernel_modules(void)
279 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
280 ret
= snprintf(modprobe
, sizeof(modprobe
),
281 "/sbin/modprobe -r -q %s",
282 kernel_modules_list
[i
].name
);
284 perror("snprintf modprobe -r");
287 modprobe
[sizeof(modprobe
) - 1] = '\0';
288 ret
= system(modprobe
);
290 ERR("Unable to launch modprobe -r for module %s",
291 kernel_modules_list
[i
].name
);
292 } else if (kernel_modules_list
[i
].required
293 && WEXITSTATUS(ret
) != 0) {
294 ERR("Unable to remove module %s",
295 kernel_modules_list
[i
].name
);
297 DBG("Modprobe removal successful %s",
298 kernel_modules_list
[i
].name
);
307 * Return group ID of the tracing group or -1 if not found.
309 static gid_t
allowed_group(void)
313 if (opt_tracing_group
) {
314 grp
= getgrnam(opt_tracing_group
);
316 grp
= getgrnam(default_tracing_group
);
326 * Init thread quit pipe.
328 * Return -1 on error or 0 if all pipes are created.
330 static int init_thread_quit_pipe(void)
334 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
336 perror("thread quit pipe");
345 * Complete teardown of a kernel session. This free all data structure related
346 * to a kernel session and update counter.
348 static void teardown_kernel_session(struct ltt_session
*session
)
350 if (!session
->kernel_session
) {
351 DBG3("No kernel session when tearingdown session");
355 DBG("Tearing down kernel session");
358 * If a custom kernel consumer was registered, close the socket before
359 * tearing down the complete kernel session structure
361 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
362 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
365 trace_kernel_destroy_session(session
->kernel_session
);
369 * Complete teardown of all UST sessions. This will free everything on his path
370 * and destroy the core essence of all ust sessions :)
372 static void teardown_ust_session(struct ltt_session
*session
)
376 if (!session
->ust_session
) {
377 DBG3("No UST session when tearingdown session");
381 DBG("Tearing down UST session(s)");
383 ret
= ust_app_destroy_trace_all(session
->ust_session
);
385 ERR("Error in ust_app_destroy_trace_all");
388 trace_ust_destroy_session(session
->ust_session
);
392 * Stop all threads by closing the thread quit pipe.
394 static void stop_threads(void)
398 /* Stopping all threads */
399 DBG("Terminating all threads");
400 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
402 ERR("write error on thread quit pipe");
405 /* Dispatch thread */
406 dispatch_thread_exit
= 1;
407 futex_nto1_wake(&ust_cmd_queue
.futex
);
413 static void cleanup(void)
417 struct ltt_session
*sess
, *stmp
;
421 DBG("Removing %s directory", rundir
);
422 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
424 ERR("asprintf failed. Something is really wrong!");
427 /* Remove lttng run directory */
430 ERR("Unable to clean %s", rundir
);
434 DBG("Cleaning up all session");
436 /* Destroy session list mutex */
437 if (session_list_ptr
!= NULL
) {
438 pthread_mutex_destroy(&session_list_ptr
->lock
);
440 /* Cleanup ALL session */
441 cds_list_for_each_entry_safe(sess
, stmp
,
442 &session_list_ptr
->head
, list
) {
443 teardown_kernel_session(sess
);
444 teardown_ust_session(sess
);
449 DBG("Closing all UST sockets");
450 ust_app_clean_list();
452 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
454 if (is_root
&& !opt_no_kernel
) {
455 DBG2("Closing kernel fd");
456 close(kernel_tracer_fd
);
457 DBG("Unloading kernel modules");
458 modprobe_remove_kernel_modules();
461 close(thread_quit_pipe
[0]);
462 close(thread_quit_pipe
[1]);
465 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
466 "Matthew, BEET driven development works!%c[%dm",
467 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
472 * Send data on a unix socket using the liblttsessiondcomm API.
474 * Return lttcomm error code.
476 static int send_unix_sock(int sock
, void *buf
, size_t len
)
478 /* Check valid length */
483 return lttcomm_send_unix_sock(sock
, buf
, len
);
487 * Free memory of a command context structure.
489 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
491 DBG("Clean command context structure");
493 if ((*cmd_ctx
)->llm
) {
494 free((*cmd_ctx
)->llm
);
496 if ((*cmd_ctx
)->lsm
) {
497 free((*cmd_ctx
)->lsm
);
505 * Send all stream fds of kernel channel to the consumer.
507 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
508 int sock
, struct ltt_kernel_channel
*channel
,
509 uid_t uid
, gid_t gid
)
512 struct ltt_kernel_stream
*stream
;
513 struct lttcomm_consumer_msg lkm
;
515 DBG("Sending streams of channel %s to kernel consumer",
516 channel
->channel
->name
);
519 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
520 lkm
.u
.channel
.channel_key
= channel
->fd
;
521 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
522 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
523 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
524 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
526 perror("send consumer channel");
531 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
535 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
536 lkm
.u
.stream
.channel_key
= channel
->fd
;
537 lkm
.u
.stream
.stream_key
= stream
->fd
;
538 lkm
.u
.stream
.state
= stream
->state
;
539 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
540 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
541 lkm
.u
.stream
.uid
= uid
;
542 lkm
.u
.stream
.gid
= gid
;
543 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
544 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
545 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
546 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
548 perror("send consumer stream");
551 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
553 perror("send consumer stream ancillary data");
558 DBG("consumer channel streams sent");
567 * Send all stream fds of the kernel session to the consumer.
569 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
570 struct ltt_kernel_session
*session
)
573 struct ltt_kernel_channel
*chan
;
574 struct lttcomm_consumer_msg lkm
;
575 int sock
= session
->consumer_fd
;
577 DBG("Sending metadata stream fd");
579 /* Extra protection. It's NOT supposed to be set to 0 at this point */
580 if (session
->consumer_fd
== 0) {
581 session
->consumer_fd
= consumer_data
->cmd_sock
;
584 if (session
->metadata_stream_fd
!= 0) {
585 /* Send metadata channel fd */
586 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
587 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
588 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
589 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
590 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
591 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
593 perror("send consumer channel");
597 /* Send metadata stream fd */
598 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
599 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
600 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
601 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
602 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
603 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
604 lkm
.u
.stream
.uid
= session
->uid
;
605 lkm
.u
.stream
.gid
= session
->gid
;
606 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
607 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
608 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
609 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
611 perror("send consumer stream");
614 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
616 perror("send consumer stream");
621 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
622 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
623 session
->uid
, session
->gid
);
629 DBG("consumer fds (metadata and channel streams) sent");
638 * Notify UST applications using the shm mmap futex.
640 static int notify_ust_apps(int active
)
644 DBG("Notifying applications of session daemon state: %d", active
);
646 /* See shm.c for this call implying mmap, shm and futex calls */
647 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
648 if (wait_shm_mmap
== NULL
) {
652 /* Wake waiting process */
653 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
655 /* Apps notified successfully */
663 * Setup the outgoing data buffer for the response (llm) by allocating the
664 * right amount of memory and copying the original information from the lsm
667 * Return total size of the buffer pointed by buf.
669 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
675 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
676 if (cmd_ctx
->llm
== NULL
) {
682 /* Copy common data */
683 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
684 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
686 cmd_ctx
->llm
->data_size
= size
;
687 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
696 * Update the kernel poll set of all channel fd available over all tracing
697 * session. Add the wakeup pipe at the end of the set.
699 static int update_kernel_poll(struct lttng_poll_event
*events
)
702 struct ltt_session
*session
;
703 struct ltt_kernel_channel
*channel
;
705 DBG("Updating kernel poll set");
708 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
709 session_lock(session
);
710 if (session
->kernel_session
== NULL
) {
711 session_unlock(session
);
715 cds_list_for_each_entry(channel
,
716 &session
->kernel_session
->channel_list
.head
, list
) {
717 /* Add channel fd to the kernel poll set */
718 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
720 session_unlock(session
);
723 DBG("Channel fd %d added to kernel set", channel
->fd
);
725 session_unlock(session
);
727 session_unlock_list();
732 session_unlock_list();
737 * Find the channel fd from 'fd' over all tracing session. When found, check
738 * for new channel stream and send those stream fds to the kernel consumer.
740 * Useful for CPU hotplug feature.
742 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
745 struct ltt_session
*session
;
746 struct ltt_kernel_channel
*channel
;
748 DBG("Updating kernel streams for channel fd %d", fd
);
751 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
752 session_lock(session
);
753 if (session
->kernel_session
== NULL
) {
754 session_unlock(session
);
758 /* This is not suppose to be 0 but this is an extra security check */
759 if (session
->kernel_session
->consumer_fd
== 0) {
760 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
763 cds_list_for_each_entry(channel
,
764 &session
->kernel_session
->channel_list
.head
, list
) {
765 if (channel
->fd
== fd
) {
766 DBG("Channel found, updating kernel streams");
767 ret
= kernel_open_channel_stream(channel
);
773 * Have we already sent fds to the consumer? If yes, it means
774 * that tracing is started so it is safe to send our updated
777 if (session
->kernel_session
->consumer_fds_sent
== 1) {
778 ret
= send_kconsumer_channel_streams(consumer_data
,
779 session
->kernel_session
->consumer_fd
, channel
,
780 session
->uid
, session
->gid
);
788 session_unlock(session
);
790 session_unlock_list();
794 session_unlock(session
);
795 session_unlock_list();
800 * For each tracing session, update newly registered apps.
802 static void update_ust_app(int app_sock
)
804 struct ltt_session
*sess
, *stmp
;
806 /* For all tracing session(s) */
807 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
808 if (sess
->ust_session
) {
809 ust_app_global_update(sess
->ust_session
, app_sock
);
815 * This thread manage event coming from the kernel.
817 * Features supported in this thread:
820 static void *thread_manage_kernel(void *data
)
822 int ret
, i
, pollfd
, update_poll_flag
= 1;
823 uint32_t revents
, nb_fd
;
825 struct lttng_poll_event events
;
827 DBG("Thread manage kernel started");
829 ret
= create_thread_poll_set(&events
, 2);
834 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
840 if (update_poll_flag
== 1) {
842 * Reset number of fd in the poll set. Always 2 since there is the thread
843 * quit pipe and the kernel pipe.
847 ret
= update_kernel_poll(&events
);
851 update_poll_flag
= 0;
854 nb_fd
= LTTNG_POLL_GETNB(&events
);
856 DBG("Thread kernel polling on %d fds", nb_fd
);
858 /* Zeroed the poll events */
859 lttng_poll_reset(&events
);
861 /* Poll infinite value of time */
862 ret
= lttng_poll_wait(&events
, -1);
865 } else if (ret
== 0) {
866 /* Should not happen since timeout is infinite */
867 ERR("Return value of poll is 0 with an infinite timeout.\n"
868 "This should not have happened! Continuing...");
872 for (i
= 0; i
< nb_fd
; i
++) {
873 /* Fetch once the poll data */
874 revents
= LTTNG_POLL_GETEV(&events
, i
);
875 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
877 /* Thread quit pipe has been closed. Killing thread. */
878 ret
= check_thread_quit_pipe(pollfd
, revents
);
883 /* Check for data on kernel pipe */
884 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
885 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
886 update_poll_flag
= 1;
890 * New CPU detected by the kernel. Adding kernel stream to
891 * kernel session and updating the kernel consumer
893 if (revents
& LPOLLIN
) {
894 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
900 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
901 * and unregister kernel stream at this point.
909 DBG("Kernel thread dying");
910 close(kernel_poll_pipe
[0]);
911 close(kernel_poll_pipe
[1]);
913 lttng_poll_clean(&events
);
919 * This thread manage the consumer error sent back to the session daemon.
921 static void *thread_manage_consumer(void *data
)
923 int sock
= 0, i
, ret
, pollfd
;
924 uint32_t revents
, nb_fd
;
925 enum lttcomm_return_code code
;
926 struct lttng_poll_event events
;
927 struct consumer_data
*consumer_data
= data
;
929 DBG("[thread] Manage consumer started");
931 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
937 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
938 * Nothing more will be added to this poll set.
940 ret
= create_thread_poll_set(&events
, 2);
945 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
950 nb_fd
= LTTNG_POLL_GETNB(&events
);
952 /* Inifinite blocking call, waiting for transmission */
953 ret
= lttng_poll_wait(&events
, -1);
958 for (i
= 0; i
< nb_fd
; i
++) {
959 /* Fetch once the poll data */
960 revents
= LTTNG_POLL_GETEV(&events
, i
);
961 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
963 /* Thread quit pipe has been closed. Killing thread. */
964 ret
= check_thread_quit_pipe(pollfd
, revents
);
969 /* Event on the registration socket */
970 if (pollfd
== consumer_data
->err_sock
) {
971 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
972 ERR("consumer err socket poll error");
978 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
983 DBG2("Receiving code from consumer err_sock");
985 /* Getting status code from kconsumerd */
986 ret
= lttcomm_recv_unix_sock(sock
, &code
,
987 sizeof(enum lttcomm_return_code
));
992 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
993 consumer_data
->cmd_sock
=
994 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
995 if (consumer_data
->cmd_sock
< 0) {
996 sem_post(&consumer_data
->sem
);
997 PERROR("consumer connect");
1000 /* Signal condition to tell that the kconsumerd is ready */
1001 sem_post(&consumer_data
->sem
);
1002 DBG("consumer command socket ready");
1004 ERR("consumer error when waiting for SOCK_READY : %s",
1005 lttcomm_get_readable_code(-code
));
1009 /* Remove the kconsumerd error sock since we've established a connexion */
1010 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1015 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1020 /* Update number of fd */
1021 nb_fd
= LTTNG_POLL_GETNB(&events
);
1023 /* Inifinite blocking call, waiting for transmission */
1024 ret
= lttng_poll_wait(&events
, -1);
1029 for (i
= 0; i
< nb_fd
; i
++) {
1030 /* Fetch once the poll data */
1031 revents
= LTTNG_POLL_GETEV(&events
, i
);
1032 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1034 /* Thread quit pipe has been closed. Killing thread. */
1035 ret
= check_thread_quit_pipe(pollfd
, revents
);
1040 /* Event on the kconsumerd socket */
1041 if (pollfd
== sock
) {
1042 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1043 ERR("consumer err socket second poll error");
1049 /* Wait for any kconsumerd error */
1050 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1051 sizeof(enum lttcomm_return_code
));
1053 ERR("consumer closed the command socket");
1057 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1060 DBG("consumer thread dying");
1061 close(consumer_data
->err_sock
);
1062 close(consumer_data
->cmd_sock
);
1065 unlink(consumer_data
->err_unix_sock_path
);
1066 unlink(consumer_data
->cmd_unix_sock_path
);
1067 consumer_data
->pid
= 0;
1069 lttng_poll_clean(&events
);
1075 * This thread manage application communication.
1077 static void *thread_manage_apps(void *data
)
1080 uint32_t revents
, nb_fd
;
1081 struct ust_command ust_cmd
;
1082 struct lttng_poll_event events
;
1084 DBG("[thread] Manage application started");
1086 rcu_register_thread();
1087 rcu_thread_online();
1089 ret
= create_thread_poll_set(&events
, 2);
1094 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1100 /* Zeroed the events structure */
1101 lttng_poll_reset(&events
);
1103 nb_fd
= LTTNG_POLL_GETNB(&events
);
1105 DBG("Apps thread polling on %d fds", nb_fd
);
1107 /* Inifinite blocking call, waiting for transmission */
1108 ret
= lttng_poll_wait(&events
, -1);
1113 for (i
= 0; i
< nb_fd
; i
++) {
1114 /* Fetch once the poll data */
1115 revents
= LTTNG_POLL_GETEV(&events
, i
);
1116 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1118 /* Thread quit pipe has been closed. Killing thread. */
1119 ret
= check_thread_quit_pipe(pollfd
, revents
);
1124 /* Inspect the apps cmd pipe */
1125 if (pollfd
== apps_cmd_pipe
[0]) {
1126 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1127 ERR("Apps command pipe error");
1129 } else if (revents
& LPOLLIN
) {
1131 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1132 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1133 perror("read apps cmd pipe");
1137 /* Register applicaton to the session daemon */
1138 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1140 if (ret
== -ENOMEM
) {
1142 } else if (ret
< 0) {
1147 * Add channel(s) and event(s) to newly registered apps
1148 * from lttng global UST domain.
1150 update_ust_app(ust_cmd
.sock
);
1152 ret
= ust_app_register_done(ust_cmd
.sock
);
1155 * If the registration is not possible, we simply
1156 * unregister the apps and continue
1158 ust_app_unregister(ust_cmd
.sock
);
1161 * We just need here to monitor the close of the UST
1162 * socket and poll set monitor those by default.
1164 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1169 DBG("Apps with sock %d added to poll set",
1177 * At this point, we know that a registered application made
1178 * the event at poll_wait.
1180 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1181 /* Removing from the poll set */
1182 ret
= lttng_poll_del(&events
, pollfd
);
1187 /* Socket closed on remote end. */
1188 ust_app_unregister(pollfd
);
1196 DBG("Application communication apps dying");
1197 close(apps_cmd_pipe
[0]);
1198 close(apps_cmd_pipe
[1]);
1200 lttng_poll_clean(&events
);
1202 rcu_thread_offline();
1203 rcu_unregister_thread();
1208 * Dispatch request from the registration threads to the application
1209 * communication thread.
1211 static void *thread_dispatch_ust_registration(void *data
)
1214 struct cds_wfq_node
*node
;
1215 struct ust_command
*ust_cmd
= NULL
;
1217 DBG("[thread] Dispatch UST command started");
1219 while (!dispatch_thread_exit
) {
1220 /* Atomically prepare the queue futex */
1221 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1224 /* Dequeue command for registration */
1225 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1227 DBG("Woken up but nothing in the UST command queue");
1228 /* Continue thread execution */
1232 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1234 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1235 " gid:%d sock:%d name:%s (version %d.%d)",
1236 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1237 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1238 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1239 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1241 * Inform apps thread of the new application registration. This
1242 * call is blocking so we can be assured that the data will be read
1243 * at some point in time or wait to the end of the world :)
1245 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1246 sizeof(struct ust_command
));
1248 perror("write apps cmd pipe");
1249 if (errno
== EBADF
) {
1251 * We can't inform the application thread to process
1252 * registration. We will exit or else application
1253 * registration will not occur and tracing will never
1260 } while (node
!= NULL
);
1262 /* Futex wait on queue. Blocking call on futex() */
1263 futex_nto1_wait(&ust_cmd_queue
.futex
);
1267 DBG("Dispatch thread dying");
1272 * This thread manage application registration.
1274 static void *thread_registration_apps(void *data
)
1276 int sock
= 0, i
, ret
, pollfd
;
1277 uint32_t revents
, nb_fd
;
1278 struct lttng_poll_event events
;
1280 * Get allocated in this thread, enqueued to a global queue, dequeued and
1281 * freed in the manage apps thread.
1283 struct ust_command
*ust_cmd
= NULL
;
1285 DBG("[thread] Manage application registration started");
1287 ret
= lttcomm_listen_unix_sock(apps_sock
);
1293 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1294 * more will be added to this poll set.
1296 ret
= create_thread_poll_set(&events
, 2);
1301 /* Add the application registration socket */
1302 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1307 /* Notify all applications to register */
1308 ret
= notify_ust_apps(1);
1310 ERR("Failed to notify applications or create the wait shared memory.\n"
1311 "Execution continues but there might be problem for already\n"
1312 "running applications that wishes to register.");
1316 DBG("Accepting application registration");
1318 nb_fd
= LTTNG_POLL_GETNB(&events
);
1320 /* Inifinite blocking call, waiting for transmission */
1321 ret
= lttng_poll_wait(&events
, -1);
1326 for (i
= 0; i
< nb_fd
; i
++) {
1327 /* Fetch once the poll data */
1328 revents
= LTTNG_POLL_GETEV(&events
, i
);
1329 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1331 /* Thread quit pipe has been closed. Killing thread. */
1332 ret
= check_thread_quit_pipe(pollfd
, revents
);
1337 /* Event on the registration socket */
1338 if (pollfd
== apps_sock
) {
1339 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1340 ERR("Register apps socket poll error");
1342 } else if (revents
& LPOLLIN
) {
1343 sock
= lttcomm_accept_unix_sock(apps_sock
);
1348 /* Create UST registration command for enqueuing */
1349 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1350 if (ust_cmd
== NULL
) {
1351 perror("ust command zmalloc");
1356 * Using message-based transmissions to ensure we don't
1357 * have to deal with partially received messages.
1359 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1360 sizeof(struct ust_register_msg
));
1361 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1363 perror("lttcomm_recv_unix_sock register apps");
1365 ERR("Wrong size received on apps register");
1372 ust_cmd
->sock
= sock
;
1374 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1375 " gid:%d sock:%d name:%s (version %d.%d)",
1376 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1377 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1378 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1379 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1382 * Lock free enqueue the registration request. The red pill
1383 * has been taken! This apps will be part of the *system*.
1385 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1388 * Wake the registration queue futex. Implicit memory
1389 * barrier with the exchange in cds_wfq_enqueue.
1391 futex_nto1_wake(&ust_cmd_queue
.futex
);
1398 DBG("UST Registration thread dying");
1400 /* Notify that the registration thread is gone */
1405 unlink(apps_unix_sock_path
);
1407 lttng_poll_clean(&events
);
1413 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1414 * exec or it will fails.
1416 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1419 struct timespec timeout
;
1421 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1422 timeout
.tv_nsec
= 0;
1424 /* Setup semaphore */
1425 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1427 PERROR("sem_init consumer semaphore");
1431 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1432 thread_manage_consumer
, consumer_data
);
1434 PERROR("pthread_create consumer");
1439 /* Get time for sem_timedwait absolute timeout */
1440 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1442 PERROR("clock_gettime spawn consumer");
1443 /* Infinite wait for the kconsumerd thread to be ready */
1444 ret
= sem_wait(&consumer_data
->sem
);
1446 /* Normal timeout if the gettime was successful */
1447 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1448 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1452 if (errno
== ETIMEDOUT
) {
1454 * Call has timed out so we kill the kconsumerd_thread and return
1457 ERR("The consumer thread was never ready. Killing it");
1458 ret
= pthread_cancel(consumer_data
->thread
);
1460 PERROR("pthread_cancel consumer thread");
1463 PERROR("semaphore wait failed consumer thread");
1468 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1469 if (consumer_data
->pid
== 0) {
1470 ERR("Kconsumerd did not start");
1471 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1474 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1483 * Join consumer thread
1485 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1490 if (consumer_data
->pid
!= 0) {
1491 ret
= kill(consumer_data
->pid
, SIGTERM
);
1493 ERR("Error killing consumer daemon");
1496 return pthread_join(consumer_data
->thread
, &status
);
1503 * Fork and exec a consumer daemon (consumerd).
1505 * Return pid if successful else -1.
1507 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1511 const char *consumer_to_use
;
1512 const char *verbosity
;
1515 DBG("Spawning consumerd");
1522 if (opt_verbose_consumer
) {
1523 verbosity
= "--verbose";
1525 verbosity
= "--quiet";
1527 switch (consumer_data
->type
) {
1528 case LTTNG_CONSUMER_KERNEL
:
1530 * Find out which consumerd to execute. We will first try the
1531 * 64-bit path, then the sessiond's installation directory, and
1532 * fallback on the 32-bit one,
1534 DBG3("Looking for a kernel consumer at these locations:");
1535 DBG3(" 1) %s", consumerd64_bin
);
1536 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1537 DBG3(" 3) %s", consumerd32_bin
);
1538 if (stat(consumerd64_bin
, &st
) == 0) {
1539 DBG3("Found location #1");
1540 consumer_to_use
= consumerd64_bin
;
1541 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1542 DBG3("Found location #2");
1543 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1544 } else if (stat(consumerd32_bin
, &st
) == 0) {
1545 DBG3("Found location #3");
1546 consumer_to_use
= consumerd32_bin
;
1548 DBG("Could not find any valid consumerd executable");
1551 DBG("Using kernel consumer at: %s", consumer_to_use
);
1552 execl(consumer_to_use
,
1553 "lttng-consumerd", verbosity
, "-k",
1554 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1555 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1558 case LTTNG_CONSUMER64_UST
:
1560 char *tmpnew
= NULL
;
1562 if (consumerd64_libdir
[0] != '\0') {
1566 tmp
= getenv("LD_LIBRARY_PATH");
1570 tmplen
= strlen("LD_LIBRARY_PATH=")
1571 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1572 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1577 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1578 strcat(tmpnew
, consumerd64_libdir
);
1579 if (tmp
[0] != '\0') {
1580 strcat(tmpnew
, ":");
1581 strcat(tmpnew
, tmp
);
1583 ret
= putenv(tmpnew
);
1589 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1590 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1591 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1592 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1594 if (consumerd64_libdir
[0] != '\0') {
1602 case LTTNG_CONSUMER32_UST
:
1604 char *tmpnew
= NULL
;
1606 if (consumerd32_libdir
[0] != '\0') {
1610 tmp
= getenv("LD_LIBRARY_PATH");
1614 tmplen
= strlen("LD_LIBRARY_PATH=")
1615 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1616 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1621 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1622 strcat(tmpnew
, consumerd32_libdir
);
1623 if (tmp
[0] != '\0') {
1624 strcat(tmpnew
, ":");
1625 strcat(tmpnew
, tmp
);
1627 ret
= putenv(tmpnew
);
1633 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1634 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1635 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1636 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1638 if (consumerd32_libdir
[0] != '\0') {
1647 perror("unknown consumer type");
1651 perror("kernel start consumer exec");
1654 } else if (pid
> 0) {
1657 perror("start consumer fork");
1665 * Spawn the consumerd daemon and session daemon thread.
1667 static int start_consumerd(struct consumer_data
*consumer_data
)
1671 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1672 if (consumer_data
->pid
!= 0) {
1673 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1677 ret
= spawn_consumerd(consumer_data
);
1679 ERR("Spawning consumerd failed");
1680 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1684 /* Setting up the consumer_data pid */
1685 consumer_data
->pid
= ret
;
1686 DBG2("Consumer pid %d", consumer_data
->pid
);
1687 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1689 DBG2("Spawning consumer control thread");
1690 ret
= spawn_consumer_thread(consumer_data
);
1692 ERR("Fatal error spawning consumer control thread");
1704 * modprobe_kernel_modules
1706 static int modprobe_kernel_modules(void)
1711 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1712 ret
= snprintf(modprobe
, sizeof(modprobe
),
1713 "/sbin/modprobe %s%s",
1714 kernel_modules_list
[i
].required
? "" : "-q ",
1715 kernel_modules_list
[i
].name
);
1717 perror("snprintf modprobe");
1720 modprobe
[sizeof(modprobe
) - 1] = '\0';
1721 ret
= system(modprobe
);
1723 ERR("Unable to launch modprobe for module %s",
1724 kernel_modules_list
[i
].name
);
1725 } else if (kernel_modules_list
[i
].required
1726 && WEXITSTATUS(ret
) != 0) {
1727 ERR("Unable to load module %s",
1728 kernel_modules_list
[i
].name
);
1730 DBG("Modprobe successfully %s",
1731 kernel_modules_list
[i
].name
);
1742 static int mount_debugfs(char *path
)
1745 char *type
= "debugfs";
1747 ret
= run_as_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1749 PERROR("Cannot create debugfs path");
1753 ret
= mount(type
, path
, type
, 0, NULL
);
1755 PERROR("Cannot mount debugfs");
1759 DBG("Mounted debugfs successfully at %s", path
);
1766 * Setup necessary data for kernel tracer action.
1768 static void init_kernel_tracer(void)
1771 char *proc_mounts
= "/proc/mounts";
1773 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1776 /* Detect debugfs */
1777 fp
= fopen(proc_mounts
, "r");
1779 ERR("Unable to probe %s", proc_mounts
);
1783 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1784 if (strstr(line
, "debugfs") != NULL
) {
1785 /* Remove first string */
1787 /* Dup string here so we can reuse line later on */
1788 debugfs_path
= strdup(strtok(NULL
, " "));
1789 DBG("Got debugfs path : %s", debugfs_path
);
1796 /* Mount debugfs if needded */
1797 if (debugfs_path
== NULL
) {
1798 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1800 perror("asprintf debugfs path");
1803 ret
= mount_debugfs(debugfs_path
);
1805 perror("Cannot mount debugfs");
1810 /* Modprobe lttng kernel modules */
1811 ret
= modprobe_kernel_modules();
1816 /* Setup lttng kernel path */
1817 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1819 perror("asprintf lttng path");
1823 /* Open debugfs lttng */
1824 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1825 if (kernel_tracer_fd
< 0) {
1826 DBG("Failed to open %s", lttng_path
);
1832 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1842 WARN("No kernel tracer available");
1843 kernel_tracer_fd
= 0;
1848 * Init tracing by creating trace directory and sending fds kernel consumer.
1850 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1854 if (session
->consumer_fds_sent
== 0) {
1856 * Assign default kernel consumer socket if no consumer assigned to the
1857 * kernel session. At this point, it's NOT suppose to be 0 but this is
1858 * an extra security check.
1860 if (session
->consumer_fd
== 0) {
1861 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1864 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1866 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1870 session
->consumer_fds_sent
= 1;
1878 * Create an UST session and add it to the session ust list.
1880 static int create_ust_session(struct ltt_session
*session
,
1881 struct lttng_domain
*domain
)
1883 struct ltt_ust_session
*lus
= NULL
;
1886 switch (domain
->type
) {
1887 case LTTNG_DOMAIN_UST
:
1890 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1894 DBG("Creating UST session");
1896 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1898 ret
= LTTCOMM_UST_SESS_FAIL
;
1902 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1903 session
->uid
, session
->gid
);
1905 if (ret
!= -EEXIST
) {
1906 ERR("Trace directory creation error");
1907 ret
= LTTCOMM_UST_SESS_FAIL
;
1912 /* The domain type dictate different actions on session creation */
1913 switch (domain
->type
) {
1914 case LTTNG_DOMAIN_UST
:
1915 /* No ustctl for the global UST domain */
1918 ERR("Unknown UST domain on create session %d", domain
->type
);
1921 lus
->uid
= session
->uid
;
1922 lus
->gid
= session
->gid
;
1923 session
->ust_session
= lus
;
1933 * Create a kernel tracer session then create the default channel.
1935 static int create_kernel_session(struct ltt_session
*session
)
1939 DBG("Creating kernel session");
1941 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1943 ret
= LTTCOMM_KERN_SESS_FAIL
;
1947 /* Set kernel consumer socket fd */
1948 if (kconsumer_data
.cmd_sock
) {
1949 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1952 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1953 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1955 if (ret
!= -EEXIST
) {
1956 ERR("Trace directory creation error");
1960 session
->kernel_session
->uid
= session
->uid
;
1961 session
->kernel_session
->gid
= session
->gid
;
1968 * Check if the UID or GID match the session. Root user has access to all
1971 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1973 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1980 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1983 struct ltt_session
*session
;
1985 DBG("Counting number of available session for UID %d GID %d",
1987 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1989 * Only list the sessions the user can control.
1991 if (!session_access_ok(session
, uid
, gid
)) {
2000 * Using the session list, filled a lttng_session array to send back to the
2001 * client for session listing.
2003 * The session list lock MUST be acquired before calling this function. Use
2004 * session_lock_list() and session_unlock_list().
2006 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2010 struct ltt_session
*session
;
2012 DBG("Getting all available session for UID %d GID %d",
2015 * Iterate over session list and append data after the control struct in
2018 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2020 * Only list the sessions the user can control.
2022 if (!session_access_ok(session
, uid
, gid
)) {
2025 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2026 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2027 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2028 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2029 sessions
[i
].enabled
= session
->enabled
;
2035 * Fill lttng_channel array of all channels.
2037 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2038 struct lttng_channel
*channels
)
2041 struct ltt_kernel_channel
*kchan
;
2043 DBG("Listing channels for session %s", session
->name
);
2046 case LTTNG_DOMAIN_KERNEL
:
2047 /* Kernel channels */
2048 if (session
->kernel_session
!= NULL
) {
2049 cds_list_for_each_entry(kchan
,
2050 &session
->kernel_session
->channel_list
.head
, list
) {
2051 /* Copy lttng_channel struct to array */
2052 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2053 channels
[i
].enabled
= kchan
->enabled
;
2058 case LTTNG_DOMAIN_UST
:
2060 struct lttng_ht_iter iter
;
2061 struct ltt_ust_channel
*uchan
;
2063 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2064 &iter
.iter
, uchan
, node
.node
) {
2065 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2066 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2067 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2068 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2069 channels
[i
].attr
.switch_timer_interval
=
2070 uchan
->attr
.switch_timer_interval
;
2071 channels
[i
].attr
.read_timer_interval
=
2072 uchan
->attr
.read_timer_interval
;
2073 channels
[i
].enabled
= uchan
->enabled
;
2074 switch (uchan
->attr
.output
) {
2075 case LTTNG_UST_MMAP
:
2077 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2090 * Create a list of ust global domain events.
2092 static int list_lttng_ust_global_events(char *channel_name
,
2093 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2096 unsigned int nb_event
= 0;
2097 struct lttng_ht_iter iter
;
2098 struct lttng_ht_node_str
*node
;
2099 struct ltt_ust_channel
*uchan
;
2100 struct ltt_ust_event
*uevent
;
2101 struct lttng_event
*tmp
;
2103 DBG("Listing UST global events for channel %s", channel_name
);
2107 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2108 node
= lttng_ht_iter_get_node_str(&iter
);
2110 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2114 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2116 nb_event
+= lttng_ht_get_count(uchan
->events
);
2118 if (nb_event
== 0) {
2123 DBG3("Listing UST global %d events", nb_event
);
2125 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2127 ret
= -LTTCOMM_FATAL
;
2131 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2132 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2133 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2134 tmp
[i
].enabled
= uevent
->enabled
;
2135 switch (uevent
->attr
.instrumentation
) {
2136 case LTTNG_UST_TRACEPOINT
:
2137 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2139 case LTTNG_UST_PROBE
:
2140 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2142 case LTTNG_UST_FUNCTION
:
2143 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2145 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2146 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2161 * Fill lttng_event array of all kernel events in the channel.
2163 static int list_lttng_kernel_events(char *channel_name
,
2164 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2167 unsigned int nb_event
;
2168 struct ltt_kernel_event
*event
;
2169 struct ltt_kernel_channel
*kchan
;
2171 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2172 if (kchan
== NULL
) {
2173 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2177 nb_event
= kchan
->event_count
;
2179 DBG("Listing events for channel %s", kchan
->channel
->name
);
2181 if (nb_event
== 0) {
2186 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2187 if (*events
== NULL
) {
2188 ret
= LTTCOMM_FATAL
;
2192 /* Kernel channels */
2193 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2194 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2195 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2196 (*events
)[i
].enabled
= event
->enabled
;
2197 switch (event
->event
->instrumentation
) {
2198 case LTTNG_KERNEL_TRACEPOINT
:
2199 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2201 case LTTNG_KERNEL_KPROBE
:
2202 case LTTNG_KERNEL_KRETPROBE
:
2203 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2204 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2205 sizeof(struct lttng_kernel_kprobe
));
2207 case LTTNG_KERNEL_FUNCTION
:
2208 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2209 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2210 sizeof(struct lttng_kernel_function
));
2212 case LTTNG_KERNEL_NOOP
:
2213 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2215 case LTTNG_KERNEL_SYSCALL
:
2216 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2218 case LTTNG_KERNEL_ALL
:
2232 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2234 static int cmd_disable_channel(struct ltt_session
*session
,
2235 int domain
, char *channel_name
)
2238 struct ltt_ust_session
*usess
;
2240 usess
= session
->ust_session
;
2243 case LTTNG_DOMAIN_KERNEL
:
2245 ret
= channel_kernel_disable(session
->kernel_session
,
2247 if (ret
!= LTTCOMM_OK
) {
2251 kernel_wait_quiescent(kernel_tracer_fd
);
2254 case LTTNG_DOMAIN_UST
:
2256 struct ltt_ust_channel
*uchan
;
2257 struct lttng_ht
*chan_ht
;
2259 chan_ht
= usess
->domain_global
.channels
;
2261 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2262 if (uchan
== NULL
) {
2263 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2267 ret
= channel_ust_disable(usess
, domain
, uchan
);
2268 if (ret
!= LTTCOMM_OK
) {
2273 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2274 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2275 case LTTNG_DOMAIN_UST_PID
:
2276 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2279 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2290 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2292 static int cmd_enable_channel(struct ltt_session
*session
,
2293 int domain
, struct lttng_channel
*attr
)
2296 struct ltt_ust_session
*usess
= session
->ust_session
;
2297 struct lttng_ht
*chan_ht
;
2299 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2302 case LTTNG_DOMAIN_KERNEL
:
2304 struct ltt_kernel_channel
*kchan
;
2306 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2307 session
->kernel_session
);
2308 if (kchan
== NULL
) {
2309 ret
= channel_kernel_create(session
->kernel_session
,
2310 attr
, kernel_poll_pipe
[1]);
2312 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2315 if (ret
!= LTTCOMM_OK
) {
2319 kernel_wait_quiescent(kernel_tracer_fd
);
2322 case LTTNG_DOMAIN_UST
:
2324 struct ltt_ust_channel
*uchan
;
2326 chan_ht
= usess
->domain_global
.channels
;
2328 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2329 if (uchan
== NULL
) {
2330 ret
= channel_ust_create(usess
, domain
, attr
);
2332 ret
= channel_ust_enable(usess
, domain
, uchan
);
2336 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2337 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2338 case LTTNG_DOMAIN_UST_PID
:
2339 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2342 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2351 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2353 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2354 char *channel_name
, char *event_name
)
2359 case LTTNG_DOMAIN_KERNEL
:
2361 struct ltt_kernel_channel
*kchan
;
2362 struct ltt_kernel_session
*ksess
;
2364 ksess
= session
->kernel_session
;
2366 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2367 if (kchan
== NULL
) {
2368 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2372 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2373 if (ret
!= LTTCOMM_OK
) {
2377 kernel_wait_quiescent(kernel_tracer_fd
);
2380 case LTTNG_DOMAIN_UST
:
2382 struct ltt_ust_channel
*uchan
;
2383 struct ltt_ust_session
*usess
;
2385 usess
= session
->ust_session
;
2387 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2389 if (uchan
== NULL
) {
2390 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2394 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2395 if (ret
!= LTTCOMM_OK
) {
2399 DBG3("Disable UST event %s in channel %s completed", event_name
,
2403 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2404 case LTTNG_DOMAIN_UST_PID
:
2405 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2407 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2418 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2420 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2426 case LTTNG_DOMAIN_KERNEL
:
2428 struct ltt_kernel_session
*ksess
;
2429 struct ltt_kernel_channel
*kchan
;
2431 ksess
= session
->kernel_session
;
2433 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2434 if (kchan
== NULL
) {
2435 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2439 ret
= event_kernel_disable_all(ksess
, kchan
);
2440 if (ret
!= LTTCOMM_OK
) {
2444 kernel_wait_quiescent(kernel_tracer_fd
);
2447 case LTTNG_DOMAIN_UST
:
2449 struct ltt_ust_session
*usess
;
2450 struct ltt_ust_channel
*uchan
;
2452 usess
= session
->ust_session
;
2454 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2456 if (uchan
== NULL
) {
2457 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2461 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2466 DBG3("Disable all UST events in channel %s completed", channel_name
);
2470 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2471 case LTTNG_DOMAIN_UST_PID
:
2472 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2474 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2485 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2487 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2488 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2493 case LTTNG_DOMAIN_KERNEL
:
2494 /* Add kernel context to kernel tracer */
2495 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2496 event_name
, channel_name
);
2497 if (ret
!= LTTCOMM_OK
) {
2501 case LTTNG_DOMAIN_UST
:
2503 struct ltt_ust_session
*usess
= session
->ust_session
;
2505 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2506 if (ret
!= LTTCOMM_OK
) {
2511 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2512 case LTTNG_DOMAIN_UST_PID
:
2513 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2515 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2526 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2528 * TODO: currently, both events and loglevels are kept within the same
2529 * namespace for UST global registry/app registery, so if an event
2530 * happen to have the same name as the loglevel (very unlikely though),
2531 * and an attempt is made to enable/disable both in the same session,
2532 * the first to be created will be the only one allowed to exist.
2534 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2535 char *channel_name
, struct lttng_event
*event
)
2538 struct lttng_channel
*attr
;
2539 struct ltt_ust_session
*usess
= session
->ust_session
;
2542 case LTTNG_DOMAIN_KERNEL
:
2544 struct ltt_kernel_channel
*kchan
;
2546 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2547 session
->kernel_session
);
2548 if (kchan
== NULL
) {
2549 attr
= channel_new_default_attr(domain
);
2551 ret
= LTTCOMM_FATAL
;
2554 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2556 /* This call will notify the kernel thread */
2557 ret
= channel_kernel_create(session
->kernel_session
,
2558 attr
, kernel_poll_pipe
[1]);
2559 if (ret
!= LTTCOMM_OK
) {
2566 /* Get the newly created kernel channel pointer */
2567 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2568 session
->kernel_session
);
2569 if (kchan
== NULL
) {
2570 /* This sould not happen... */
2571 ret
= LTTCOMM_FATAL
;
2575 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2577 if (ret
!= LTTCOMM_OK
) {
2581 kernel_wait_quiescent(kernel_tracer_fd
);
2584 case LTTNG_DOMAIN_UST
:
2586 struct lttng_channel
*attr
;
2587 struct ltt_ust_channel
*uchan
;
2589 /* Get channel from global UST domain */
2590 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2592 if (uchan
== NULL
) {
2593 /* Create default channel */
2594 attr
= channel_new_default_attr(domain
);
2596 ret
= LTTCOMM_FATAL
;
2599 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2600 attr
->name
[NAME_MAX
- 1] = '\0';
2602 ret
= channel_ust_create(usess
, domain
, attr
);
2603 if (ret
!= LTTCOMM_OK
) {
2609 /* Get the newly created channel reference back */
2610 uchan
= trace_ust_find_channel_by_name(
2611 usess
->domain_global
.channels
, channel_name
);
2612 if (uchan
== NULL
) {
2613 /* Something is really wrong */
2614 ret
= LTTCOMM_FATAL
;
2619 /* At this point, the session and channel exist on the tracer */
2620 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2621 if (ret
!= LTTCOMM_OK
) {
2626 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2627 case LTTNG_DOMAIN_UST_PID
:
2628 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2630 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2641 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2643 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2644 char *channel_name
, int event_type
)
2647 struct ltt_kernel_channel
*kchan
;
2650 case LTTNG_DOMAIN_KERNEL
:
2651 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2652 session
->kernel_session
);
2653 if (kchan
== NULL
) {
2654 /* This call will notify the kernel thread */
2655 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2656 kernel_poll_pipe
[1]);
2657 if (ret
!= LTTCOMM_OK
) {
2661 /* Get the newly created kernel channel pointer */
2662 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2663 session
->kernel_session
);
2664 if (kchan
== NULL
) {
2665 /* This sould not happen... */
2666 ret
= LTTCOMM_FATAL
;
2672 switch (event_type
) {
2673 case LTTNG_EVENT_SYSCALL
:
2674 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2675 kchan
, kernel_tracer_fd
);
2677 case LTTNG_EVENT_TRACEPOINT
:
2679 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2680 * events already registered to the channel.
2682 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2683 kchan
, kernel_tracer_fd
);
2685 case LTTNG_EVENT_ALL
:
2686 /* Enable syscalls and tracepoints */
2687 ret
= event_kernel_enable_all(session
->kernel_session
,
2688 kchan
, kernel_tracer_fd
);
2691 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2695 /* Manage return value */
2696 if (ret
!= LTTCOMM_OK
) {
2700 kernel_wait_quiescent(kernel_tracer_fd
);
2702 case LTTNG_DOMAIN_UST
:
2704 struct lttng_channel
*attr
;
2705 struct ltt_ust_channel
*uchan
;
2706 struct ltt_ust_session
*usess
= session
->ust_session
;
2708 /* Get channel from global UST domain */
2709 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2711 if (uchan
== NULL
) {
2712 /* Create default channel */
2713 attr
= channel_new_default_attr(domain
);
2715 ret
= LTTCOMM_FATAL
;
2718 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2719 attr
->name
[NAME_MAX
- 1] = '\0';
2721 /* Use the internal command enable channel */
2722 ret
= channel_ust_create(usess
, domain
, attr
);
2723 if (ret
!= LTTCOMM_OK
) {
2729 /* Get the newly created channel reference back */
2730 uchan
= trace_ust_find_channel_by_name(
2731 usess
->domain_global
.channels
, channel_name
);
2732 if (uchan
== NULL
) {
2733 /* Something is really wrong */
2734 ret
= LTTCOMM_FATAL
;
2739 /* At this point, the session and channel exist on the tracer */
2741 switch (event_type
) {
2742 case LTTNG_EVENT_ALL
:
2743 case LTTNG_EVENT_TRACEPOINT
:
2744 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2745 if (ret
!= LTTCOMM_OK
) {
2750 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2754 /* Manage return value */
2755 if (ret
!= LTTCOMM_OK
) {
2761 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2762 case LTTNG_DOMAIN_UST_PID
:
2763 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2765 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2776 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2778 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2781 ssize_t nb_events
= 0;
2784 case LTTNG_DOMAIN_KERNEL
:
2785 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2786 if (nb_events
< 0) {
2787 ret
= LTTCOMM_KERN_LIST_FAIL
;
2791 case LTTNG_DOMAIN_UST
:
2792 nb_events
= ust_app_list_events(events
);
2793 if (nb_events
< 0) {
2794 ret
= LTTCOMM_UST_LIST_FAIL
;
2799 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2806 /* Return negative value to differentiate return code */
2811 * Command LTTNG_START_TRACE processed by the client thread.
2813 static int cmd_start_trace(struct ltt_session
*session
)
2816 struct ltt_kernel_session
*ksession
;
2817 struct ltt_ust_session
*usess
;
2820 ksession
= session
->kernel_session
;
2821 usess
= session
->ust_session
;
2823 if (session
->enabled
) {
2824 ret
= LTTCOMM_UST_START_FAIL
;
2828 session
->enabled
= 1;
2830 /* Kernel tracing */
2831 if (ksession
!= NULL
) {
2832 struct ltt_kernel_channel
*kchan
;
2834 /* Open kernel metadata */
2835 if (ksession
->metadata
== NULL
) {
2836 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2838 ret
= LTTCOMM_KERN_META_FAIL
;
2843 /* Open kernel metadata stream */
2844 if (ksession
->metadata_stream_fd
== 0) {
2845 ret
= kernel_open_metadata_stream(ksession
);
2847 ERR("Kernel create metadata stream failed");
2848 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2853 /* For each channel */
2854 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2855 if (kchan
->stream_count
== 0) {
2856 ret
= kernel_open_channel_stream(kchan
);
2858 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2861 /* Update the stream global counter */
2862 ksession
->stream_count_global
+= ret
;
2866 /* Setup kernel consumer socket and send fds to it */
2867 ret
= init_kernel_tracing(ksession
);
2869 ret
= LTTCOMM_KERN_START_FAIL
;
2873 /* This start the kernel tracing */
2874 ret
= kernel_start_session(ksession
);
2876 ret
= LTTCOMM_KERN_START_FAIL
;
2880 /* Quiescent wait after starting trace */
2881 kernel_wait_quiescent(kernel_tracer_fd
);
2884 /* Flag session that trace should start automatically */
2886 usess
->start_trace
= 1;
2888 ret
= ust_app_start_trace_all(usess
);
2890 ret
= LTTCOMM_UST_START_FAIL
;
2902 * Command LTTNG_STOP_TRACE processed by the client thread.
2904 static int cmd_stop_trace(struct ltt_session
*session
)
2907 struct ltt_kernel_channel
*kchan
;
2908 struct ltt_kernel_session
*ksession
;
2909 struct ltt_ust_session
*usess
;
2912 ksession
= session
->kernel_session
;
2913 usess
= session
->ust_session
;
2915 if (!session
->enabled
) {
2916 ret
= LTTCOMM_UST_STOP_FAIL
;
2920 session
->enabled
= 0;
2923 if (ksession
!= NULL
) {
2924 DBG("Stop kernel tracing");
2926 /* Flush all buffers before stopping */
2927 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2929 ERR("Kernel metadata flush failed");
2932 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2933 ret
= kernel_flush_buffer(kchan
);
2935 ERR("Kernel flush buffer error");
2939 ret
= kernel_stop_session(ksession
);
2941 ret
= LTTCOMM_KERN_STOP_FAIL
;
2945 kernel_wait_quiescent(kernel_tracer_fd
);
2949 usess
->start_trace
= 0;
2951 ret
= ust_app_stop_trace_all(usess
);
2953 ret
= LTTCOMM_UST_STOP_FAIL
;
2965 * Command LTTNG_CREATE_SESSION processed by the client thread.
2967 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2971 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2972 if (ret
!= LTTCOMM_OK
) {
2983 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2985 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2989 /* Clean kernel session teardown */
2990 teardown_kernel_session(session
);
2991 /* UST session teardown */
2992 teardown_ust_session(session
);
2995 * Must notify the kernel thread here to update it's poll setin order
2996 * to remove the channel(s)' fd just destroyed.
2998 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3000 perror("write kernel poll pipe");
3003 ret
= session_destroy(session
);
3009 * Command LTTNG_CALIBRATE processed by the client thread.
3011 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3016 case LTTNG_DOMAIN_KERNEL
:
3018 struct lttng_kernel_calibrate kcalibrate
;
3020 kcalibrate
.type
= calibrate
->type
;
3021 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3023 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3029 /* TODO: Userspace tracing */
3030 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3041 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3043 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3049 case LTTNG_DOMAIN_KERNEL
:
3050 /* Can't register a consumer if there is already one */
3051 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3052 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3056 sock
= lttcomm_connect_unix_sock(sock_path
);
3058 ret
= LTTCOMM_CONNECT_FAIL
;
3062 session
->kernel_session
->consumer_fd
= sock
;
3065 /* TODO: Userspace tracing */
3066 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3077 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3079 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3080 struct lttng_domain
**domains
)
3085 if (session
->kernel_session
!= NULL
) {
3086 DBG3("Listing domains found kernel domain");
3090 if (session
->ust_session
!= NULL
) {
3091 DBG3("Listing domains found UST global domain");
3095 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3096 if (*domains
== NULL
) {
3097 ret
= -LTTCOMM_FATAL
;
3101 if (session
->kernel_session
!= NULL
) {
3102 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3106 if (session
->ust_session
!= NULL
) {
3107 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3118 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3120 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3121 struct lttng_channel
**channels
)
3124 ssize_t nb_chan
= 0;
3127 case LTTNG_DOMAIN_KERNEL
:
3128 if (session
->kernel_session
!= NULL
) {
3129 nb_chan
= session
->kernel_session
->channel_count
;
3131 DBG3("Number of kernel channels %zd", nb_chan
);
3133 case LTTNG_DOMAIN_UST
:
3134 if (session
->ust_session
!= NULL
) {
3135 nb_chan
= lttng_ht_get_count(
3136 session
->ust_session
->domain_global
.channels
);
3138 DBG3("Number of UST global channels %zd", nb_chan
);
3142 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3147 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3148 if (*channels
== NULL
) {
3149 ret
= -LTTCOMM_FATAL
;
3153 list_lttng_channels(domain
, session
, *channels
);
3165 * Command LTTNG_LIST_EVENTS processed by the client thread.
3167 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3168 char *channel_name
, struct lttng_event
**events
)
3171 ssize_t nb_event
= 0;
3174 case LTTNG_DOMAIN_KERNEL
:
3175 if (session
->kernel_session
!= NULL
) {
3176 nb_event
= list_lttng_kernel_events(channel_name
,
3177 session
->kernel_session
, events
);
3180 case LTTNG_DOMAIN_UST
:
3182 if (session
->ust_session
!= NULL
) {
3183 nb_event
= list_lttng_ust_global_events(channel_name
,
3184 &session
->ust_session
->domain_global
, events
);
3189 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3200 * Process the command requested by the lttng client within the command
3201 * context structure. This function make sure that the return structure (llm)
3202 * is set and ready for transmission before returning.
3204 * Return any error encountered or 0 for success.
3206 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3208 int ret
= LTTCOMM_OK
;
3209 int need_tracing_session
= 1;
3211 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3213 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3214 ret
= LTTCOMM_KERN_NA
;
3219 * Check for command that don't needs to allocate a returned payload. We do
3220 * this here so we don't have to make the call for no payload at each
3223 switch(cmd_ctx
->lsm
->cmd_type
) {
3224 case LTTNG_LIST_SESSIONS
:
3225 case LTTNG_LIST_TRACEPOINTS
:
3226 case LTTNG_LIST_DOMAINS
:
3227 case LTTNG_LIST_CHANNELS
:
3228 case LTTNG_LIST_EVENTS
:
3231 /* Setup lttng message with no payload */
3232 ret
= setup_lttng_msg(cmd_ctx
, 0);
3234 /* This label does not try to unlock the session */
3235 goto init_setup_error
;
3239 /* Commands that DO NOT need a session. */
3240 switch (cmd_ctx
->lsm
->cmd_type
) {
3241 case LTTNG_CALIBRATE
:
3242 case LTTNG_CREATE_SESSION
:
3243 case LTTNG_LIST_SESSIONS
:
3244 case LTTNG_LIST_TRACEPOINTS
:
3245 need_tracing_session
= 0;
3248 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3249 session_lock_list();
3250 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3251 session_unlock_list();
3252 if (cmd_ctx
->session
== NULL
) {
3253 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3254 ret
= LTTCOMM_SESS_NOT_FOUND
;
3256 /* If no session name specified */
3257 ret
= LTTCOMM_SELECT_SESS
;
3261 /* Acquire lock for the session */
3262 session_lock(cmd_ctx
->session
);
3268 * Check domain type for specific "pre-action".
3270 switch (cmd_ctx
->lsm
->domain
.type
) {
3271 case LTTNG_DOMAIN_KERNEL
:
3273 ret
= LTTCOMM_KERN_NA
;
3277 /* Kernel tracer check */
3278 if (kernel_tracer_fd
== 0) {
3279 /* Basically, load kernel tracer modules */
3280 init_kernel_tracer();
3281 if (kernel_tracer_fd
== 0) {
3282 ret
= LTTCOMM_KERN_NA
;
3287 /* Need a session for kernel command */
3288 if (need_tracing_session
) {
3289 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3290 ret
= create_kernel_session(cmd_ctx
->session
);
3292 ret
= LTTCOMM_KERN_SESS_FAIL
;
3297 /* Start the kernel consumer daemon */
3298 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3299 if (kconsumer_data
.pid
== 0 &&
3300 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3301 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3302 ret
= start_consumerd(&kconsumer_data
);
3304 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3308 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3312 case LTTNG_DOMAIN_UST
:
3314 if (need_tracing_session
) {
3315 if (cmd_ctx
->session
->ust_session
== NULL
) {
3316 ret
= create_ust_session(cmd_ctx
->session
,
3317 &cmd_ctx
->lsm
->domain
);
3318 if (ret
!= LTTCOMM_OK
) {
3322 /* Start the UST consumer daemons */
3324 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3325 if (consumerd64_bin
[0] != '\0' &&
3326 ustconsumer64_data
.pid
== 0 &&
3327 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3328 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3329 ret
= start_consumerd(&ustconsumer64_data
);
3331 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3332 ust_consumerd64_fd
= -EINVAL
;
3336 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3338 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3341 if (consumerd32_bin
[0] != '\0' &&
3342 ustconsumer32_data
.pid
== 0 &&
3343 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3344 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3345 ret
= start_consumerd(&ustconsumer32_data
);
3347 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3348 ust_consumerd32_fd
= -EINVAL
;
3351 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3353 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3363 * Check that the UID or GID match that of the tracing session.
3364 * The root user can interact with all sessions.
3366 if (need_tracing_session
) {
3367 if (!session_access_ok(cmd_ctx
->session
,
3368 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3369 ret
= LTTCOMM_EPERM
;
3374 /* Process by command type */
3375 switch (cmd_ctx
->lsm
->cmd_type
) {
3376 case LTTNG_ADD_CONTEXT
:
3378 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3379 cmd_ctx
->lsm
->u
.context
.channel_name
,
3380 cmd_ctx
->lsm
->u
.context
.event_name
,
3381 &cmd_ctx
->lsm
->u
.context
.ctx
);
3384 case LTTNG_DISABLE_CHANNEL
:
3386 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3387 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3390 case LTTNG_DISABLE_EVENT
:
3392 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3393 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3394 cmd_ctx
->lsm
->u
.disable
.name
);
3398 case LTTNG_DISABLE_ALL_EVENT
:
3400 DBG("Disabling all events");
3402 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3403 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3406 case LTTNG_ENABLE_CHANNEL
:
3408 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3409 &cmd_ctx
->lsm
->u
.channel
.chan
);
3412 case LTTNG_ENABLE_EVENT
:
3414 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3415 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3416 &cmd_ctx
->lsm
->u
.enable
.event
);
3419 case LTTNG_ENABLE_ALL_EVENT
:
3421 DBG("Enabling all events");
3423 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3424 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3425 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3428 case LTTNG_LIST_TRACEPOINTS
:
3430 struct lttng_event
*events
;
3433 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3434 if (nb_events
< 0) {
3440 * Setup lttng message with payload size set to the event list size in
3441 * bytes and then copy list into the llm payload.
3443 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3449 /* Copy event list into message payload */
3450 memcpy(cmd_ctx
->llm
->payload
, events
,
3451 sizeof(struct lttng_event
) * nb_events
);
3458 case LTTNG_START_TRACE
:
3460 ret
= cmd_start_trace(cmd_ctx
->session
);
3463 case LTTNG_STOP_TRACE
:
3465 ret
= cmd_stop_trace(cmd_ctx
->session
);
3468 case LTTNG_CREATE_SESSION
:
3470 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3471 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3474 case LTTNG_DESTROY_SESSION
:
3476 ret
= cmd_destroy_session(cmd_ctx
->session
,
3477 cmd_ctx
->lsm
->session
.name
);
3480 case LTTNG_LIST_DOMAINS
:
3483 struct lttng_domain
*domains
;
3485 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3491 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3496 /* Copy event list into message payload */
3497 memcpy(cmd_ctx
->llm
->payload
, domains
,
3498 nb_dom
* sizeof(struct lttng_domain
));
3505 case LTTNG_LIST_CHANNELS
:
3508 struct lttng_channel
*channels
;
3510 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3511 cmd_ctx
->session
, &channels
);
3517 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3522 /* Copy event list into message payload */
3523 memcpy(cmd_ctx
->llm
->payload
, channels
,
3524 nb_chan
* sizeof(struct lttng_channel
));
3531 case LTTNG_LIST_EVENTS
:
3534 struct lttng_event
*events
= NULL
;
3536 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3537 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3543 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3548 /* Copy event list into message payload */
3549 memcpy(cmd_ctx
->llm
->payload
, events
,
3550 nb_event
* sizeof(struct lttng_event
));
3557 case LTTNG_LIST_SESSIONS
:
3559 unsigned int nr_sessions
;
3561 session_lock_list();
3562 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3563 if (nr_sessions
== 0) {
3564 ret
= LTTCOMM_NO_SESSION
;
3565 session_unlock_list();
3568 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3570 session_unlock_list();
3574 /* Filled the session array */
3575 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3576 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3578 session_unlock_list();
3583 case LTTNG_CALIBRATE
:
3585 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3586 &cmd_ctx
->lsm
->u
.calibrate
);
3589 case LTTNG_REGISTER_CONSUMER
:
3591 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3592 cmd_ctx
->lsm
->u
.reg
.path
);
3601 if (cmd_ctx
->llm
== NULL
) {
3602 DBG("Missing llm structure. Allocating one.");
3603 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3607 /* Set return code */
3608 cmd_ctx
->llm
->ret_code
= ret
;
3610 if (cmd_ctx
->session
) {
3611 session_unlock(cmd_ctx
->session
);
3618 * This thread manage all clients request using the unix client socket for
3621 static void *thread_manage_clients(void *data
)
3623 int sock
= 0, ret
, i
, pollfd
;
3624 uint32_t revents
, nb_fd
;
3625 struct command_ctx
*cmd_ctx
= NULL
;
3626 struct lttng_poll_event events
;
3628 DBG("[thread] Manage client started");
3630 rcu_register_thread();
3632 ret
= lttcomm_listen_unix_sock(client_sock
);
3638 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3639 * more will be added to this poll set.
3641 ret
= create_thread_poll_set(&events
, 2);
3646 /* Add the application registration socket */
3647 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3653 * Notify parent pid that we are ready to accept command for client side.
3655 if (opt_sig_parent
) {
3656 kill(ppid
, SIGCHLD
);
3660 DBG("Accepting client command ...");
3662 nb_fd
= LTTNG_POLL_GETNB(&events
);
3664 /* Inifinite blocking call, waiting for transmission */
3665 ret
= lttng_poll_wait(&events
, -1);
3670 for (i
= 0; i
< nb_fd
; i
++) {
3671 /* Fetch once the poll data */
3672 revents
= LTTNG_POLL_GETEV(&events
, i
);
3673 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3675 /* Thread quit pipe has been closed. Killing thread. */
3676 ret
= check_thread_quit_pipe(pollfd
, revents
);
3681 /* Event on the registration socket */
3682 if (pollfd
== client_sock
) {
3683 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3684 ERR("Client socket poll error");
3690 DBG("Wait for client response");
3692 sock
= lttcomm_accept_unix_sock(client_sock
);
3697 /* Set socket option for credentials retrieval */
3698 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3703 /* Allocate context command to process the client request */
3704 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3705 if (cmd_ctx
== NULL
) {
3706 perror("zmalloc cmd_ctx");
3710 /* Allocate data buffer for reception */
3711 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3712 if (cmd_ctx
->lsm
== NULL
) {
3713 perror("zmalloc cmd_ctx->lsm");
3717 cmd_ctx
->llm
= NULL
;
3718 cmd_ctx
->session
= NULL
;
3721 * Data is received from the lttng client. The struct
3722 * lttcomm_session_msg (lsm) contains the command and data request of
3725 DBG("Receiving data from client ...");
3726 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3727 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3729 DBG("Nothing recv() from client... continuing");
3735 // TODO: Validate cmd_ctx including sanity check for
3736 // security purpose.
3738 rcu_thread_online();
3740 * This function dispatch the work to the kernel or userspace tracer
3741 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3742 * informations for the client. The command context struct contains
3743 * everything this function may needs.
3745 ret
= process_client_msg(cmd_ctx
);
3746 rcu_thread_offline();
3749 * TODO: Inform client somehow of the fatal error. At
3750 * this point, ret < 0 means that a zmalloc failed
3751 * (ENOMEM). Error detected but still accept command.
3753 clean_command_ctx(&cmd_ctx
);
3757 DBG("Sending response (size: %d, retcode: %s)",
3758 cmd_ctx
->lttng_msg_size
,
3759 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3760 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3762 ERR("Failed to send data back to client");
3765 /* End of transmission */
3768 clean_command_ctx(&cmd_ctx
);
3772 DBG("Client thread dying");
3773 unlink(client_unix_sock_path
);
3777 lttng_poll_clean(&events
);
3778 clean_command_ctx(&cmd_ctx
);
3780 rcu_unregister_thread();
3786 * usage function on stderr
3788 static void usage(void)
3790 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3791 fprintf(stderr
, " -h, --help Display this usage.\n");
3792 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3793 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3794 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3795 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3796 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3797 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3798 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3799 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3800 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3801 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3802 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3803 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3804 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3805 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3806 fprintf(stderr
, " -V, --version Show version number.\n");
3807 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3808 fprintf(stderr
, " -q, --quiet No output at all.\n");
3809 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3810 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3811 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3815 * daemon argument parsing
3817 static int parse_args(int argc
, char **argv
)
3821 static struct option long_options
[] = {
3822 { "client-sock", 1, 0, 'c' },
3823 { "apps-sock", 1, 0, 'a' },
3824 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3825 { "kconsumerd-err-sock", 1, 0, 'E' },
3826 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3827 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3828 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3829 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3830 { "consumerd32-path", 1, 0, 'u' },
3831 { "consumerd32-libdir", 1, 0, 'U' },
3832 { "consumerd64-path", 1, 0, 't' },
3833 { "consumerd64-libdir", 1, 0, 'T' },
3834 { "daemonize", 0, 0, 'd' },
3835 { "sig-parent", 0, 0, 'S' },
3836 { "help", 0, 0, 'h' },
3837 { "group", 1, 0, 'g' },
3838 { "version", 0, 0, 'V' },
3839 { "quiet", 0, 0, 'q' },
3840 { "verbose", 0, 0, 'v' },
3841 { "verbose-consumer", 0, 0, 'Z' },
3842 { "no-kernel", 0, 0, 'N' },
3847 int option_index
= 0;
3848 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3849 long_options
, &option_index
);
3856 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3858 fprintf(stderr
, " with arg %s\n", optarg
);
3862 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3865 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3871 opt_tracing_group
= optarg
;
3877 fprintf(stdout
, "%s\n", VERSION
);
3883 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3886 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3889 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3892 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3895 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3898 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3907 /* Verbose level can increase using multiple -v */
3911 opt_verbose_consumer
+= 1;
3914 consumerd32_bin
= optarg
;
3917 consumerd32_libdir
= optarg
;
3920 consumerd64_bin
= optarg
;
3923 consumerd64_libdir
= optarg
;
3926 /* Unknown option or other error.
3927 * Error is printed by getopt, just return */
3936 * Creates the two needed socket by the daemon.
3937 * apps_sock - The communication socket for all UST apps.
3938 * client_sock - The communication of the cli tool (lttng).
3940 static int init_daemon_socket(void)
3945 old_umask
= umask(0);
3947 /* Create client tool unix socket */
3948 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3949 if (client_sock
< 0) {
3950 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3955 /* File permission MUST be 660 */
3956 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3958 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3963 /* Create the application unix socket */
3964 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3965 if (apps_sock
< 0) {
3966 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3971 /* File permission MUST be 666 */
3972 ret
= chmod(apps_unix_sock_path
,
3973 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3975 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3986 * Check if the global socket is available, and if a daemon is answering at the
3987 * other side. If yes, error is returned.
3989 static int check_existing_daemon(void)
3991 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3992 access(apps_unix_sock_path
, F_OK
) < 0) {
3996 /* Is there anybody out there ? */
3997 if (lttng_session_daemon_alive()) {
4005 * Set the tracing group gid onto the client socket.
4007 * Race window between mkdir and chown is OK because we are going from more
4008 * permissive (root.root) to les permissive (root.tracing).
4010 static int set_permissions(char *rundir
)
4015 gid
= allowed_group();
4017 WARN("No tracing group detected");
4022 /* Set lttng run dir */
4023 ret
= chown(rundir
, 0, gid
);
4025 ERR("Unable to set group on %s", rundir
);
4029 /* lttng client socket path */
4030 ret
= chown(client_unix_sock_path
, 0, gid
);
4032 ERR("Unable to set group on %s", client_unix_sock_path
);
4036 /* kconsumer error socket path */
4037 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4039 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4043 /* 64-bit ustconsumer error socket path */
4044 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4046 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4050 /* 32-bit ustconsumer compat32 error socket path */
4051 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4053 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4057 DBG("All permissions are set");
4064 * Create the pipe used to wake up the kernel thread.
4066 static int create_kernel_poll_pipe(void)
4068 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4072 * Create the application command pipe to wake thread_manage_apps.
4074 static int create_apps_cmd_pipe(void)
4076 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4080 * Create the lttng run directory needed for all global sockets and pipe.
4082 static int create_lttng_rundir(const char *rundir
)
4086 DBG3("Creating LTTng run directory: %s", rundir
);
4088 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4090 if (errno
!= EEXIST
) {
4091 ERR("Unable to create %s", rundir
);
4103 * Setup sockets and directory needed by the kconsumerd communication with the
4106 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4110 char path
[PATH_MAX
];
4112 switch (consumer_data
->type
) {
4113 case LTTNG_CONSUMER_KERNEL
:
4114 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4116 case LTTNG_CONSUMER64_UST
:
4117 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4119 case LTTNG_CONSUMER32_UST
:
4120 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4123 ERR("Consumer type unknown");
4128 DBG2("Creating consumer directory: %s", path
);
4130 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4132 if (errno
!= EEXIST
) {
4133 ERR("Failed to create %s", path
);
4139 /* Create the kconsumerd error unix socket */
4140 consumer_data
->err_sock
=
4141 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4142 if (consumer_data
->err_sock
< 0) {
4143 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4148 /* File permission MUST be 660 */
4149 ret
= chmod(consumer_data
->err_unix_sock_path
,
4150 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4152 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4162 * Signal handler for the daemon
4164 * Simply stop all worker threads, leaving main() return gracefully after
4165 * joining all threads and calling cleanup().
4167 static void sighandler(int sig
)
4171 DBG("SIGPIPE caugth");
4174 DBG("SIGINT caugth");
4178 DBG("SIGTERM caugth");
4187 * Setup signal handler for :
4188 * SIGINT, SIGTERM, SIGPIPE
4190 static int set_signal_handler(void)
4193 struct sigaction sa
;
4196 if ((ret
= sigemptyset(&sigset
)) < 0) {
4197 perror("sigemptyset");
4201 sa
.sa_handler
= sighandler
;
4202 sa
.sa_mask
= sigset
;
4204 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4205 perror("sigaction");
4209 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4210 perror("sigaction");
4214 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4215 perror("sigaction");
4219 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4225 * Set open files limit to unlimited. This daemon can open a large number of
4226 * file descriptors in order to consumer multiple kernel traces.
4228 static void set_ulimit(void)
4233 /* The kernel does not allowed an infinite limit for open files */
4234 lim
.rlim_cur
= 65535;
4235 lim
.rlim_max
= 65535;
4237 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4239 perror("failed to set open files limit");
4246 int main(int argc
, char **argv
)
4250 const char *home_path
;
4252 rcu_register_thread();
4254 /* Create thread quit pipe */
4255 if ((ret
= init_thread_quit_pipe()) < 0) {
4259 setup_consumerd_path();
4261 /* Parse arguments */
4263 if ((ret
= parse_args(argc
, argv
) < 0)) {
4276 /* Check if daemon is UID = 0 */
4277 is_root
= !getuid();
4280 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4282 /* Create global run dir with root access */
4283 ret
= create_lttng_rundir(rundir
);
4288 if (strlen(apps_unix_sock_path
) == 0) {
4289 snprintf(apps_unix_sock_path
, PATH_MAX
,
4290 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4293 if (strlen(client_unix_sock_path
) == 0) {
4294 snprintf(client_unix_sock_path
, PATH_MAX
,
4295 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4298 /* Set global SHM for ust */
4299 if (strlen(wait_shm_path
) == 0) {
4300 snprintf(wait_shm_path
, PATH_MAX
,
4301 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4304 /* Setup kernel consumerd path */
4305 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4306 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4307 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4308 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4310 DBG2("Kernel consumer err path: %s",
4311 kconsumer_data
.err_unix_sock_path
);
4312 DBG2("Kernel consumer cmd path: %s",
4313 kconsumer_data
.cmd_unix_sock_path
);
4315 home_path
= get_home_dir();
4316 if (home_path
== NULL
) {
4317 /* TODO: Add --socket PATH option */
4318 ERR("Can't get HOME directory for sockets creation.");
4324 * Create rundir from home path. This will create something like
4327 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4333 ret
= create_lttng_rundir(rundir
);
4338 if (strlen(apps_unix_sock_path
) == 0) {
4339 snprintf(apps_unix_sock_path
, PATH_MAX
,
4340 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4343 /* Set the cli tool unix socket path */
4344 if (strlen(client_unix_sock_path
) == 0) {
4345 snprintf(client_unix_sock_path
, PATH_MAX
,
4346 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4349 /* Set global SHM for ust */
4350 if (strlen(wait_shm_path
) == 0) {
4351 snprintf(wait_shm_path
, PATH_MAX
,
4352 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4356 DBG("Client socket path %s", client_unix_sock_path
);
4357 DBG("Application socket path %s", apps_unix_sock_path
);
4358 DBG("LTTng run directory path: %s", rundir
);
4360 /* 32 bits consumerd path setup */
4361 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4362 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4363 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4364 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4366 DBG2("UST consumer 32 bits err path: %s",
4367 ustconsumer32_data
.err_unix_sock_path
);
4368 DBG2("UST consumer 32 bits cmd path: %s",
4369 ustconsumer32_data
.cmd_unix_sock_path
);
4371 /* 64 bits consumerd path setup */
4372 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4373 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4374 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4375 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4377 DBG2("UST consumer 64 bits err path: %s",
4378 ustconsumer64_data
.err_unix_sock_path
);
4379 DBG2("UST consumer 64 bits cmd path: %s",
4380 ustconsumer64_data
.cmd_unix_sock_path
);
4383 * See if daemon already exist.
4385 if ((ret
= check_existing_daemon()) < 0) {
4386 ERR("Already running daemon.\n");
4388 * We do not goto exit because we must not cleanup()
4389 * because a daemon is already running.
4394 /* After this point, we can safely call cleanup() with "goto exit" */
4397 * These actions must be executed as root. We do that *after* setting up
4398 * the sockets path because we MUST make the check for another daemon using
4399 * those paths *before* trying to set the kernel consumer sockets and init
4403 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4408 /* Setup kernel tracer */
4409 if (!opt_no_kernel
) {
4410 init_kernel_tracer();
4413 /* Set ulimit for open files */
4417 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4422 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4427 if ((ret
= set_signal_handler()) < 0) {
4431 /* Setup the needed unix socket */
4432 if ((ret
= init_daemon_socket()) < 0) {
4436 /* Set credentials to socket */
4437 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4441 /* Get parent pid if -S, --sig-parent is specified. */
4442 if (opt_sig_parent
) {
4446 /* Setup the kernel pipe for waking up the kernel thread */
4447 if ((ret
= create_kernel_poll_pipe()) < 0) {
4451 /* Setup the thread apps communication pipe. */
4452 if ((ret
= create_apps_cmd_pipe()) < 0) {
4456 /* Init UST command queue. */
4457 cds_wfq_init(&ust_cmd_queue
.queue
);
4459 /* Init UST app hash table */
4463 * Get session list pointer. This pointer MUST NOT be free(). This list is
4464 * statically declared in session.c
4466 session_list_ptr
= session_get_list();
4468 /* Set up max poll set size */
4469 lttng_poll_set_max_size();
4471 /* Create thread to manage the client socket */
4472 ret
= pthread_create(&client_thread
, NULL
,
4473 thread_manage_clients
, (void *) NULL
);
4475 perror("pthread_create clients");
4479 /* Create thread to dispatch registration */
4480 ret
= pthread_create(&dispatch_thread
, NULL
,
4481 thread_dispatch_ust_registration
, (void *) NULL
);
4483 perror("pthread_create dispatch");
4487 /* Create thread to manage application registration. */
4488 ret
= pthread_create(®_apps_thread
, NULL
,
4489 thread_registration_apps
, (void *) NULL
);
4491 perror("pthread_create registration");
4495 /* Create thread to manage application socket */
4496 ret
= pthread_create(&apps_thread
, NULL
,
4497 thread_manage_apps
, (void *) NULL
);
4499 perror("pthread_create apps");
4503 /* Create kernel thread to manage kernel event */
4504 ret
= pthread_create(&kernel_thread
, NULL
,
4505 thread_manage_kernel
, (void *) NULL
);
4507 perror("pthread_create kernel");
4511 ret
= pthread_join(kernel_thread
, &status
);
4513 perror("pthread_join");
4514 goto error
; /* join error, exit without cleanup */
4518 ret
= pthread_join(apps_thread
, &status
);
4520 perror("pthread_join");
4521 goto error
; /* join error, exit without cleanup */
4525 ret
= pthread_join(reg_apps_thread
, &status
);
4527 perror("pthread_join");
4528 goto error
; /* join error, exit without cleanup */
4532 ret
= pthread_join(dispatch_thread
, &status
);
4534 perror("pthread_join");
4535 goto error
; /* join error, exit without cleanup */
4539 ret
= pthread_join(client_thread
, &status
);
4541 perror("pthread_join");
4542 goto error
; /* join error, exit without cleanup */
4545 ret
= join_consumer_thread(&kconsumer_data
);
4547 perror("join_consumer");
4548 goto error
; /* join error, exit without cleanup */
4554 * cleanup() is called when no other thread is running.
4556 rcu_thread_online();
4558 rcu_thread_offline();
4559 rcu_unregister_thread();