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.
24 #include <semaphore.h>
30 #include <sys/mount.h>
31 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
36 #include <urcu/futex.h>
40 #include <common/common.h>
41 #include <common/compat/poll.h>
42 #include <common/compat/socket.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
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
[] = 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
= DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
102 .cmd_unix_sock_path
= DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
104 static struct consumer_data ustconsumer64_data
= {
105 .type
= LTTNG_CONSUMER64_UST
,
106 .err_unix_sock_path
= DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
,
107 .cmd_unix_sock_path
= DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
,
109 static struct consumer_data ustconsumer32_data
= {
110 .type
= LTTNG_CONSUMER32_UST
,
111 .err_unix_sock_path
= DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
,
112 .cmd_unix_sock_path
= DEFAULT_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
= -1;
126 static int apps_sock
= -1;
127 static int kernel_tracer_fd
= -1;
128 static int kernel_poll_pipe
[2] = { -1, -1 };
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] = { -1, -1 };
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] = { -1, -1 };
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_CONSUMERD32_LIBDIR");
220 consumerd32_libdir
= libdir
;
222 libdir
= getenv("LTTNG_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 * Return group ID of the tracing group or -1 if not found.
275 static gid_t
allowed_group(void)
279 if (opt_tracing_group
) {
280 grp
= getgrnam(opt_tracing_group
);
282 grp
= getgrnam(default_tracing_group
);
292 * Init thread quit pipe.
294 * Return -1 on error or 0 if all pipes are created.
296 static int init_thread_quit_pipe(void)
300 ret
= pipe(thread_quit_pipe
);
302 PERROR("thread quit pipe");
306 for (i
= 0; i
< 2; i
++) {
307 ret
= fcntl(thread_quit_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
319 * Complete teardown of a kernel session. This free all data structure related
320 * to a kernel session and update counter.
322 static void teardown_kernel_session(struct ltt_session
*session
)
324 if (!session
->kernel_session
) {
325 DBG3("No kernel session when tearing down session");
329 DBG("Tearing down kernel session");
332 * If a custom kernel consumer was registered, close the socket before
333 * tearing down the complete kernel session structure
335 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
336 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
339 trace_kernel_destroy_session(session
->kernel_session
);
343 * Complete teardown of all UST sessions. This will free everything on his path
344 * and destroy the core essence of all ust sessions :)
346 static void teardown_ust_session(struct ltt_session
*session
)
350 if (!session
->ust_session
) {
351 DBG3("No UST session when tearing down session");
355 DBG("Tearing down UST session(s)");
357 ret
= ust_app_destroy_trace_all(session
->ust_session
);
359 ERR("Error in ust_app_destroy_trace_all");
362 trace_ust_destroy_session(session
->ust_session
);
366 * Stop all threads by closing the thread quit pipe.
368 static void stop_threads(void)
372 /* Stopping all threads */
373 DBG("Terminating all threads");
374 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
376 ERR("write error on thread quit pipe");
379 /* Dispatch thread */
380 dispatch_thread_exit
= 1;
381 futex_nto1_wake(&ust_cmd_queue
.futex
);
387 static void cleanup(void)
391 struct ltt_session
*sess
, *stmp
;
395 DBG("Removing %s directory", rundir
);
396 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
398 ERR("asprintf failed. Something is really wrong!");
401 /* Remove lttng run directory */
404 ERR("Unable to clean %s", rundir
);
408 DBG("Cleaning up all sessions");
410 /* Destroy session list mutex */
411 if (session_list_ptr
!= NULL
) {
412 pthread_mutex_destroy(&session_list_ptr
->lock
);
414 /* Cleanup ALL session */
415 cds_list_for_each_entry_safe(sess
, stmp
,
416 &session_list_ptr
->head
, list
) {
417 teardown_kernel_session(sess
);
418 teardown_ust_session(sess
);
423 DBG("Closing all UST sockets");
424 ust_app_clean_list();
426 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
428 if (is_root
&& !opt_no_kernel
) {
429 DBG2("Closing kernel fd");
430 if (kernel_tracer_fd
>= 0) {
431 ret
= close(kernel_tracer_fd
);
436 DBG("Unloading kernel modules");
437 modprobe_remove_lttng_all();
441 * Closing all pipes used for communication between threads.
443 for (i
= 0; i
< 2; i
++) {
444 if (kernel_poll_pipe
[i
] >= 0) {
445 ret
= close(kernel_poll_pipe
[i
]);
452 for (i
= 0; i
< 2; i
++) {
453 if (thread_quit_pipe
[i
] >= 0) {
454 ret
= close(thread_quit_pipe
[i
]);
460 for (i
= 0; i
< 2; i
++) {
461 if (apps_cmd_pipe
[i
] >= 0) {
462 ret
= close(apps_cmd_pipe
[i
]);
470 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
471 "Matthew, BEET driven development works!%c[%dm",
472 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
477 * Send data on a unix socket using the liblttsessiondcomm API.
479 * Return lttcomm error code.
481 static int send_unix_sock(int sock
, void *buf
, size_t len
)
483 /* Check valid length */
488 return lttcomm_send_unix_sock(sock
, buf
, len
);
492 * Free memory of a command context structure.
494 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
496 DBG("Clean command context structure");
498 if ((*cmd_ctx
)->llm
) {
499 free((*cmd_ctx
)->llm
);
501 if ((*cmd_ctx
)->lsm
) {
502 free((*cmd_ctx
)->lsm
);
510 * Send all stream fds of kernel channel to the consumer.
512 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
513 int sock
, struct ltt_kernel_channel
*channel
,
514 uid_t uid
, gid_t gid
)
517 struct ltt_kernel_stream
*stream
;
518 struct lttcomm_consumer_msg lkm
;
520 DBG("Sending streams of channel %s to kernel consumer",
521 channel
->channel
->name
);
524 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
525 lkm
.u
.channel
.channel_key
= channel
->fd
;
526 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
527 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
528 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
529 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
531 PERROR("send consumer channel");
536 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
540 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
541 lkm
.u
.stream
.channel_key
= channel
->fd
;
542 lkm
.u
.stream
.stream_key
= stream
->fd
;
543 lkm
.u
.stream
.state
= stream
->state
;
544 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
545 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
546 lkm
.u
.stream
.uid
= uid
;
547 lkm
.u
.stream
.gid
= gid
;
548 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
549 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
550 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
551 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
553 PERROR("send consumer stream");
556 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
558 PERROR("send consumer stream ancillary data");
563 DBG("consumer channel streams sent");
572 * Send all stream fds of the kernel session to the consumer.
574 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
575 struct ltt_kernel_session
*session
)
578 struct ltt_kernel_channel
*chan
;
579 struct lttcomm_consumer_msg lkm
;
580 int sock
= session
->consumer_fd
;
582 DBG("Sending metadata stream fd");
584 /* Extra protection. It's NOT supposed to be set to 0 at this point */
585 if (session
->consumer_fd
== 0) {
586 session
->consumer_fd
= consumer_data
->cmd_sock
;
589 if (session
->metadata_stream_fd
!= 0) {
590 /* Send metadata channel fd */
591 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
592 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
593 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
594 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
595 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
596 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
598 PERROR("send consumer channel");
602 /* Send metadata stream fd */
603 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
604 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
605 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
606 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
607 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
608 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
609 lkm
.u
.stream
.uid
= session
->uid
;
610 lkm
.u
.stream
.gid
= session
->gid
;
611 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
612 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
613 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
614 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
616 PERROR("send consumer stream");
619 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
621 PERROR("send consumer stream");
626 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
627 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
628 session
->uid
, session
->gid
);
634 DBG("consumer fds (metadata and channel streams) sent");
643 * Notify UST applications using the shm mmap futex.
645 static int notify_ust_apps(int active
)
649 DBG("Notifying applications of session daemon state: %d", active
);
651 /* See shm.c for this call implying mmap, shm and futex calls */
652 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
653 if (wait_shm_mmap
== NULL
) {
657 /* Wake waiting process */
658 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
660 /* Apps notified successfully */
668 * Setup the outgoing data buffer for the response (llm) by allocating the
669 * right amount of memory and copying the original information from the lsm
672 * Return total size of the buffer pointed by buf.
674 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
680 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
681 if (cmd_ctx
->llm
== NULL
) {
687 /* Copy common data */
688 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
689 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
691 cmd_ctx
->llm
->data_size
= size
;
692 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
701 * Update the kernel poll set of all channel fd available over all tracing
702 * session. Add the wakeup pipe at the end of the set.
704 static int update_kernel_poll(struct lttng_poll_event
*events
)
707 struct ltt_session
*session
;
708 struct ltt_kernel_channel
*channel
;
710 DBG("Updating kernel poll set");
713 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
714 session_lock(session
);
715 if (session
->kernel_session
== NULL
) {
716 session_unlock(session
);
720 cds_list_for_each_entry(channel
,
721 &session
->kernel_session
->channel_list
.head
, list
) {
722 /* Add channel fd to the kernel poll set */
723 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
725 session_unlock(session
);
728 DBG("Channel fd %d added to kernel set", channel
->fd
);
730 session_unlock(session
);
732 session_unlock_list();
737 session_unlock_list();
742 * Find the channel fd from 'fd' over all tracing session. When found, check
743 * for new channel stream and send those stream fds to the kernel consumer.
745 * Useful for CPU hotplug feature.
747 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
750 struct ltt_session
*session
;
751 struct ltt_kernel_channel
*channel
;
753 DBG("Updating kernel streams for channel fd %d", fd
);
756 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
757 session_lock(session
);
758 if (session
->kernel_session
== NULL
) {
759 session_unlock(session
);
763 /* This is not suppose to be 0 but this is an extra security check */
764 if (session
->kernel_session
->consumer_fd
== 0) {
765 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
768 cds_list_for_each_entry(channel
,
769 &session
->kernel_session
->channel_list
.head
, list
) {
770 if (channel
->fd
== fd
) {
771 DBG("Channel found, updating kernel streams");
772 ret
= kernel_open_channel_stream(channel
);
778 * Have we already sent fds to the consumer? If yes, it means
779 * that tracing is started so it is safe to send our updated
782 if (session
->kernel_session
->consumer_fds_sent
== 1) {
783 ret
= send_kconsumer_channel_streams(consumer_data
,
784 session
->kernel_session
->consumer_fd
, channel
,
785 session
->uid
, session
->gid
);
793 session_unlock(session
);
795 session_unlock_list();
799 session_unlock(session
);
800 session_unlock_list();
805 * For each tracing session, update newly registered apps.
807 static void update_ust_app(int app_sock
)
809 struct ltt_session
*sess
, *stmp
;
813 /* For all tracing session(s) */
814 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
816 if (sess
->ust_session
) {
817 ust_app_global_update(sess
->ust_session
, app_sock
);
819 session_unlock(sess
);
822 session_unlock_list();
826 * This thread manage event coming from the kernel.
828 * Features supported in this thread:
831 static void *thread_manage_kernel(void *data
)
833 int ret
, i
, pollfd
, update_poll_flag
= 1;
834 uint32_t revents
, nb_fd
;
836 struct lttng_poll_event events
;
838 DBG("Thread manage kernel started");
840 ret
= create_thread_poll_set(&events
, 2);
842 goto error_poll_create
;
845 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
851 if (update_poll_flag
== 1) {
853 * Reset number of fd in the poll set. Always 2 since there is the thread
854 * quit pipe and the kernel pipe.
858 ret
= update_kernel_poll(&events
);
862 update_poll_flag
= 0;
865 nb_fd
= LTTNG_POLL_GETNB(&events
);
867 DBG("Thread kernel polling on %d fds", nb_fd
);
869 /* Zeroed the poll events */
870 lttng_poll_reset(&events
);
872 /* Poll infinite value of time */
874 ret
= lttng_poll_wait(&events
, -1);
877 * Restart interrupted system call.
879 if (errno
== EINTR
) {
883 } else if (ret
== 0) {
884 /* Should not happen since timeout is infinite */
885 ERR("Return value of poll is 0 with an infinite timeout.\n"
886 "This should not have happened! Continuing...");
890 for (i
= 0; i
< nb_fd
; i
++) {
891 /* Fetch once the poll data */
892 revents
= LTTNG_POLL_GETEV(&events
, i
);
893 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
895 /* Thread quit pipe has been closed. Killing thread. */
896 ret
= check_thread_quit_pipe(pollfd
, revents
);
901 /* Check for data on kernel pipe */
902 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
903 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
904 update_poll_flag
= 1;
908 * New CPU detected by the kernel. Adding kernel stream to
909 * kernel session and updating the kernel consumer
911 if (revents
& LPOLLIN
) {
912 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
918 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
919 * and unregister kernel stream at this point.
927 lttng_poll_clean(&events
);
929 DBG("Kernel thread dying");
934 * This thread manage the consumer error sent back to the session daemon.
936 static void *thread_manage_consumer(void *data
)
938 int sock
= -1, i
, ret
, pollfd
;
939 uint32_t revents
, nb_fd
;
940 enum lttcomm_return_code code
;
941 struct lttng_poll_event events
;
942 struct consumer_data
*consumer_data
= data
;
944 DBG("[thread] Manage consumer started");
946 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
952 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
953 * Nothing more will be added to this poll set.
955 ret
= create_thread_poll_set(&events
, 2);
960 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
965 nb_fd
= LTTNG_POLL_GETNB(&events
);
967 /* Inifinite blocking call, waiting for transmission */
969 ret
= lttng_poll_wait(&events
, -1);
972 * Restart interrupted system call.
974 if (errno
== EINTR
) {
980 for (i
= 0; i
< nb_fd
; i
++) {
981 /* Fetch once the poll data */
982 revents
= LTTNG_POLL_GETEV(&events
, i
);
983 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
985 /* Thread quit pipe has been closed. Killing thread. */
986 ret
= check_thread_quit_pipe(pollfd
, revents
);
991 /* Event on the registration socket */
992 if (pollfd
== consumer_data
->err_sock
) {
993 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
994 ERR("consumer err socket poll error");
1000 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
1005 DBG2("Receiving code from consumer err_sock");
1007 /* Getting status code from kconsumerd */
1008 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1009 sizeof(enum lttcomm_return_code
));
1014 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1015 consumer_data
->cmd_sock
=
1016 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1017 if (consumer_data
->cmd_sock
< 0) {
1018 sem_post(&consumer_data
->sem
);
1019 PERROR("consumer connect");
1022 /* Signal condition to tell that the kconsumerd is ready */
1023 sem_post(&consumer_data
->sem
);
1024 DBG("consumer command socket ready");
1026 ERR("consumer error when waiting for SOCK_READY : %s",
1027 lttcomm_get_readable_code(-code
));
1031 /* Remove the kconsumerd error sock since we've established a connexion */
1032 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1037 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1042 /* Update number of fd */
1043 nb_fd
= LTTNG_POLL_GETNB(&events
);
1045 /* Inifinite blocking call, waiting for transmission */
1047 ret
= lttng_poll_wait(&events
, -1);
1050 * Restart interrupted system call.
1052 if (errno
== EINTR
) {
1058 for (i
= 0; i
< nb_fd
; i
++) {
1059 /* Fetch once the poll data */
1060 revents
= LTTNG_POLL_GETEV(&events
, i
);
1061 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1063 /* Thread quit pipe has been closed. Killing thread. */
1064 ret
= check_thread_quit_pipe(pollfd
, revents
);
1069 /* Event on the kconsumerd socket */
1070 if (pollfd
== sock
) {
1071 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1072 ERR("consumer err socket second poll error");
1078 /* Wait for any kconsumerd error */
1079 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1080 sizeof(enum lttcomm_return_code
));
1082 ERR("consumer closed the command socket");
1086 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1089 if (consumer_data
->err_sock
>= 0) {
1090 ret
= close(consumer_data
->err_sock
);
1095 if (consumer_data
->cmd_sock
>= 0) {
1096 ret
= close(consumer_data
->cmd_sock
);
1108 unlink(consumer_data
->err_unix_sock_path
);
1109 unlink(consumer_data
->cmd_unix_sock_path
);
1110 consumer_data
->pid
= 0;
1112 lttng_poll_clean(&events
);
1115 DBG("consumer thread cleanup completed");
1121 * This thread manage application communication.
1123 static void *thread_manage_apps(void *data
)
1126 uint32_t revents
, nb_fd
;
1127 struct ust_command ust_cmd
;
1128 struct lttng_poll_event events
;
1130 DBG("[thread] Manage application started");
1132 rcu_register_thread();
1133 rcu_thread_online();
1135 ret
= create_thread_poll_set(&events
, 2);
1137 goto error_poll_create
;
1140 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1146 /* Zeroed the events structure */
1147 lttng_poll_reset(&events
);
1149 nb_fd
= LTTNG_POLL_GETNB(&events
);
1151 DBG("Apps thread polling on %d fds", nb_fd
);
1153 /* Inifinite blocking call, waiting for transmission */
1155 ret
= lttng_poll_wait(&events
, -1);
1158 * Restart interrupted system call.
1160 if (errno
== EINTR
) {
1166 for (i
= 0; i
< nb_fd
; i
++) {
1167 /* Fetch once the poll data */
1168 revents
= LTTNG_POLL_GETEV(&events
, i
);
1169 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1171 /* Thread quit pipe has been closed. Killing thread. */
1172 ret
= check_thread_quit_pipe(pollfd
, revents
);
1177 /* Inspect the apps cmd pipe */
1178 if (pollfd
== apps_cmd_pipe
[0]) {
1179 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1180 ERR("Apps command pipe error");
1182 } else if (revents
& LPOLLIN
) {
1184 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1185 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1186 PERROR("read apps cmd pipe");
1190 /* Register applicaton to the session daemon */
1191 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1193 if (ret
== -ENOMEM
) {
1195 } else if (ret
< 0) {
1200 * Validate UST version compatibility.
1202 ret
= ust_app_validate_version(ust_cmd
.sock
);
1205 * Add channel(s) and event(s) to newly registered apps
1206 * from lttng global UST domain.
1208 update_ust_app(ust_cmd
.sock
);
1211 ret
= ust_app_register_done(ust_cmd
.sock
);
1214 * If the registration is not possible, we simply
1215 * unregister the apps and continue
1217 ust_app_unregister(ust_cmd
.sock
);
1220 * We just need here to monitor the close of the UST
1221 * socket and poll set monitor those by default.
1222 * Listen on POLLIN (even if we never expect any
1223 * data) to ensure that hangup wakes us.
1225 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1230 DBG("Apps with sock %d added to poll set",
1238 * At this point, we know that a registered application made
1239 * the event at poll_wait.
1241 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1242 /* Removing from the poll set */
1243 ret
= lttng_poll_del(&events
, pollfd
);
1248 /* Socket closed on remote end. */
1249 ust_app_unregister(pollfd
);
1257 lttng_poll_clean(&events
);
1259 DBG("Application communication apps thread cleanup complete");
1260 rcu_thread_offline();
1261 rcu_unregister_thread();
1266 * Dispatch request from the registration threads to the application
1267 * communication thread.
1269 static void *thread_dispatch_ust_registration(void *data
)
1272 struct cds_wfq_node
*node
;
1273 struct ust_command
*ust_cmd
= NULL
;
1275 DBG("[thread] Dispatch UST command started");
1277 while (!dispatch_thread_exit
) {
1278 /* Atomically prepare the queue futex */
1279 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1282 /* Dequeue command for registration */
1283 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1285 DBG("Woken up but nothing in the UST command queue");
1286 /* Continue thread execution */
1290 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1292 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1293 " gid:%d sock:%d name:%s (version %d.%d)",
1294 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1295 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1296 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1297 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1299 * Inform apps thread of the new application registration. This
1300 * call is blocking so we can be assured that the data will be read
1301 * at some point in time or wait to the end of the world :)
1303 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1304 sizeof(struct ust_command
));
1306 PERROR("write apps cmd pipe");
1307 if (errno
== EBADF
) {
1309 * We can't inform the application thread to process
1310 * registration. We will exit or else application
1311 * registration will not occur and tracing will never
1318 } while (node
!= NULL
);
1320 /* Futex wait on queue. Blocking call on futex() */
1321 futex_nto1_wait(&ust_cmd_queue
.futex
);
1325 DBG("Dispatch thread dying");
1330 * This thread manage application registration.
1332 static void *thread_registration_apps(void *data
)
1334 int sock
= -1, i
, ret
, pollfd
;
1335 uint32_t revents
, nb_fd
;
1336 struct lttng_poll_event events
;
1338 * Get allocated in this thread, enqueued to a global queue, dequeued and
1339 * freed in the manage apps thread.
1341 struct ust_command
*ust_cmd
= NULL
;
1343 DBG("[thread] Manage application registration started");
1345 ret
= lttcomm_listen_unix_sock(apps_sock
);
1351 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1352 * more will be added to this poll set.
1354 ret
= create_thread_poll_set(&events
, 2);
1356 goto error_create_poll
;
1359 /* Add the application registration socket */
1360 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1362 goto error_poll_add
;
1365 /* Notify all applications to register */
1366 ret
= notify_ust_apps(1);
1368 ERR("Failed to notify applications or create the wait shared memory.\n"
1369 "Execution continues but there might be problem for already\n"
1370 "running applications that wishes to register.");
1374 DBG("Accepting application registration");
1376 nb_fd
= LTTNG_POLL_GETNB(&events
);
1378 /* Inifinite blocking call, waiting for transmission */
1380 ret
= lttng_poll_wait(&events
, -1);
1383 * Restart interrupted system call.
1385 if (errno
== EINTR
) {
1391 for (i
= 0; i
< nb_fd
; i
++) {
1392 /* Fetch once the poll data */
1393 revents
= LTTNG_POLL_GETEV(&events
, i
);
1394 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1396 /* Thread quit pipe has been closed. Killing thread. */
1397 ret
= check_thread_quit_pipe(pollfd
, revents
);
1402 /* Event on the registration socket */
1403 if (pollfd
== apps_sock
) {
1404 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1405 ERR("Register apps socket poll error");
1407 } else if (revents
& LPOLLIN
) {
1408 sock
= lttcomm_accept_unix_sock(apps_sock
);
1413 /* Create UST registration command for enqueuing */
1414 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1415 if (ust_cmd
== NULL
) {
1416 PERROR("ust command zmalloc");
1421 * Using message-based transmissions to ensure we don't
1422 * have to deal with partially received messages.
1424 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1425 sizeof(struct ust_register_msg
));
1426 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1428 PERROR("lttcomm_recv_unix_sock register apps");
1430 ERR("Wrong size received on apps register");
1441 ust_cmd
->sock
= sock
;
1443 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1444 " gid:%d sock:%d name:%s (version %d.%d)",
1445 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1446 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1447 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1448 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1451 * Lock free enqueue the registration request. The red pill
1452 * has been taken! This apps will be part of the *system*.
1454 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1457 * Wake the registration queue futex. Implicit memory
1458 * barrier with the exchange in cds_wfq_enqueue.
1460 futex_nto1_wake(&ust_cmd_queue
.futex
);
1467 /* Notify that the registration thread is gone */
1470 if (apps_sock
>= 0) {
1471 ret
= close(apps_sock
);
1482 unlink(apps_unix_sock_path
);
1485 lttng_poll_clean(&events
);
1488 DBG("UST Registration thread cleanup complete");
1494 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1495 * exec or it will fails.
1497 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1500 struct timespec timeout
;
1502 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1503 timeout
.tv_nsec
= 0;
1505 /* Setup semaphore */
1506 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1508 PERROR("sem_init consumer semaphore");
1512 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1513 thread_manage_consumer
, consumer_data
);
1515 PERROR("pthread_create consumer");
1520 /* Get time for sem_timedwait absolute timeout */
1521 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1523 PERROR("clock_gettime spawn consumer");
1524 /* Infinite wait for the kconsumerd thread to be ready */
1525 ret
= sem_wait(&consumer_data
->sem
);
1527 /* Normal timeout if the gettime was successful */
1528 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1529 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1533 if (errno
== ETIMEDOUT
) {
1535 * Call has timed out so we kill the kconsumerd_thread and return
1538 ERR("The consumer thread was never ready. Killing it");
1539 ret
= pthread_cancel(consumer_data
->thread
);
1541 PERROR("pthread_cancel consumer thread");
1544 PERROR("semaphore wait failed consumer thread");
1549 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1550 if (consumer_data
->pid
== 0) {
1551 ERR("Kconsumerd did not start");
1552 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1555 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1564 * Join consumer thread
1566 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1571 if (consumer_data
->pid
!= 0) {
1572 ret
= kill(consumer_data
->pid
, SIGTERM
);
1574 ERR("Error killing consumer daemon");
1577 return pthread_join(consumer_data
->thread
, &status
);
1584 * Fork and exec a consumer daemon (consumerd).
1586 * Return pid if successful else -1.
1588 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1592 const char *consumer_to_use
;
1593 const char *verbosity
;
1596 DBG("Spawning consumerd");
1603 if (opt_verbose_consumer
) {
1604 verbosity
= "--verbose";
1606 verbosity
= "--quiet";
1608 switch (consumer_data
->type
) {
1609 case LTTNG_CONSUMER_KERNEL
:
1611 * Find out which consumerd to execute. We will first try the
1612 * 64-bit path, then the sessiond's installation directory, and
1613 * fallback on the 32-bit one,
1615 DBG3("Looking for a kernel consumer at these locations:");
1616 DBG3(" 1) %s", consumerd64_bin
);
1617 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1618 DBG3(" 3) %s", consumerd32_bin
);
1619 if (stat(consumerd64_bin
, &st
) == 0) {
1620 DBG3("Found location #1");
1621 consumer_to_use
= consumerd64_bin
;
1622 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1623 DBG3("Found location #2");
1624 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1625 } else if (stat(consumerd32_bin
, &st
) == 0) {
1626 DBG3("Found location #3");
1627 consumer_to_use
= consumerd32_bin
;
1629 DBG("Could not find any valid consumerd executable");
1632 DBG("Using kernel consumer at: %s", consumer_to_use
);
1633 execl(consumer_to_use
,
1634 "lttng-consumerd", verbosity
, "-k",
1635 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1636 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1639 case LTTNG_CONSUMER64_UST
:
1641 char *tmpnew
= NULL
;
1643 if (consumerd64_libdir
[0] != '\0') {
1647 tmp
= getenv("LD_LIBRARY_PATH");
1651 tmplen
= strlen("LD_LIBRARY_PATH=")
1652 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1653 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1658 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1659 strcat(tmpnew
, consumerd64_libdir
);
1660 if (tmp
[0] != '\0') {
1661 strcat(tmpnew
, ":");
1662 strcat(tmpnew
, tmp
);
1664 ret
= putenv(tmpnew
);
1670 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1671 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1672 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1673 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1675 if (consumerd64_libdir
[0] != '\0') {
1683 case LTTNG_CONSUMER32_UST
:
1685 char *tmpnew
= NULL
;
1687 if (consumerd32_libdir
[0] != '\0') {
1691 tmp
= getenv("LD_LIBRARY_PATH");
1695 tmplen
= strlen("LD_LIBRARY_PATH=")
1696 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1697 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1702 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1703 strcat(tmpnew
, consumerd32_libdir
);
1704 if (tmp
[0] != '\0') {
1705 strcat(tmpnew
, ":");
1706 strcat(tmpnew
, tmp
);
1708 ret
= putenv(tmpnew
);
1714 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1715 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1716 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1717 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1719 if (consumerd32_libdir
[0] != '\0') {
1728 PERROR("unknown consumer type");
1732 PERROR("kernel start consumer exec");
1735 } else if (pid
> 0) {
1738 PERROR("start consumer fork");
1746 * Spawn the consumerd daemon and session daemon thread.
1748 static int start_consumerd(struct consumer_data
*consumer_data
)
1752 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1753 if (consumer_data
->pid
!= 0) {
1754 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1758 ret
= spawn_consumerd(consumer_data
);
1760 ERR("Spawning consumerd failed");
1761 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1765 /* Setting up the consumer_data pid */
1766 consumer_data
->pid
= ret
;
1767 DBG2("Consumer pid %d", consumer_data
->pid
);
1768 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1770 DBG2("Spawning consumer control thread");
1771 ret
= spawn_consumer_thread(consumer_data
);
1773 ERR("Fatal error spawning consumer control thread");
1785 * Check version of the lttng-modules.
1787 static int validate_lttng_modules_version(void)
1789 return kernel_validate_version(kernel_tracer_fd
);
1793 * Setup necessary data for kernel tracer action.
1795 static int init_kernel_tracer(void)
1799 /* Modprobe lttng kernel modules */
1800 ret
= modprobe_lttng_control();
1805 /* Open debugfs lttng */
1806 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1807 if (kernel_tracer_fd
< 0) {
1808 DBG("Failed to open %s", module_proc_lttng
);
1813 /* Validate kernel version */
1814 ret
= validate_lttng_modules_version();
1819 ret
= modprobe_lttng_data();
1824 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1828 modprobe_remove_lttng_control();
1829 ret
= close(kernel_tracer_fd
);
1833 kernel_tracer_fd
= -1;
1834 return LTTCOMM_KERN_VERSION
;
1837 ret
= close(kernel_tracer_fd
);
1843 modprobe_remove_lttng_control();
1846 WARN("No kernel tracer available");
1847 kernel_tracer_fd
= -1;
1848 return LTTCOMM_KERN_NA
;
1852 * Init tracing by creating trace directory and sending fds kernel consumer.
1854 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1858 if (session
->consumer_fds_sent
== 0) {
1860 * Assign default kernel consumer socket if no consumer assigned to the
1861 * kernel session. At this point, it's NOT suppose to be 0 but this is
1862 * an extra security check.
1864 if (session
->consumer_fd
== 0) {
1865 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1868 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1870 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1874 session
->consumer_fds_sent
= 1;
1882 * Create an UST session and add it to the session ust list.
1884 static int create_ust_session(struct ltt_session
*session
,
1885 struct lttng_domain
*domain
)
1887 struct ltt_ust_session
*lus
= NULL
;
1890 switch (domain
->type
) {
1891 case LTTNG_DOMAIN_UST
:
1894 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1898 DBG("Creating UST session");
1900 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1902 ret
= LTTCOMM_UST_SESS_FAIL
;
1906 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1907 session
->uid
, session
->gid
);
1909 if (ret
!= -EEXIST
) {
1910 ERR("Trace directory creation error");
1911 ret
= LTTCOMM_UST_SESS_FAIL
;
1916 /* The domain type dictate different actions on session creation */
1917 switch (domain
->type
) {
1918 case LTTNG_DOMAIN_UST
:
1919 /* No ustctl for the global UST domain */
1922 ERR("Unknown UST domain on create session %d", domain
->type
);
1925 lus
->uid
= session
->uid
;
1926 lus
->gid
= session
->gid
;
1927 session
->ust_session
= lus
;
1937 * Create a kernel tracer session then create the default channel.
1939 static int create_kernel_session(struct ltt_session
*session
)
1943 DBG("Creating kernel session");
1945 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1947 ret
= LTTCOMM_KERN_SESS_FAIL
;
1951 /* Set kernel consumer socket fd */
1952 if (kconsumer_data
.cmd_sock
) {
1953 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1956 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1957 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1959 if (ret
!= -EEXIST
) {
1960 ERR("Trace directory creation error");
1964 session
->kernel_session
->uid
= session
->uid
;
1965 session
->kernel_session
->gid
= session
->gid
;
1972 * Check if the UID or GID match the session. Root user has access to all
1975 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1977 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1984 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1987 struct ltt_session
*session
;
1989 DBG("Counting number of available session for UID %d GID %d",
1991 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1993 * Only list the sessions the user can control.
1995 if (!session_access_ok(session
, uid
, gid
)) {
2004 * Using the session list, filled a lttng_session array to send back to the
2005 * client for session listing.
2007 * The session list lock MUST be acquired before calling this function. Use
2008 * session_lock_list() and session_unlock_list().
2010 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2014 struct ltt_session
*session
;
2016 DBG("Getting all available session for UID %d GID %d",
2019 * Iterate over session list and append data after the control struct in
2022 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2024 * Only list the sessions the user can control.
2026 if (!session_access_ok(session
, uid
, gid
)) {
2029 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2030 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2031 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2032 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2033 sessions
[i
].enabled
= session
->enabled
;
2039 * Fill lttng_channel array of all channels.
2041 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2042 struct lttng_channel
*channels
)
2045 struct ltt_kernel_channel
*kchan
;
2047 DBG("Listing channels for session %s", session
->name
);
2050 case LTTNG_DOMAIN_KERNEL
:
2051 /* Kernel channels */
2052 if (session
->kernel_session
!= NULL
) {
2053 cds_list_for_each_entry(kchan
,
2054 &session
->kernel_session
->channel_list
.head
, list
) {
2055 /* Copy lttng_channel struct to array */
2056 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2057 channels
[i
].enabled
= kchan
->enabled
;
2062 case LTTNG_DOMAIN_UST
:
2064 struct lttng_ht_iter iter
;
2065 struct ltt_ust_channel
*uchan
;
2067 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2068 &iter
.iter
, uchan
, node
.node
) {
2069 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2070 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2071 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2072 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2073 channels
[i
].attr
.switch_timer_interval
=
2074 uchan
->attr
.switch_timer_interval
;
2075 channels
[i
].attr
.read_timer_interval
=
2076 uchan
->attr
.read_timer_interval
;
2077 channels
[i
].enabled
= uchan
->enabled
;
2078 switch (uchan
->attr
.output
) {
2079 case LTTNG_UST_MMAP
:
2081 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2094 * Create a list of ust global domain events.
2096 static int list_lttng_ust_global_events(char *channel_name
,
2097 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2100 unsigned int nb_event
= 0;
2101 struct lttng_ht_iter iter
;
2102 struct lttng_ht_node_str
*node
;
2103 struct ltt_ust_channel
*uchan
;
2104 struct ltt_ust_event
*uevent
;
2105 struct lttng_event
*tmp
;
2107 DBG("Listing UST global events for channel %s", channel_name
);
2111 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2112 node
= lttng_ht_iter_get_node_str(&iter
);
2114 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2118 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2120 nb_event
+= lttng_ht_get_count(uchan
->events
);
2122 if (nb_event
== 0) {
2127 DBG3("Listing UST global %d events", nb_event
);
2129 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2131 ret
= -LTTCOMM_FATAL
;
2135 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2136 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2137 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2138 tmp
[i
].enabled
= uevent
->enabled
;
2139 switch (uevent
->attr
.instrumentation
) {
2140 case LTTNG_UST_TRACEPOINT
:
2141 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2143 case LTTNG_UST_PROBE
:
2144 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2146 case LTTNG_UST_FUNCTION
:
2147 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2150 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2151 switch (uevent
->attr
.loglevel_type
) {
2152 case LTTNG_UST_LOGLEVEL_ALL
:
2153 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2155 case LTTNG_UST_LOGLEVEL_RANGE
:
2156 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2158 case LTTNG_UST_LOGLEVEL_SINGLE
:
2159 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2174 * Fill lttng_event array of all kernel events in the channel.
2176 static int list_lttng_kernel_events(char *channel_name
,
2177 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2180 unsigned int nb_event
;
2181 struct ltt_kernel_event
*event
;
2182 struct ltt_kernel_channel
*kchan
;
2184 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2185 if (kchan
== NULL
) {
2186 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2190 nb_event
= kchan
->event_count
;
2192 DBG("Listing events for channel %s", kchan
->channel
->name
);
2194 if (nb_event
== 0) {
2199 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2200 if (*events
== NULL
) {
2201 ret
= LTTCOMM_FATAL
;
2205 /* Kernel channels */
2206 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2207 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2208 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2209 (*events
)[i
].enabled
= event
->enabled
;
2210 switch (event
->event
->instrumentation
) {
2211 case LTTNG_KERNEL_TRACEPOINT
:
2212 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2214 case LTTNG_KERNEL_KPROBE
:
2215 case LTTNG_KERNEL_KRETPROBE
:
2216 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2217 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2218 sizeof(struct lttng_kernel_kprobe
));
2220 case LTTNG_KERNEL_FUNCTION
:
2221 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2222 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2223 sizeof(struct lttng_kernel_function
));
2225 case LTTNG_KERNEL_NOOP
:
2226 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2228 case LTTNG_KERNEL_SYSCALL
:
2229 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2231 case LTTNG_KERNEL_ALL
:
2245 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2247 static int cmd_disable_channel(struct ltt_session
*session
,
2248 int domain
, char *channel_name
)
2251 struct ltt_ust_session
*usess
;
2253 usess
= session
->ust_session
;
2256 case LTTNG_DOMAIN_KERNEL
:
2258 ret
= channel_kernel_disable(session
->kernel_session
,
2260 if (ret
!= LTTCOMM_OK
) {
2264 kernel_wait_quiescent(kernel_tracer_fd
);
2267 case LTTNG_DOMAIN_UST
:
2269 struct ltt_ust_channel
*uchan
;
2270 struct lttng_ht
*chan_ht
;
2272 chan_ht
= usess
->domain_global
.channels
;
2274 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2275 if (uchan
== NULL
) {
2276 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2280 ret
= channel_ust_disable(usess
, domain
, uchan
);
2281 if (ret
!= LTTCOMM_OK
) {
2287 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2288 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2289 case LTTNG_DOMAIN_UST_PID
:
2292 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2303 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2305 static int cmd_enable_channel(struct ltt_session
*session
,
2306 int domain
, struct lttng_channel
*attr
)
2309 struct ltt_ust_session
*usess
= session
->ust_session
;
2310 struct lttng_ht
*chan_ht
;
2312 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2315 case LTTNG_DOMAIN_KERNEL
:
2317 struct ltt_kernel_channel
*kchan
;
2319 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2320 session
->kernel_session
);
2321 if (kchan
== NULL
) {
2322 ret
= channel_kernel_create(session
->kernel_session
,
2323 attr
, kernel_poll_pipe
[1]);
2325 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2328 if (ret
!= LTTCOMM_OK
) {
2332 kernel_wait_quiescent(kernel_tracer_fd
);
2335 case LTTNG_DOMAIN_UST
:
2337 struct ltt_ust_channel
*uchan
;
2339 chan_ht
= usess
->domain_global
.channels
;
2341 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2342 if (uchan
== NULL
) {
2343 ret
= channel_ust_create(usess
, domain
, attr
);
2345 ret
= channel_ust_enable(usess
, domain
, uchan
);
2350 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2351 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2352 case LTTNG_DOMAIN_UST_PID
:
2355 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2364 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2366 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2367 char *channel_name
, char *event_name
)
2372 case LTTNG_DOMAIN_KERNEL
:
2374 struct ltt_kernel_channel
*kchan
;
2375 struct ltt_kernel_session
*ksess
;
2377 ksess
= session
->kernel_session
;
2379 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2380 if (kchan
== NULL
) {
2381 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2385 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2386 if (ret
!= LTTCOMM_OK
) {
2390 kernel_wait_quiescent(kernel_tracer_fd
);
2393 case LTTNG_DOMAIN_UST
:
2395 struct ltt_ust_channel
*uchan
;
2396 struct ltt_ust_session
*usess
;
2398 usess
= session
->ust_session
;
2400 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2402 if (uchan
== NULL
) {
2403 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2407 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2408 if (ret
!= LTTCOMM_OK
) {
2412 DBG3("Disable UST event %s in channel %s completed", event_name
,
2417 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2418 case LTTNG_DOMAIN_UST_PID
:
2419 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2433 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2435 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2441 case LTTNG_DOMAIN_KERNEL
:
2443 struct ltt_kernel_session
*ksess
;
2444 struct ltt_kernel_channel
*kchan
;
2446 ksess
= session
->kernel_session
;
2448 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2449 if (kchan
== NULL
) {
2450 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2454 ret
= event_kernel_disable_all(ksess
, kchan
);
2455 if (ret
!= LTTCOMM_OK
) {
2459 kernel_wait_quiescent(kernel_tracer_fd
);
2462 case LTTNG_DOMAIN_UST
:
2464 struct ltt_ust_session
*usess
;
2465 struct ltt_ust_channel
*uchan
;
2467 usess
= session
->ust_session
;
2469 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2471 if (uchan
== NULL
) {
2472 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2476 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2481 DBG3("Disable all UST events in channel %s completed", channel_name
);
2486 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2487 case LTTNG_DOMAIN_UST_PID
:
2488 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2502 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2504 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2505 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2510 case LTTNG_DOMAIN_KERNEL
:
2511 /* Add kernel context to kernel tracer */
2512 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2513 event_name
, channel_name
);
2514 if (ret
!= LTTCOMM_OK
) {
2518 case LTTNG_DOMAIN_UST
:
2520 struct ltt_ust_session
*usess
= session
->ust_session
;
2522 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2523 if (ret
!= LTTCOMM_OK
) {
2529 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2530 case LTTNG_DOMAIN_UST_PID
:
2531 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2545 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2547 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2548 char *channel_name
, struct lttng_event
*event
)
2551 struct lttng_channel
*attr
;
2552 struct ltt_ust_session
*usess
= session
->ust_session
;
2555 case LTTNG_DOMAIN_KERNEL
:
2557 struct ltt_kernel_channel
*kchan
;
2559 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2560 session
->kernel_session
);
2561 if (kchan
== NULL
) {
2562 attr
= channel_new_default_attr(domain
);
2564 ret
= LTTCOMM_FATAL
;
2567 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2569 /* This call will notify the kernel thread */
2570 ret
= channel_kernel_create(session
->kernel_session
,
2571 attr
, kernel_poll_pipe
[1]);
2572 if (ret
!= LTTCOMM_OK
) {
2579 /* Get the newly created kernel channel pointer */
2580 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2581 session
->kernel_session
);
2582 if (kchan
== NULL
) {
2583 /* This sould not happen... */
2584 ret
= LTTCOMM_FATAL
;
2588 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2590 if (ret
!= LTTCOMM_OK
) {
2594 kernel_wait_quiescent(kernel_tracer_fd
);
2597 case LTTNG_DOMAIN_UST
:
2599 struct lttng_channel
*attr
;
2600 struct ltt_ust_channel
*uchan
;
2602 /* Get channel from global UST domain */
2603 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2605 if (uchan
== NULL
) {
2606 /* Create default channel */
2607 attr
= channel_new_default_attr(domain
);
2609 ret
= LTTCOMM_FATAL
;
2612 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2613 attr
->name
[NAME_MAX
- 1] = '\0';
2615 ret
= channel_ust_create(usess
, domain
, attr
);
2616 if (ret
!= LTTCOMM_OK
) {
2622 /* Get the newly created channel reference back */
2623 uchan
= trace_ust_find_channel_by_name(
2624 usess
->domain_global
.channels
, channel_name
);
2625 if (uchan
== NULL
) {
2626 /* Something is really wrong */
2627 ret
= LTTCOMM_FATAL
;
2632 /* At this point, the session and channel exist on the tracer */
2633 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2634 if (ret
!= LTTCOMM_OK
) {
2640 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2641 case LTTNG_DOMAIN_UST_PID
:
2642 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2656 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2658 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2659 char *channel_name
, int event_type
)
2662 struct ltt_kernel_channel
*kchan
;
2665 case LTTNG_DOMAIN_KERNEL
:
2666 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2667 session
->kernel_session
);
2668 if (kchan
== NULL
) {
2669 /* This call will notify the kernel thread */
2670 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2671 kernel_poll_pipe
[1]);
2672 if (ret
!= LTTCOMM_OK
) {
2676 /* Get the newly created kernel channel pointer */
2677 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2678 session
->kernel_session
);
2679 if (kchan
== NULL
) {
2680 /* This sould not happen... */
2681 ret
= LTTCOMM_FATAL
;
2687 switch (event_type
) {
2688 case LTTNG_EVENT_SYSCALL
:
2689 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2690 kchan
, kernel_tracer_fd
);
2692 case LTTNG_EVENT_TRACEPOINT
:
2694 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2695 * events already registered to the channel.
2697 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2698 kchan
, kernel_tracer_fd
);
2700 case LTTNG_EVENT_ALL
:
2701 /* Enable syscalls and tracepoints */
2702 ret
= event_kernel_enable_all(session
->kernel_session
,
2703 kchan
, kernel_tracer_fd
);
2706 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2710 /* Manage return value */
2711 if (ret
!= LTTCOMM_OK
) {
2715 kernel_wait_quiescent(kernel_tracer_fd
);
2717 case LTTNG_DOMAIN_UST
:
2719 struct lttng_channel
*attr
;
2720 struct ltt_ust_channel
*uchan
;
2721 struct ltt_ust_session
*usess
= session
->ust_session
;
2723 /* Get channel from global UST domain */
2724 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2726 if (uchan
== NULL
) {
2727 /* Create default channel */
2728 attr
= channel_new_default_attr(domain
);
2730 ret
= LTTCOMM_FATAL
;
2733 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2734 attr
->name
[NAME_MAX
- 1] = '\0';
2736 /* Use the internal command enable channel */
2737 ret
= channel_ust_create(usess
, domain
, attr
);
2738 if (ret
!= LTTCOMM_OK
) {
2744 /* Get the newly created channel reference back */
2745 uchan
= trace_ust_find_channel_by_name(
2746 usess
->domain_global
.channels
, channel_name
);
2747 if (uchan
== NULL
) {
2748 /* Something is really wrong */
2749 ret
= LTTCOMM_FATAL
;
2754 /* At this point, the session and channel exist on the tracer */
2756 switch (event_type
) {
2757 case LTTNG_EVENT_ALL
:
2758 case LTTNG_EVENT_TRACEPOINT
:
2759 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2760 if (ret
!= LTTCOMM_OK
) {
2765 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2769 /* Manage return value */
2770 if (ret
!= LTTCOMM_OK
) {
2777 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2778 case LTTNG_DOMAIN_UST_PID
:
2779 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2793 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2795 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2798 ssize_t nb_events
= 0;
2801 case LTTNG_DOMAIN_KERNEL
:
2802 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2803 if (nb_events
< 0) {
2804 ret
= LTTCOMM_KERN_LIST_FAIL
;
2808 case LTTNG_DOMAIN_UST
:
2809 nb_events
= ust_app_list_events(events
);
2810 if (nb_events
< 0) {
2811 ret
= LTTCOMM_UST_LIST_FAIL
;
2823 /* Return negative value to differentiate return code */
2828 * Command LTTNG_START_TRACE processed by the client thread.
2830 static int cmd_start_trace(struct ltt_session
*session
)
2833 struct ltt_kernel_session
*ksession
;
2834 struct ltt_ust_session
*usess
;
2837 ksession
= session
->kernel_session
;
2838 usess
= session
->ust_session
;
2840 if (session
->enabled
) {
2841 ret
= LTTCOMM_UST_START_FAIL
;
2845 session
->enabled
= 1;
2847 /* Kernel tracing */
2848 if (ksession
!= NULL
) {
2849 struct ltt_kernel_channel
*kchan
;
2851 /* Open kernel metadata */
2852 if (ksession
->metadata
== NULL
) {
2853 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2855 ret
= LTTCOMM_KERN_META_FAIL
;
2860 /* Open kernel metadata stream */
2861 if (ksession
->metadata_stream_fd
== 0) {
2862 ret
= kernel_open_metadata_stream(ksession
);
2864 ERR("Kernel create metadata stream failed");
2865 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2870 /* For each channel */
2871 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2872 if (kchan
->stream_count
== 0) {
2873 ret
= kernel_open_channel_stream(kchan
);
2875 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2878 /* Update the stream global counter */
2879 ksession
->stream_count_global
+= ret
;
2883 /* Setup kernel consumer socket and send fds to it */
2884 ret
= init_kernel_tracing(ksession
);
2886 ret
= LTTCOMM_KERN_START_FAIL
;
2890 /* This start the kernel tracing */
2891 ret
= kernel_start_session(ksession
);
2893 ret
= LTTCOMM_KERN_START_FAIL
;
2897 /* Quiescent wait after starting trace */
2898 kernel_wait_quiescent(kernel_tracer_fd
);
2901 /* Flag session that trace should start automatically */
2903 usess
->start_trace
= 1;
2905 ret
= ust_app_start_trace_all(usess
);
2907 ret
= LTTCOMM_UST_START_FAIL
;
2919 * Command LTTNG_STOP_TRACE processed by the client thread.
2921 static int cmd_stop_trace(struct ltt_session
*session
)
2924 struct ltt_kernel_channel
*kchan
;
2925 struct ltt_kernel_session
*ksession
;
2926 struct ltt_ust_session
*usess
;
2929 ksession
= session
->kernel_session
;
2930 usess
= session
->ust_session
;
2932 if (!session
->enabled
) {
2933 ret
= LTTCOMM_UST_STOP_FAIL
;
2937 session
->enabled
= 0;
2940 if (ksession
!= NULL
) {
2941 DBG("Stop kernel tracing");
2943 /* Flush all buffers before stopping */
2944 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2946 ERR("Kernel metadata flush failed");
2949 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2950 ret
= kernel_flush_buffer(kchan
);
2952 ERR("Kernel flush buffer error");
2956 ret
= kernel_stop_session(ksession
);
2958 ret
= LTTCOMM_KERN_STOP_FAIL
;
2962 kernel_wait_quiescent(kernel_tracer_fd
);
2966 usess
->start_trace
= 0;
2968 ret
= ust_app_stop_trace_all(usess
);
2970 ret
= LTTCOMM_UST_STOP_FAIL
;
2982 * Command LTTNG_CREATE_SESSION processed by the client thread.
2984 static int cmd_create_session(char *name
, char *path
, lttng_sock_cred
*creds
)
2988 ret
= session_create(name
, path
, LTTNG_SOCK_GET_UID_CRED(creds
),
2989 LTTNG_SOCK_GET_GID_CRED(creds
));
2990 if (ret
!= LTTCOMM_OK
) {
3001 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3003 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
3007 /* Clean kernel session teardown */
3008 teardown_kernel_session(session
);
3009 /* UST session teardown */
3010 teardown_ust_session(session
);
3013 * Must notify the kernel thread here to update it's poll setin order
3014 * to remove the channel(s)' fd just destroyed.
3016 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3018 PERROR("write kernel poll pipe");
3021 ret
= session_destroy(session
);
3027 * Command LTTNG_CALIBRATE processed by the client thread.
3029 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3034 case LTTNG_DOMAIN_KERNEL
:
3036 struct lttng_kernel_calibrate kcalibrate
;
3038 kcalibrate
.type
= calibrate
->type
;
3039 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3041 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3046 case LTTNG_DOMAIN_UST
:
3048 struct lttng_ust_calibrate ucalibrate
;
3050 ucalibrate
.type
= calibrate
->type
;
3051 ret
= ust_app_calibrate_glb(&ucalibrate
);
3053 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3070 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3072 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3078 case LTTNG_DOMAIN_KERNEL
:
3079 /* Can't register a consumer if there is already one */
3080 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3081 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3085 sock
= lttcomm_connect_unix_sock(sock_path
);
3087 ret
= LTTCOMM_CONNECT_FAIL
;
3091 session
->kernel_session
->consumer_fd
= sock
;
3094 /* TODO: Userspace tracing */
3106 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3108 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3109 struct lttng_domain
**domains
)
3114 if (session
->kernel_session
!= NULL
) {
3115 DBG3("Listing domains found kernel domain");
3119 if (session
->ust_session
!= NULL
) {
3120 DBG3("Listing domains found UST global domain");
3124 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3125 if (*domains
== NULL
) {
3126 ret
= -LTTCOMM_FATAL
;
3130 if (session
->kernel_session
!= NULL
) {
3131 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3135 if (session
->ust_session
!= NULL
) {
3136 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3147 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3149 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3150 struct lttng_channel
**channels
)
3153 ssize_t nb_chan
= 0;
3156 case LTTNG_DOMAIN_KERNEL
:
3157 if (session
->kernel_session
!= NULL
) {
3158 nb_chan
= session
->kernel_session
->channel_count
;
3160 DBG3("Number of kernel channels %zd", nb_chan
);
3162 case LTTNG_DOMAIN_UST
:
3163 if (session
->ust_session
!= NULL
) {
3164 nb_chan
= lttng_ht_get_count(
3165 session
->ust_session
->domain_global
.channels
);
3167 DBG3("Number of UST global channels %zd", nb_chan
);
3176 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3177 if (*channels
== NULL
) {
3178 ret
= -LTTCOMM_FATAL
;
3182 list_lttng_channels(domain
, session
, *channels
);
3194 * Command LTTNG_LIST_EVENTS processed by the client thread.
3196 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3197 char *channel_name
, struct lttng_event
**events
)
3200 ssize_t nb_event
= 0;
3203 case LTTNG_DOMAIN_KERNEL
:
3204 if (session
->kernel_session
!= NULL
) {
3205 nb_event
= list_lttng_kernel_events(channel_name
,
3206 session
->kernel_session
, events
);
3209 case LTTNG_DOMAIN_UST
:
3211 if (session
->ust_session
!= NULL
) {
3212 nb_event
= list_lttng_ust_global_events(channel_name
,
3213 &session
->ust_session
->domain_global
, events
);
3229 * Process the command requested by the lttng client within the command
3230 * context structure. This function make sure that the return structure (llm)
3231 * is set and ready for transmission before returning.
3233 * Return any error encountered or 0 for success.
3235 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3237 int ret
= LTTCOMM_OK
;
3238 int need_tracing_session
= 1;
3241 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3243 switch (cmd_ctx
->lsm
->cmd_type
) {
3244 case LTTNG_CREATE_SESSION
:
3245 case LTTNG_DESTROY_SESSION
:
3246 case LTTNG_LIST_SESSIONS
:
3247 case LTTNG_LIST_DOMAINS
:
3248 case LTTNG_START_TRACE
:
3249 case LTTNG_STOP_TRACE
:
3256 if (opt_no_kernel
&& need_domain
3257 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3258 ret
= LTTCOMM_KERN_NA
;
3263 * Check for command that don't needs to allocate a returned payload. We do
3264 * this here so we don't have to make the call for no payload at each
3267 switch(cmd_ctx
->lsm
->cmd_type
) {
3268 case LTTNG_LIST_SESSIONS
:
3269 case LTTNG_LIST_TRACEPOINTS
:
3270 case LTTNG_LIST_DOMAINS
:
3271 case LTTNG_LIST_CHANNELS
:
3272 case LTTNG_LIST_EVENTS
:
3275 /* Setup lttng message with no payload */
3276 ret
= setup_lttng_msg(cmd_ctx
, 0);
3278 /* This label does not try to unlock the session */
3279 goto init_setup_error
;
3283 /* Commands that DO NOT need a session. */
3284 switch (cmd_ctx
->lsm
->cmd_type
) {
3285 case LTTNG_CREATE_SESSION
:
3286 case LTTNG_CALIBRATE
:
3287 case LTTNG_LIST_SESSIONS
:
3288 case LTTNG_LIST_TRACEPOINTS
:
3289 need_tracing_session
= 0;
3292 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3293 session_lock_list();
3294 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3295 session_unlock_list();
3296 if (cmd_ctx
->session
== NULL
) {
3297 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3298 ret
= LTTCOMM_SESS_NOT_FOUND
;
3300 /* If no session name specified */
3301 ret
= LTTCOMM_SELECT_SESS
;
3305 /* Acquire lock for the session */
3306 session_lock(cmd_ctx
->session
);
3315 * Check domain type for specific "pre-action".
3317 switch (cmd_ctx
->lsm
->domain
.type
) {
3318 case LTTNG_DOMAIN_KERNEL
:
3320 ret
= LTTCOMM_KERN_NA
;
3324 /* Kernel tracer check */
3325 if (kernel_tracer_fd
== -1) {
3326 /* Basically, load kernel tracer modules */
3327 ret
= init_kernel_tracer();
3333 /* Need a session for kernel command */
3334 if (need_tracing_session
) {
3335 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3336 ret
= create_kernel_session(cmd_ctx
->session
);
3338 ret
= LTTCOMM_KERN_SESS_FAIL
;
3343 /* Start the kernel consumer daemon */
3344 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3345 if (kconsumer_data
.pid
== 0 &&
3346 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3347 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3348 ret
= start_consumerd(&kconsumer_data
);
3350 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3354 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3358 case LTTNG_DOMAIN_UST
:
3360 if (need_tracing_session
) {
3361 if (cmd_ctx
->session
->ust_session
== NULL
) {
3362 ret
= create_ust_session(cmd_ctx
->session
,
3363 &cmd_ctx
->lsm
->domain
);
3364 if (ret
!= LTTCOMM_OK
) {
3368 /* Start the UST consumer daemons */
3370 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3371 if (consumerd64_bin
[0] != '\0' &&
3372 ustconsumer64_data
.pid
== 0 &&
3373 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3374 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3375 ret
= start_consumerd(&ustconsumer64_data
);
3377 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3378 ust_consumerd64_fd
= -EINVAL
;
3382 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3384 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3387 if (consumerd32_bin
[0] != '\0' &&
3388 ustconsumer32_data
.pid
== 0 &&
3389 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3390 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3391 ret
= start_consumerd(&ustconsumer32_data
);
3393 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3394 ust_consumerd32_fd
= -EINVAL
;
3397 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3399 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3410 * Check that the UID or GID match that of the tracing session.
3411 * The root user can interact with all sessions.
3413 if (need_tracing_session
) {
3414 if (!session_access_ok(cmd_ctx
->session
,
3415 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3416 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
))) {
3417 ret
= LTTCOMM_EPERM
;
3422 /* Process by command type */
3423 switch (cmd_ctx
->lsm
->cmd_type
) {
3424 case LTTNG_ADD_CONTEXT
:
3426 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3427 cmd_ctx
->lsm
->u
.context
.channel_name
,
3428 cmd_ctx
->lsm
->u
.context
.event_name
,
3429 &cmd_ctx
->lsm
->u
.context
.ctx
);
3432 case LTTNG_DISABLE_CHANNEL
:
3434 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3435 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3438 case LTTNG_DISABLE_EVENT
:
3440 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3441 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3442 cmd_ctx
->lsm
->u
.disable
.name
);
3445 case LTTNG_DISABLE_ALL_EVENT
:
3447 DBG("Disabling all events");
3449 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3450 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3453 case LTTNG_ENABLE_CHANNEL
:
3455 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3456 &cmd_ctx
->lsm
->u
.channel
.chan
);
3459 case LTTNG_ENABLE_EVENT
:
3461 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3462 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3463 &cmd_ctx
->lsm
->u
.enable
.event
);
3466 case LTTNG_ENABLE_ALL_EVENT
:
3468 DBG("Enabling all events");
3470 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3471 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3472 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3475 case LTTNG_LIST_TRACEPOINTS
:
3477 struct lttng_event
*events
;
3480 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3481 if (nb_events
< 0) {
3487 * Setup lttng message with payload size set to the event list size in
3488 * bytes and then copy list into the llm payload.
3490 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3496 /* Copy event list into message payload */
3497 memcpy(cmd_ctx
->llm
->payload
, events
,
3498 sizeof(struct lttng_event
) * nb_events
);
3505 case LTTNG_START_TRACE
:
3507 ret
= cmd_start_trace(cmd_ctx
->session
);
3510 case LTTNG_STOP_TRACE
:
3512 ret
= cmd_stop_trace(cmd_ctx
->session
);
3515 case LTTNG_CREATE_SESSION
:
3517 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3518 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3521 case LTTNG_DESTROY_SESSION
:
3523 ret
= cmd_destroy_session(cmd_ctx
->session
,
3524 cmd_ctx
->lsm
->session
.name
);
3527 case LTTNG_LIST_DOMAINS
:
3530 struct lttng_domain
*domains
;
3532 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3538 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3543 /* Copy event list into message payload */
3544 memcpy(cmd_ctx
->llm
->payload
, domains
,
3545 nb_dom
* sizeof(struct lttng_domain
));
3552 case LTTNG_LIST_CHANNELS
:
3555 struct lttng_channel
*channels
;
3557 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3558 cmd_ctx
->session
, &channels
);
3564 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3569 /* Copy event list into message payload */
3570 memcpy(cmd_ctx
->llm
->payload
, channels
,
3571 nb_chan
* sizeof(struct lttng_channel
));
3578 case LTTNG_LIST_EVENTS
:
3581 struct lttng_event
*events
= NULL
;
3583 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3584 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3590 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3595 /* Copy event list into message payload */
3596 memcpy(cmd_ctx
->llm
->payload
, events
,
3597 nb_event
* sizeof(struct lttng_event
));
3604 case LTTNG_LIST_SESSIONS
:
3606 unsigned int nr_sessions
;
3608 session_lock_list();
3609 nr_sessions
= lttng_sessions_count(
3610 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3611 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3613 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3615 session_unlock_list();
3619 /* Filled the session array */
3620 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3621 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
3622 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
3624 session_unlock_list();
3629 case LTTNG_CALIBRATE
:
3631 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3632 &cmd_ctx
->lsm
->u
.calibrate
);
3635 case LTTNG_REGISTER_CONSUMER
:
3637 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3638 cmd_ctx
->lsm
->u
.reg
.path
);
3647 if (cmd_ctx
->llm
== NULL
) {
3648 DBG("Missing llm structure. Allocating one.");
3649 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3653 /* Set return code */
3654 cmd_ctx
->llm
->ret_code
= ret
;
3656 if (cmd_ctx
->session
) {
3657 session_unlock(cmd_ctx
->session
);
3664 * This thread manage all clients request using the unix client socket for
3667 static void *thread_manage_clients(void *data
)
3669 int sock
= -1, ret
, i
, pollfd
;
3670 uint32_t revents
, nb_fd
;
3671 struct command_ctx
*cmd_ctx
= NULL
;
3672 struct lttng_poll_event events
;
3674 DBG("[thread] Manage client started");
3676 rcu_register_thread();
3678 ret
= lttcomm_listen_unix_sock(client_sock
);
3684 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3685 * more will be added to this poll set.
3687 ret
= create_thread_poll_set(&events
, 2);
3692 /* Add the application registration socket */
3693 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3699 * Notify parent pid that we are ready to accept command for client side.
3701 if (opt_sig_parent
) {
3702 kill(ppid
, SIGUSR1
);
3706 DBG("Accepting client command ...");
3708 nb_fd
= LTTNG_POLL_GETNB(&events
);
3710 /* Inifinite blocking call, waiting for transmission */
3712 ret
= lttng_poll_wait(&events
, -1);
3715 * Restart interrupted system call.
3717 if (errno
== EINTR
) {
3723 for (i
= 0; i
< nb_fd
; i
++) {
3724 /* Fetch once the poll data */
3725 revents
= LTTNG_POLL_GETEV(&events
, i
);
3726 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3728 /* Thread quit pipe has been closed. Killing thread. */
3729 ret
= check_thread_quit_pipe(pollfd
, revents
);
3734 /* Event on the registration socket */
3735 if (pollfd
== client_sock
) {
3736 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3737 ERR("Client socket poll error");
3743 DBG("Wait for client response");
3745 sock
= lttcomm_accept_unix_sock(client_sock
);
3750 /* Set socket option for credentials retrieval */
3751 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3756 /* Allocate context command to process the client request */
3757 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3758 if (cmd_ctx
== NULL
) {
3759 PERROR("zmalloc cmd_ctx");
3763 /* Allocate data buffer for reception */
3764 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3765 if (cmd_ctx
->lsm
== NULL
) {
3766 PERROR("zmalloc cmd_ctx->lsm");
3770 cmd_ctx
->llm
= NULL
;
3771 cmd_ctx
->session
= NULL
;
3774 * Data is received from the lttng client. The struct
3775 * lttcomm_session_msg (lsm) contains the command and data request of
3778 DBG("Receiving data from client ...");
3779 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3780 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3782 DBG("Nothing recv() from client... continuing");
3792 // TODO: Validate cmd_ctx including sanity check for
3793 // security purpose.
3795 rcu_thread_online();
3797 * This function dispatch the work to the kernel or userspace tracer
3798 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3799 * informations for the client. The command context struct contains
3800 * everything this function may needs.
3802 ret
= process_client_msg(cmd_ctx
);
3803 rcu_thread_offline();
3806 * TODO: Inform client somehow of the fatal error. At
3807 * this point, ret < 0 means that a zmalloc failed
3808 * (ENOMEM). Error detected but still accept command.
3810 clean_command_ctx(&cmd_ctx
);
3814 DBG("Sending response (size: %d, retcode: %s)",
3815 cmd_ctx
->lttng_msg_size
,
3816 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3817 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3819 ERR("Failed to send data back to client");
3822 /* End of transmission */
3829 clean_command_ctx(&cmd_ctx
);
3833 DBG("Client thread dying");
3834 unlink(client_unix_sock_path
);
3835 if (client_sock
>= 0) {
3836 ret
= close(client_sock
);
3848 lttng_poll_clean(&events
);
3849 clean_command_ctx(&cmd_ctx
);
3851 rcu_unregister_thread();
3857 * usage function on stderr
3859 static void usage(void)
3861 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3862 fprintf(stderr
, " -h, --help Display this usage.\n");
3863 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3864 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3865 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3866 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3867 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3868 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3869 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3870 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3871 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3872 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3873 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3874 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3875 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3876 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3877 fprintf(stderr
, " -V, --version Show version number.\n");
3878 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3879 fprintf(stderr
, " -q, --quiet No output at all.\n");
3880 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3881 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3882 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3886 * daemon argument parsing
3888 static int parse_args(int argc
, char **argv
)
3892 static struct option long_options
[] = {
3893 { "client-sock", 1, 0, 'c' },
3894 { "apps-sock", 1, 0, 'a' },
3895 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3896 { "kconsumerd-err-sock", 1, 0, 'E' },
3897 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3898 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3899 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3900 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3901 { "consumerd32-path", 1, 0, 'u' },
3902 { "consumerd32-libdir", 1, 0, 'U' },
3903 { "consumerd64-path", 1, 0, 't' },
3904 { "consumerd64-libdir", 1, 0, 'T' },
3905 { "daemonize", 0, 0, 'd' },
3906 { "sig-parent", 0, 0, 'S' },
3907 { "help", 0, 0, 'h' },
3908 { "group", 1, 0, 'g' },
3909 { "version", 0, 0, 'V' },
3910 { "quiet", 0, 0, 'q' },
3911 { "verbose", 0, 0, 'v' },
3912 { "verbose-consumer", 0, 0, 'Z' },
3913 { "no-kernel", 0, 0, 'N' },
3918 int option_index
= 0;
3919 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3920 long_options
, &option_index
);
3927 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3929 fprintf(stderr
, " with arg %s\n", optarg
);
3933 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3936 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3942 opt_tracing_group
= optarg
;
3948 fprintf(stdout
, "%s\n", VERSION
);
3954 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3957 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3960 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3963 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3966 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3969 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3978 /* Verbose level can increase using multiple -v */
3982 opt_verbose_consumer
+= 1;
3985 consumerd32_bin
= optarg
;
3988 consumerd32_libdir
= optarg
;
3991 consumerd64_bin
= optarg
;
3994 consumerd64_libdir
= optarg
;
3997 /* Unknown option or other error.
3998 * Error is printed by getopt, just return */
4007 * Creates the two needed socket by the daemon.
4008 * apps_sock - The communication socket for all UST apps.
4009 * client_sock - The communication of the cli tool (lttng).
4011 static int init_daemon_socket(void)
4016 old_umask
= umask(0);
4018 /* Create client tool unix socket */
4019 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4020 if (client_sock
< 0) {
4021 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4026 /* File permission MUST be 660 */
4027 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4029 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4034 /* Create the application unix socket */
4035 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4036 if (apps_sock
< 0) {
4037 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4042 /* File permission MUST be 666 */
4043 ret
= chmod(apps_unix_sock_path
,
4044 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4046 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4057 * Check if the global socket is available, and if a daemon is answering at the
4058 * other side. If yes, error is returned.
4060 static int check_existing_daemon(void)
4062 /* Is there anybody out there ? */
4063 if (lttng_session_daemon_alive()) {
4071 * Set the tracing group gid onto the client socket.
4073 * Race window between mkdir and chown is OK because we are going from more
4074 * permissive (root.root) to less permissive (root.tracing).
4076 static int set_permissions(char *rundir
)
4081 gid
= allowed_group();
4083 WARN("No tracing group detected");
4088 /* Set lttng run dir */
4089 ret
= chown(rundir
, 0, gid
);
4091 ERR("Unable to set group on %s", rundir
);
4095 /* Ensure tracing group can search the run dir */
4096 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4098 ERR("Unable to set permissions on %s", rundir
);
4102 /* lttng client socket path */
4103 ret
= chown(client_unix_sock_path
, 0, gid
);
4105 ERR("Unable to set group on %s", client_unix_sock_path
);
4109 /* kconsumer error socket path */
4110 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4112 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4116 /* 64-bit ustconsumer error socket path */
4117 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4119 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4123 /* 32-bit ustconsumer compat32 error socket path */
4124 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4126 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4130 DBG("All permissions are set");
4137 * Create the pipe used to wake up the kernel thread.
4138 * Closed in cleanup().
4140 static int create_kernel_poll_pipe(void)
4144 ret
= pipe(kernel_poll_pipe
);
4146 PERROR("kernel poll pipe");
4150 for (i
= 0; i
< 2; i
++) {
4151 ret
= fcntl(kernel_poll_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4153 PERROR("fcntl kernel_poll_pipe");
4163 * Create the application command pipe to wake thread_manage_apps.
4164 * Closed in cleanup().
4166 static int create_apps_cmd_pipe(void)
4170 ret
= pipe(apps_cmd_pipe
);
4172 PERROR("apps cmd pipe");
4176 for (i
= 0; i
< 2; i
++) {
4177 ret
= fcntl(apps_cmd_pipe
[i
], F_SETFD
, FD_CLOEXEC
);
4179 PERROR("fcntl apps_cmd_pipe");
4189 * Create the lttng run directory needed for all global sockets and pipe.
4191 static int create_lttng_rundir(const char *rundir
)
4195 DBG3("Creating LTTng run directory: %s", rundir
);
4197 ret
= mkdir(rundir
, S_IRWXU
);
4199 if (errno
!= EEXIST
) {
4200 ERR("Unable to create %s", rundir
);
4212 * Setup sockets and directory needed by the kconsumerd communication with the
4215 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4219 char path
[PATH_MAX
];
4221 switch (consumer_data
->type
) {
4222 case LTTNG_CONSUMER_KERNEL
:
4223 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4225 case LTTNG_CONSUMER64_UST
:
4226 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4228 case LTTNG_CONSUMER32_UST
:
4229 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4232 ERR("Consumer type unknown");
4237 DBG2("Creating consumer directory: %s", path
);
4239 ret
= mkdir(path
, S_IRWXU
);
4241 if (errno
!= EEXIST
) {
4242 ERR("Failed to create %s", path
);
4248 /* Create the kconsumerd error unix socket */
4249 consumer_data
->err_sock
=
4250 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4251 if (consumer_data
->err_sock
< 0) {
4252 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4257 /* File permission MUST be 660 */
4258 ret
= chmod(consumer_data
->err_unix_sock_path
,
4259 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4261 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4271 * Signal handler for the daemon
4273 * Simply stop all worker threads, leaving main() return gracefully after
4274 * joining all threads and calling cleanup().
4276 static void sighandler(int sig
)
4280 DBG("SIGPIPE caught");
4283 DBG("SIGINT caught");
4287 DBG("SIGTERM caught");
4296 * Setup signal handler for :
4297 * SIGINT, SIGTERM, SIGPIPE
4299 static int set_signal_handler(void)
4302 struct sigaction sa
;
4305 if ((ret
= sigemptyset(&sigset
)) < 0) {
4306 PERROR("sigemptyset");
4310 sa
.sa_handler
= sighandler
;
4311 sa
.sa_mask
= sigset
;
4313 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4314 PERROR("sigaction");
4318 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4319 PERROR("sigaction");
4323 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4324 PERROR("sigaction");
4328 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4334 * Set open files limit to unlimited. This daemon can open a large number of
4335 * file descriptors in order to consumer multiple kernel traces.
4337 static void set_ulimit(void)
4342 /* The kernel does not allowed an infinite limit for open files */
4343 lim
.rlim_cur
= 65535;
4344 lim
.rlim_max
= 65535;
4346 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4348 PERROR("failed to set open files limit");
4355 int main(int argc
, char **argv
)
4359 const char *home_path
;
4361 init_kernel_workarounds();
4363 rcu_register_thread();
4365 /* Create thread quit pipe */
4366 if ((ret
= init_thread_quit_pipe()) < 0) {
4370 setup_consumerd_path();
4372 /* Parse arguments */
4374 if ((ret
= parse_args(argc
, argv
) < 0)) {
4387 /* Check if daemon is UID = 0 */
4388 is_root
= !getuid();
4391 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4393 /* Create global run dir with root access */
4394 ret
= create_lttng_rundir(rundir
);
4399 if (strlen(apps_unix_sock_path
) == 0) {
4400 snprintf(apps_unix_sock_path
, PATH_MAX
,
4401 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4404 if (strlen(client_unix_sock_path
) == 0) {
4405 snprintf(client_unix_sock_path
, PATH_MAX
,
4406 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4409 /* Set global SHM for ust */
4410 if (strlen(wait_shm_path
) == 0) {
4411 snprintf(wait_shm_path
, PATH_MAX
,
4412 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4415 /* Setup kernel consumerd path */
4416 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4417 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4418 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4419 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4421 DBG2("Kernel consumer err path: %s",
4422 kconsumer_data
.err_unix_sock_path
);
4423 DBG2("Kernel consumer cmd path: %s",
4424 kconsumer_data
.cmd_unix_sock_path
);
4426 home_path
= get_home_dir();
4427 if (home_path
== NULL
) {
4428 /* TODO: Add --socket PATH option */
4429 ERR("Can't get HOME directory for sockets creation.");
4435 * Create rundir from home path. This will create something like
4438 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4444 ret
= create_lttng_rundir(rundir
);
4449 if (strlen(apps_unix_sock_path
) == 0) {
4450 snprintf(apps_unix_sock_path
, PATH_MAX
,
4451 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4454 /* Set the cli tool unix socket path */
4455 if (strlen(client_unix_sock_path
) == 0) {
4456 snprintf(client_unix_sock_path
, PATH_MAX
,
4457 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4460 /* Set global SHM for ust */
4461 if (strlen(wait_shm_path
) == 0) {
4462 snprintf(wait_shm_path
, PATH_MAX
,
4463 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4467 DBG("Client socket path %s", client_unix_sock_path
);
4468 DBG("Application socket path %s", apps_unix_sock_path
);
4469 DBG("LTTng run directory path: %s", rundir
);
4471 /* 32 bits consumerd path setup */
4472 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4473 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4474 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4475 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4477 DBG2("UST consumer 32 bits err path: %s",
4478 ustconsumer32_data
.err_unix_sock_path
);
4479 DBG2("UST consumer 32 bits cmd path: %s",
4480 ustconsumer32_data
.cmd_unix_sock_path
);
4482 /* 64 bits consumerd path setup */
4483 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4484 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4485 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4486 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4488 DBG2("UST consumer 64 bits err path: %s",
4489 ustconsumer64_data
.err_unix_sock_path
);
4490 DBG2("UST consumer 64 bits cmd path: %s",
4491 ustconsumer64_data
.cmd_unix_sock_path
);
4494 * See if daemon already exist.
4496 if ((ret
= check_existing_daemon()) < 0) {
4497 ERR("Already running daemon.\n");
4499 * We do not goto exit because we must not cleanup()
4500 * because a daemon is already running.
4505 /* After this point, we can safely call cleanup() with "goto exit" */
4508 * These actions must be executed as root. We do that *after* setting up
4509 * the sockets path because we MUST make the check for another daemon using
4510 * those paths *before* trying to set the kernel consumer sockets and init
4514 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4519 /* Setup kernel tracer */
4520 if (!opt_no_kernel
) {
4521 init_kernel_tracer();
4524 /* Set ulimit for open files */
4528 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4533 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4538 if ((ret
= set_signal_handler()) < 0) {
4542 /* Setup the needed unix socket */
4543 if ((ret
= init_daemon_socket()) < 0) {
4547 /* Set credentials to socket */
4548 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4552 /* Get parent pid if -S, --sig-parent is specified. */
4553 if (opt_sig_parent
) {
4557 /* Setup the kernel pipe for waking up the kernel thread */
4558 if ((ret
= create_kernel_poll_pipe()) < 0) {
4562 /* Setup the thread apps communication pipe. */
4563 if ((ret
= create_apps_cmd_pipe()) < 0) {
4567 /* Init UST command queue. */
4568 cds_wfq_init(&ust_cmd_queue
.queue
);
4570 /* Init UST app hash table */
4574 * Get session list pointer. This pointer MUST NOT be free(). This list is
4575 * statically declared in session.c
4577 session_list_ptr
= session_get_list();
4579 /* Set up max poll set size */
4580 lttng_poll_set_max_size();
4582 /* Create thread to manage the client socket */
4583 ret
= pthread_create(&client_thread
, NULL
,
4584 thread_manage_clients
, (void *) NULL
);
4586 PERROR("pthread_create clients");
4590 /* Create thread to dispatch registration */
4591 ret
= pthread_create(&dispatch_thread
, NULL
,
4592 thread_dispatch_ust_registration
, (void *) NULL
);
4594 PERROR("pthread_create dispatch");
4598 /* Create thread to manage application registration. */
4599 ret
= pthread_create(®_apps_thread
, NULL
,
4600 thread_registration_apps
, (void *) NULL
);
4602 PERROR("pthread_create registration");
4606 /* Create thread to manage application socket */
4607 ret
= pthread_create(&apps_thread
, NULL
,
4608 thread_manage_apps
, (void *) NULL
);
4610 PERROR("pthread_create apps");
4614 /* Create kernel thread to manage kernel event */
4615 ret
= pthread_create(&kernel_thread
, NULL
,
4616 thread_manage_kernel
, (void *) NULL
);
4618 PERROR("pthread_create kernel");
4622 ret
= pthread_join(kernel_thread
, &status
);
4624 PERROR("pthread_join");
4625 goto error
; /* join error, exit without cleanup */
4629 ret
= pthread_join(apps_thread
, &status
);
4631 PERROR("pthread_join");
4632 goto error
; /* join error, exit without cleanup */
4636 ret
= pthread_join(reg_apps_thread
, &status
);
4638 PERROR("pthread_join");
4639 goto error
; /* join error, exit without cleanup */
4643 ret
= pthread_join(dispatch_thread
, &status
);
4645 PERROR("pthread_join");
4646 goto error
; /* join error, exit without cleanup */
4650 ret
= pthread_join(client_thread
, &status
);
4652 PERROR("pthread_join");
4653 goto error
; /* join error, exit without cleanup */
4656 ret
= join_consumer_thread(&kconsumer_data
);
4658 PERROR("join_consumer");
4659 goto error
; /* join error, exit without cleanup */
4665 * cleanup() is called when no other thread is running.
4667 rcu_thread_online();
4669 rcu_thread_offline();
4670 rcu_unregister_thread();