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 <bin/lttng-consumerd/lttng-consumerd.h>
42 #include <common/lttngerr.h>
43 #include <common/kernel-consumer/kernel-consumer.h>
44 #include <common/ust-consumer/ust-consumer.h>
45 #include <common/runas.h>
47 #include "lttng-sessiond.h"
49 #include "compat/poll.h"
58 #define CONSUMERD_FILE "lttng-consumerd"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
79 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
80 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
81 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
82 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
85 int opt_verbose
; /* Not static for lttngerr.h */
86 int opt_verbose_consumer
; /* Not static for lttngerr.h */
87 int opt_quiet
; /* Not static for lttngerr.h */
90 const char *opt_tracing_group
;
91 static int opt_sig_parent
;
92 static int opt_daemon
;
93 static int opt_no_kernel
;
94 static int is_root
; /* Set to 1 if the daemon is running as root */
95 static pid_t ppid
; /* Parent PID for --sig-parent option */
98 /* Consumer daemon specific control data */
99 static struct consumer_data kconsumer_data
= {
100 .type
= LTTNG_CONSUMER_KERNEL
,
101 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
102 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
104 static struct consumer_data ustconsumer64_data
= {
105 .type
= LTTNG_CONSUMER64_UST
,
106 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
107 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
109 static struct consumer_data ustconsumer32_data
= {
110 .type
= LTTNG_CONSUMER32_UST
,
111 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
112 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
115 static int dispatch_thread_exit
;
117 /* Global application Unix socket path */
118 static char apps_unix_sock_path
[PATH_MAX
];
119 /* Global client Unix socket path */
120 static char client_unix_sock_path
[PATH_MAX
];
121 /* global wait shm path for UST */
122 static char wait_shm_path
[PATH_MAX
];
124 /* Sockets and FDs */
125 static int client_sock
;
126 static int apps_sock
;
127 static int kernel_tracer_fd
;
128 static int kernel_poll_pipe
[2];
131 * Quit pipe for all threads. This permits a single cancellation point
132 * for all threads when receiving an event on the pipe.
134 static int thread_quit_pipe
[2];
137 * This pipe is used to inform the thread managing application communication
138 * that a command is queued and ready to be processed.
140 static int apps_cmd_pipe
[2];
142 /* Pthread, Mutexes and Semaphores */
143 static pthread_t apps_thread
;
144 static pthread_t reg_apps_thread
;
145 static pthread_t client_thread
;
146 static pthread_t kernel_thread
;
147 static pthread_t dispatch_thread
;
151 * UST registration command queue. This queue is tied with a futex and uses a N
152 * wakers / 1 waiter implemented and detailed in futex.c/.h
154 * The thread_manage_apps and thread_dispatch_ust_registration interact with
155 * this queue and the wait/wake scheme.
157 static struct ust_cmd_queue ust_cmd_queue
;
160 * Pointer initialized before thread creation.
162 * This points to the tracing session list containing the session count and a
163 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
164 * MUST NOT be taken if you call a public function in session.c.
166 * The lock is nested inside the structure: session_list_ptr->lock. Please use
167 * session_lock_list and session_unlock_list for lock acquisition.
169 static struct ltt_session_list
*session_list_ptr
;
171 int ust_consumerd64_fd
= -1;
172 int ust_consumerd32_fd
= -1;
174 static const char *consumerd32_bin
= CONFIG_CONSUMERD32_BIN
;
175 static const char *consumerd64_bin
= CONFIG_CONSUMERD64_BIN
;
176 static const char *consumerd32_libdir
= CONFIG_CONSUMERD32_LIBDIR
;
177 static const char *consumerd64_libdir
= CONFIG_CONSUMERD64_LIBDIR
;
180 void setup_consumerd_path(void)
182 const char *bin
, *libdir
;
185 * Allow INSTALL_BIN_PATH to be used as a target path for the
186 * native architecture size consumer if CONFIG_CONSUMER*_PATH
187 * has not been defined.
189 #if (CAA_BITS_PER_LONG == 32)
190 if (!consumerd32_bin
[0]) {
191 consumerd32_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
193 if (!consumerd32_libdir
[0]) {
194 consumerd32_libdir
= INSTALL_LIB_PATH
;
196 #elif (CAA_BITS_PER_LONG == 64)
197 if (!consumerd64_bin
[0]) {
198 consumerd64_bin
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
200 if (!consumerd64_libdir
[0]) {
201 consumerd64_libdir
= INSTALL_LIB_PATH
;
204 #error "Unknown bitness"
208 * runtime env. var. overrides the build default.
210 bin
= getenv("LTTNG_CONSUMERD32_BIN");
212 consumerd32_bin
= bin
;
214 bin
= getenv("LTTNG_CONSUMERD64_BIN");
216 consumerd64_bin
= bin
;
218 libdir
= getenv("LTTNG_TOOLS_CONSUMERD32_LIBDIR");
220 consumerd32_libdir
= libdir
;
222 libdir
= getenv("LTTNG_TOOLS_CONSUMERD64_LIBDIR");
224 consumerd64_libdir
= libdir
;
229 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
231 static int create_thread_poll_set(struct lttng_poll_event
*events
,
236 if (events
== NULL
|| size
== 0) {
241 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
247 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
259 * Check if the thread quit pipe was triggered.
261 * Return 1 if it was triggered else 0;
263 static int check_thread_quit_pipe(int fd
, uint32_t events
)
265 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
273 * Remove modules in reverse load order.
275 static int modprobe_remove_kernel_modules(void)
280 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
281 ret
= snprintf(modprobe
, sizeof(modprobe
),
282 "/sbin/modprobe -r -q %s",
283 kernel_modules_list
[i
].name
);
285 perror("snprintf modprobe -r");
288 modprobe
[sizeof(modprobe
) - 1] = '\0';
289 ret
= system(modprobe
);
291 ERR("Unable to launch modprobe -r for module %s",
292 kernel_modules_list
[i
].name
);
293 } else if (kernel_modules_list
[i
].required
294 && WEXITSTATUS(ret
) != 0) {
295 ERR("Unable to remove module %s",
296 kernel_modules_list
[i
].name
);
298 DBG("Modprobe removal successful %s",
299 kernel_modules_list
[i
].name
);
308 * Return group ID of the tracing group or -1 if not found.
310 static gid_t
allowed_group(void)
314 if (opt_tracing_group
) {
315 grp
= getgrnam(opt_tracing_group
);
317 grp
= getgrnam(default_tracing_group
);
327 * Init thread quit pipe.
329 * Return -1 on error or 0 if all pipes are created.
331 static int init_thread_quit_pipe(void)
335 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
337 perror("thread quit pipe");
346 * Complete teardown of a kernel session. This free all data structure related
347 * to a kernel session and update counter.
349 static void teardown_kernel_session(struct ltt_session
*session
)
351 if (!session
->kernel_session
) {
352 DBG3("No kernel session when tearingdown session");
356 DBG("Tearing down kernel session");
359 * If a custom kernel consumer was registered, close the socket before
360 * tearing down the complete kernel session structure
362 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
363 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
366 trace_kernel_destroy_session(session
->kernel_session
);
370 * Complete teardown of all UST sessions. This will free everything on his path
371 * and destroy the core essence of all ust sessions :)
373 static void teardown_ust_session(struct ltt_session
*session
)
377 if (!session
->ust_session
) {
378 DBG3("No UST session when tearingdown session");
382 DBG("Tearing down UST session(s)");
384 ret
= ust_app_destroy_trace_all(session
->ust_session
);
386 ERR("Error in ust_app_destroy_trace_all");
389 trace_ust_destroy_session(session
->ust_session
);
393 * Stop all threads by closing the thread quit pipe.
395 static void stop_threads(void)
399 /* Stopping all threads */
400 DBG("Terminating all threads");
401 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
403 ERR("write error on thread quit pipe");
406 /* Dispatch thread */
407 dispatch_thread_exit
= 1;
408 futex_nto1_wake(&ust_cmd_queue
.futex
);
414 static void cleanup(void)
418 struct ltt_session
*sess
, *stmp
;
422 DBG("Removing %s directory", rundir
);
423 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
425 ERR("asprintf failed. Something is really wrong!");
428 /* Remove lttng run directory */
431 ERR("Unable to clean %s", rundir
);
435 DBG("Cleaning up all session");
437 /* Destroy session list mutex */
438 if (session_list_ptr
!= NULL
) {
439 pthread_mutex_destroy(&session_list_ptr
->lock
);
441 /* Cleanup ALL session */
442 cds_list_for_each_entry_safe(sess
, stmp
,
443 &session_list_ptr
->head
, list
) {
444 teardown_kernel_session(sess
);
445 teardown_ust_session(sess
);
450 DBG("Closing all UST sockets");
451 ust_app_clean_list();
453 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
455 if (is_root
&& !opt_no_kernel
) {
456 DBG2("Closing kernel fd");
457 close(kernel_tracer_fd
);
458 DBG("Unloading kernel modules");
459 modprobe_remove_kernel_modules();
462 close(thread_quit_pipe
[0]);
463 close(thread_quit_pipe
[1]);
466 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
467 "Matthew, BEET driven development works!%c[%dm",
468 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
473 * Send data on a unix socket using the liblttsessiondcomm API.
475 * Return lttcomm error code.
477 static int send_unix_sock(int sock
, void *buf
, size_t len
)
479 /* Check valid length */
484 return lttcomm_send_unix_sock(sock
, buf
, len
);
488 * Free memory of a command context structure.
490 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
492 DBG("Clean command context structure");
494 if ((*cmd_ctx
)->llm
) {
495 free((*cmd_ctx
)->llm
);
497 if ((*cmd_ctx
)->lsm
) {
498 free((*cmd_ctx
)->lsm
);
506 * Send all stream fds of kernel channel to the consumer.
508 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
509 int sock
, struct ltt_kernel_channel
*channel
,
510 uid_t uid
, gid_t gid
)
513 struct ltt_kernel_stream
*stream
;
514 struct lttcomm_consumer_msg lkm
;
516 DBG("Sending streams of channel %s to kernel consumer",
517 channel
->channel
->name
);
520 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
521 lkm
.u
.channel
.channel_key
= channel
->fd
;
522 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
523 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
524 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
525 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
527 perror("send consumer channel");
532 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
536 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
537 lkm
.u
.stream
.channel_key
= channel
->fd
;
538 lkm
.u
.stream
.stream_key
= stream
->fd
;
539 lkm
.u
.stream
.state
= stream
->state
;
540 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
541 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
542 lkm
.u
.stream
.uid
= uid
;
543 lkm
.u
.stream
.gid
= gid
;
544 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
545 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
546 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
547 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
549 perror("send consumer stream");
552 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
554 perror("send consumer stream ancillary data");
559 DBG("consumer channel streams sent");
568 * Send all stream fds of the kernel session to the consumer.
570 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
571 struct ltt_kernel_session
*session
)
574 struct ltt_kernel_channel
*chan
;
575 struct lttcomm_consumer_msg lkm
;
576 int sock
= session
->consumer_fd
;
578 DBG("Sending metadata stream fd");
580 /* Extra protection. It's NOT supposed to be set to 0 at this point */
581 if (session
->consumer_fd
== 0) {
582 session
->consumer_fd
= consumer_data
->cmd_sock
;
585 if (session
->metadata_stream_fd
!= 0) {
586 /* Send metadata channel fd */
587 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
588 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
589 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
590 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
591 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
592 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
594 perror("send consumer channel");
598 /* Send metadata stream fd */
599 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
600 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
601 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
602 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
603 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
604 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
605 lkm
.u
.stream
.uid
= session
->uid
;
606 lkm
.u
.stream
.gid
= session
->gid
;
607 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
608 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
609 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
610 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
612 perror("send consumer stream");
615 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
617 perror("send consumer stream");
622 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
623 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
624 session
->uid
, session
->gid
);
630 DBG("consumer fds (metadata and channel streams) sent");
639 * Notify UST applications using the shm mmap futex.
641 static int notify_ust_apps(int active
)
645 DBG("Notifying applications of session daemon state: %d", active
);
647 /* See shm.c for this call implying mmap, shm and futex calls */
648 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
649 if (wait_shm_mmap
== NULL
) {
653 /* Wake waiting process */
654 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
656 /* Apps notified successfully */
664 * Setup the outgoing data buffer for the response (llm) by allocating the
665 * right amount of memory and copying the original information from the lsm
668 * Return total size of the buffer pointed by buf.
670 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
676 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
677 if (cmd_ctx
->llm
== NULL
) {
683 /* Copy common data */
684 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
685 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
687 cmd_ctx
->llm
->data_size
= size
;
688 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
697 * Update the kernel poll set of all channel fd available over all tracing
698 * session. Add the wakeup pipe at the end of the set.
700 static int update_kernel_poll(struct lttng_poll_event
*events
)
703 struct ltt_session
*session
;
704 struct ltt_kernel_channel
*channel
;
706 DBG("Updating kernel poll set");
709 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
710 session_lock(session
);
711 if (session
->kernel_session
== NULL
) {
712 session_unlock(session
);
716 cds_list_for_each_entry(channel
,
717 &session
->kernel_session
->channel_list
.head
, list
) {
718 /* Add channel fd to the kernel poll set */
719 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
721 session_unlock(session
);
724 DBG("Channel fd %d added to kernel set", channel
->fd
);
726 session_unlock(session
);
728 session_unlock_list();
733 session_unlock_list();
738 * Find the channel fd from 'fd' over all tracing session. When found, check
739 * for new channel stream and send those stream fds to the kernel consumer.
741 * Useful for CPU hotplug feature.
743 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
746 struct ltt_session
*session
;
747 struct ltt_kernel_channel
*channel
;
749 DBG("Updating kernel streams for channel fd %d", fd
);
752 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
753 session_lock(session
);
754 if (session
->kernel_session
== NULL
) {
755 session_unlock(session
);
759 /* This is not suppose to be 0 but this is an extra security check */
760 if (session
->kernel_session
->consumer_fd
== 0) {
761 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
764 cds_list_for_each_entry(channel
,
765 &session
->kernel_session
->channel_list
.head
, list
) {
766 if (channel
->fd
== fd
) {
767 DBG("Channel found, updating kernel streams");
768 ret
= kernel_open_channel_stream(channel
);
774 * Have we already sent fds to the consumer? If yes, it means
775 * that tracing is started so it is safe to send our updated
778 if (session
->kernel_session
->consumer_fds_sent
== 1) {
779 ret
= send_kconsumer_channel_streams(consumer_data
,
780 session
->kernel_session
->consumer_fd
, channel
,
781 session
->uid
, session
->gid
);
789 session_unlock(session
);
791 session_unlock_list();
795 session_unlock(session
);
796 session_unlock_list();
801 * For each tracing session, update newly registered apps.
803 static void update_ust_app(int app_sock
)
805 struct ltt_session
*sess
, *stmp
;
807 /* For all tracing session(s) */
808 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
809 if (sess
->ust_session
) {
810 ust_app_global_update(sess
->ust_session
, app_sock
);
816 * This thread manage event coming from the kernel.
818 * Features supported in this thread:
821 static void *thread_manage_kernel(void *data
)
823 int ret
, i
, pollfd
, update_poll_flag
= 1;
824 uint32_t revents
, nb_fd
;
826 struct lttng_poll_event events
;
828 DBG("Thread manage kernel started");
830 ret
= create_thread_poll_set(&events
, 2);
835 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
841 if (update_poll_flag
== 1) {
843 * Reset number of fd in the poll set. Always 2 since there is the thread
844 * quit pipe and the kernel pipe.
848 ret
= update_kernel_poll(&events
);
852 update_poll_flag
= 0;
855 nb_fd
= LTTNG_POLL_GETNB(&events
);
857 DBG("Thread kernel polling on %d fds", nb_fd
);
859 /* Zeroed the poll events */
860 lttng_poll_reset(&events
);
862 /* Poll infinite value of time */
863 ret
= lttng_poll_wait(&events
, -1);
866 } else if (ret
== 0) {
867 /* Should not happen since timeout is infinite */
868 ERR("Return value of poll is 0 with an infinite timeout.\n"
869 "This should not have happened! Continuing...");
873 for (i
= 0; i
< nb_fd
; i
++) {
874 /* Fetch once the poll data */
875 revents
= LTTNG_POLL_GETEV(&events
, i
);
876 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
878 /* Thread quit pipe has been closed. Killing thread. */
879 ret
= check_thread_quit_pipe(pollfd
, revents
);
884 /* Check for data on kernel pipe */
885 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
886 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
887 update_poll_flag
= 1;
891 * New CPU detected by the kernel. Adding kernel stream to
892 * kernel session and updating the kernel consumer
894 if (revents
& LPOLLIN
) {
895 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
901 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
902 * and unregister kernel stream at this point.
910 DBG("Kernel thread dying");
911 close(kernel_poll_pipe
[0]);
912 close(kernel_poll_pipe
[1]);
914 lttng_poll_clean(&events
);
920 * This thread manage the consumer error sent back to the session daemon.
922 static void *thread_manage_consumer(void *data
)
924 int sock
= 0, i
, ret
, pollfd
;
925 uint32_t revents
, nb_fd
;
926 enum lttcomm_return_code code
;
927 struct lttng_poll_event events
;
928 struct consumer_data
*consumer_data
= data
;
930 DBG("[thread] Manage consumer started");
932 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
938 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
939 * Nothing more will be added to this poll set.
941 ret
= create_thread_poll_set(&events
, 2);
946 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
951 nb_fd
= LTTNG_POLL_GETNB(&events
);
953 /* Inifinite blocking call, waiting for transmission */
954 ret
= lttng_poll_wait(&events
, -1);
959 for (i
= 0; i
< nb_fd
; i
++) {
960 /* Fetch once the poll data */
961 revents
= LTTNG_POLL_GETEV(&events
, i
);
962 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
964 /* Thread quit pipe has been closed. Killing thread. */
965 ret
= check_thread_quit_pipe(pollfd
, revents
);
970 /* Event on the registration socket */
971 if (pollfd
== consumer_data
->err_sock
) {
972 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
973 ERR("consumer err socket poll error");
979 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
984 DBG2("Receiving code from consumer err_sock");
986 /* Getting status code from kconsumerd */
987 ret
= lttcomm_recv_unix_sock(sock
, &code
,
988 sizeof(enum lttcomm_return_code
));
993 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
994 consumer_data
->cmd_sock
=
995 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
996 if (consumer_data
->cmd_sock
< 0) {
997 sem_post(&consumer_data
->sem
);
998 PERROR("consumer connect");
1001 /* Signal condition to tell that the kconsumerd is ready */
1002 sem_post(&consumer_data
->sem
);
1003 DBG("consumer command socket ready");
1005 ERR("consumer error when waiting for SOCK_READY : %s",
1006 lttcomm_get_readable_code(-code
));
1010 /* Remove the kconsumerd error sock since we've established a connexion */
1011 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1016 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1021 /* Update number of fd */
1022 nb_fd
= LTTNG_POLL_GETNB(&events
);
1024 /* Inifinite blocking call, waiting for transmission */
1025 ret
= lttng_poll_wait(&events
, -1);
1030 for (i
= 0; i
< nb_fd
; i
++) {
1031 /* Fetch once the poll data */
1032 revents
= LTTNG_POLL_GETEV(&events
, i
);
1033 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1035 /* Thread quit pipe has been closed. Killing thread. */
1036 ret
= check_thread_quit_pipe(pollfd
, revents
);
1041 /* Event on the kconsumerd socket */
1042 if (pollfd
== sock
) {
1043 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1044 ERR("consumer err socket second poll error");
1050 /* Wait for any kconsumerd error */
1051 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1052 sizeof(enum lttcomm_return_code
));
1054 ERR("consumer closed the command socket");
1058 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1061 DBG("consumer thread dying");
1062 close(consumer_data
->err_sock
);
1063 close(consumer_data
->cmd_sock
);
1066 unlink(consumer_data
->err_unix_sock_path
);
1067 unlink(consumer_data
->cmd_unix_sock_path
);
1068 consumer_data
->pid
= 0;
1070 lttng_poll_clean(&events
);
1076 * This thread manage application communication.
1078 static void *thread_manage_apps(void *data
)
1081 uint32_t revents
, nb_fd
;
1082 struct ust_command ust_cmd
;
1083 struct lttng_poll_event events
;
1085 DBG("[thread] Manage application started");
1087 rcu_register_thread();
1088 rcu_thread_online();
1090 ret
= create_thread_poll_set(&events
, 2);
1095 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1101 /* Zeroed the events structure */
1102 lttng_poll_reset(&events
);
1104 nb_fd
= LTTNG_POLL_GETNB(&events
);
1106 DBG("Apps thread polling on %d fds", nb_fd
);
1108 /* Inifinite blocking call, waiting for transmission */
1109 ret
= lttng_poll_wait(&events
, -1);
1114 for (i
= 0; i
< nb_fd
; i
++) {
1115 /* Fetch once the poll data */
1116 revents
= LTTNG_POLL_GETEV(&events
, i
);
1117 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1119 /* Thread quit pipe has been closed. Killing thread. */
1120 ret
= check_thread_quit_pipe(pollfd
, revents
);
1125 /* Inspect the apps cmd pipe */
1126 if (pollfd
== apps_cmd_pipe
[0]) {
1127 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1128 ERR("Apps command pipe error");
1130 } else if (revents
& LPOLLIN
) {
1132 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1133 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1134 perror("read apps cmd pipe");
1138 /* Register applicaton to the session daemon */
1139 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1141 if (ret
== -ENOMEM
) {
1143 } else if (ret
< 0) {
1148 * Add channel(s) and event(s) to newly registered apps
1149 * from lttng global UST domain.
1151 update_ust_app(ust_cmd
.sock
);
1153 ret
= ust_app_register_done(ust_cmd
.sock
);
1156 * If the registration is not possible, we simply
1157 * unregister the apps and continue
1159 ust_app_unregister(ust_cmd
.sock
);
1162 * We just need here to monitor the close of the UST
1163 * socket and poll set monitor those by default.
1165 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1170 DBG("Apps with sock %d added to poll set",
1178 * At this point, we know that a registered application made
1179 * the event at poll_wait.
1181 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1182 /* Removing from the poll set */
1183 ret
= lttng_poll_del(&events
, pollfd
);
1188 /* Socket closed on remote end. */
1189 ust_app_unregister(pollfd
);
1197 DBG("Application communication apps dying");
1198 close(apps_cmd_pipe
[0]);
1199 close(apps_cmd_pipe
[1]);
1201 lttng_poll_clean(&events
);
1203 rcu_thread_offline();
1204 rcu_unregister_thread();
1209 * Dispatch request from the registration threads to the application
1210 * communication thread.
1212 static void *thread_dispatch_ust_registration(void *data
)
1215 struct cds_wfq_node
*node
;
1216 struct ust_command
*ust_cmd
= NULL
;
1218 DBG("[thread] Dispatch UST command started");
1220 while (!dispatch_thread_exit
) {
1221 /* Atomically prepare the queue futex */
1222 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1225 /* Dequeue command for registration */
1226 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1228 DBG("Woken up but nothing in the UST command queue");
1229 /* Continue thread execution */
1233 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1235 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1236 " gid:%d sock:%d name:%s (version %d.%d)",
1237 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1238 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1239 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1240 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1242 * Inform apps thread of the new application registration. This
1243 * call is blocking so we can be assured that the data will be read
1244 * at some point in time or wait to the end of the world :)
1246 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1247 sizeof(struct ust_command
));
1249 perror("write apps cmd pipe");
1250 if (errno
== EBADF
) {
1252 * We can't inform the application thread to process
1253 * registration. We will exit or else application
1254 * registration will not occur and tracing will never
1261 } while (node
!= NULL
);
1263 /* Futex wait on queue. Blocking call on futex() */
1264 futex_nto1_wait(&ust_cmd_queue
.futex
);
1268 DBG("Dispatch thread dying");
1273 * This thread manage application registration.
1275 static void *thread_registration_apps(void *data
)
1277 int sock
= 0, i
, ret
, pollfd
;
1278 uint32_t revents
, nb_fd
;
1279 struct lttng_poll_event events
;
1281 * Get allocated in this thread, enqueued to a global queue, dequeued and
1282 * freed in the manage apps thread.
1284 struct ust_command
*ust_cmd
= NULL
;
1286 DBG("[thread] Manage application registration started");
1288 ret
= lttcomm_listen_unix_sock(apps_sock
);
1294 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1295 * more will be added to this poll set.
1297 ret
= create_thread_poll_set(&events
, 2);
1302 /* Add the application registration socket */
1303 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1308 /* Notify all applications to register */
1309 ret
= notify_ust_apps(1);
1311 ERR("Failed to notify applications or create the wait shared memory.\n"
1312 "Execution continues but there might be problem for already\n"
1313 "running applications that wishes to register.");
1317 DBG("Accepting application registration");
1319 nb_fd
= LTTNG_POLL_GETNB(&events
);
1321 /* Inifinite blocking call, waiting for transmission */
1322 ret
= lttng_poll_wait(&events
, -1);
1327 for (i
= 0; i
< nb_fd
; i
++) {
1328 /* Fetch once the poll data */
1329 revents
= LTTNG_POLL_GETEV(&events
, i
);
1330 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1332 /* Thread quit pipe has been closed. Killing thread. */
1333 ret
= check_thread_quit_pipe(pollfd
, revents
);
1338 /* Event on the registration socket */
1339 if (pollfd
== apps_sock
) {
1340 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1341 ERR("Register apps socket poll error");
1343 } else if (revents
& LPOLLIN
) {
1344 sock
= lttcomm_accept_unix_sock(apps_sock
);
1349 /* Create UST registration command for enqueuing */
1350 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1351 if (ust_cmd
== NULL
) {
1352 perror("ust command zmalloc");
1357 * Using message-based transmissions to ensure we don't
1358 * have to deal with partially received messages.
1360 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1361 sizeof(struct ust_register_msg
));
1362 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1364 perror("lttcomm_recv_unix_sock register apps");
1366 ERR("Wrong size received on apps register");
1373 ust_cmd
->sock
= sock
;
1375 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1376 " gid:%d sock:%d name:%s (version %d.%d)",
1377 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1378 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1379 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1380 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1383 * Lock free enqueue the registration request. The red pill
1384 * has been taken! This apps will be part of the *system*.
1386 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1389 * Wake the registration queue futex. Implicit memory
1390 * barrier with the exchange in cds_wfq_enqueue.
1392 futex_nto1_wake(&ust_cmd_queue
.futex
);
1399 DBG("UST Registration thread dying");
1401 /* Notify that the registration thread is gone */
1406 unlink(apps_unix_sock_path
);
1408 lttng_poll_clean(&events
);
1414 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1415 * exec or it will fails.
1417 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1420 struct timespec timeout
;
1422 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1423 timeout
.tv_nsec
= 0;
1425 /* Setup semaphore */
1426 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1428 PERROR("sem_init consumer semaphore");
1432 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1433 thread_manage_consumer
, consumer_data
);
1435 PERROR("pthread_create consumer");
1440 /* Get time for sem_timedwait absolute timeout */
1441 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1443 PERROR("clock_gettime spawn consumer");
1444 /* Infinite wait for the kconsumerd thread to be ready */
1445 ret
= sem_wait(&consumer_data
->sem
);
1447 /* Normal timeout if the gettime was successful */
1448 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1449 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1453 if (errno
== ETIMEDOUT
) {
1455 * Call has timed out so we kill the kconsumerd_thread and return
1458 ERR("The consumer thread was never ready. Killing it");
1459 ret
= pthread_cancel(consumer_data
->thread
);
1461 PERROR("pthread_cancel consumer thread");
1464 PERROR("semaphore wait failed consumer thread");
1469 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1470 if (consumer_data
->pid
== 0) {
1471 ERR("Kconsumerd did not start");
1472 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1475 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1484 * Join consumer thread
1486 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1491 if (consumer_data
->pid
!= 0) {
1492 ret
= kill(consumer_data
->pid
, SIGTERM
);
1494 ERR("Error killing consumer daemon");
1497 return pthread_join(consumer_data
->thread
, &status
);
1504 * Fork and exec a consumer daemon (consumerd).
1506 * Return pid if successful else -1.
1508 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1512 const char *consumer_to_use
;
1513 const char *verbosity
;
1516 DBG("Spawning consumerd");
1523 if (opt_verbose_consumer
) {
1524 verbosity
= "--verbose";
1526 verbosity
= "--quiet";
1528 switch (consumer_data
->type
) {
1529 case LTTNG_CONSUMER_KERNEL
:
1531 * Find out which consumerd to execute. We will first try the
1532 * 64-bit path, then the sessiond's installation directory, and
1533 * fallback on the 32-bit one,
1535 DBG3("Looking for a kernel consumer at these locations:");
1536 DBG3(" 1) %s", consumerd64_bin
);
1537 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1538 DBG3(" 3) %s", consumerd32_bin
);
1539 if (stat(consumerd64_bin
, &st
) == 0) {
1540 DBG3("Found location #1");
1541 consumer_to_use
= consumerd64_bin
;
1542 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1543 DBG3("Found location #2");
1544 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1545 } else if (stat(consumerd32_bin
, &st
) == 0) {
1546 DBG3("Found location #3");
1547 consumer_to_use
= consumerd32_bin
;
1549 DBG("Could not find any valid consumerd executable");
1552 DBG("Using kernel consumer at: %s", consumer_to_use
);
1553 execl(consumer_to_use
,
1554 "lttng-consumerd", verbosity
, "-k",
1555 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1556 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1559 case LTTNG_CONSUMER64_UST
:
1561 char *tmpnew
= NULL
;
1563 if (consumerd64_libdir
[0] != '\0') {
1567 tmp
= getenv("LD_LIBRARY_PATH");
1571 tmplen
= strlen("LD_LIBRARY_PATH=")
1572 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1573 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1578 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1579 strcat(tmpnew
, consumerd64_libdir
);
1580 if (tmp
[0] != '\0') {
1581 strcat(tmpnew
, ":");
1582 strcat(tmpnew
, tmp
);
1584 ret
= putenv(tmpnew
);
1590 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1591 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1592 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1593 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1595 if (consumerd64_libdir
[0] != '\0') {
1603 case LTTNG_CONSUMER32_UST
:
1605 char *tmpnew
= NULL
;
1607 if (consumerd32_libdir
[0] != '\0') {
1611 tmp
= getenv("LD_LIBRARY_PATH");
1615 tmplen
= strlen("LD_LIBRARY_PATH=")
1616 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1617 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1622 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1623 strcat(tmpnew
, consumerd32_libdir
);
1624 if (tmp
[0] != '\0') {
1625 strcat(tmpnew
, ":");
1626 strcat(tmpnew
, tmp
);
1628 ret
= putenv(tmpnew
);
1634 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1635 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1636 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1637 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1639 if (consumerd32_libdir
[0] != '\0') {
1648 perror("unknown consumer type");
1652 perror("kernel start consumer exec");
1655 } else if (pid
> 0) {
1658 perror("start consumer fork");
1666 * Spawn the consumerd daemon and session daemon thread.
1668 static int start_consumerd(struct consumer_data
*consumer_data
)
1672 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1673 if (consumer_data
->pid
!= 0) {
1674 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1678 ret
= spawn_consumerd(consumer_data
);
1680 ERR("Spawning consumerd failed");
1681 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1685 /* Setting up the consumer_data pid */
1686 consumer_data
->pid
= ret
;
1687 DBG2("Consumer pid %d", consumer_data
->pid
);
1688 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1690 DBG2("Spawning consumer control thread");
1691 ret
= spawn_consumer_thread(consumer_data
);
1693 ERR("Fatal error spawning consumer control thread");
1705 * modprobe_kernel_modules
1707 static int modprobe_kernel_modules(void)
1712 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1713 ret
= snprintf(modprobe
, sizeof(modprobe
),
1714 "/sbin/modprobe %s%s",
1715 kernel_modules_list
[i
].required
? "" : "-q ",
1716 kernel_modules_list
[i
].name
);
1718 perror("snprintf modprobe");
1721 modprobe
[sizeof(modprobe
) - 1] = '\0';
1722 ret
= system(modprobe
);
1724 ERR("Unable to launch modprobe for module %s",
1725 kernel_modules_list
[i
].name
);
1726 } else if (kernel_modules_list
[i
].required
1727 && WEXITSTATUS(ret
) != 0) {
1728 ERR("Unable to load module %s",
1729 kernel_modules_list
[i
].name
);
1731 DBG("Modprobe successfully %s",
1732 kernel_modules_list
[i
].name
);
1743 static int mount_debugfs(char *path
)
1746 char *type
= "debugfs";
1748 ret
= run_as_mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1750 PERROR("Cannot create debugfs path");
1754 ret
= mount(type
, path
, type
, 0, NULL
);
1756 PERROR("Cannot mount debugfs");
1760 DBG("Mounted debugfs successfully at %s", path
);
1767 * Setup necessary data for kernel tracer action.
1769 static void init_kernel_tracer(void)
1772 char *proc_mounts
= "/proc/mounts";
1774 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1777 /* Detect debugfs */
1778 fp
= fopen(proc_mounts
, "r");
1780 ERR("Unable to probe %s", proc_mounts
);
1784 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1785 if (strstr(line
, "debugfs") != NULL
) {
1786 /* Remove first string */
1788 /* Dup string here so we can reuse line later on */
1789 debugfs_path
= strdup(strtok(NULL
, " "));
1790 DBG("Got debugfs path : %s", debugfs_path
);
1797 /* Mount debugfs if needded */
1798 if (debugfs_path
== NULL
) {
1799 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1801 perror("asprintf debugfs path");
1804 ret
= mount_debugfs(debugfs_path
);
1806 perror("Cannot mount debugfs");
1811 /* Modprobe lttng kernel modules */
1812 ret
= modprobe_kernel_modules();
1817 /* Setup lttng kernel path */
1818 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1820 perror("asprintf lttng path");
1824 /* Open debugfs lttng */
1825 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1826 if (kernel_tracer_fd
< 0) {
1827 DBG("Failed to open %s", lttng_path
);
1833 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1843 WARN("No kernel tracer available");
1844 kernel_tracer_fd
= 0;
1849 * Init tracing by creating trace directory and sending fds kernel consumer.
1851 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1855 if (session
->consumer_fds_sent
== 0) {
1857 * Assign default kernel consumer socket if no consumer assigned to the
1858 * kernel session. At this point, it's NOT suppose to be 0 but this is
1859 * an extra security check.
1861 if (session
->consumer_fd
== 0) {
1862 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1865 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1867 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1871 session
->consumer_fds_sent
= 1;
1879 * Create an UST session and add it to the session ust list.
1881 static int create_ust_session(struct ltt_session
*session
,
1882 struct lttng_domain
*domain
)
1884 struct ltt_ust_session
*lus
= NULL
;
1887 switch (domain
->type
) {
1888 case LTTNG_DOMAIN_UST
:
1891 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1895 DBG("Creating UST session");
1897 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1899 ret
= LTTCOMM_UST_SESS_FAIL
;
1903 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1904 session
->uid
, session
->gid
);
1906 if (ret
!= -EEXIST
) {
1907 ERR("Trace directory creation error");
1908 ret
= LTTCOMM_UST_SESS_FAIL
;
1913 /* The domain type dictate different actions on session creation */
1914 switch (domain
->type
) {
1915 case LTTNG_DOMAIN_UST
:
1916 /* No ustctl for the global UST domain */
1919 ERR("Unknown UST domain on create session %d", domain
->type
);
1922 lus
->uid
= session
->uid
;
1923 lus
->gid
= session
->gid
;
1924 session
->ust_session
= lus
;
1934 * Create a kernel tracer session then create the default channel.
1936 static int create_kernel_session(struct ltt_session
*session
)
1940 DBG("Creating kernel session");
1942 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1944 ret
= LTTCOMM_KERN_SESS_FAIL
;
1948 /* Set kernel consumer socket fd */
1949 if (kconsumer_data
.cmd_sock
) {
1950 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1953 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1954 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1956 if (ret
!= -EEXIST
) {
1957 ERR("Trace directory creation error");
1961 session
->kernel_session
->uid
= session
->uid
;
1962 session
->kernel_session
->gid
= session
->gid
;
1969 * Check if the UID or GID match the session. Root user has access to all
1972 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1974 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1981 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1984 struct ltt_session
*session
;
1986 DBG("Counting number of available session for UID %d GID %d",
1988 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1990 * Only list the sessions the user can control.
1992 if (!session_access_ok(session
, uid
, gid
)) {
2001 * Using the session list, filled a lttng_session array to send back to the
2002 * client for session listing.
2004 * The session list lock MUST be acquired before calling this function. Use
2005 * session_lock_list() and session_unlock_list().
2007 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2011 struct ltt_session
*session
;
2013 DBG("Getting all available session for UID %d GID %d",
2016 * Iterate over session list and append data after the control struct in
2019 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2021 * Only list the sessions the user can control.
2023 if (!session_access_ok(session
, uid
, gid
)) {
2026 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2027 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2028 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2029 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2030 sessions
[i
].enabled
= session
->enabled
;
2036 * Fill lttng_channel array of all channels.
2038 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2039 struct lttng_channel
*channels
)
2042 struct ltt_kernel_channel
*kchan
;
2044 DBG("Listing channels for session %s", session
->name
);
2047 case LTTNG_DOMAIN_KERNEL
:
2048 /* Kernel channels */
2049 if (session
->kernel_session
!= NULL
) {
2050 cds_list_for_each_entry(kchan
,
2051 &session
->kernel_session
->channel_list
.head
, list
) {
2052 /* Copy lttng_channel struct to array */
2053 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2054 channels
[i
].enabled
= kchan
->enabled
;
2059 case LTTNG_DOMAIN_UST
:
2061 struct lttng_ht_iter iter
;
2062 struct ltt_ust_channel
*uchan
;
2064 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2065 &iter
.iter
, uchan
, node
.node
) {
2066 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2067 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2068 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2069 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2070 channels
[i
].attr
.switch_timer_interval
=
2071 uchan
->attr
.switch_timer_interval
;
2072 channels
[i
].attr
.read_timer_interval
=
2073 uchan
->attr
.read_timer_interval
;
2074 channels
[i
].enabled
= uchan
->enabled
;
2075 switch (uchan
->attr
.output
) {
2076 case LTTNG_UST_MMAP
:
2078 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2091 * Create a list of ust global domain events.
2093 static int list_lttng_ust_global_events(char *channel_name
,
2094 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2097 unsigned int nb_event
= 0;
2098 struct lttng_ht_iter iter
;
2099 struct lttng_ht_node_str
*node
;
2100 struct ltt_ust_channel
*uchan
;
2101 struct ltt_ust_event
*uevent
;
2102 struct lttng_event
*tmp
;
2104 DBG("Listing UST global events for channel %s", channel_name
);
2108 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2109 node
= lttng_ht_iter_get_node_str(&iter
);
2111 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2115 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2117 nb_event
+= lttng_ht_get_count(uchan
->events
);
2119 if (nb_event
== 0) {
2124 DBG3("Listing UST global %d events", nb_event
);
2126 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2128 ret
= -LTTCOMM_FATAL
;
2132 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2133 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2134 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2135 tmp
[i
].enabled
= uevent
->enabled
;
2136 switch (uevent
->attr
.instrumentation
) {
2137 case LTTNG_UST_TRACEPOINT
:
2138 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2140 case LTTNG_UST_PROBE
:
2141 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2143 case LTTNG_UST_FUNCTION
:
2144 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2146 case LTTNG_UST_TRACEPOINT_LOGLEVEL
:
2147 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT_LOGLEVEL
;
2162 * Fill lttng_event array of all kernel events in the channel.
2164 static int list_lttng_kernel_events(char *channel_name
,
2165 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2168 unsigned int nb_event
;
2169 struct ltt_kernel_event
*event
;
2170 struct ltt_kernel_channel
*kchan
;
2172 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2173 if (kchan
== NULL
) {
2174 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2178 nb_event
= kchan
->event_count
;
2180 DBG("Listing events for channel %s", kchan
->channel
->name
);
2182 if (nb_event
== 0) {
2187 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2188 if (*events
== NULL
) {
2189 ret
= LTTCOMM_FATAL
;
2193 /* Kernel channels */
2194 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2195 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2196 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2197 (*events
)[i
].enabled
= event
->enabled
;
2198 switch (event
->event
->instrumentation
) {
2199 case LTTNG_KERNEL_TRACEPOINT
:
2200 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2202 case LTTNG_KERNEL_KPROBE
:
2203 case LTTNG_KERNEL_KRETPROBE
:
2204 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2205 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2206 sizeof(struct lttng_kernel_kprobe
));
2208 case LTTNG_KERNEL_FUNCTION
:
2209 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2210 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2211 sizeof(struct lttng_kernel_function
));
2213 case LTTNG_KERNEL_NOOP
:
2214 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2216 case LTTNG_KERNEL_SYSCALL
:
2217 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2219 case LTTNG_KERNEL_ALL
:
2233 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2235 static int cmd_disable_channel(struct ltt_session
*session
,
2236 int domain
, char *channel_name
)
2239 struct ltt_ust_session
*usess
;
2241 usess
= session
->ust_session
;
2244 case LTTNG_DOMAIN_KERNEL
:
2246 ret
= channel_kernel_disable(session
->kernel_session
,
2248 if (ret
!= LTTCOMM_OK
) {
2252 kernel_wait_quiescent(kernel_tracer_fd
);
2255 case LTTNG_DOMAIN_UST
:
2257 struct ltt_ust_channel
*uchan
;
2258 struct lttng_ht
*chan_ht
;
2260 chan_ht
= usess
->domain_global
.channels
;
2262 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2263 if (uchan
== NULL
) {
2264 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2268 ret
= channel_ust_disable(usess
, domain
, uchan
);
2269 if (ret
!= LTTCOMM_OK
) {
2274 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2275 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2276 case LTTNG_DOMAIN_UST_PID
:
2277 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2280 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2291 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2293 static int cmd_enable_channel(struct ltt_session
*session
,
2294 int domain
, struct lttng_channel
*attr
)
2297 struct ltt_ust_session
*usess
= session
->ust_session
;
2298 struct lttng_ht
*chan_ht
;
2300 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2303 case LTTNG_DOMAIN_KERNEL
:
2305 struct ltt_kernel_channel
*kchan
;
2307 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2308 session
->kernel_session
);
2309 if (kchan
== NULL
) {
2310 ret
= channel_kernel_create(session
->kernel_session
,
2311 attr
, kernel_poll_pipe
[1]);
2313 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2316 if (ret
!= LTTCOMM_OK
) {
2320 kernel_wait_quiescent(kernel_tracer_fd
);
2323 case LTTNG_DOMAIN_UST
:
2325 struct ltt_ust_channel
*uchan
;
2327 chan_ht
= usess
->domain_global
.channels
;
2329 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2330 if (uchan
== NULL
) {
2331 ret
= channel_ust_create(usess
, domain
, attr
);
2333 ret
= channel_ust_enable(usess
, domain
, uchan
);
2337 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2338 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2339 case LTTNG_DOMAIN_UST_PID
:
2340 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2343 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2352 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2354 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2355 char *channel_name
, char *event_name
)
2360 case LTTNG_DOMAIN_KERNEL
:
2362 struct ltt_kernel_channel
*kchan
;
2363 struct ltt_kernel_session
*ksess
;
2365 ksess
= session
->kernel_session
;
2367 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2368 if (kchan
== NULL
) {
2369 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2373 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2374 if (ret
!= LTTCOMM_OK
) {
2378 kernel_wait_quiescent(kernel_tracer_fd
);
2381 case LTTNG_DOMAIN_UST
:
2383 struct ltt_ust_channel
*uchan
;
2384 struct ltt_ust_session
*usess
;
2386 usess
= session
->ust_session
;
2388 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2390 if (uchan
== NULL
) {
2391 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2395 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2396 if (ret
!= LTTCOMM_OK
) {
2400 DBG3("Disable UST event %s in channel %s completed", event_name
,
2404 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2405 case LTTNG_DOMAIN_UST_PID
:
2406 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2408 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2419 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2421 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2427 case LTTNG_DOMAIN_KERNEL
:
2429 struct ltt_kernel_session
*ksess
;
2430 struct ltt_kernel_channel
*kchan
;
2432 ksess
= session
->kernel_session
;
2434 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2435 if (kchan
== NULL
) {
2436 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2440 ret
= event_kernel_disable_all(ksess
, kchan
);
2441 if (ret
!= LTTCOMM_OK
) {
2445 kernel_wait_quiescent(kernel_tracer_fd
);
2448 case LTTNG_DOMAIN_UST
:
2450 struct ltt_ust_session
*usess
;
2451 struct ltt_ust_channel
*uchan
;
2453 usess
= session
->ust_session
;
2455 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2457 if (uchan
== NULL
) {
2458 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2462 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2467 DBG3("Disable all UST events in channel %s completed", channel_name
);
2471 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2472 case LTTNG_DOMAIN_UST_PID
:
2473 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2475 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2486 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2488 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2489 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2494 case LTTNG_DOMAIN_KERNEL
:
2495 /* Add kernel context to kernel tracer */
2496 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2497 event_name
, channel_name
);
2498 if (ret
!= LTTCOMM_OK
) {
2502 case LTTNG_DOMAIN_UST
:
2504 struct ltt_ust_session
*usess
= session
->ust_session
;
2506 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2507 if (ret
!= LTTCOMM_OK
) {
2512 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2513 case LTTNG_DOMAIN_UST_PID
:
2514 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2516 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2527 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2529 * TODO: currently, both events and loglevels are kept within the same
2530 * namespace for UST global registry/app registery, so if an event
2531 * happen to have the same name as the loglevel (very unlikely though),
2532 * and an attempt is made to enable/disable both in the same session,
2533 * the first to be created will be the only one allowed to exist.
2535 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2536 char *channel_name
, struct lttng_event
*event
)
2539 struct lttng_channel
*attr
;
2540 struct ltt_ust_session
*usess
= session
->ust_session
;
2543 case LTTNG_DOMAIN_KERNEL
:
2545 struct ltt_kernel_channel
*kchan
;
2547 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2548 session
->kernel_session
);
2549 if (kchan
== NULL
) {
2550 attr
= channel_new_default_attr(domain
);
2552 ret
= LTTCOMM_FATAL
;
2555 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2557 /* This call will notify the kernel thread */
2558 ret
= channel_kernel_create(session
->kernel_session
,
2559 attr
, kernel_poll_pipe
[1]);
2560 if (ret
!= LTTCOMM_OK
) {
2567 /* Get the newly created kernel channel pointer */
2568 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2569 session
->kernel_session
);
2570 if (kchan
== NULL
) {
2571 /* This sould not happen... */
2572 ret
= LTTCOMM_FATAL
;
2576 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2578 if (ret
!= LTTCOMM_OK
) {
2582 kernel_wait_quiescent(kernel_tracer_fd
);
2585 case LTTNG_DOMAIN_UST
:
2587 struct lttng_channel
*attr
;
2588 struct ltt_ust_channel
*uchan
;
2590 /* Get channel from global UST domain */
2591 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2593 if (uchan
== NULL
) {
2594 /* Create default channel */
2595 attr
= channel_new_default_attr(domain
);
2597 ret
= LTTCOMM_FATAL
;
2600 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2601 attr
->name
[NAME_MAX
- 1] = '\0';
2603 ret
= channel_ust_create(usess
, domain
, attr
);
2604 if (ret
!= LTTCOMM_OK
) {
2610 /* Get the newly created channel reference back */
2611 uchan
= trace_ust_find_channel_by_name(
2612 usess
->domain_global
.channels
, channel_name
);
2613 if (uchan
== NULL
) {
2614 /* Something is really wrong */
2615 ret
= LTTCOMM_FATAL
;
2620 /* At this point, the session and channel exist on the tracer */
2621 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2622 if (ret
!= LTTCOMM_OK
) {
2627 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2628 case LTTNG_DOMAIN_UST_PID
:
2629 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2631 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2642 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2644 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2645 char *channel_name
, int event_type
)
2648 struct ltt_kernel_channel
*kchan
;
2651 case LTTNG_DOMAIN_KERNEL
:
2652 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2653 session
->kernel_session
);
2654 if (kchan
== NULL
) {
2655 /* This call will notify the kernel thread */
2656 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2657 kernel_poll_pipe
[1]);
2658 if (ret
!= LTTCOMM_OK
) {
2662 /* Get the newly created kernel channel pointer */
2663 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2664 session
->kernel_session
);
2665 if (kchan
== NULL
) {
2666 /* This sould not happen... */
2667 ret
= LTTCOMM_FATAL
;
2673 switch (event_type
) {
2674 case LTTNG_EVENT_SYSCALL
:
2675 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2676 kchan
, kernel_tracer_fd
);
2678 case LTTNG_EVENT_TRACEPOINT
:
2680 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2681 * events already registered to the channel.
2683 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2684 kchan
, kernel_tracer_fd
);
2686 case LTTNG_EVENT_ALL
:
2687 /* Enable syscalls and tracepoints */
2688 ret
= event_kernel_enable_all(session
->kernel_session
,
2689 kchan
, kernel_tracer_fd
);
2692 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2696 /* Manage return value */
2697 if (ret
!= LTTCOMM_OK
) {
2701 kernel_wait_quiescent(kernel_tracer_fd
);
2703 case LTTNG_DOMAIN_UST
:
2705 struct lttng_channel
*attr
;
2706 struct ltt_ust_channel
*uchan
;
2707 struct ltt_ust_session
*usess
= session
->ust_session
;
2709 /* Get channel from global UST domain */
2710 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2712 if (uchan
== NULL
) {
2713 /* Create default channel */
2714 attr
= channel_new_default_attr(domain
);
2716 ret
= LTTCOMM_FATAL
;
2719 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2720 attr
->name
[NAME_MAX
- 1] = '\0';
2722 /* Use the internal command enable channel */
2723 ret
= channel_ust_create(usess
, domain
, attr
);
2724 if (ret
!= LTTCOMM_OK
) {
2730 /* Get the newly created channel reference back */
2731 uchan
= trace_ust_find_channel_by_name(
2732 usess
->domain_global
.channels
, channel_name
);
2733 if (uchan
== NULL
) {
2734 /* Something is really wrong */
2735 ret
= LTTCOMM_FATAL
;
2740 /* At this point, the session and channel exist on the tracer */
2742 switch (event_type
) {
2743 case LTTNG_EVENT_ALL
:
2744 case LTTNG_EVENT_TRACEPOINT
:
2745 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2746 if (ret
!= LTTCOMM_OK
) {
2751 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2755 /* Manage return value */
2756 if (ret
!= LTTCOMM_OK
) {
2762 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2763 case LTTNG_DOMAIN_UST_PID
:
2764 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2766 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2777 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2779 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2782 ssize_t nb_events
= 0;
2785 case LTTNG_DOMAIN_KERNEL
:
2786 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2787 if (nb_events
< 0) {
2788 ret
= LTTCOMM_KERN_LIST_FAIL
;
2792 case LTTNG_DOMAIN_UST
:
2793 nb_events
= ust_app_list_events(events
);
2794 if (nb_events
< 0) {
2795 ret
= LTTCOMM_UST_LIST_FAIL
;
2800 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2807 /* Return negative value to differentiate return code */
2812 * Command LTTNG_START_TRACE processed by the client thread.
2814 static int cmd_start_trace(struct ltt_session
*session
)
2817 struct ltt_kernel_session
*ksession
;
2818 struct ltt_ust_session
*usess
;
2821 ksession
= session
->kernel_session
;
2822 usess
= session
->ust_session
;
2824 if (session
->enabled
) {
2825 ret
= LTTCOMM_UST_START_FAIL
;
2829 session
->enabled
= 1;
2831 /* Kernel tracing */
2832 if (ksession
!= NULL
) {
2833 struct ltt_kernel_channel
*kchan
;
2835 /* Open kernel metadata */
2836 if (ksession
->metadata
== NULL
) {
2837 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2839 ret
= LTTCOMM_KERN_META_FAIL
;
2844 /* Open kernel metadata stream */
2845 if (ksession
->metadata_stream_fd
== 0) {
2846 ret
= kernel_open_metadata_stream(ksession
);
2848 ERR("Kernel create metadata stream failed");
2849 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2854 /* For each channel */
2855 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2856 if (kchan
->stream_count
== 0) {
2857 ret
= kernel_open_channel_stream(kchan
);
2859 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2862 /* Update the stream global counter */
2863 ksession
->stream_count_global
+= ret
;
2867 /* Setup kernel consumer socket and send fds to it */
2868 ret
= init_kernel_tracing(ksession
);
2870 ret
= LTTCOMM_KERN_START_FAIL
;
2874 /* This start the kernel tracing */
2875 ret
= kernel_start_session(ksession
);
2877 ret
= LTTCOMM_KERN_START_FAIL
;
2881 /* Quiescent wait after starting trace */
2882 kernel_wait_quiescent(kernel_tracer_fd
);
2885 /* Flag session that trace should start automatically */
2887 usess
->start_trace
= 1;
2889 ret
= ust_app_start_trace_all(usess
);
2891 ret
= LTTCOMM_UST_START_FAIL
;
2903 * Command LTTNG_STOP_TRACE processed by the client thread.
2905 static int cmd_stop_trace(struct ltt_session
*session
)
2908 struct ltt_kernel_channel
*kchan
;
2909 struct ltt_kernel_session
*ksession
;
2910 struct ltt_ust_session
*usess
;
2913 ksession
= session
->kernel_session
;
2914 usess
= session
->ust_session
;
2916 if (!session
->enabled
) {
2917 ret
= LTTCOMM_UST_STOP_FAIL
;
2921 session
->enabled
= 0;
2924 if (ksession
!= NULL
) {
2925 DBG("Stop kernel tracing");
2927 /* Flush all buffers before stopping */
2928 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2930 ERR("Kernel metadata flush failed");
2933 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2934 ret
= kernel_flush_buffer(kchan
);
2936 ERR("Kernel flush buffer error");
2940 ret
= kernel_stop_session(ksession
);
2942 ret
= LTTCOMM_KERN_STOP_FAIL
;
2946 kernel_wait_quiescent(kernel_tracer_fd
);
2950 usess
->start_trace
= 0;
2952 ret
= ust_app_stop_trace_all(usess
);
2954 ret
= LTTCOMM_UST_STOP_FAIL
;
2966 * Command LTTNG_CREATE_SESSION processed by the client thread.
2968 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2972 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2973 if (ret
!= LTTCOMM_OK
) {
2984 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2986 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2990 /* Clean kernel session teardown */
2991 teardown_kernel_session(session
);
2992 /* UST session teardown */
2993 teardown_ust_session(session
);
2996 * Must notify the kernel thread here to update it's poll setin order
2997 * to remove the channel(s)' fd just destroyed.
2999 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3001 perror("write kernel poll pipe");
3004 ret
= session_destroy(session
);
3010 * Command LTTNG_CALIBRATE processed by the client thread.
3012 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3017 case LTTNG_DOMAIN_KERNEL
:
3019 struct lttng_kernel_calibrate kcalibrate
;
3021 kcalibrate
.type
= calibrate
->type
;
3022 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3024 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3030 /* TODO: Userspace tracing */
3031 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3042 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3044 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3050 case LTTNG_DOMAIN_KERNEL
:
3051 /* Can't register a consumer if there is already one */
3052 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3053 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3057 sock
= lttcomm_connect_unix_sock(sock_path
);
3059 ret
= LTTCOMM_CONNECT_FAIL
;
3063 session
->kernel_session
->consumer_fd
= sock
;
3066 /* TODO: Userspace tracing */
3067 ret
= LTTCOMM_NOT_IMPLEMENTED
;
3078 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3080 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3081 struct lttng_domain
**domains
)
3086 if (session
->kernel_session
!= NULL
) {
3087 DBG3("Listing domains found kernel domain");
3091 if (session
->ust_session
!= NULL
) {
3092 DBG3("Listing domains found UST global domain");
3096 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3097 if (*domains
== NULL
) {
3098 ret
= -LTTCOMM_FATAL
;
3102 if (session
->kernel_session
!= NULL
) {
3103 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3107 if (session
->ust_session
!= NULL
) {
3108 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3119 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3121 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3122 struct lttng_channel
**channels
)
3125 ssize_t nb_chan
= 0;
3128 case LTTNG_DOMAIN_KERNEL
:
3129 if (session
->kernel_session
!= NULL
) {
3130 nb_chan
= session
->kernel_session
->channel_count
;
3132 DBG3("Number of kernel channels %zd", nb_chan
);
3134 case LTTNG_DOMAIN_UST
:
3135 if (session
->ust_session
!= NULL
) {
3136 nb_chan
= lttng_ht_get_count(
3137 session
->ust_session
->domain_global
.channels
);
3139 DBG3("Number of UST global channels %zd", nb_chan
);
3143 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3148 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3149 if (*channels
== NULL
) {
3150 ret
= -LTTCOMM_FATAL
;
3154 list_lttng_channels(domain
, session
, *channels
);
3166 * Command LTTNG_LIST_EVENTS processed by the client thread.
3168 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3169 char *channel_name
, struct lttng_event
**events
)
3172 ssize_t nb_event
= 0;
3175 case LTTNG_DOMAIN_KERNEL
:
3176 if (session
->kernel_session
!= NULL
) {
3177 nb_event
= list_lttng_kernel_events(channel_name
,
3178 session
->kernel_session
, events
);
3181 case LTTNG_DOMAIN_UST
:
3183 if (session
->ust_session
!= NULL
) {
3184 nb_event
= list_lttng_ust_global_events(channel_name
,
3185 &session
->ust_session
->domain_global
, events
);
3190 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
3201 * Process the command requested by the lttng client within the command
3202 * context structure. This function make sure that the return structure (llm)
3203 * is set and ready for transmission before returning.
3205 * Return any error encountered or 0 for success.
3207 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3209 int ret
= LTTCOMM_OK
;
3210 int need_tracing_session
= 1;
3212 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3214 if (opt_no_kernel
&& cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3215 ret
= LTTCOMM_KERN_NA
;
3220 * Check for command that don't needs to allocate a returned payload. We do
3221 * this here so we don't have to make the call for no payload at each
3224 switch(cmd_ctx
->lsm
->cmd_type
) {
3225 case LTTNG_LIST_SESSIONS
:
3226 case LTTNG_LIST_TRACEPOINTS
:
3227 case LTTNG_LIST_DOMAINS
:
3228 case LTTNG_LIST_CHANNELS
:
3229 case LTTNG_LIST_EVENTS
:
3232 /* Setup lttng message with no payload */
3233 ret
= setup_lttng_msg(cmd_ctx
, 0);
3235 /* This label does not try to unlock the session */
3236 goto init_setup_error
;
3240 /* Commands that DO NOT need a session. */
3241 switch (cmd_ctx
->lsm
->cmd_type
) {
3242 case LTTNG_CALIBRATE
:
3243 case LTTNG_CREATE_SESSION
:
3244 case LTTNG_LIST_SESSIONS
:
3245 case LTTNG_LIST_TRACEPOINTS
:
3246 need_tracing_session
= 0;
3249 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3250 session_lock_list();
3251 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3252 session_unlock_list();
3253 if (cmd_ctx
->session
== NULL
) {
3254 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3255 ret
= LTTCOMM_SESS_NOT_FOUND
;
3257 /* If no session name specified */
3258 ret
= LTTCOMM_SELECT_SESS
;
3262 /* Acquire lock for the session */
3263 session_lock(cmd_ctx
->session
);
3269 * Check domain type for specific "pre-action".
3271 switch (cmd_ctx
->lsm
->domain
.type
) {
3272 case LTTNG_DOMAIN_KERNEL
:
3274 ret
= LTTCOMM_KERN_NA
;
3278 /* Kernel tracer check */
3279 if (kernel_tracer_fd
== 0) {
3280 /* Basically, load kernel tracer modules */
3281 init_kernel_tracer();
3282 if (kernel_tracer_fd
== 0) {
3283 ret
= LTTCOMM_KERN_NA
;
3288 /* Need a session for kernel command */
3289 if (need_tracing_session
) {
3290 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3291 ret
= create_kernel_session(cmd_ctx
->session
);
3293 ret
= LTTCOMM_KERN_SESS_FAIL
;
3298 /* Start the kernel consumer daemon */
3299 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3300 if (kconsumer_data
.pid
== 0 &&
3301 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3302 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3303 ret
= start_consumerd(&kconsumer_data
);
3305 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3309 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3313 case LTTNG_DOMAIN_UST
:
3315 if (need_tracing_session
) {
3316 if (cmd_ctx
->session
->ust_session
== NULL
) {
3317 ret
= create_ust_session(cmd_ctx
->session
,
3318 &cmd_ctx
->lsm
->domain
);
3319 if (ret
!= LTTCOMM_OK
) {
3323 /* Start the UST consumer daemons */
3325 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3326 if (consumerd64_bin
[0] != '\0' &&
3327 ustconsumer64_data
.pid
== 0 &&
3328 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3329 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3330 ret
= start_consumerd(&ustconsumer64_data
);
3332 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3333 ust_consumerd64_fd
= -EINVAL
;
3337 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3339 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3342 if (consumerd32_bin
[0] != '\0' &&
3343 ustconsumer32_data
.pid
== 0 &&
3344 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3345 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3346 ret
= start_consumerd(&ustconsumer32_data
);
3348 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3349 ust_consumerd32_fd
= -EINVAL
;
3352 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3354 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3364 * Check that the UID or GID match that of the tracing session.
3365 * The root user can interact with all sessions.
3367 if (need_tracing_session
) {
3368 if (!session_access_ok(cmd_ctx
->session
,
3369 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3370 ret
= LTTCOMM_EPERM
;
3375 /* Process by command type */
3376 switch (cmd_ctx
->lsm
->cmd_type
) {
3377 case LTTNG_ADD_CONTEXT
:
3379 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3380 cmd_ctx
->lsm
->u
.context
.channel_name
,
3381 cmd_ctx
->lsm
->u
.context
.event_name
,
3382 &cmd_ctx
->lsm
->u
.context
.ctx
);
3385 case LTTNG_DISABLE_CHANNEL
:
3387 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3388 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3391 case LTTNG_DISABLE_EVENT
:
3393 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3394 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3395 cmd_ctx
->lsm
->u
.disable
.name
);
3399 case LTTNG_DISABLE_ALL_EVENT
:
3401 DBG("Disabling all events");
3403 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3404 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3407 case LTTNG_ENABLE_CHANNEL
:
3409 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3410 &cmd_ctx
->lsm
->u
.channel
.chan
);
3413 case LTTNG_ENABLE_EVENT
:
3415 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3416 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3417 &cmd_ctx
->lsm
->u
.enable
.event
);
3420 case LTTNG_ENABLE_ALL_EVENT
:
3422 DBG("Enabling all events");
3424 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3425 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3426 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3429 case LTTNG_LIST_TRACEPOINTS
:
3431 struct lttng_event
*events
;
3434 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3435 if (nb_events
< 0) {
3441 * Setup lttng message with payload size set to the event list size in
3442 * bytes and then copy list into the llm payload.
3444 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3450 /* Copy event list into message payload */
3451 memcpy(cmd_ctx
->llm
->payload
, events
,
3452 sizeof(struct lttng_event
) * nb_events
);
3459 case LTTNG_START_TRACE
:
3461 ret
= cmd_start_trace(cmd_ctx
->session
);
3464 case LTTNG_STOP_TRACE
:
3466 ret
= cmd_stop_trace(cmd_ctx
->session
);
3469 case LTTNG_CREATE_SESSION
:
3471 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3472 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3475 case LTTNG_DESTROY_SESSION
:
3477 ret
= cmd_destroy_session(cmd_ctx
->session
,
3478 cmd_ctx
->lsm
->session
.name
);
3481 case LTTNG_LIST_DOMAINS
:
3484 struct lttng_domain
*domains
;
3486 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3492 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3497 /* Copy event list into message payload */
3498 memcpy(cmd_ctx
->llm
->payload
, domains
,
3499 nb_dom
* sizeof(struct lttng_domain
));
3506 case LTTNG_LIST_CHANNELS
:
3509 struct lttng_channel
*channels
;
3511 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3512 cmd_ctx
->session
, &channels
);
3518 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3523 /* Copy event list into message payload */
3524 memcpy(cmd_ctx
->llm
->payload
, channels
,
3525 nb_chan
* sizeof(struct lttng_channel
));
3532 case LTTNG_LIST_EVENTS
:
3535 struct lttng_event
*events
= NULL
;
3537 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3538 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3544 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3549 /* Copy event list into message payload */
3550 memcpy(cmd_ctx
->llm
->payload
, events
,
3551 nb_event
* sizeof(struct lttng_event
));
3558 case LTTNG_LIST_SESSIONS
:
3560 unsigned int nr_sessions
;
3562 session_lock_list();
3563 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3564 if (nr_sessions
== 0) {
3565 ret
= LTTCOMM_NO_SESSION
;
3566 session_unlock_list();
3569 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3571 session_unlock_list();
3575 /* Filled the session array */
3576 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3577 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3579 session_unlock_list();
3584 case LTTNG_CALIBRATE
:
3586 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3587 &cmd_ctx
->lsm
->u
.calibrate
);
3590 case LTTNG_REGISTER_CONSUMER
:
3592 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3593 cmd_ctx
->lsm
->u
.reg
.path
);
3602 if (cmd_ctx
->llm
== NULL
) {
3603 DBG("Missing llm structure. Allocating one.");
3604 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3608 /* Set return code */
3609 cmd_ctx
->llm
->ret_code
= ret
;
3611 if (cmd_ctx
->session
) {
3612 session_unlock(cmd_ctx
->session
);
3619 * This thread manage all clients request using the unix client socket for
3622 static void *thread_manage_clients(void *data
)
3624 int sock
= 0, ret
, i
, pollfd
;
3625 uint32_t revents
, nb_fd
;
3626 struct command_ctx
*cmd_ctx
= NULL
;
3627 struct lttng_poll_event events
;
3629 DBG("[thread] Manage client started");
3631 rcu_register_thread();
3633 ret
= lttcomm_listen_unix_sock(client_sock
);
3639 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3640 * more will be added to this poll set.
3642 ret
= create_thread_poll_set(&events
, 2);
3647 /* Add the application registration socket */
3648 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3654 * Notify parent pid that we are ready to accept command for client side.
3656 if (opt_sig_parent
) {
3657 kill(ppid
, SIGCHLD
);
3661 DBG("Accepting client command ...");
3663 nb_fd
= LTTNG_POLL_GETNB(&events
);
3665 /* Inifinite blocking call, waiting for transmission */
3666 ret
= lttng_poll_wait(&events
, -1);
3671 for (i
= 0; i
< nb_fd
; i
++) {
3672 /* Fetch once the poll data */
3673 revents
= LTTNG_POLL_GETEV(&events
, i
);
3674 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3676 /* Thread quit pipe has been closed. Killing thread. */
3677 ret
= check_thread_quit_pipe(pollfd
, revents
);
3682 /* Event on the registration socket */
3683 if (pollfd
== client_sock
) {
3684 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3685 ERR("Client socket poll error");
3691 DBG("Wait for client response");
3693 sock
= lttcomm_accept_unix_sock(client_sock
);
3698 /* Set socket option for credentials retrieval */
3699 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3704 /* Allocate context command to process the client request */
3705 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3706 if (cmd_ctx
== NULL
) {
3707 perror("zmalloc cmd_ctx");
3711 /* Allocate data buffer for reception */
3712 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3713 if (cmd_ctx
->lsm
== NULL
) {
3714 perror("zmalloc cmd_ctx->lsm");
3718 cmd_ctx
->llm
= NULL
;
3719 cmd_ctx
->session
= NULL
;
3722 * Data is received from the lttng client. The struct
3723 * lttcomm_session_msg (lsm) contains the command and data request of
3726 DBG("Receiving data from client ...");
3727 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3728 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3730 DBG("Nothing recv() from client... continuing");
3736 // TODO: Validate cmd_ctx including sanity check for
3737 // security purpose.
3739 rcu_thread_online();
3741 * This function dispatch the work to the kernel or userspace tracer
3742 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3743 * informations for the client. The command context struct contains
3744 * everything this function may needs.
3746 ret
= process_client_msg(cmd_ctx
);
3747 rcu_thread_offline();
3750 * TODO: Inform client somehow of the fatal error. At
3751 * this point, ret < 0 means that a zmalloc failed
3752 * (ENOMEM). Error detected but still accept command.
3754 clean_command_ctx(&cmd_ctx
);
3758 DBG("Sending response (size: %d, retcode: %s)",
3759 cmd_ctx
->lttng_msg_size
,
3760 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3761 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3763 ERR("Failed to send data back to client");
3766 /* End of transmission */
3769 clean_command_ctx(&cmd_ctx
);
3773 DBG("Client thread dying");
3774 unlink(client_unix_sock_path
);
3778 lttng_poll_clean(&events
);
3779 clean_command_ctx(&cmd_ctx
);
3781 rcu_unregister_thread();
3787 * usage function on stderr
3789 static void usage(void)
3791 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3792 fprintf(stderr
, " -h, --help Display this usage.\n");
3793 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3794 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3795 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3796 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3797 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3798 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3799 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3800 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3801 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3802 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3803 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3804 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3805 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3806 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3807 fprintf(stderr
, " -V, --version Show version number.\n");
3808 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3809 fprintf(stderr
, " -q, --quiet No output at all.\n");
3810 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3811 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3812 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3816 * daemon argument parsing
3818 static int parse_args(int argc
, char **argv
)
3822 static struct option long_options
[] = {
3823 { "client-sock", 1, 0, 'c' },
3824 { "apps-sock", 1, 0, 'a' },
3825 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3826 { "kconsumerd-err-sock", 1, 0, 'E' },
3827 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3828 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3829 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3830 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3831 { "consumerd32-path", 1, 0, 'u' },
3832 { "consumerd32-libdir", 1, 0, 'U' },
3833 { "consumerd64-path", 1, 0, 't' },
3834 { "consumerd64-libdir", 1, 0, 'T' },
3835 { "daemonize", 0, 0, 'd' },
3836 { "sig-parent", 0, 0, 'S' },
3837 { "help", 0, 0, 'h' },
3838 { "group", 1, 0, 'g' },
3839 { "version", 0, 0, 'V' },
3840 { "quiet", 0, 0, 'q' },
3841 { "verbose", 0, 0, 'v' },
3842 { "verbose-consumer", 0, 0, 'Z' },
3843 { "no-kernel", 0, 0, 'N' },
3848 int option_index
= 0;
3849 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3850 long_options
, &option_index
);
3857 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3859 fprintf(stderr
, " with arg %s\n", optarg
);
3863 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3866 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3872 opt_tracing_group
= optarg
;
3878 fprintf(stdout
, "%s\n", VERSION
);
3884 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3887 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3890 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3893 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3896 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3899 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3908 /* Verbose level can increase using multiple -v */
3912 opt_verbose_consumer
+= 1;
3915 consumerd32_bin
= optarg
;
3918 consumerd32_libdir
= optarg
;
3921 consumerd64_bin
= optarg
;
3924 consumerd64_libdir
= optarg
;
3927 /* Unknown option or other error.
3928 * Error is printed by getopt, just return */
3937 * Creates the two needed socket by the daemon.
3938 * apps_sock - The communication socket for all UST apps.
3939 * client_sock - The communication of the cli tool (lttng).
3941 static int init_daemon_socket(void)
3946 old_umask
= umask(0);
3948 /* Create client tool unix socket */
3949 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3950 if (client_sock
< 0) {
3951 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3956 /* File permission MUST be 660 */
3957 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3959 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3964 /* Create the application unix socket */
3965 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3966 if (apps_sock
< 0) {
3967 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3972 /* File permission MUST be 666 */
3973 ret
= chmod(apps_unix_sock_path
,
3974 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3976 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3987 * Check if the global socket is available, and if a daemon is answering at the
3988 * other side. If yes, error is returned.
3990 static int check_existing_daemon(void)
3992 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3993 access(apps_unix_sock_path
, F_OK
) < 0) {
3997 /* Is there anybody out there ? */
3998 if (lttng_session_daemon_alive()) {
4006 * Set the tracing group gid onto the client socket.
4008 * Race window between mkdir and chown is OK because we are going from more
4009 * permissive (root.root) to les permissive (root.tracing).
4011 static int set_permissions(char *rundir
)
4016 gid
= allowed_group();
4018 WARN("No tracing group detected");
4023 /* Set lttng run dir */
4024 ret
= chown(rundir
, 0, gid
);
4026 ERR("Unable to set group on %s", rundir
);
4030 /* lttng client socket path */
4031 ret
= chown(client_unix_sock_path
, 0, gid
);
4033 ERR("Unable to set group on %s", client_unix_sock_path
);
4037 /* kconsumer error socket path */
4038 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4040 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4044 /* 64-bit ustconsumer error socket path */
4045 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4047 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4051 /* 32-bit ustconsumer compat32 error socket path */
4052 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4054 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4058 DBG("All permissions are set");
4065 * Create the pipe used to wake up the kernel thread.
4067 static int create_kernel_poll_pipe(void)
4069 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4073 * Create the application command pipe to wake thread_manage_apps.
4075 static int create_apps_cmd_pipe(void)
4077 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4081 * Create the lttng run directory needed for all global sockets and pipe.
4083 static int create_lttng_rundir(const char *rundir
)
4087 DBG3("Creating LTTng run directory: %s", rundir
);
4089 ret
= mkdir(rundir
, S_IRWXU
| S_IRWXG
);
4091 if (errno
!= EEXIST
) {
4092 ERR("Unable to create %s", rundir
);
4104 * Setup sockets and directory needed by the kconsumerd communication with the
4107 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4111 char path
[PATH_MAX
];
4113 switch (consumer_data
->type
) {
4114 case LTTNG_CONSUMER_KERNEL
:
4115 snprintf(path
, PATH_MAX
, KCONSUMERD_PATH
, rundir
);
4117 case LTTNG_CONSUMER64_UST
:
4118 snprintf(path
, PATH_MAX
, USTCONSUMERD64_PATH
, rundir
);
4120 case LTTNG_CONSUMER32_UST
:
4121 snprintf(path
, PATH_MAX
, USTCONSUMERD32_PATH
, rundir
);
4124 ERR("Consumer type unknown");
4129 DBG2("Creating consumer directory: %s", path
);
4131 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
4133 if (errno
!= EEXIST
) {
4134 ERR("Failed to create %s", path
);
4140 /* Create the kconsumerd error unix socket */
4141 consumer_data
->err_sock
=
4142 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4143 if (consumer_data
->err_sock
< 0) {
4144 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4149 /* File permission MUST be 660 */
4150 ret
= chmod(consumer_data
->err_unix_sock_path
,
4151 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4153 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4163 * Signal handler for the daemon
4165 * Simply stop all worker threads, leaving main() return gracefully after
4166 * joining all threads and calling cleanup().
4168 static void sighandler(int sig
)
4172 DBG("SIGPIPE catched");
4175 DBG("SIGINT catched");
4179 DBG("SIGTERM catched");
4188 * Setup signal handler for :
4189 * SIGINT, SIGTERM, SIGPIPE
4191 static int set_signal_handler(void)
4194 struct sigaction sa
;
4197 if ((ret
= sigemptyset(&sigset
)) < 0) {
4198 perror("sigemptyset");
4202 sa
.sa_handler
= sighandler
;
4203 sa
.sa_mask
= sigset
;
4205 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4206 perror("sigaction");
4210 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4211 perror("sigaction");
4215 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4216 perror("sigaction");
4220 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4226 * Set open files limit to unlimited. This daemon can open a large number of
4227 * file descriptors in order to consumer multiple kernel traces.
4229 static void set_ulimit(void)
4234 /* The kernel does not allowed an infinite limit for open files */
4235 lim
.rlim_cur
= 65535;
4236 lim
.rlim_max
= 65535;
4238 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4240 perror("failed to set open files limit");
4247 int main(int argc
, char **argv
)
4251 const char *home_path
;
4253 rcu_register_thread();
4255 /* Create thread quit pipe */
4256 if ((ret
= init_thread_quit_pipe()) < 0) {
4260 setup_consumerd_path();
4262 /* Parse arguments */
4264 if ((ret
= parse_args(argc
, argv
) < 0)) {
4277 /* Check if daemon is UID = 0 */
4278 is_root
= !getuid();
4281 rundir
= strdup(LTTNG_RUNDIR
);
4283 /* Create global run dir with root access */
4284 ret
= create_lttng_rundir(rundir
);
4289 if (strlen(apps_unix_sock_path
) == 0) {
4290 snprintf(apps_unix_sock_path
, PATH_MAX
,
4291 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4294 if (strlen(client_unix_sock_path
) == 0) {
4295 snprintf(client_unix_sock_path
, PATH_MAX
,
4296 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4299 /* Set global SHM for ust */
4300 if (strlen(wait_shm_path
) == 0) {
4301 snprintf(wait_shm_path
, PATH_MAX
,
4302 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4305 /* Setup kernel consumerd path */
4306 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4307 KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4308 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4309 KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4311 DBG2("Kernel consumer err path: %s",
4312 kconsumer_data
.err_unix_sock_path
);
4313 DBG2("Kernel consumer cmd path: %s",
4314 kconsumer_data
.cmd_unix_sock_path
);
4316 home_path
= get_home_dir();
4317 if (home_path
== NULL
) {
4318 /* TODO: Add --socket PATH option */
4319 ERR("Can't get HOME directory for sockets creation.");
4325 * Create rundir from home path. This will create something like
4328 ret
= asprintf(&rundir
, LTTNG_HOME_RUNDIR
, home_path
);
4334 ret
= create_lttng_rundir(rundir
);
4339 if (strlen(apps_unix_sock_path
) == 0) {
4340 snprintf(apps_unix_sock_path
, PATH_MAX
,
4341 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4344 /* Set the cli tool unix socket path */
4345 if (strlen(client_unix_sock_path
) == 0) {
4346 snprintf(client_unix_sock_path
, PATH_MAX
,
4347 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4350 /* Set global SHM for ust */
4351 if (strlen(wait_shm_path
) == 0) {
4352 snprintf(wait_shm_path
, PATH_MAX
,
4353 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4357 DBG("Client socket path %s", client_unix_sock_path
);
4358 DBG("Application socket path %s", apps_unix_sock_path
);
4359 DBG("LTTng run directory path: %s", rundir
);
4361 /* 32 bits consumerd path setup */
4362 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4363 USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4364 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4365 USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4367 DBG2("UST consumer 32 bits err path: %s",
4368 ustconsumer32_data
.err_unix_sock_path
);
4369 DBG2("UST consumer 32 bits cmd path: %s",
4370 ustconsumer32_data
.cmd_unix_sock_path
);
4372 /* 64 bits consumerd path setup */
4373 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4374 USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4375 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4376 USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4378 DBG2("UST consumer 64 bits err path: %s",
4379 ustconsumer64_data
.err_unix_sock_path
);
4380 DBG2("UST consumer 64 bits cmd path: %s",
4381 ustconsumer64_data
.cmd_unix_sock_path
);
4384 * See if daemon already exist.
4386 if ((ret
= check_existing_daemon()) < 0) {
4387 ERR("Already running daemon.\n");
4389 * We do not goto exit because we must not cleanup()
4390 * because a daemon is already running.
4395 /* After this point, we can safely call cleanup() with "goto exit" */
4398 * These actions must be executed as root. We do that *after* setting up
4399 * the sockets path because we MUST make the check for another daemon using
4400 * those paths *before* trying to set the kernel consumer sockets and init
4404 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4409 /* Setup kernel tracer */
4410 if (!opt_no_kernel
) {
4411 init_kernel_tracer();
4414 /* Set ulimit for open files */
4418 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4423 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4428 if ((ret
= set_signal_handler()) < 0) {
4432 /* Setup the needed unix socket */
4433 if ((ret
= init_daemon_socket()) < 0) {
4437 /* Set credentials to socket */
4438 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4442 /* Get parent pid if -S, --sig-parent is specified. */
4443 if (opt_sig_parent
) {
4447 /* Setup the kernel pipe for waking up the kernel thread */
4448 if ((ret
= create_kernel_poll_pipe()) < 0) {
4452 /* Setup the thread apps communication pipe. */
4453 if ((ret
= create_apps_cmd_pipe()) < 0) {
4457 /* Init UST command queue. */
4458 cds_wfq_init(&ust_cmd_queue
.queue
);
4460 /* Init UST app hash table */
4464 * Get session list pointer. This pointer MUST NOT be free(). This list is
4465 * statically declared in session.c
4467 session_list_ptr
= session_get_list();
4469 /* Set up max poll set size */
4470 lttng_poll_set_max_size();
4472 /* Create thread to manage the client socket */
4473 ret
= pthread_create(&client_thread
, NULL
,
4474 thread_manage_clients
, (void *) NULL
);
4476 perror("pthread_create clients");
4480 /* Create thread to dispatch registration */
4481 ret
= pthread_create(&dispatch_thread
, NULL
,
4482 thread_dispatch_ust_registration
, (void *) NULL
);
4484 perror("pthread_create dispatch");
4488 /* Create thread to manage application registration. */
4489 ret
= pthread_create(®_apps_thread
, NULL
,
4490 thread_registration_apps
, (void *) NULL
);
4492 perror("pthread_create registration");
4496 /* Create thread to manage application socket */
4497 ret
= pthread_create(&apps_thread
, NULL
,
4498 thread_manage_apps
, (void *) NULL
);
4500 perror("pthread_create apps");
4504 /* Create kernel thread to manage kernel event */
4505 ret
= pthread_create(&kernel_thread
, NULL
,
4506 thread_manage_kernel
, (void *) NULL
);
4508 perror("pthread_create kernel");
4512 ret
= pthread_join(kernel_thread
, &status
);
4514 perror("pthread_join");
4515 goto error
; /* join error, exit without cleanup */
4519 ret
= pthread_join(apps_thread
, &status
);
4521 perror("pthread_join");
4522 goto error
; /* join error, exit without cleanup */
4526 ret
= pthread_join(reg_apps_thread
, &status
);
4528 perror("pthread_join");
4529 goto error
; /* join error, exit without cleanup */
4533 ret
= pthread_join(dispatch_thread
, &status
);
4535 perror("pthread_join");
4536 goto error
; /* join error, exit without cleanup */
4540 ret
= pthread_join(client_thread
, &status
);
4542 perror("pthread_join");
4543 goto error
; /* join error, exit without cleanup */
4546 ret
= join_consumer_thread(&kconsumer_data
);
4548 perror("join_consumer");
4549 goto error
; /* join error, exit without cleanup */
4555 * cleanup() is called when no other thread is running.
4557 rcu_thread_online();
4559 rcu_thread_offline();
4560 rcu_unregister_thread();