2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <semaphore.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
35 #include <sys/types.h>
37 #include <urcu/futex.h>
41 #include <common/common.h>
42 #include <common/compat/poll.h>
43 #include <common/defaults.h>
44 #include <common/kernel-consumer/kernel-consumer.h>
45 #include <common/ust-consumer/ust-consumer.h>
47 #include "lttng-sessiond.h"
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
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
302 PERROR("thread quit pipe");
311 * Complete teardown of a kernel session. This free all data structure related
312 * to a kernel session and update counter.
314 static void teardown_kernel_session(struct ltt_session
*session
)
316 if (!session
->kernel_session
) {
317 DBG3("No kernel session when tearing down session");
321 DBG("Tearing down kernel session");
324 * If a custom kernel consumer was registered, close the socket before
325 * tearing down the complete kernel session structure
327 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
328 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
331 trace_kernel_destroy_session(session
->kernel_session
);
335 * Complete teardown of all UST sessions. This will free everything on his path
336 * and destroy the core essence of all ust sessions :)
338 static void teardown_ust_session(struct ltt_session
*session
)
342 if (!session
->ust_session
) {
343 DBG3("No UST session when tearing down session");
347 DBG("Tearing down UST session(s)");
349 ret
= ust_app_destroy_trace_all(session
->ust_session
);
351 ERR("Error in ust_app_destroy_trace_all");
354 trace_ust_destroy_session(session
->ust_session
);
358 * Stop all threads by closing the thread quit pipe.
360 static void stop_threads(void)
364 /* Stopping all threads */
365 DBG("Terminating all threads");
366 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
368 ERR("write error on thread quit pipe");
371 /* Dispatch thread */
372 dispatch_thread_exit
= 1;
373 futex_nto1_wake(&ust_cmd_queue
.futex
);
379 static void cleanup(void)
383 struct ltt_session
*sess
, *stmp
;
387 DBG("Removing %s directory", rundir
);
388 ret
= asprintf(&cmd
, "rm -rf %s", rundir
);
390 ERR("asprintf failed. Something is really wrong!");
393 /* Remove lttng run directory */
396 ERR("Unable to clean %s", rundir
);
400 DBG("Cleaning up all sessions");
402 /* Destroy session list mutex */
403 if (session_list_ptr
!= NULL
) {
404 pthread_mutex_destroy(&session_list_ptr
->lock
);
406 /* Cleanup ALL session */
407 cds_list_for_each_entry_safe(sess
, stmp
,
408 &session_list_ptr
->head
, list
) {
409 teardown_kernel_session(sess
);
410 teardown_ust_session(sess
);
415 DBG("Closing all UST sockets");
416 ust_app_clean_list();
418 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
420 if (is_root
&& !opt_no_kernel
) {
421 DBG2("Closing kernel fd");
422 if (kernel_tracer_fd
>= 0) {
423 ret
= close(kernel_tracer_fd
);
428 DBG("Unloading kernel modules");
429 modprobe_remove_lttng_all();
433 * Closing all pipes used for communication between threads.
435 for (i
= 0; i
< 2; i
++) {
436 if (kernel_poll_pipe
[i
] >= 0) {
437 ret
= close(kernel_poll_pipe
[i
]);
444 for (i
= 0; i
< 2; i
++) {
445 if (thread_quit_pipe
[i
] >= 0) {
446 ret
= close(thread_quit_pipe
[i
]);
452 for (i
= 0; i
< 2; i
++) {
453 if (apps_cmd_pipe
[i
] >= 0) {
454 ret
= close(apps_cmd_pipe
[i
]);
462 DBG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
463 "Matthew, BEET driven development works!%c[%dm",
464 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
469 * Send data on a unix socket using the liblttsessiondcomm API.
471 * Return lttcomm error code.
473 static int send_unix_sock(int sock
, void *buf
, size_t len
)
475 /* Check valid length */
480 return lttcomm_send_unix_sock(sock
, buf
, len
);
484 * Free memory of a command context structure.
486 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
488 DBG("Clean command context structure");
490 if ((*cmd_ctx
)->llm
) {
491 free((*cmd_ctx
)->llm
);
493 if ((*cmd_ctx
)->lsm
) {
494 free((*cmd_ctx
)->lsm
);
502 * Send all stream fds of kernel channel to the consumer.
504 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
505 int sock
, struct ltt_kernel_channel
*channel
,
506 uid_t uid
, gid_t gid
)
509 struct ltt_kernel_stream
*stream
;
510 struct lttcomm_consumer_msg lkm
;
512 DBG("Sending streams of channel %s to kernel consumer",
513 channel
->channel
->name
);
516 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
517 lkm
.u
.channel
.channel_key
= channel
->fd
;
518 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
519 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
520 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
521 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
523 PERROR("send consumer channel");
528 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
532 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
533 lkm
.u
.stream
.channel_key
= channel
->fd
;
534 lkm
.u
.stream
.stream_key
= stream
->fd
;
535 lkm
.u
.stream
.state
= stream
->state
;
536 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
537 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
538 lkm
.u
.stream
.uid
= uid
;
539 lkm
.u
.stream
.gid
= gid
;
540 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
541 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
542 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
543 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
545 PERROR("send consumer stream");
548 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
550 PERROR("send consumer stream ancillary data");
555 DBG("consumer channel streams sent");
564 * Send all stream fds of the kernel session to the consumer.
566 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
567 struct ltt_kernel_session
*session
)
570 struct ltt_kernel_channel
*chan
;
571 struct lttcomm_consumer_msg lkm
;
572 int sock
= session
->consumer_fd
;
574 DBG("Sending metadata stream fd");
576 /* Extra protection. It's NOT supposed to be set to 0 at this point */
577 if (session
->consumer_fd
== 0) {
578 session
->consumer_fd
= consumer_data
->cmd_sock
;
581 if (session
->metadata_stream_fd
!= 0) {
582 /* Send metadata channel fd */
583 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
584 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
585 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
586 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
587 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
588 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
590 PERROR("send consumer channel");
594 /* Send metadata stream fd */
595 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
596 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
597 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
598 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
599 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
600 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
601 lkm
.u
.stream
.uid
= session
->uid
;
602 lkm
.u
.stream
.gid
= session
->gid
;
603 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
604 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
605 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
606 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
608 PERROR("send consumer stream");
611 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
613 PERROR("send consumer stream");
618 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
619 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
,
620 session
->uid
, session
->gid
);
626 DBG("consumer fds (metadata and channel streams) sent");
635 * Notify UST applications using the shm mmap futex.
637 static int notify_ust_apps(int active
)
641 DBG("Notifying applications of session daemon state: %d", active
);
643 /* See shm.c for this call implying mmap, shm and futex calls */
644 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
645 if (wait_shm_mmap
== NULL
) {
649 /* Wake waiting process */
650 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
652 /* Apps notified successfully */
660 * Setup the outgoing data buffer for the response (llm) by allocating the
661 * right amount of memory and copying the original information from the lsm
664 * Return total size of the buffer pointed by buf.
666 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
672 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
673 if (cmd_ctx
->llm
== NULL
) {
679 /* Copy common data */
680 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
681 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
683 cmd_ctx
->llm
->data_size
= size
;
684 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
693 * Update the kernel poll set of all channel fd available over all tracing
694 * session. Add the wakeup pipe at the end of the set.
696 static int update_kernel_poll(struct lttng_poll_event
*events
)
699 struct ltt_session
*session
;
700 struct ltt_kernel_channel
*channel
;
702 DBG("Updating kernel poll set");
705 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
706 session_lock(session
);
707 if (session
->kernel_session
== NULL
) {
708 session_unlock(session
);
712 cds_list_for_each_entry(channel
,
713 &session
->kernel_session
->channel_list
.head
, list
) {
714 /* Add channel fd to the kernel poll set */
715 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
717 session_unlock(session
);
720 DBG("Channel fd %d added to kernel set", channel
->fd
);
722 session_unlock(session
);
724 session_unlock_list();
729 session_unlock_list();
734 * Find the channel fd from 'fd' over all tracing session. When found, check
735 * for new channel stream and send those stream fds to the kernel consumer.
737 * Useful for CPU hotplug feature.
739 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
742 struct ltt_session
*session
;
743 struct ltt_kernel_channel
*channel
;
745 DBG("Updating kernel streams for channel fd %d", fd
);
748 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
749 session_lock(session
);
750 if (session
->kernel_session
== NULL
) {
751 session_unlock(session
);
755 /* This is not suppose to be 0 but this is an extra security check */
756 if (session
->kernel_session
->consumer_fd
== 0) {
757 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
760 cds_list_for_each_entry(channel
,
761 &session
->kernel_session
->channel_list
.head
, list
) {
762 if (channel
->fd
== fd
) {
763 DBG("Channel found, updating kernel streams");
764 ret
= kernel_open_channel_stream(channel
);
770 * Have we already sent fds to the consumer? If yes, it means
771 * that tracing is started so it is safe to send our updated
774 if (session
->kernel_session
->consumer_fds_sent
== 1) {
775 ret
= send_kconsumer_channel_streams(consumer_data
,
776 session
->kernel_session
->consumer_fd
, channel
,
777 session
->uid
, session
->gid
);
785 session_unlock(session
);
787 session_unlock_list();
791 session_unlock(session
);
792 session_unlock_list();
797 * For each tracing session, update newly registered apps.
799 static void update_ust_app(int app_sock
)
801 struct ltt_session
*sess
, *stmp
;
805 /* For all tracing session(s) */
806 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
808 if (sess
->ust_session
) {
809 ust_app_global_update(sess
->ust_session
, app_sock
);
811 session_unlock(sess
);
814 session_unlock_list();
818 * This thread manage event coming from the kernel.
820 * Features supported in this thread:
823 static void *thread_manage_kernel(void *data
)
825 int ret
, i
, pollfd
, update_poll_flag
= 1;
826 uint32_t revents
, nb_fd
;
828 struct lttng_poll_event events
;
830 DBG("Thread manage kernel started");
832 ret
= create_thread_poll_set(&events
, 2);
834 goto error_poll_create
;
837 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
843 if (update_poll_flag
== 1) {
845 * Reset number of fd in the poll set. Always 2 since there is the thread
846 * quit pipe and the kernel pipe.
850 ret
= update_kernel_poll(&events
);
854 update_poll_flag
= 0;
857 nb_fd
= LTTNG_POLL_GETNB(&events
);
859 DBG("Thread kernel polling on %d fds", nb_fd
);
861 /* Zeroed the poll events */
862 lttng_poll_reset(&events
);
864 /* Poll infinite value of time */
866 ret
= lttng_poll_wait(&events
, -1);
869 * Restart interrupted system call.
871 if (errno
== EINTR
) {
875 } else if (ret
== 0) {
876 /* Should not happen since timeout is infinite */
877 ERR("Return value of poll is 0 with an infinite timeout.\n"
878 "This should not have happened! Continuing...");
882 for (i
= 0; i
< nb_fd
; i
++) {
883 /* Fetch once the poll data */
884 revents
= LTTNG_POLL_GETEV(&events
, i
);
885 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
887 /* Thread quit pipe has been closed. Killing thread. */
888 ret
= check_thread_quit_pipe(pollfd
, revents
);
893 /* Check for data on kernel pipe */
894 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
895 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
896 update_poll_flag
= 1;
900 * New CPU detected by the kernel. Adding kernel stream to
901 * kernel session and updating the kernel consumer
903 if (revents
& LPOLLIN
) {
904 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
910 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
911 * and unregister kernel stream at this point.
919 lttng_poll_clean(&events
);
921 DBG("Kernel thread dying");
926 * This thread manage the consumer error sent back to the session daemon.
928 static void *thread_manage_consumer(void *data
)
930 int sock
= -1, i
, ret
, pollfd
;
931 uint32_t revents
, nb_fd
;
932 enum lttcomm_return_code code
;
933 struct lttng_poll_event events
;
934 struct consumer_data
*consumer_data
= data
;
936 DBG("[thread] Manage consumer started");
938 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
944 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
945 * Nothing more will be added to this poll set.
947 ret
= create_thread_poll_set(&events
, 2);
952 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
957 nb_fd
= LTTNG_POLL_GETNB(&events
);
959 /* Inifinite blocking call, waiting for transmission */
961 ret
= lttng_poll_wait(&events
, -1);
964 * Restart interrupted system call.
966 if (errno
== EINTR
) {
972 for (i
= 0; i
< nb_fd
; i
++) {
973 /* Fetch once the poll data */
974 revents
= LTTNG_POLL_GETEV(&events
, i
);
975 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
977 /* Thread quit pipe has been closed. Killing thread. */
978 ret
= check_thread_quit_pipe(pollfd
, revents
);
983 /* Event on the registration socket */
984 if (pollfd
== consumer_data
->err_sock
) {
985 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
986 ERR("consumer err socket poll error");
992 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
997 DBG2("Receiving code from consumer err_sock");
999 /* Getting status code from kconsumerd */
1000 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1001 sizeof(enum lttcomm_return_code
));
1006 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
1007 consumer_data
->cmd_sock
=
1008 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
1009 if (consumer_data
->cmd_sock
< 0) {
1010 sem_post(&consumer_data
->sem
);
1011 PERROR("consumer connect");
1014 /* Signal condition to tell that the kconsumerd is ready */
1015 sem_post(&consumer_data
->sem
);
1016 DBG("consumer command socket ready");
1018 ERR("consumer error when waiting for SOCK_READY : %s",
1019 lttcomm_get_readable_code(-code
));
1023 /* Remove the kconsumerd error sock since we've established a connexion */
1024 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
1029 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1034 /* Update number of fd */
1035 nb_fd
= LTTNG_POLL_GETNB(&events
);
1037 /* Inifinite blocking call, waiting for transmission */
1039 ret
= lttng_poll_wait(&events
, -1);
1042 * Restart interrupted system call.
1044 if (errno
== EINTR
) {
1050 for (i
= 0; i
< nb_fd
; i
++) {
1051 /* Fetch once the poll data */
1052 revents
= LTTNG_POLL_GETEV(&events
, i
);
1053 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1055 /* Thread quit pipe has been closed. Killing thread. */
1056 ret
= check_thread_quit_pipe(pollfd
, revents
);
1061 /* Event on the kconsumerd socket */
1062 if (pollfd
== sock
) {
1063 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1064 ERR("consumer err socket second poll error");
1070 /* Wait for any kconsumerd error */
1071 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1072 sizeof(enum lttcomm_return_code
));
1074 ERR("consumer closed the command socket");
1078 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1081 if (consumer_data
->err_sock
>= 0) {
1082 ret
= close(consumer_data
->err_sock
);
1087 if (consumer_data
->cmd_sock
>= 0) {
1088 ret
= close(consumer_data
->cmd_sock
);
1100 unlink(consumer_data
->err_unix_sock_path
);
1101 unlink(consumer_data
->cmd_unix_sock_path
);
1102 consumer_data
->pid
= 0;
1104 lttng_poll_clean(&events
);
1107 DBG("consumer thread cleanup completed");
1113 * This thread manage application communication.
1115 static void *thread_manage_apps(void *data
)
1118 uint32_t revents
, nb_fd
;
1119 struct ust_command ust_cmd
;
1120 struct lttng_poll_event events
;
1122 DBG("[thread] Manage application started");
1124 rcu_register_thread();
1125 rcu_thread_online();
1127 ret
= create_thread_poll_set(&events
, 2);
1129 goto error_poll_create
;
1132 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1138 /* Zeroed the events structure */
1139 lttng_poll_reset(&events
);
1141 nb_fd
= LTTNG_POLL_GETNB(&events
);
1143 DBG("Apps thread polling on %d fds", nb_fd
);
1145 /* Inifinite blocking call, waiting for transmission */
1147 ret
= lttng_poll_wait(&events
, -1);
1150 * Restart interrupted system call.
1152 if (errno
== EINTR
) {
1158 for (i
= 0; i
< nb_fd
; i
++) {
1159 /* Fetch once the poll data */
1160 revents
= LTTNG_POLL_GETEV(&events
, i
);
1161 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1163 /* Thread quit pipe has been closed. Killing thread. */
1164 ret
= check_thread_quit_pipe(pollfd
, revents
);
1169 /* Inspect the apps cmd pipe */
1170 if (pollfd
== apps_cmd_pipe
[0]) {
1171 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1172 ERR("Apps command pipe error");
1174 } else if (revents
& LPOLLIN
) {
1176 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1177 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1178 PERROR("read apps cmd pipe");
1182 /* Register applicaton to the session daemon */
1183 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1185 if (ret
== -ENOMEM
) {
1187 } else if (ret
< 0) {
1192 * Validate UST version compatibility.
1194 ret
= ust_app_validate_version(ust_cmd
.sock
);
1197 * Add channel(s) and event(s) to newly registered apps
1198 * from lttng global UST domain.
1200 update_ust_app(ust_cmd
.sock
);
1203 ret
= ust_app_register_done(ust_cmd
.sock
);
1206 * If the registration is not possible, we simply
1207 * unregister the apps and continue
1209 ust_app_unregister(ust_cmd
.sock
);
1212 * We just need here to monitor the close of the UST
1213 * socket and poll set monitor those by default.
1214 * Listen on POLLIN (even if we never expect any
1215 * data) to ensure that hangup wakes us.
1217 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, LPOLLIN
);
1222 DBG("Apps with sock %d added to poll set",
1230 * At this point, we know that a registered application made
1231 * the event at poll_wait.
1233 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1234 /* Removing from the poll set */
1235 ret
= lttng_poll_del(&events
, pollfd
);
1240 /* Socket closed on remote end. */
1241 ust_app_unregister(pollfd
);
1249 lttng_poll_clean(&events
);
1251 DBG("Application communication apps thread cleanup complete");
1252 rcu_thread_offline();
1253 rcu_unregister_thread();
1258 * Dispatch request from the registration threads to the application
1259 * communication thread.
1261 static void *thread_dispatch_ust_registration(void *data
)
1264 struct cds_wfq_node
*node
;
1265 struct ust_command
*ust_cmd
= NULL
;
1267 DBG("[thread] Dispatch UST command started");
1269 while (!dispatch_thread_exit
) {
1270 /* Atomically prepare the queue futex */
1271 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1274 /* Dequeue command for registration */
1275 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1277 DBG("Woken up but nothing in the UST command queue");
1278 /* Continue thread execution */
1282 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1284 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1285 " gid:%d sock:%d name:%s (version %d.%d)",
1286 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1287 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1288 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1289 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1291 * Inform apps thread of the new application registration. This
1292 * call is blocking so we can be assured that the data will be read
1293 * at some point in time or wait to the end of the world :)
1295 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1296 sizeof(struct ust_command
));
1298 PERROR("write apps cmd pipe");
1299 if (errno
== EBADF
) {
1301 * We can't inform the application thread to process
1302 * registration. We will exit or else application
1303 * registration will not occur and tracing will never
1310 } while (node
!= NULL
);
1312 /* Futex wait on queue. Blocking call on futex() */
1313 futex_nto1_wait(&ust_cmd_queue
.futex
);
1317 DBG("Dispatch thread dying");
1322 * This thread manage application registration.
1324 static void *thread_registration_apps(void *data
)
1326 int sock
= -1, i
, ret
, pollfd
;
1327 uint32_t revents
, nb_fd
;
1328 struct lttng_poll_event events
;
1330 * Get allocated in this thread, enqueued to a global queue, dequeued and
1331 * freed in the manage apps thread.
1333 struct ust_command
*ust_cmd
= NULL
;
1335 DBG("[thread] Manage application registration started");
1337 ret
= lttcomm_listen_unix_sock(apps_sock
);
1343 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1344 * more will be added to this poll set.
1346 ret
= create_thread_poll_set(&events
, 2);
1348 goto error_create_poll
;
1351 /* Add the application registration socket */
1352 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1354 goto error_poll_add
;
1357 /* Notify all applications to register */
1358 ret
= notify_ust_apps(1);
1360 ERR("Failed to notify applications or create the wait shared memory.\n"
1361 "Execution continues but there might be problem for already\n"
1362 "running applications that wishes to register.");
1366 DBG("Accepting application registration");
1368 nb_fd
= LTTNG_POLL_GETNB(&events
);
1370 /* Inifinite blocking call, waiting for transmission */
1372 ret
= lttng_poll_wait(&events
, -1);
1375 * Restart interrupted system call.
1377 if (errno
== EINTR
) {
1383 for (i
= 0; i
< nb_fd
; i
++) {
1384 /* Fetch once the poll data */
1385 revents
= LTTNG_POLL_GETEV(&events
, i
);
1386 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1388 /* Thread quit pipe has been closed. Killing thread. */
1389 ret
= check_thread_quit_pipe(pollfd
, revents
);
1394 /* Event on the registration socket */
1395 if (pollfd
== apps_sock
) {
1396 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1397 ERR("Register apps socket poll error");
1399 } else if (revents
& LPOLLIN
) {
1400 sock
= lttcomm_accept_unix_sock(apps_sock
);
1405 /* Create UST registration command for enqueuing */
1406 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1407 if (ust_cmd
== NULL
) {
1408 PERROR("ust command zmalloc");
1413 * Using message-based transmissions to ensure we don't
1414 * have to deal with partially received messages.
1416 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1417 sizeof(struct ust_register_msg
));
1418 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1420 PERROR("lttcomm_recv_unix_sock register apps");
1422 ERR("Wrong size received on apps register");
1433 ust_cmd
->sock
= sock
;
1435 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1436 " gid:%d sock:%d name:%s (version %d.%d)",
1437 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1438 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1439 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1440 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1443 * Lock free enqueue the registration request. The red pill
1444 * has been taken! This apps will be part of the *system*.
1446 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1449 * Wake the registration queue futex. Implicit memory
1450 * barrier with the exchange in cds_wfq_enqueue.
1452 futex_nto1_wake(&ust_cmd_queue
.futex
);
1459 /* Notify that the registration thread is gone */
1462 if (apps_sock
>= 0) {
1463 ret
= close(apps_sock
);
1474 unlink(apps_unix_sock_path
);
1477 lttng_poll_clean(&events
);
1480 DBG("UST Registration thread cleanup complete");
1486 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1487 * exec or it will fails.
1489 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1492 struct timespec timeout
;
1494 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1495 timeout
.tv_nsec
= 0;
1497 /* Setup semaphore */
1498 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1500 PERROR("sem_init consumer semaphore");
1504 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1505 thread_manage_consumer
, consumer_data
);
1507 PERROR("pthread_create consumer");
1512 /* Get time for sem_timedwait absolute timeout */
1513 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1515 PERROR("clock_gettime spawn consumer");
1516 /* Infinite wait for the kconsumerd thread to be ready */
1517 ret
= sem_wait(&consumer_data
->sem
);
1519 /* Normal timeout if the gettime was successful */
1520 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1521 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1525 if (errno
== ETIMEDOUT
) {
1527 * Call has timed out so we kill the kconsumerd_thread and return
1530 ERR("The consumer thread was never ready. Killing it");
1531 ret
= pthread_cancel(consumer_data
->thread
);
1533 PERROR("pthread_cancel consumer thread");
1536 PERROR("semaphore wait failed consumer thread");
1541 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1542 if (consumer_data
->pid
== 0) {
1543 ERR("Kconsumerd did not start");
1544 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1547 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1556 * Join consumer thread
1558 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1563 if (consumer_data
->pid
!= 0) {
1564 ret
= kill(consumer_data
->pid
, SIGTERM
);
1566 ERR("Error killing consumer daemon");
1569 return pthread_join(consumer_data
->thread
, &status
);
1576 * Fork and exec a consumer daemon (consumerd).
1578 * Return pid if successful else -1.
1580 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1584 const char *consumer_to_use
;
1585 const char *verbosity
;
1588 DBG("Spawning consumerd");
1595 if (opt_verbose_consumer
) {
1596 verbosity
= "--verbose";
1598 verbosity
= "--quiet";
1600 switch (consumer_data
->type
) {
1601 case LTTNG_CONSUMER_KERNEL
:
1603 * Find out which consumerd to execute. We will first try the
1604 * 64-bit path, then the sessiond's installation directory, and
1605 * fallback on the 32-bit one,
1607 DBG3("Looking for a kernel consumer at these locations:");
1608 DBG3(" 1) %s", consumerd64_bin
);
1609 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, CONSUMERD_FILE
);
1610 DBG3(" 3) %s", consumerd32_bin
);
1611 if (stat(consumerd64_bin
, &st
) == 0) {
1612 DBG3("Found location #1");
1613 consumer_to_use
= consumerd64_bin
;
1614 } else if (stat(INSTALL_BIN_PATH
"/" CONSUMERD_FILE
, &st
) == 0) {
1615 DBG3("Found location #2");
1616 consumer_to_use
= INSTALL_BIN_PATH
"/" CONSUMERD_FILE
;
1617 } else if (stat(consumerd32_bin
, &st
) == 0) {
1618 DBG3("Found location #3");
1619 consumer_to_use
= consumerd32_bin
;
1621 DBG("Could not find any valid consumerd executable");
1624 DBG("Using kernel consumer at: %s", consumer_to_use
);
1625 execl(consumer_to_use
,
1626 "lttng-consumerd", verbosity
, "-k",
1627 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1628 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1631 case LTTNG_CONSUMER64_UST
:
1633 char *tmpnew
= NULL
;
1635 if (consumerd64_libdir
[0] != '\0') {
1639 tmp
= getenv("LD_LIBRARY_PATH");
1643 tmplen
= strlen("LD_LIBRARY_PATH=")
1644 + strlen(consumerd64_libdir
) + 1 /* : */ + strlen(tmp
);
1645 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1650 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1651 strcat(tmpnew
, consumerd64_libdir
);
1652 if (tmp
[0] != '\0') {
1653 strcat(tmpnew
, ":");
1654 strcat(tmpnew
, tmp
);
1656 ret
= putenv(tmpnew
);
1662 DBG("Using 64-bit UST consumer at: %s", consumerd64_bin
);
1663 ret
= execl(consumerd64_bin
, "lttng-consumerd", verbosity
, "-u",
1664 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1665 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1667 if (consumerd64_libdir
[0] != '\0') {
1675 case LTTNG_CONSUMER32_UST
:
1677 char *tmpnew
= NULL
;
1679 if (consumerd32_libdir
[0] != '\0') {
1683 tmp
= getenv("LD_LIBRARY_PATH");
1687 tmplen
= strlen("LD_LIBRARY_PATH=")
1688 + strlen(consumerd32_libdir
) + 1 /* : */ + strlen(tmp
);
1689 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
1694 strcpy(tmpnew
, "LD_LIBRARY_PATH=");
1695 strcat(tmpnew
, consumerd32_libdir
);
1696 if (tmp
[0] != '\0') {
1697 strcat(tmpnew
, ":");
1698 strcat(tmpnew
, tmp
);
1700 ret
= putenv(tmpnew
);
1706 DBG("Using 32-bit UST consumer at: %s", consumerd32_bin
);
1707 ret
= execl(consumerd32_bin
, "lttng-consumerd", verbosity
, "-u",
1708 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1709 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1711 if (consumerd32_libdir
[0] != '\0') {
1720 PERROR("unknown consumer type");
1724 PERROR("kernel start consumer exec");
1727 } else if (pid
> 0) {
1730 PERROR("start consumer fork");
1738 * Spawn the consumerd daemon and session daemon thread.
1740 static int start_consumerd(struct consumer_data
*consumer_data
)
1744 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1745 if (consumer_data
->pid
!= 0) {
1746 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1750 ret
= spawn_consumerd(consumer_data
);
1752 ERR("Spawning consumerd failed");
1753 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1757 /* Setting up the consumer_data pid */
1758 consumer_data
->pid
= ret
;
1759 DBG2("Consumer pid %d", consumer_data
->pid
);
1760 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1762 DBG2("Spawning consumer control thread");
1763 ret
= spawn_consumer_thread(consumer_data
);
1765 ERR("Fatal error spawning consumer control thread");
1777 * Check version of the lttng-modules.
1779 static int validate_lttng_modules_version(void)
1781 return kernel_validate_version(kernel_tracer_fd
);
1785 * Setup necessary data for kernel tracer action.
1787 static int init_kernel_tracer(void)
1791 /* Modprobe lttng kernel modules */
1792 ret
= modprobe_lttng_control();
1797 /* Open debugfs lttng */
1798 kernel_tracer_fd
= open(module_proc_lttng
, O_RDWR
);
1799 if (kernel_tracer_fd
< 0) {
1800 DBG("Failed to open %s", module_proc_lttng
);
1805 /* Validate kernel version */
1806 ret
= validate_lttng_modules_version();
1811 ret
= modprobe_lttng_data();
1816 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1820 modprobe_remove_lttng_control();
1821 ret
= close(kernel_tracer_fd
);
1825 kernel_tracer_fd
= -1;
1826 return LTTCOMM_KERN_VERSION
;
1829 ret
= close(kernel_tracer_fd
);
1835 modprobe_remove_lttng_control();
1838 WARN("No kernel tracer available");
1839 kernel_tracer_fd
= -1;
1840 return LTTCOMM_KERN_NA
;
1844 * Init tracing by creating trace directory and sending fds kernel consumer.
1846 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1850 if (session
->consumer_fds_sent
== 0) {
1852 * Assign default kernel consumer socket if no consumer assigned to the
1853 * kernel session. At this point, it's NOT suppose to be 0 but this is
1854 * an extra security check.
1856 if (session
->consumer_fd
== 0) {
1857 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1860 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1862 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1866 session
->consumer_fds_sent
= 1;
1874 * Create an UST session and add it to the session ust list.
1876 static int create_ust_session(struct ltt_session
*session
,
1877 struct lttng_domain
*domain
)
1879 struct ltt_ust_session
*lus
= NULL
;
1882 switch (domain
->type
) {
1883 case LTTNG_DOMAIN_UST
:
1886 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1890 DBG("Creating UST session");
1892 lus
= trace_ust_create_session(session
->path
, session
->id
, domain
);
1894 ret
= LTTCOMM_UST_SESS_FAIL
;
1898 ret
= run_as_mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1899 session
->uid
, session
->gid
);
1901 if (ret
!= -EEXIST
) {
1902 ERR("Trace directory creation error");
1903 ret
= LTTCOMM_UST_SESS_FAIL
;
1908 /* The domain type dictate different actions on session creation */
1909 switch (domain
->type
) {
1910 case LTTNG_DOMAIN_UST
:
1911 /* No ustctl for the global UST domain */
1914 ERR("Unknown UST domain on create session %d", domain
->type
);
1917 lus
->uid
= session
->uid
;
1918 lus
->gid
= session
->gid
;
1919 session
->ust_session
= lus
;
1929 * Create a kernel tracer session then create the default channel.
1931 static int create_kernel_session(struct ltt_session
*session
)
1935 DBG("Creating kernel session");
1937 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1939 ret
= LTTCOMM_KERN_SESS_FAIL
;
1943 /* Set kernel consumer socket fd */
1944 if (kconsumer_data
.cmd_sock
) {
1945 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1948 ret
= run_as_mkdir_recursive(session
->kernel_session
->trace_path
,
1949 S_IRWXU
| S_IRWXG
, session
->uid
, session
->gid
);
1951 if (ret
!= -EEXIST
) {
1952 ERR("Trace directory creation error");
1956 session
->kernel_session
->uid
= session
->uid
;
1957 session
->kernel_session
->gid
= session
->gid
;
1964 * Check if the UID or GID match the session. Root user has access to all
1967 static int session_access_ok(struct ltt_session
*session
, uid_t uid
, gid_t gid
)
1969 if (uid
!= session
->uid
&& gid
!= session
->gid
&& uid
!= 0) {
1976 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
1979 struct ltt_session
*session
;
1981 DBG("Counting number of available session for UID %d GID %d",
1983 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1985 * Only list the sessions the user can control.
1987 if (!session_access_ok(session
, uid
, gid
)) {
1996 * Using the session list, filled a lttng_session array to send back to the
1997 * client for session listing.
1999 * The session list lock MUST be acquired before calling this function. Use
2000 * session_lock_list() and session_unlock_list().
2002 static void list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2006 struct ltt_session
*session
;
2008 DBG("Getting all available session for UID %d GID %d",
2011 * Iterate over session list and append data after the control struct in
2014 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
2016 * Only list the sessions the user can control.
2018 if (!session_access_ok(session
, uid
, gid
)) {
2021 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
2022 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
2023 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2024 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2025 sessions
[i
].enabled
= session
->enabled
;
2031 * Fill lttng_channel array of all channels.
2033 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
2034 struct lttng_channel
*channels
)
2037 struct ltt_kernel_channel
*kchan
;
2039 DBG("Listing channels for session %s", session
->name
);
2042 case LTTNG_DOMAIN_KERNEL
:
2043 /* Kernel channels */
2044 if (session
->kernel_session
!= NULL
) {
2045 cds_list_for_each_entry(kchan
,
2046 &session
->kernel_session
->channel_list
.head
, list
) {
2047 /* Copy lttng_channel struct to array */
2048 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
2049 channels
[i
].enabled
= kchan
->enabled
;
2054 case LTTNG_DOMAIN_UST
:
2056 struct lttng_ht_iter iter
;
2057 struct ltt_ust_channel
*uchan
;
2059 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
2060 &iter
.iter
, uchan
, node
.node
) {
2061 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
2062 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
2063 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2064 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2065 channels
[i
].attr
.switch_timer_interval
=
2066 uchan
->attr
.switch_timer_interval
;
2067 channels
[i
].attr
.read_timer_interval
=
2068 uchan
->attr
.read_timer_interval
;
2069 channels
[i
].enabled
= uchan
->enabled
;
2070 switch (uchan
->attr
.output
) {
2071 case LTTNG_UST_MMAP
:
2073 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
2086 * Create a list of ust global domain events.
2088 static int list_lttng_ust_global_events(char *channel_name
,
2089 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
2092 unsigned int nb_event
= 0;
2093 struct lttng_ht_iter iter
;
2094 struct lttng_ht_node_str
*node
;
2095 struct ltt_ust_channel
*uchan
;
2096 struct ltt_ust_event
*uevent
;
2097 struct lttng_event
*tmp
;
2099 DBG("Listing UST global events for channel %s", channel_name
);
2103 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
2104 node
= lttng_ht_iter_get_node_str(&iter
);
2106 ret
= -LTTCOMM_UST_CHAN_NOT_FOUND
;
2110 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
2112 nb_event
+= lttng_ht_get_count(uchan
->events
);
2114 if (nb_event
== 0) {
2119 DBG3("Listing UST global %d events", nb_event
);
2121 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2123 ret
= -LTTCOMM_FATAL
;
2127 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
2128 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
2129 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2130 tmp
[i
].enabled
= uevent
->enabled
;
2131 switch (uevent
->attr
.instrumentation
) {
2132 case LTTNG_UST_TRACEPOINT
:
2133 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2135 case LTTNG_UST_PROBE
:
2136 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
2138 case LTTNG_UST_FUNCTION
:
2139 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
2142 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
2143 switch (uevent
->attr
.loglevel_type
) {
2144 case LTTNG_UST_LOGLEVEL_ALL
:
2145 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2147 case LTTNG_UST_LOGLEVEL_RANGE
:
2148 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
2150 case LTTNG_UST_LOGLEVEL_SINGLE
:
2151 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
2166 * Fill lttng_event array of all kernel events in the channel.
2168 static int list_lttng_kernel_events(char *channel_name
,
2169 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2172 unsigned int nb_event
;
2173 struct ltt_kernel_event
*event
;
2174 struct ltt_kernel_channel
*kchan
;
2176 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2177 if (kchan
== NULL
) {
2178 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2182 nb_event
= kchan
->event_count
;
2184 DBG("Listing events for channel %s", kchan
->channel
->name
);
2186 if (nb_event
== 0) {
2191 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2192 if (*events
== NULL
) {
2193 ret
= LTTCOMM_FATAL
;
2197 /* Kernel channels */
2198 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2199 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2200 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2201 (*events
)[i
].enabled
= event
->enabled
;
2202 switch (event
->event
->instrumentation
) {
2203 case LTTNG_KERNEL_TRACEPOINT
:
2204 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2206 case LTTNG_KERNEL_KPROBE
:
2207 case LTTNG_KERNEL_KRETPROBE
:
2208 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2209 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2210 sizeof(struct lttng_kernel_kprobe
));
2212 case LTTNG_KERNEL_FUNCTION
:
2213 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2214 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2215 sizeof(struct lttng_kernel_function
));
2217 case LTTNG_KERNEL_NOOP
:
2218 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2220 case LTTNG_KERNEL_SYSCALL
:
2221 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2223 case LTTNG_KERNEL_ALL
:
2237 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2239 static int cmd_disable_channel(struct ltt_session
*session
,
2240 int domain
, char *channel_name
)
2243 struct ltt_ust_session
*usess
;
2245 usess
= session
->ust_session
;
2248 case LTTNG_DOMAIN_KERNEL
:
2250 ret
= channel_kernel_disable(session
->kernel_session
,
2252 if (ret
!= LTTCOMM_OK
) {
2256 kernel_wait_quiescent(kernel_tracer_fd
);
2259 case LTTNG_DOMAIN_UST
:
2261 struct ltt_ust_channel
*uchan
;
2262 struct lttng_ht
*chan_ht
;
2264 chan_ht
= usess
->domain_global
.channels
;
2266 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
2267 if (uchan
== NULL
) {
2268 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2272 ret
= channel_ust_disable(usess
, domain
, uchan
);
2273 if (ret
!= LTTCOMM_OK
) {
2279 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2280 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2281 case LTTNG_DOMAIN_UST_PID
:
2284 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2295 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2297 static int cmd_enable_channel(struct ltt_session
*session
,
2298 int domain
, struct lttng_channel
*attr
)
2301 struct ltt_ust_session
*usess
= session
->ust_session
;
2302 struct lttng_ht
*chan_ht
;
2304 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2307 case LTTNG_DOMAIN_KERNEL
:
2309 struct ltt_kernel_channel
*kchan
;
2311 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2312 session
->kernel_session
);
2313 if (kchan
== NULL
) {
2314 ret
= channel_kernel_create(session
->kernel_session
,
2315 attr
, kernel_poll_pipe
[1]);
2317 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2320 if (ret
!= LTTCOMM_OK
) {
2324 kernel_wait_quiescent(kernel_tracer_fd
);
2327 case LTTNG_DOMAIN_UST
:
2329 struct ltt_ust_channel
*uchan
;
2331 chan_ht
= usess
->domain_global
.channels
;
2333 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
2334 if (uchan
== NULL
) {
2335 ret
= channel_ust_create(usess
, domain
, attr
);
2337 ret
= channel_ust_enable(usess
, domain
, uchan
);
2342 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2343 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2344 case LTTNG_DOMAIN_UST_PID
:
2347 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2356 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2358 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2359 char *channel_name
, char *event_name
)
2364 case LTTNG_DOMAIN_KERNEL
:
2366 struct ltt_kernel_channel
*kchan
;
2367 struct ltt_kernel_session
*ksess
;
2369 ksess
= session
->kernel_session
;
2371 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2372 if (kchan
== NULL
) {
2373 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2377 ret
= event_kernel_disable_tracepoint(ksess
, kchan
, event_name
);
2378 if (ret
!= LTTCOMM_OK
) {
2382 kernel_wait_quiescent(kernel_tracer_fd
);
2385 case LTTNG_DOMAIN_UST
:
2387 struct ltt_ust_channel
*uchan
;
2388 struct ltt_ust_session
*usess
;
2390 usess
= session
->ust_session
;
2392 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2394 if (uchan
== NULL
) {
2395 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2399 ret
= event_ust_disable_tracepoint(usess
, domain
, uchan
, event_name
);
2400 if (ret
!= LTTCOMM_OK
) {
2404 DBG3("Disable UST event %s in channel %s completed", event_name
,
2409 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2410 case LTTNG_DOMAIN_UST_PID
:
2411 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2425 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2427 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2433 case LTTNG_DOMAIN_KERNEL
:
2435 struct ltt_kernel_session
*ksess
;
2436 struct ltt_kernel_channel
*kchan
;
2438 ksess
= session
->kernel_session
;
2440 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
2441 if (kchan
== NULL
) {
2442 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2446 ret
= event_kernel_disable_all(ksess
, kchan
);
2447 if (ret
!= LTTCOMM_OK
) {
2451 kernel_wait_quiescent(kernel_tracer_fd
);
2454 case LTTNG_DOMAIN_UST
:
2456 struct ltt_ust_session
*usess
;
2457 struct ltt_ust_channel
*uchan
;
2459 usess
= session
->ust_session
;
2461 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2463 if (uchan
== NULL
) {
2464 ret
= LTTCOMM_UST_CHAN_NOT_FOUND
;
2468 ret
= event_ust_disable_all_tracepoints(usess
, domain
, uchan
);
2473 DBG3("Disable all UST events in channel %s completed", channel_name
);
2478 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2479 case LTTNG_DOMAIN_UST_PID
:
2480 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2494 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2496 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2497 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2502 case LTTNG_DOMAIN_KERNEL
:
2503 /* Add kernel context to kernel tracer */
2504 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2505 event_name
, channel_name
);
2506 if (ret
!= LTTCOMM_OK
) {
2510 case LTTNG_DOMAIN_UST
:
2512 struct ltt_ust_session
*usess
= session
->ust_session
;
2514 ret
= context_ust_add(usess
, domain
, ctx
, event_name
, channel_name
);
2515 if (ret
!= LTTCOMM_OK
) {
2521 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2522 case LTTNG_DOMAIN_UST_PID
:
2523 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2537 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2539 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2540 char *channel_name
, struct lttng_event
*event
)
2543 struct lttng_channel
*attr
;
2544 struct ltt_ust_session
*usess
= session
->ust_session
;
2547 case LTTNG_DOMAIN_KERNEL
:
2549 struct ltt_kernel_channel
*kchan
;
2551 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2552 session
->kernel_session
);
2553 if (kchan
== NULL
) {
2554 attr
= channel_new_default_attr(domain
);
2556 ret
= LTTCOMM_FATAL
;
2559 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2561 /* This call will notify the kernel thread */
2562 ret
= channel_kernel_create(session
->kernel_session
,
2563 attr
, kernel_poll_pipe
[1]);
2564 if (ret
!= LTTCOMM_OK
) {
2571 /* Get the newly created kernel channel pointer */
2572 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2573 session
->kernel_session
);
2574 if (kchan
== NULL
) {
2575 /* This sould not happen... */
2576 ret
= LTTCOMM_FATAL
;
2580 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2582 if (ret
!= LTTCOMM_OK
) {
2586 kernel_wait_quiescent(kernel_tracer_fd
);
2589 case LTTNG_DOMAIN_UST
:
2591 struct lttng_channel
*attr
;
2592 struct ltt_ust_channel
*uchan
;
2594 /* Get channel from global UST domain */
2595 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2597 if (uchan
== NULL
) {
2598 /* Create default channel */
2599 attr
= channel_new_default_attr(domain
);
2601 ret
= LTTCOMM_FATAL
;
2604 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2605 attr
->name
[NAME_MAX
- 1] = '\0';
2607 ret
= channel_ust_create(usess
, domain
, attr
);
2608 if (ret
!= LTTCOMM_OK
) {
2614 /* Get the newly created channel reference back */
2615 uchan
= trace_ust_find_channel_by_name(
2616 usess
->domain_global
.channels
, channel_name
);
2617 if (uchan
== NULL
) {
2618 /* Something is really wrong */
2619 ret
= LTTCOMM_FATAL
;
2624 /* At this point, the session and channel exist on the tracer */
2625 ret
= event_ust_enable_tracepoint(usess
, domain
, uchan
, event
);
2626 if (ret
!= LTTCOMM_OK
) {
2632 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2633 case LTTNG_DOMAIN_UST_PID
:
2634 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2648 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2650 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2651 char *channel_name
, int event_type
)
2654 struct ltt_kernel_channel
*kchan
;
2657 case LTTNG_DOMAIN_KERNEL
:
2658 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2659 session
->kernel_session
);
2660 if (kchan
== NULL
) {
2661 /* This call will notify the kernel thread */
2662 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2663 kernel_poll_pipe
[1]);
2664 if (ret
!= LTTCOMM_OK
) {
2668 /* Get the newly created kernel channel pointer */
2669 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2670 session
->kernel_session
);
2671 if (kchan
== NULL
) {
2672 /* This sould not happen... */
2673 ret
= LTTCOMM_FATAL
;
2679 switch (event_type
) {
2680 case LTTNG_EVENT_SYSCALL
:
2681 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2682 kchan
, kernel_tracer_fd
);
2684 case LTTNG_EVENT_TRACEPOINT
:
2686 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2687 * events already registered to the channel.
2689 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2690 kchan
, kernel_tracer_fd
);
2692 case LTTNG_EVENT_ALL
:
2693 /* Enable syscalls and tracepoints */
2694 ret
= event_kernel_enable_all(session
->kernel_session
,
2695 kchan
, kernel_tracer_fd
);
2698 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2702 /* Manage return value */
2703 if (ret
!= LTTCOMM_OK
) {
2707 kernel_wait_quiescent(kernel_tracer_fd
);
2709 case LTTNG_DOMAIN_UST
:
2711 struct lttng_channel
*attr
;
2712 struct ltt_ust_channel
*uchan
;
2713 struct ltt_ust_session
*usess
= session
->ust_session
;
2715 /* Get channel from global UST domain */
2716 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2718 if (uchan
== NULL
) {
2719 /* Create default channel */
2720 attr
= channel_new_default_attr(domain
);
2722 ret
= LTTCOMM_FATAL
;
2725 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2726 attr
->name
[NAME_MAX
- 1] = '\0';
2728 /* Use the internal command enable channel */
2729 ret
= channel_ust_create(usess
, domain
, attr
);
2730 if (ret
!= LTTCOMM_OK
) {
2736 /* Get the newly created channel reference back */
2737 uchan
= trace_ust_find_channel_by_name(
2738 usess
->domain_global
.channels
, channel_name
);
2739 if (uchan
== NULL
) {
2740 /* Something is really wrong */
2741 ret
= LTTCOMM_FATAL
;
2746 /* At this point, the session and channel exist on the tracer */
2748 switch (event_type
) {
2749 case LTTNG_EVENT_ALL
:
2750 case LTTNG_EVENT_TRACEPOINT
:
2751 ret
= event_ust_enable_all_tracepoints(usess
, domain
, uchan
);
2752 if (ret
!= LTTCOMM_OK
) {
2757 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2761 /* Manage return value */
2762 if (ret
!= LTTCOMM_OK
) {
2769 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2770 case LTTNG_DOMAIN_UST_PID
:
2771 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2785 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2787 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2790 ssize_t nb_events
= 0;
2793 case LTTNG_DOMAIN_KERNEL
:
2794 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2795 if (nb_events
< 0) {
2796 ret
= LTTCOMM_KERN_LIST_FAIL
;
2800 case LTTNG_DOMAIN_UST
:
2801 nb_events
= ust_app_list_events(events
);
2802 if (nb_events
< 0) {
2803 ret
= LTTCOMM_UST_LIST_FAIL
;
2815 /* Return negative value to differentiate return code */
2820 * Command LTTNG_START_TRACE processed by the client thread.
2822 static int cmd_start_trace(struct ltt_session
*session
)
2825 struct ltt_kernel_session
*ksession
;
2826 struct ltt_ust_session
*usess
;
2829 ksession
= session
->kernel_session
;
2830 usess
= session
->ust_session
;
2832 if (session
->enabled
) {
2833 ret
= LTTCOMM_UST_START_FAIL
;
2837 session
->enabled
= 1;
2839 /* Kernel tracing */
2840 if (ksession
!= NULL
) {
2841 struct ltt_kernel_channel
*kchan
;
2843 /* Open kernel metadata */
2844 if (ksession
->metadata
== NULL
) {
2845 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2847 ret
= LTTCOMM_KERN_META_FAIL
;
2852 /* Open kernel metadata stream */
2853 if (ksession
->metadata_stream_fd
== 0) {
2854 ret
= kernel_open_metadata_stream(ksession
);
2856 ERR("Kernel create metadata stream failed");
2857 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2862 /* For each channel */
2863 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2864 if (kchan
->stream_count
== 0) {
2865 ret
= kernel_open_channel_stream(kchan
);
2867 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2870 /* Update the stream global counter */
2871 ksession
->stream_count_global
+= ret
;
2875 /* Setup kernel consumer socket and send fds to it */
2876 ret
= init_kernel_tracing(ksession
);
2878 ret
= LTTCOMM_KERN_START_FAIL
;
2882 /* This start the kernel tracing */
2883 ret
= kernel_start_session(ksession
);
2885 ret
= LTTCOMM_KERN_START_FAIL
;
2889 /* Quiescent wait after starting trace */
2890 kernel_wait_quiescent(kernel_tracer_fd
);
2893 /* Flag session that trace should start automatically */
2895 usess
->start_trace
= 1;
2897 ret
= ust_app_start_trace_all(usess
);
2899 ret
= LTTCOMM_UST_START_FAIL
;
2911 * Command LTTNG_STOP_TRACE processed by the client thread.
2913 static int cmd_stop_trace(struct ltt_session
*session
)
2916 struct ltt_kernel_channel
*kchan
;
2917 struct ltt_kernel_session
*ksession
;
2918 struct ltt_ust_session
*usess
;
2921 ksession
= session
->kernel_session
;
2922 usess
= session
->ust_session
;
2924 if (!session
->enabled
) {
2925 ret
= LTTCOMM_UST_STOP_FAIL
;
2929 session
->enabled
= 0;
2932 if (ksession
!= NULL
) {
2933 DBG("Stop kernel tracing");
2935 /* Flush all buffers before stopping */
2936 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2938 ERR("Kernel metadata flush failed");
2941 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2942 ret
= kernel_flush_buffer(kchan
);
2944 ERR("Kernel flush buffer error");
2948 ret
= kernel_stop_session(ksession
);
2950 ret
= LTTCOMM_KERN_STOP_FAIL
;
2954 kernel_wait_quiescent(kernel_tracer_fd
);
2958 usess
->start_trace
= 0;
2960 ret
= ust_app_stop_trace_all(usess
);
2962 ret
= LTTCOMM_UST_STOP_FAIL
;
2974 * Command LTTNG_CREATE_SESSION processed by the client thread.
2976 static int cmd_create_session(char *name
, char *path
, struct ucred
*creds
)
2980 ret
= session_create(name
, path
, creds
->uid
, creds
->gid
);
2981 if (ret
!= LTTCOMM_OK
) {
2992 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2994 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2998 /* Clean kernel session teardown */
2999 teardown_kernel_session(session
);
3000 /* UST session teardown */
3001 teardown_ust_session(session
);
3004 * Must notify the kernel thread here to update it's poll setin order
3005 * to remove the channel(s)' fd just destroyed.
3007 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
3009 PERROR("write kernel poll pipe");
3012 ret
= session_destroy(session
);
3018 * Command LTTNG_CALIBRATE processed by the client thread.
3020 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
3025 case LTTNG_DOMAIN_KERNEL
:
3027 struct lttng_kernel_calibrate kcalibrate
;
3029 kcalibrate
.type
= calibrate
->type
;
3030 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
3032 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
3037 case LTTNG_DOMAIN_UST
:
3039 struct lttng_ust_calibrate ucalibrate
;
3041 ucalibrate
.type
= calibrate
->type
;
3042 ret
= ust_app_calibrate_glb(&ucalibrate
);
3044 ret
= LTTCOMM_UST_CALIBRATE_FAIL
;
3061 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3063 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
3069 case LTTNG_DOMAIN_KERNEL
:
3070 /* Can't register a consumer if there is already one */
3071 if (session
->kernel_session
->consumer_fds_sent
!= 0) {
3072 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3076 sock
= lttcomm_connect_unix_sock(sock_path
);
3078 ret
= LTTCOMM_CONNECT_FAIL
;
3082 session
->kernel_session
->consumer_fd
= sock
;
3085 /* TODO: Userspace tracing */
3097 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3099 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
3100 struct lttng_domain
**domains
)
3105 if (session
->kernel_session
!= NULL
) {
3106 DBG3("Listing domains found kernel domain");
3110 if (session
->ust_session
!= NULL
) {
3111 DBG3("Listing domains found UST global domain");
3115 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3116 if (*domains
== NULL
) {
3117 ret
= -LTTCOMM_FATAL
;
3121 if (session
->kernel_session
!= NULL
) {
3122 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3126 if (session
->ust_session
!= NULL
) {
3127 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3138 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3140 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
3141 struct lttng_channel
**channels
)
3144 ssize_t nb_chan
= 0;
3147 case LTTNG_DOMAIN_KERNEL
:
3148 if (session
->kernel_session
!= NULL
) {
3149 nb_chan
= session
->kernel_session
->channel_count
;
3151 DBG3("Number of kernel channels %zd", nb_chan
);
3153 case LTTNG_DOMAIN_UST
:
3154 if (session
->ust_session
!= NULL
) {
3155 nb_chan
= lttng_ht_get_count(
3156 session
->ust_session
->domain_global
.channels
);
3158 DBG3("Number of UST global channels %zd", nb_chan
);
3167 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
3168 if (*channels
== NULL
) {
3169 ret
= -LTTCOMM_FATAL
;
3173 list_lttng_channels(domain
, session
, *channels
);
3185 * Command LTTNG_LIST_EVENTS processed by the client thread.
3187 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
3188 char *channel_name
, struct lttng_event
**events
)
3191 ssize_t nb_event
= 0;
3194 case LTTNG_DOMAIN_KERNEL
:
3195 if (session
->kernel_session
!= NULL
) {
3196 nb_event
= list_lttng_kernel_events(channel_name
,
3197 session
->kernel_session
, events
);
3200 case LTTNG_DOMAIN_UST
:
3202 if (session
->ust_session
!= NULL
) {
3203 nb_event
= list_lttng_ust_global_events(channel_name
,
3204 &session
->ust_session
->domain_global
, events
);
3220 * Process the command requested by the lttng client within the command
3221 * context structure. This function make sure that the return structure (llm)
3222 * is set and ready for transmission before returning.
3224 * Return any error encountered or 0 for success.
3226 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3228 int ret
= LTTCOMM_OK
;
3229 int need_tracing_session
= 1;
3232 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3234 switch (cmd_ctx
->lsm
->cmd_type
) {
3235 case LTTNG_CREATE_SESSION
:
3236 case LTTNG_DESTROY_SESSION
:
3237 case LTTNG_LIST_SESSIONS
:
3238 case LTTNG_LIST_DOMAINS
:
3239 case LTTNG_START_TRACE
:
3240 case LTTNG_STOP_TRACE
:
3247 if (opt_no_kernel
&& need_domain
3248 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
3249 ret
= LTTCOMM_KERN_NA
;
3254 * Check for command that don't needs to allocate a returned payload. We do
3255 * this here so we don't have to make the call for no payload at each
3258 switch(cmd_ctx
->lsm
->cmd_type
) {
3259 case LTTNG_LIST_SESSIONS
:
3260 case LTTNG_LIST_TRACEPOINTS
:
3261 case LTTNG_LIST_DOMAINS
:
3262 case LTTNG_LIST_CHANNELS
:
3263 case LTTNG_LIST_EVENTS
:
3266 /* Setup lttng message with no payload */
3267 ret
= setup_lttng_msg(cmd_ctx
, 0);
3269 /* This label does not try to unlock the session */
3270 goto init_setup_error
;
3274 /* Commands that DO NOT need a session. */
3275 switch (cmd_ctx
->lsm
->cmd_type
) {
3276 case LTTNG_CREATE_SESSION
:
3277 case LTTNG_CALIBRATE
:
3278 case LTTNG_LIST_SESSIONS
:
3279 case LTTNG_LIST_TRACEPOINTS
:
3280 need_tracing_session
= 0;
3283 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3284 session_lock_list();
3285 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3286 session_unlock_list();
3287 if (cmd_ctx
->session
== NULL
) {
3288 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3289 ret
= LTTCOMM_SESS_NOT_FOUND
;
3291 /* If no session name specified */
3292 ret
= LTTCOMM_SELECT_SESS
;
3296 /* Acquire lock for the session */
3297 session_lock(cmd_ctx
->session
);
3306 * Check domain type for specific "pre-action".
3308 switch (cmd_ctx
->lsm
->domain
.type
) {
3309 case LTTNG_DOMAIN_KERNEL
:
3311 ret
= LTTCOMM_KERN_NA
;
3315 /* Kernel tracer check */
3316 if (kernel_tracer_fd
== -1) {
3317 /* Basically, load kernel tracer modules */
3318 ret
= init_kernel_tracer();
3324 /* Need a session for kernel command */
3325 if (need_tracing_session
) {
3326 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3327 ret
= create_kernel_session(cmd_ctx
->session
);
3329 ret
= LTTCOMM_KERN_SESS_FAIL
;
3334 /* Start the kernel consumer daemon */
3335 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3336 if (kconsumer_data
.pid
== 0 &&
3337 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3338 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3339 ret
= start_consumerd(&kconsumer_data
);
3341 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3345 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3349 case LTTNG_DOMAIN_UST
:
3351 if (need_tracing_session
) {
3352 if (cmd_ctx
->session
->ust_session
== NULL
) {
3353 ret
= create_ust_session(cmd_ctx
->session
,
3354 &cmd_ctx
->lsm
->domain
);
3355 if (ret
!= LTTCOMM_OK
) {
3359 /* Start the UST consumer daemons */
3361 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3362 if (consumerd64_bin
[0] != '\0' &&
3363 ustconsumer64_data
.pid
== 0 &&
3364 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3365 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3366 ret
= start_consumerd(&ustconsumer64_data
);
3368 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3369 ust_consumerd64_fd
= -EINVAL
;
3373 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3375 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3378 if (consumerd32_bin
[0] != '\0' &&
3379 ustconsumer32_data
.pid
== 0 &&
3380 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3381 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3382 ret
= start_consumerd(&ustconsumer32_data
);
3384 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3385 ust_consumerd32_fd
= -EINVAL
;
3388 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3390 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3401 * Check that the UID or GID match that of the tracing session.
3402 * The root user can interact with all sessions.
3404 if (need_tracing_session
) {
3405 if (!session_access_ok(cmd_ctx
->session
,
3406 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
)) {
3407 ret
= LTTCOMM_EPERM
;
3412 /* Process by command type */
3413 switch (cmd_ctx
->lsm
->cmd_type
) {
3414 case LTTNG_ADD_CONTEXT
:
3416 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3417 cmd_ctx
->lsm
->u
.context
.channel_name
,
3418 cmd_ctx
->lsm
->u
.context
.event_name
,
3419 &cmd_ctx
->lsm
->u
.context
.ctx
);
3422 case LTTNG_DISABLE_CHANNEL
:
3424 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3425 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3428 case LTTNG_DISABLE_EVENT
:
3430 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3431 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3432 cmd_ctx
->lsm
->u
.disable
.name
);
3435 case LTTNG_DISABLE_ALL_EVENT
:
3437 DBG("Disabling all events");
3439 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3440 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3443 case LTTNG_ENABLE_CHANNEL
:
3445 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3446 &cmd_ctx
->lsm
->u
.channel
.chan
);
3449 case LTTNG_ENABLE_EVENT
:
3451 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3452 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3453 &cmd_ctx
->lsm
->u
.enable
.event
);
3456 case LTTNG_ENABLE_ALL_EVENT
:
3458 DBG("Enabling all events");
3460 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3461 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3462 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3465 case LTTNG_LIST_TRACEPOINTS
:
3467 struct lttng_event
*events
;
3470 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3471 if (nb_events
< 0) {
3477 * Setup lttng message with payload size set to the event list size in
3478 * bytes and then copy list into the llm payload.
3480 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3486 /* Copy event list into message payload */
3487 memcpy(cmd_ctx
->llm
->payload
, events
,
3488 sizeof(struct lttng_event
) * nb_events
);
3495 case LTTNG_START_TRACE
:
3497 ret
= cmd_start_trace(cmd_ctx
->session
);
3500 case LTTNG_STOP_TRACE
:
3502 ret
= cmd_stop_trace(cmd_ctx
->session
);
3505 case LTTNG_CREATE_SESSION
:
3507 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3508 cmd_ctx
->lsm
->session
.path
, &cmd_ctx
->creds
);
3511 case LTTNG_DESTROY_SESSION
:
3513 ret
= cmd_destroy_session(cmd_ctx
->session
,
3514 cmd_ctx
->lsm
->session
.name
);
3517 case LTTNG_LIST_DOMAINS
:
3520 struct lttng_domain
*domains
;
3522 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3528 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3533 /* Copy event list into message payload */
3534 memcpy(cmd_ctx
->llm
->payload
, domains
,
3535 nb_dom
* sizeof(struct lttng_domain
));
3542 case LTTNG_LIST_CHANNELS
:
3545 struct lttng_channel
*channels
;
3547 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3548 cmd_ctx
->session
, &channels
);
3554 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3559 /* Copy event list into message payload */
3560 memcpy(cmd_ctx
->llm
->payload
, channels
,
3561 nb_chan
* sizeof(struct lttng_channel
));
3568 case LTTNG_LIST_EVENTS
:
3571 struct lttng_event
*events
= NULL
;
3573 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3574 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3580 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3585 /* Copy event list into message payload */
3586 memcpy(cmd_ctx
->llm
->payload
, events
,
3587 nb_event
* sizeof(struct lttng_event
));
3594 case LTTNG_LIST_SESSIONS
:
3596 unsigned int nr_sessions
;
3598 session_lock_list();
3599 nr_sessions
= lttng_sessions_count(cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3601 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) * nr_sessions
);
3603 session_unlock_list();
3607 /* Filled the session array */
3608 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
),
3609 cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
3611 session_unlock_list();
3616 case LTTNG_CALIBRATE
:
3618 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3619 &cmd_ctx
->lsm
->u
.calibrate
);
3622 case LTTNG_REGISTER_CONSUMER
:
3624 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3625 cmd_ctx
->lsm
->u
.reg
.path
);
3634 if (cmd_ctx
->llm
== NULL
) {
3635 DBG("Missing llm structure. Allocating one.");
3636 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3640 /* Set return code */
3641 cmd_ctx
->llm
->ret_code
= ret
;
3643 if (cmd_ctx
->session
) {
3644 session_unlock(cmd_ctx
->session
);
3651 * This thread manage all clients request using the unix client socket for
3654 static void *thread_manage_clients(void *data
)
3656 int sock
= -1, ret
, i
, pollfd
;
3657 uint32_t revents
, nb_fd
;
3658 struct command_ctx
*cmd_ctx
= NULL
;
3659 struct lttng_poll_event events
;
3661 DBG("[thread] Manage client started");
3663 rcu_register_thread();
3665 ret
= lttcomm_listen_unix_sock(client_sock
);
3671 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3672 * more will be added to this poll set.
3674 ret
= create_thread_poll_set(&events
, 2);
3679 /* Add the application registration socket */
3680 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3686 * Notify parent pid that we are ready to accept command for client side.
3688 if (opt_sig_parent
) {
3689 kill(ppid
, SIGUSR1
);
3693 DBG("Accepting client command ...");
3695 nb_fd
= LTTNG_POLL_GETNB(&events
);
3697 /* Inifinite blocking call, waiting for transmission */
3699 ret
= lttng_poll_wait(&events
, -1);
3702 * Restart interrupted system call.
3704 if (errno
== EINTR
) {
3710 for (i
= 0; i
< nb_fd
; i
++) {
3711 /* Fetch once the poll data */
3712 revents
= LTTNG_POLL_GETEV(&events
, i
);
3713 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3715 /* Thread quit pipe has been closed. Killing thread. */
3716 ret
= check_thread_quit_pipe(pollfd
, revents
);
3721 /* Event on the registration socket */
3722 if (pollfd
== client_sock
) {
3723 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3724 ERR("Client socket poll error");
3730 DBG("Wait for client response");
3732 sock
= lttcomm_accept_unix_sock(client_sock
);
3737 /* Set socket option for credentials retrieval */
3738 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
3743 /* Allocate context command to process the client request */
3744 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3745 if (cmd_ctx
== NULL
) {
3746 PERROR("zmalloc cmd_ctx");
3750 /* Allocate data buffer for reception */
3751 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3752 if (cmd_ctx
->lsm
== NULL
) {
3753 PERROR("zmalloc cmd_ctx->lsm");
3757 cmd_ctx
->llm
= NULL
;
3758 cmd_ctx
->session
= NULL
;
3761 * Data is received from the lttng client. The struct
3762 * lttcomm_session_msg (lsm) contains the command and data request of
3765 DBG("Receiving data from client ...");
3766 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
3767 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
3769 DBG("Nothing recv() from client... continuing");
3779 // TODO: Validate cmd_ctx including sanity check for
3780 // security purpose.
3782 rcu_thread_online();
3784 * This function dispatch the work to the kernel or userspace tracer
3785 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3786 * informations for the client. The command context struct contains
3787 * everything this function may needs.
3789 ret
= process_client_msg(cmd_ctx
);
3790 rcu_thread_offline();
3793 * TODO: Inform client somehow of the fatal error. At
3794 * this point, ret < 0 means that a zmalloc failed
3795 * (ENOMEM). Error detected but still accept command.
3797 clean_command_ctx(&cmd_ctx
);
3801 DBG("Sending response (size: %d, retcode: %s)",
3802 cmd_ctx
->lttng_msg_size
,
3803 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3804 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3806 ERR("Failed to send data back to client");
3809 /* End of transmission */
3816 clean_command_ctx(&cmd_ctx
);
3820 DBG("Client thread dying");
3821 unlink(client_unix_sock_path
);
3822 if (client_sock
>= 0) {
3823 ret
= close(client_sock
);
3835 lttng_poll_clean(&events
);
3836 clean_command_ctx(&cmd_ctx
);
3838 rcu_unregister_thread();
3844 * usage function on stderr
3846 static void usage(void)
3848 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3849 fprintf(stderr
, " -h, --help Display this usage.\n");
3850 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3851 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3852 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3853 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3854 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3855 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3856 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3857 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3858 fprintf(stderr
, " --consumerd32-path PATH Specify path for the 32-bit UST consumer daemon binary\n");
3859 fprintf(stderr
, " --consumerd32-libdir PATH Specify path for the 32-bit UST consumer daemon libraries\n");
3860 fprintf(stderr
, " --consumerd64-path PATH Specify path for the 64-bit UST consumer daemon binary\n");
3861 fprintf(stderr
, " --consumerd64-libdir PATH Specify path for the 64-bit UST consumer daemon libraries\n");
3862 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3863 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3864 fprintf(stderr
, " -V, --version Show version number.\n");
3865 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3866 fprintf(stderr
, " -q, --quiet No output at all.\n");
3867 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3868 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3869 fprintf(stderr
, " --no-kernel Disable kernel tracer\n");
3873 * daemon argument parsing
3875 static int parse_args(int argc
, char **argv
)
3879 static struct option long_options
[] = {
3880 { "client-sock", 1, 0, 'c' },
3881 { "apps-sock", 1, 0, 'a' },
3882 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3883 { "kconsumerd-err-sock", 1, 0, 'E' },
3884 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3885 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3886 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3887 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3888 { "consumerd32-path", 1, 0, 'u' },
3889 { "consumerd32-libdir", 1, 0, 'U' },
3890 { "consumerd64-path", 1, 0, 't' },
3891 { "consumerd64-libdir", 1, 0, 'T' },
3892 { "daemonize", 0, 0, 'd' },
3893 { "sig-parent", 0, 0, 'S' },
3894 { "help", 0, 0, 'h' },
3895 { "group", 1, 0, 'g' },
3896 { "version", 0, 0, 'V' },
3897 { "quiet", 0, 0, 'q' },
3898 { "verbose", 0, 0, 'v' },
3899 { "verbose-consumer", 0, 0, 'Z' },
3900 { "no-kernel", 0, 0, 'N' },
3905 int option_index
= 0;
3906 c
= getopt_long(argc
, argv
, "dhqvVSN" "a:c:g:s:C:E:D:F:Z:u:t",
3907 long_options
, &option_index
);
3914 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3916 fprintf(stderr
, " with arg %s\n", optarg
);
3920 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3923 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3929 opt_tracing_group
= optarg
;
3935 fprintf(stdout
, "%s\n", VERSION
);
3941 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3944 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3947 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3950 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3953 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3956 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3965 /* Verbose level can increase using multiple -v */
3969 opt_verbose_consumer
+= 1;
3972 consumerd32_bin
= optarg
;
3975 consumerd32_libdir
= optarg
;
3978 consumerd64_bin
= optarg
;
3981 consumerd64_libdir
= optarg
;
3984 /* Unknown option or other error.
3985 * Error is printed by getopt, just return */
3994 * Creates the two needed socket by the daemon.
3995 * apps_sock - The communication socket for all UST apps.
3996 * client_sock - The communication of the cli tool (lttng).
3998 static int init_daemon_socket(void)
4003 old_umask
= umask(0);
4005 /* Create client tool unix socket */
4006 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
4007 if (client_sock
< 0) {
4008 ERR("Create unix sock failed: %s", client_unix_sock_path
);
4013 /* File permission MUST be 660 */
4014 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4016 ERR("Set file permissions failed: %s", client_unix_sock_path
);
4021 /* Create the application unix socket */
4022 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
4023 if (apps_sock
< 0) {
4024 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
4029 /* File permission MUST be 666 */
4030 ret
= chmod(apps_unix_sock_path
,
4031 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
4033 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
4044 * Check if the global socket is available, and if a daemon is answering at the
4045 * other side. If yes, error is returned.
4047 static int check_existing_daemon(void)
4049 /* Is there anybody out there ? */
4050 if (lttng_session_daemon_alive()) {
4058 * Set the tracing group gid onto the client socket.
4060 * Race window between mkdir and chown is OK because we are going from more
4061 * permissive (root.root) to less permissive (root.tracing).
4063 static int set_permissions(char *rundir
)
4068 gid
= allowed_group();
4070 WARN("No tracing group detected");
4075 /* Set lttng run dir */
4076 ret
= chown(rundir
, 0, gid
);
4078 ERR("Unable to set group on %s", rundir
);
4082 /* Ensure tracing group can search the run dir */
4083 ret
= chmod(rundir
, S_IRWXU
| S_IXGRP
| S_IXOTH
);
4085 ERR("Unable to set permissions on %s", rundir
);
4089 /* lttng client socket path */
4090 ret
= chown(client_unix_sock_path
, 0, gid
);
4092 ERR("Unable to set group on %s", client_unix_sock_path
);
4096 /* kconsumer error socket path */
4097 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
4099 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
4103 /* 64-bit ustconsumer error socket path */
4104 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
4106 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
4110 /* 32-bit ustconsumer compat32 error socket path */
4111 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
4113 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
4117 DBG("All permissions are set");
4124 * Create the pipe used to wake up the kernel thread.
4125 * Closed in cleanup().
4127 static int create_kernel_poll_pipe(void)
4129 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
4133 * Create the application command pipe to wake thread_manage_apps.
4134 * Closed in cleanup().
4136 static int create_apps_cmd_pipe(void)
4138 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
4142 * Create the lttng run directory needed for all global sockets and pipe.
4144 static int create_lttng_rundir(const char *rundir
)
4148 DBG3("Creating LTTng run directory: %s", rundir
);
4150 ret
= mkdir(rundir
, S_IRWXU
);
4152 if (errno
!= EEXIST
) {
4153 ERR("Unable to create %s", rundir
);
4165 * Setup sockets and directory needed by the kconsumerd communication with the
4168 static int set_consumer_sockets(struct consumer_data
*consumer_data
,
4172 char path
[PATH_MAX
];
4174 switch (consumer_data
->type
) {
4175 case LTTNG_CONSUMER_KERNEL
:
4176 snprintf(path
, PATH_MAX
, DEFAULT_KCONSUMERD_PATH
, rundir
);
4178 case LTTNG_CONSUMER64_UST
:
4179 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD64_PATH
, rundir
);
4181 case LTTNG_CONSUMER32_UST
:
4182 snprintf(path
, PATH_MAX
, DEFAULT_USTCONSUMERD32_PATH
, rundir
);
4185 ERR("Consumer type unknown");
4190 DBG2("Creating consumer directory: %s", path
);
4192 ret
= mkdir(path
, S_IRWXU
);
4194 if (errno
!= EEXIST
) {
4195 ERR("Failed to create %s", path
);
4201 /* Create the kconsumerd error unix socket */
4202 consumer_data
->err_sock
=
4203 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
4204 if (consumer_data
->err_sock
< 0) {
4205 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
4210 /* File permission MUST be 660 */
4211 ret
= chmod(consumer_data
->err_unix_sock_path
,
4212 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
4214 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
4224 * Signal handler for the daemon
4226 * Simply stop all worker threads, leaving main() return gracefully after
4227 * joining all threads and calling cleanup().
4229 static void sighandler(int sig
)
4233 DBG("SIGPIPE caught");
4236 DBG("SIGINT caught");
4240 DBG("SIGTERM caught");
4249 * Setup signal handler for :
4250 * SIGINT, SIGTERM, SIGPIPE
4252 static int set_signal_handler(void)
4255 struct sigaction sa
;
4258 if ((ret
= sigemptyset(&sigset
)) < 0) {
4259 PERROR("sigemptyset");
4263 sa
.sa_handler
= sighandler
;
4264 sa
.sa_mask
= sigset
;
4266 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
4267 PERROR("sigaction");
4271 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
4272 PERROR("sigaction");
4276 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
4277 PERROR("sigaction");
4281 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
4287 * Set open files limit to unlimited. This daemon can open a large number of
4288 * file descriptors in order to consumer multiple kernel traces.
4290 static void set_ulimit(void)
4295 /* The kernel does not allowed an infinite limit for open files */
4296 lim
.rlim_cur
= 65535;
4297 lim
.rlim_max
= 65535;
4299 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
4301 PERROR("failed to set open files limit");
4308 int main(int argc
, char **argv
)
4312 const char *home_path
;
4314 init_kernel_workarounds();
4316 rcu_register_thread();
4318 /* Create thread quit pipe */
4319 if ((ret
= init_thread_quit_pipe()) < 0) {
4323 setup_consumerd_path();
4325 /* Parse arguments */
4327 if ((ret
= parse_args(argc
, argv
) < 0)) {
4340 /* Check if daemon is UID = 0 */
4341 is_root
= !getuid();
4344 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
4346 /* Create global run dir with root access */
4347 ret
= create_lttng_rundir(rundir
);
4352 if (strlen(apps_unix_sock_path
) == 0) {
4353 snprintf(apps_unix_sock_path
, PATH_MAX
,
4354 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4357 if (strlen(client_unix_sock_path
) == 0) {
4358 snprintf(client_unix_sock_path
, PATH_MAX
,
4359 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4362 /* Set global SHM for ust */
4363 if (strlen(wait_shm_path
) == 0) {
4364 snprintf(wait_shm_path
, PATH_MAX
,
4365 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4368 /* Setup kernel consumerd path */
4369 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
,
4370 DEFAULT_KCONSUMERD_ERR_SOCK_PATH
, rundir
);
4371 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
,
4372 DEFAULT_KCONSUMERD_CMD_SOCK_PATH
, rundir
);
4374 DBG2("Kernel consumer err path: %s",
4375 kconsumer_data
.err_unix_sock_path
);
4376 DBG2("Kernel consumer cmd path: %s",
4377 kconsumer_data
.cmd_unix_sock_path
);
4379 home_path
= get_home_dir();
4380 if (home_path
== NULL
) {
4381 /* TODO: Add --socket PATH option */
4382 ERR("Can't get HOME directory for sockets creation.");
4388 * Create rundir from home path. This will create something like
4391 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
4397 ret
= create_lttng_rundir(rundir
);
4402 if (strlen(apps_unix_sock_path
) == 0) {
4403 snprintf(apps_unix_sock_path
, PATH_MAX
,
4404 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4407 /* Set the cli tool unix socket path */
4408 if (strlen(client_unix_sock_path
) == 0) {
4409 snprintf(client_unix_sock_path
, PATH_MAX
,
4410 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4413 /* Set global SHM for ust */
4414 if (strlen(wait_shm_path
) == 0) {
4415 snprintf(wait_shm_path
, PATH_MAX
,
4416 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4420 DBG("Client socket path %s", client_unix_sock_path
);
4421 DBG("Application socket path %s", apps_unix_sock_path
);
4422 DBG("LTTng run directory path: %s", rundir
);
4424 /* 32 bits consumerd path setup */
4425 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
,
4426 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, rundir
);
4427 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
,
4428 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, rundir
);
4430 DBG2("UST consumer 32 bits err path: %s",
4431 ustconsumer32_data
.err_unix_sock_path
);
4432 DBG2("UST consumer 32 bits cmd path: %s",
4433 ustconsumer32_data
.cmd_unix_sock_path
);
4435 /* 64 bits consumerd path setup */
4436 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
,
4437 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, rundir
);
4438 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
,
4439 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, rundir
);
4441 DBG2("UST consumer 64 bits err path: %s",
4442 ustconsumer64_data
.err_unix_sock_path
);
4443 DBG2("UST consumer 64 bits cmd path: %s",
4444 ustconsumer64_data
.cmd_unix_sock_path
);
4447 * See if daemon already exist.
4449 if ((ret
= check_existing_daemon()) < 0) {
4450 ERR("Already running daemon.\n");
4452 * We do not goto exit because we must not cleanup()
4453 * because a daemon is already running.
4458 /* After this point, we can safely call cleanup() with "goto exit" */
4461 * These actions must be executed as root. We do that *after* setting up
4462 * the sockets path because we MUST make the check for another daemon using
4463 * those paths *before* trying to set the kernel consumer sockets and init
4467 ret
= set_consumer_sockets(&kconsumer_data
, rundir
);
4472 /* Setup kernel tracer */
4473 if (!opt_no_kernel
) {
4474 init_kernel_tracer();
4477 /* Set ulimit for open files */
4481 ret
= set_consumer_sockets(&ustconsumer64_data
, rundir
);
4486 ret
= set_consumer_sockets(&ustconsumer32_data
, rundir
);
4491 if ((ret
= set_signal_handler()) < 0) {
4495 /* Setup the needed unix socket */
4496 if ((ret
= init_daemon_socket()) < 0) {
4500 /* Set credentials to socket */
4501 if (is_root
&& ((ret
= set_permissions(rundir
)) < 0)) {
4505 /* Get parent pid if -S, --sig-parent is specified. */
4506 if (opt_sig_parent
) {
4510 /* Setup the kernel pipe for waking up the kernel thread */
4511 if ((ret
= create_kernel_poll_pipe()) < 0) {
4515 /* Setup the thread apps communication pipe. */
4516 if ((ret
= create_apps_cmd_pipe()) < 0) {
4520 /* Init UST command queue. */
4521 cds_wfq_init(&ust_cmd_queue
.queue
);
4523 /* Init UST app hash table */
4527 * Get session list pointer. This pointer MUST NOT be free(). This list is
4528 * statically declared in session.c
4530 session_list_ptr
= session_get_list();
4532 /* Set up max poll set size */
4533 lttng_poll_set_max_size();
4535 /* Create thread to manage the client socket */
4536 ret
= pthread_create(&client_thread
, NULL
,
4537 thread_manage_clients
, (void *) NULL
);
4539 PERROR("pthread_create clients");
4543 /* Create thread to dispatch registration */
4544 ret
= pthread_create(&dispatch_thread
, NULL
,
4545 thread_dispatch_ust_registration
, (void *) NULL
);
4547 PERROR("pthread_create dispatch");
4551 /* Create thread to manage application registration. */
4552 ret
= pthread_create(®_apps_thread
, NULL
,
4553 thread_registration_apps
, (void *) NULL
);
4555 PERROR("pthread_create registration");
4559 /* Create thread to manage application socket */
4560 ret
= pthread_create(&apps_thread
, NULL
,
4561 thread_manage_apps
, (void *) NULL
);
4563 PERROR("pthread_create apps");
4567 /* Create kernel thread to manage kernel event */
4568 ret
= pthread_create(&kernel_thread
, NULL
,
4569 thread_manage_kernel
, (void *) NULL
);
4571 PERROR("pthread_create kernel");
4575 ret
= pthread_join(kernel_thread
, &status
);
4577 PERROR("pthread_join");
4578 goto error
; /* join error, exit without cleanup */
4582 ret
= pthread_join(apps_thread
, &status
);
4584 PERROR("pthread_join");
4585 goto error
; /* join error, exit without cleanup */
4589 ret
= pthread_join(reg_apps_thread
, &status
);
4591 PERROR("pthread_join");
4592 goto error
; /* join error, exit without cleanup */
4596 ret
= pthread_join(dispatch_thread
, &status
);
4598 PERROR("pthread_join");
4599 goto error
; /* join error, exit without cleanup */
4603 ret
= pthread_join(client_thread
, &status
);
4605 PERROR("pthread_join");
4606 goto error
; /* join error, exit without cleanup */
4609 ret
= join_consumer_thread(&kconsumer_data
);
4611 PERROR("join_consumer");
4612 goto error
; /* join error, exit without cleanup */
4618 * cleanup() is called when no other thread is running.
4620 rcu_thread_online();
4622 rcu_thread_offline();
4623 rcu_unregister_thread();