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 <lttng-consumerd.h>
42 #include <lttng-sessiond-comm.h>
43 #include <lttng/lttng-consumer.h>
48 #include "compat/poll.h"
52 #include "hashtable.h"
53 #include "kernel-ctl.h"
54 #include "lttng-sessiond.h"
60 struct consumer_data
{
61 enum lttng_consumer_type type
;
63 pthread_t thread
; /* Worker thread interacting with the consumer */
66 /* Mutex to control consumerd pid assignation */
67 pthread_mutex_t pid_mutex
;
73 /* consumer error and command Unix socket path */
74 char err_unix_sock_path
[PATH_MAX
];
75 char cmd_unix_sock_path
[PATH_MAX
];
79 const char default_home_dir
[] = DEFAULT_HOME_DIR
;
80 const char default_tracing_group
[] = LTTNG_DEFAULT_TRACING_GROUP
;
81 const char default_ust_sock_dir
[] = DEFAULT_UST_SOCK_DIR
;
82 const char default_global_apps_pipe
[] = DEFAULT_GLOBAL_APPS_PIPE
;
85 int opt_verbose
; /* Not static for lttngerr.h */
86 int opt_verbose_consumer
; /* Not static for lttngerr.h */
87 int opt_quiet
; /* Not static for lttngerr.h */
90 const char *opt_tracing_group
;
91 static int opt_sig_parent
;
92 static int opt_daemon
;
93 static int is_root
; /* Set to 1 if the daemon is running as root */
94 static pid_t ppid
; /* Parent PID for --sig-parent option */
96 /* Consumer daemon specific control data */
97 static struct consumer_data kconsumer_data
= {
98 .type
= LTTNG_CONSUMER_KERNEL
,
99 .err_unix_sock_path
= KCONSUMERD_ERR_SOCK_PATH
,
100 .cmd_unix_sock_path
= KCONSUMERD_CMD_SOCK_PATH
,
102 static struct consumer_data ustconsumer64_data
= {
103 .type
= LTTNG_CONSUMER64_UST
,
104 .err_unix_sock_path
= USTCONSUMERD64_ERR_SOCK_PATH
,
105 .cmd_unix_sock_path
= USTCONSUMERD64_CMD_SOCK_PATH
,
107 static struct consumer_data ustconsumer32_data
= {
108 .type
= LTTNG_CONSUMER32_UST
,
109 .err_unix_sock_path
= USTCONSUMERD32_ERR_SOCK_PATH
,
110 .cmd_unix_sock_path
= USTCONSUMERD32_CMD_SOCK_PATH
,
113 static int dispatch_thread_exit
;
115 /* Global application Unix socket path */
116 static char apps_unix_sock_path
[PATH_MAX
];
117 /* Global client Unix socket path */
118 static char client_unix_sock_path
[PATH_MAX
];
119 /* global wait shm path for UST */
120 static char wait_shm_path
[PATH_MAX
];
122 /* Sockets and FDs */
123 static int client_sock
;
124 static int apps_sock
;
125 static int kernel_tracer_fd
;
126 static int kernel_poll_pipe
[2];
129 * Quit pipe for all threads. This permits a single cancellation point
130 * for all threads when receiving an event on the pipe.
132 static int thread_quit_pipe
[2];
135 * This pipe is used to inform the thread managing application communication
136 * that a command is queued and ready to be processed.
138 static int apps_cmd_pipe
[2];
140 /* Pthread, Mutexes and Semaphores */
141 static pthread_t apps_thread
;
142 static pthread_t reg_apps_thread
;
143 static pthread_t client_thread
;
144 static pthread_t kernel_thread
;
145 static pthread_t dispatch_thread
;
149 * UST registration command queue. This queue is tied with a futex and uses a N
150 * wakers / 1 waiter implemented and detailed in futex.c/.h
152 * The thread_manage_apps and thread_dispatch_ust_registration interact with
153 * this queue and the wait/wake scheme.
155 static struct ust_cmd_queue ust_cmd_queue
;
158 * Pointer initialized before thread creation.
160 * This points to the tracing session list containing the session count and a
161 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
162 * MUST NOT be taken if you call a public function in session.c.
164 * The lock is nested inside the structure: session_list_ptr->lock. Please use
165 * session_lock_list and session_unlock_list for lock acquisition.
167 static struct ltt_session_list
*session_list_ptr
;
169 int ust_consumerd64_fd
= -1;
170 int ust_consumerd32_fd
= -1;
172 static const char *consumerd64_prog
= "lttng-consumerd";
173 static const char *consumerd32_prog
= "lttng-consumerd";
175 static const char *consumerd64_bindir
=
176 __stringify(CONFIG_64BIT_BINDIR
);
177 static const char *consumerd32_bindir
=
178 __stringify(CONFIG_32BIT_BINDIR
);
181 void setup_consumerd_path(void)
186 * Allow INSTALL_BIN_PATH to be used as a target path for the
187 * native architecture size consumer if CONFIG_NBIT_BINDIR as
190 #if (CAA_BITS_PER_LONG == 64)
191 if (!consumerd64_bindir
[0]) {
192 consumerd64_bindir
= INSTALL_BIN_PATH
;
194 #elif (CAA_BITS_PER_LONG == 32)
195 if (!consumerd32_bindir
[0]) {
196 consumerd32_bindir
= INSTALL_BIN_PATH
;
199 #error "Unknown bitness"
203 * runtime env. var. overrides the build default.
205 bindir
= getenv("LTTNG_TOOLS_64BIT_BINDIR");
207 consumerd64_bindir
= bindir
;
209 bindir
= getenv("LTTNG_TOOLS_32BIT_BINDIR");
211 consumerd32_bindir
= bindir
;
216 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
218 static int create_thread_poll_set(struct lttng_poll_event
*events
,
223 if (events
== NULL
|| size
== 0) {
228 ret
= lttng_poll_create(events
, size
, LTTNG_CLOEXEC
);
234 ret
= lttng_poll_add(events
, thread_quit_pipe
[0], LPOLLIN
);
246 * Check if the thread quit pipe was triggered.
248 * Return 1 if it was triggered else 0;
250 static int check_thread_quit_pipe(int fd
, uint32_t events
)
252 if (fd
== thread_quit_pipe
[0] && (events
& LPOLLIN
)) {
260 * Remove modules in reverse load order.
262 static int modprobe_remove_kernel_modules(void)
267 for (i
= ARRAY_SIZE(kernel_modules_list
) - 1; i
>= 0; i
--) {
268 ret
= snprintf(modprobe
, sizeof(modprobe
),
269 "/sbin/modprobe -r -q %s",
270 kernel_modules_list
[i
].name
);
272 perror("snprintf modprobe -r");
275 modprobe
[sizeof(modprobe
) - 1] = '\0';
276 ret
= system(modprobe
);
278 ERR("Unable to launch modprobe -r for module %s",
279 kernel_modules_list
[i
].name
);
280 } else if (kernel_modules_list
[i
].required
281 && WEXITSTATUS(ret
) != 0) {
282 ERR("Unable to remove module %s",
283 kernel_modules_list
[i
].name
);
285 DBG("Modprobe removal successful %s",
286 kernel_modules_list
[i
].name
);
295 * Return group ID of the tracing group or -1 if not found.
297 static gid_t
allowed_group(void)
301 if (opt_tracing_group
) {
302 grp
= getgrnam(opt_tracing_group
);
304 grp
= getgrnam(default_tracing_group
);
314 * Init thread quit pipe.
316 * Return -1 on error or 0 if all pipes are created.
318 static int init_thread_quit_pipe(void)
322 ret
= pipe2(thread_quit_pipe
, O_CLOEXEC
);
324 perror("thread quit pipe");
333 * Complete teardown of a kernel session. This free all data structure related
334 * to a kernel session and update counter.
336 static void teardown_kernel_session(struct ltt_session
*session
)
338 if (!session
->kernel_session
) {
339 DBG3("No kernel session when tearingdown session");
343 DBG("Tearing down kernel session");
346 * If a custom kernel consumer was registered, close the socket before
347 * tearing down the complete kernel session structure
349 if (session
->kernel_session
->consumer_fd
!= kconsumer_data
.cmd_sock
) {
350 lttcomm_close_unix_sock(session
->kernel_session
->consumer_fd
);
353 trace_kernel_destroy_session(session
->kernel_session
);
357 * Complete teardown of all UST sessions. This will free everything on his path
358 * and destroy the core essence of all ust sessions :)
360 static void teardown_ust_session(struct ltt_session
*session
)
364 if (!session
->ust_session
) {
365 DBG3("No UST session when tearingdown session");
369 DBG("Tearing down UST session(s)");
371 ret
= ust_app_destroy_trace_all(session
->ust_session
);
373 ERR("Error in ust_app_destroy_trace_all");
376 trace_ust_destroy_session(session
->ust_session
);
380 * Stop all threads by closing the thread quit pipe.
382 static void stop_threads(void)
386 /* Stopping all threads */
387 DBG("Terminating all threads");
388 ret
= notify_thread_pipe(thread_quit_pipe
[1]);
390 ERR("write error on thread quit pipe");
393 /* Dispatch thread */
394 dispatch_thread_exit
= 1;
395 futex_nto1_wake(&ust_cmd_queue
.futex
);
401 static void cleanup(void)
405 struct ltt_session
*sess
, *stmp
;
410 DBG("Removing %s directory", LTTNG_RUNDIR
);
411 ret
= asprintf(&cmd
, "rm -rf " LTTNG_RUNDIR
);
413 ERR("asprintf failed. Something is really wrong!");
416 /* Remove lttng run directory */
419 ERR("Unable to clean " LTTNG_RUNDIR
);
423 DBG("Cleaning up all session");
425 /* Destroy session list mutex */
426 if (session_list_ptr
!= NULL
) {
427 pthread_mutex_destroy(&session_list_ptr
->lock
);
429 /* Cleanup ALL session */
430 cds_list_for_each_entry_safe(sess
, stmp
,
431 &session_list_ptr
->head
, list
) {
432 teardown_kernel_session(sess
);
433 teardown_ust_session(sess
);
438 DBG("Closing all UST sockets");
439 ust_app_clean_list();
441 pthread_mutex_destroy(&kconsumer_data
.pid_mutex
);
443 DBG("Closing kernel fd");
444 close(kernel_tracer_fd
);
447 DBG("Unloading kernel modules");
448 modprobe_remove_kernel_modules();
451 close(thread_quit_pipe
[0]);
452 close(thread_quit_pipe
[1]);
455 MSG("%c[%d;%dm*** assert failed :-) *** ==> %c[%dm%c[%d;%dm"
456 "Matthew, BEET driven development works!%c[%dm",
457 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
462 * Send data on a unix socket using the liblttsessiondcomm API.
464 * Return lttcomm error code.
466 static int send_unix_sock(int sock
, void *buf
, size_t len
)
468 /* Check valid length */
473 return lttcomm_send_unix_sock(sock
, buf
, len
);
477 * Free memory of a command context structure.
479 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
481 DBG("Clean command context structure");
483 if ((*cmd_ctx
)->llm
) {
484 free((*cmd_ctx
)->llm
);
486 if ((*cmd_ctx
)->lsm
) {
487 free((*cmd_ctx
)->lsm
);
495 * Send all stream fds of kernel channel to the consumer.
497 static int send_kconsumer_channel_streams(struct consumer_data
*consumer_data
,
498 int sock
, struct ltt_kernel_channel
*channel
)
501 struct ltt_kernel_stream
*stream
;
502 struct lttcomm_consumer_msg lkm
;
504 DBG("Sending streams of channel %s to kernel consumer",
505 channel
->channel
->name
);
508 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
509 lkm
.u
.channel
.channel_key
= channel
->fd
;
510 lkm
.u
.channel
.max_sb_size
= channel
->channel
->attr
.subbuf_size
;
511 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
512 DBG("Sending channel %d to consumer", lkm
.u
.channel
.channel_key
);
513 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
515 perror("send consumer channel");
520 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
524 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
525 lkm
.u
.stream
.channel_key
= channel
->fd
;
526 lkm
.u
.stream
.stream_key
= stream
->fd
;
527 lkm
.u
.stream
.state
= stream
->state
;
528 lkm
.u
.stream
.output
= channel
->channel
->attr
.output
;
529 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
530 strncpy(lkm
.u
.stream
.path_name
, stream
->pathname
, PATH_MAX
- 1);
531 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
532 DBG("Sending stream %d to consumer", lkm
.u
.stream
.stream_key
);
533 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
535 perror("send consumer stream");
538 ret
= lttcomm_send_fds_unix_sock(sock
, &stream
->fd
, 1);
540 perror("send consumer stream ancillary data");
545 DBG("consumer channel streams sent");
554 * Send all stream fds of the kernel session to the consumer.
556 static int send_kconsumer_session_streams(struct consumer_data
*consumer_data
,
557 struct ltt_kernel_session
*session
)
560 struct ltt_kernel_channel
*chan
;
561 struct lttcomm_consumer_msg lkm
;
562 int sock
= session
->consumer_fd
;
564 DBG("Sending metadata stream fd");
566 /* Extra protection. It's NOT supposed to be set to 0 at this point */
567 if (session
->consumer_fd
== 0) {
568 session
->consumer_fd
= consumer_data
->cmd_sock
;
571 if (session
->metadata_stream_fd
!= 0) {
572 /* Send metadata channel fd */
573 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
574 lkm
.u
.channel
.channel_key
= session
->metadata
->fd
;
575 lkm
.u
.channel
.max_sb_size
= session
->metadata
->conf
->attr
.subbuf_size
;
576 lkm
.u
.channel
.mmap_len
= 0; /* for kernel */
577 DBG("Sending metadata channel %d to consumer", lkm
.u
.stream
.stream_key
);
578 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
580 perror("send consumer channel");
584 /* Send metadata stream fd */
585 lkm
.cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
586 lkm
.u
.stream
.channel_key
= session
->metadata
->fd
;
587 lkm
.u
.stream
.stream_key
= session
->metadata_stream_fd
;
588 lkm
.u
.stream
.state
= LTTNG_CONSUMER_ACTIVE_STREAM
;
589 lkm
.u
.stream
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
590 lkm
.u
.stream
.mmap_len
= 0; /* for kernel */
591 strncpy(lkm
.u
.stream
.path_name
, session
->metadata
->pathname
, PATH_MAX
- 1);
592 lkm
.u
.stream
.path_name
[PATH_MAX
- 1] = '\0';
593 DBG("Sending metadata stream %d to consumer", lkm
.u
.stream
.stream_key
);
594 ret
= lttcomm_send_unix_sock(sock
, &lkm
, sizeof(lkm
));
596 perror("send consumer stream");
599 ret
= lttcomm_send_fds_unix_sock(sock
, &session
->metadata_stream_fd
, 1);
601 perror("send consumer stream");
606 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
607 ret
= send_kconsumer_channel_streams(consumer_data
, sock
, chan
);
613 DBG("consumer fds (metadata and channel streams) sent");
622 * Notify UST applications using the shm mmap futex.
624 static int notify_ust_apps(int active
)
628 DBG("Notifying applications of session daemon state: %d", active
);
630 /* See shm.c for this call implying mmap, shm and futex calls */
631 wait_shm_mmap
= shm_ust_get_mmap(wait_shm_path
, is_root
);
632 if (wait_shm_mmap
== NULL
) {
636 /* Wake waiting process */
637 futex_wait_update((int32_t *) wait_shm_mmap
, active
);
639 /* Apps notified successfully */
647 * Setup the outgoing data buffer for the response (llm) by allocating the
648 * right amount of memory and copying the original information from the lsm
651 * Return total size of the buffer pointed by buf.
653 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
, size_t size
)
659 cmd_ctx
->llm
= zmalloc(sizeof(struct lttcomm_lttng_msg
) + buf_size
);
660 if (cmd_ctx
->llm
== NULL
) {
666 /* Copy common data */
667 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
668 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
670 cmd_ctx
->llm
->data_size
= size
;
671 cmd_ctx
->lttng_msg_size
= sizeof(struct lttcomm_lttng_msg
) + buf_size
;
680 * Update the kernel poll set of all channel fd available over all tracing
681 * session. Add the wakeup pipe at the end of the set.
683 static int update_kernel_poll(struct lttng_poll_event
*events
)
686 struct ltt_session
*session
;
687 struct ltt_kernel_channel
*channel
;
689 DBG("Updating kernel poll set");
692 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
693 session_lock(session
);
694 if (session
->kernel_session
== NULL
) {
695 session_unlock(session
);
699 cds_list_for_each_entry(channel
,
700 &session
->kernel_session
->channel_list
.head
, list
) {
701 /* Add channel fd to the kernel poll set */
702 ret
= lttng_poll_add(events
, channel
->fd
, LPOLLIN
| LPOLLRDNORM
);
704 session_unlock(session
);
707 DBG("Channel fd %d added to kernel set", channel
->fd
);
709 session_unlock(session
);
711 session_unlock_list();
716 session_unlock_list();
721 * Find the channel fd from 'fd' over all tracing session. When found, check
722 * for new channel stream and send those stream fds to the kernel consumer.
724 * Useful for CPU hotplug feature.
726 static int update_kernel_stream(struct consumer_data
*consumer_data
, int fd
)
729 struct ltt_session
*session
;
730 struct ltt_kernel_channel
*channel
;
732 DBG("Updating kernel streams for channel fd %d", fd
);
735 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
736 session_lock(session
);
737 if (session
->kernel_session
== NULL
) {
738 session_unlock(session
);
742 /* This is not suppose to be 0 but this is an extra security check */
743 if (session
->kernel_session
->consumer_fd
== 0) {
744 session
->kernel_session
->consumer_fd
= consumer_data
->cmd_sock
;
747 cds_list_for_each_entry(channel
,
748 &session
->kernel_session
->channel_list
.head
, list
) {
749 if (channel
->fd
== fd
) {
750 DBG("Channel found, updating kernel streams");
751 ret
= kernel_open_channel_stream(channel
);
757 * Have we already sent fds to the consumer? If yes, it means
758 * that tracing is started so it is safe to send our updated
761 if (session
->kernel_session
->consumer_fds_sent
== 1) {
762 ret
= send_kconsumer_channel_streams(consumer_data
,
763 session
->kernel_session
->consumer_fd
, channel
);
771 session_unlock(session
);
773 session_unlock_list();
777 session_unlock(session
);
778 session_unlock_list();
783 * For each tracing session, update newly registered apps.
785 static void update_ust_app(int app_sock
)
787 struct ltt_session
*sess
, *stmp
;
789 /* For all tracing session(s) */
790 cds_list_for_each_entry_safe(sess
, stmp
, &session_list_ptr
->head
, list
) {
791 if (sess
->ust_session
) {
792 ust_app_global_update(sess
->ust_session
, app_sock
);
798 * This thread manage event coming from the kernel.
800 * Features supported in this thread:
803 static void *thread_manage_kernel(void *data
)
805 int ret
, i
, pollfd
, update_poll_flag
= 1;
806 uint32_t revents
, nb_fd
;
808 struct lttng_poll_event events
;
810 DBG("Thread manage kernel started");
812 ret
= create_thread_poll_set(&events
, 2);
817 ret
= lttng_poll_add(&events
, kernel_poll_pipe
[0], LPOLLIN
);
823 if (update_poll_flag
== 1) {
825 * Reset number of fd in the poll set. Always 2 since there is the thread
826 * quit pipe and the kernel pipe.
830 ret
= update_kernel_poll(&events
);
834 update_poll_flag
= 0;
837 nb_fd
= LTTNG_POLL_GETNB(&events
);
839 DBG("Thread kernel polling on %d fds", nb_fd
);
841 /* Zeroed the poll events */
842 lttng_poll_reset(&events
);
844 /* Poll infinite value of time */
845 ret
= lttng_poll_wait(&events
, -1);
848 } else if (ret
== 0) {
849 /* Should not happen since timeout is infinite */
850 ERR("Return value of poll is 0 with an infinite timeout.\n"
851 "This should not have happened! Continuing...");
855 for (i
= 0; i
< nb_fd
; i
++) {
856 /* Fetch once the poll data */
857 revents
= LTTNG_POLL_GETEV(&events
, i
);
858 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
860 /* Thread quit pipe has been closed. Killing thread. */
861 ret
= check_thread_quit_pipe(pollfd
, revents
);
866 /* Check for data on kernel pipe */
867 if (pollfd
== kernel_poll_pipe
[0] && (revents
& LPOLLIN
)) {
868 ret
= read(kernel_poll_pipe
[0], &tmp
, 1);
869 update_poll_flag
= 1;
873 * New CPU detected by the kernel. Adding kernel stream to
874 * kernel session and updating the kernel consumer
876 if (revents
& LPOLLIN
) {
877 ret
= update_kernel_stream(&kconsumer_data
, pollfd
);
883 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
884 * and unregister kernel stream at this point.
892 DBG("Kernel thread dying");
893 close(kernel_poll_pipe
[0]);
894 close(kernel_poll_pipe
[1]);
896 lttng_poll_clean(&events
);
902 * This thread manage the consumer error sent back to the session daemon.
904 static void *thread_manage_consumer(void *data
)
906 int sock
= 0, i
, ret
, pollfd
;
907 uint32_t revents
, nb_fd
;
908 enum lttcomm_return_code code
;
909 struct lttng_poll_event events
;
910 struct consumer_data
*consumer_data
= data
;
912 DBG("[thread] Manage consumer started");
914 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
920 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
921 * Nothing more will be added to this poll set.
923 ret
= create_thread_poll_set(&events
, 2);
928 ret
= lttng_poll_add(&events
, consumer_data
->err_sock
, LPOLLIN
| LPOLLRDHUP
);
933 nb_fd
= LTTNG_POLL_GETNB(&events
);
935 /* Inifinite blocking call, waiting for transmission */
936 ret
= lttng_poll_wait(&events
, -1);
941 for (i
= 0; i
< nb_fd
; i
++) {
942 /* Fetch once the poll data */
943 revents
= LTTNG_POLL_GETEV(&events
, i
);
944 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
946 /* Thread quit pipe has been closed. Killing thread. */
947 ret
= check_thread_quit_pipe(pollfd
, revents
);
952 /* Event on the registration socket */
953 if (pollfd
== consumer_data
->err_sock
) {
954 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
955 ERR("consumer err socket poll error");
961 sock
= lttcomm_accept_unix_sock(consumer_data
->err_sock
);
966 DBG2("Receiving code from consumer err_sock");
968 /* Getting status code from kconsumerd */
969 ret
= lttcomm_recv_unix_sock(sock
, &code
,
970 sizeof(enum lttcomm_return_code
));
975 if (code
== CONSUMERD_COMMAND_SOCK_READY
) {
976 consumer_data
->cmd_sock
=
977 lttcomm_connect_unix_sock(consumer_data
->cmd_unix_sock_path
);
978 if (consumer_data
->cmd_sock
< 0) {
979 sem_post(&consumer_data
->sem
);
980 PERROR("consumer connect");
983 /* Signal condition to tell that the kconsumerd is ready */
984 sem_post(&consumer_data
->sem
);
985 DBG("consumer command socket ready");
987 ERR("consumer error when waiting for SOCK_READY : %s",
988 lttcomm_get_readable_code(-code
));
992 /* Remove the kconsumerd error sock since we've established a connexion */
993 ret
= lttng_poll_del(&events
, consumer_data
->err_sock
);
998 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLRDHUP
);
1003 /* Update number of fd */
1004 nb_fd
= LTTNG_POLL_GETNB(&events
);
1006 /* Inifinite blocking call, waiting for transmission */
1007 ret
= lttng_poll_wait(&events
, -1);
1012 for (i
= 0; i
< nb_fd
; i
++) {
1013 /* Fetch once the poll data */
1014 revents
= LTTNG_POLL_GETEV(&events
, i
);
1015 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1017 /* Thread quit pipe has been closed. Killing thread. */
1018 ret
= check_thread_quit_pipe(pollfd
, revents
);
1023 /* Event on the kconsumerd socket */
1024 if (pollfd
== sock
) {
1025 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1026 ERR("consumer err socket second poll error");
1032 /* Wait for any kconsumerd error */
1033 ret
= lttcomm_recv_unix_sock(sock
, &code
,
1034 sizeof(enum lttcomm_return_code
));
1036 ERR("consumer closed the command socket");
1040 ERR("consumer return code : %s", lttcomm_get_readable_code(-code
));
1043 DBG("consumer thread dying");
1044 close(consumer_data
->err_sock
);
1045 close(consumer_data
->cmd_sock
);
1048 unlink(consumer_data
->err_unix_sock_path
);
1049 unlink(consumer_data
->cmd_unix_sock_path
);
1050 consumer_data
->pid
= 0;
1052 lttng_poll_clean(&events
);
1058 * This thread manage application communication.
1060 static void *thread_manage_apps(void *data
)
1063 uint32_t revents
, nb_fd
;
1064 struct ust_command ust_cmd
;
1065 struct lttng_poll_event events
;
1067 DBG("[thread] Manage application started");
1069 rcu_register_thread();
1070 rcu_thread_online();
1072 ret
= create_thread_poll_set(&events
, 2);
1077 ret
= lttng_poll_add(&events
, apps_cmd_pipe
[0], LPOLLIN
| LPOLLRDHUP
);
1083 /* Zeroed the events structure */
1084 lttng_poll_reset(&events
);
1086 nb_fd
= LTTNG_POLL_GETNB(&events
);
1088 DBG("Apps thread polling on %d fds", nb_fd
);
1090 /* Inifinite blocking call, waiting for transmission */
1091 ret
= lttng_poll_wait(&events
, -1);
1096 for (i
= 0; i
< nb_fd
; i
++) {
1097 /* Fetch once the poll data */
1098 revents
= LTTNG_POLL_GETEV(&events
, i
);
1099 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1101 /* Thread quit pipe has been closed. Killing thread. */
1102 ret
= check_thread_quit_pipe(pollfd
, revents
);
1107 /* Inspect the apps cmd pipe */
1108 if (pollfd
== apps_cmd_pipe
[0]) {
1109 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1110 ERR("Apps command pipe error");
1112 } else if (revents
& LPOLLIN
) {
1114 ret
= read(apps_cmd_pipe
[0], &ust_cmd
, sizeof(ust_cmd
));
1115 if (ret
< 0 || ret
< sizeof(ust_cmd
)) {
1116 perror("read apps cmd pipe");
1120 /* Register applicaton to the session daemon */
1121 ret
= ust_app_register(&ust_cmd
.reg_msg
,
1123 if (ret
== -ENOMEM
) {
1125 } else if (ret
< 0) {
1130 * Add channel(s) and event(s) to newly registered apps
1131 * from lttng global UST domain.
1133 update_ust_app(ust_cmd
.sock
);
1135 ret
= ustctl_register_done(ust_cmd
.sock
);
1138 * If the registration is not possible, we simply
1139 * unregister the apps and continue
1141 ust_app_unregister(ust_cmd
.sock
);
1144 * We just need here to monitor the close of the UST
1145 * socket and poll set monitor those by default.
1147 ret
= lttng_poll_add(&events
, ust_cmd
.sock
, 0);
1152 DBG("Apps with sock %d added to poll set",
1160 * At this point, we know that a registered application made
1161 * the event at poll_wait.
1163 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1164 /* Removing from the poll set */
1165 ret
= lttng_poll_del(&events
, pollfd
);
1170 /* Socket closed on remote end. */
1171 ust_app_unregister(pollfd
);
1179 DBG("Application communication apps dying");
1180 close(apps_cmd_pipe
[0]);
1181 close(apps_cmd_pipe
[1]);
1183 lttng_poll_clean(&events
);
1185 rcu_thread_offline();
1186 rcu_unregister_thread();
1191 * Dispatch request from the registration threads to the application
1192 * communication thread.
1194 static void *thread_dispatch_ust_registration(void *data
)
1197 struct cds_wfq_node
*node
;
1198 struct ust_command
*ust_cmd
= NULL
;
1200 DBG("[thread] Dispatch UST command started");
1202 while (!dispatch_thread_exit
) {
1203 /* Atomically prepare the queue futex */
1204 futex_nto1_prepare(&ust_cmd_queue
.futex
);
1207 /* Dequeue command for registration */
1208 node
= cds_wfq_dequeue_blocking(&ust_cmd_queue
.queue
);
1210 DBG("Woken up but nothing in the UST command queue");
1211 /* Continue thread execution */
1215 ust_cmd
= caa_container_of(node
, struct ust_command
, node
);
1217 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1218 " gid:%d sock:%d name:%s (version %d.%d)",
1219 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1220 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1221 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1222 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1224 * Inform apps thread of the new application registration. This
1225 * call is blocking so we can be assured that the data will be read
1226 * at some point in time or wait to the end of the world :)
1228 ret
= write(apps_cmd_pipe
[1], ust_cmd
,
1229 sizeof(struct ust_command
));
1231 perror("write apps cmd pipe");
1232 if (errno
== EBADF
) {
1234 * We can't inform the application thread to process
1235 * registration. We will exit or else application
1236 * registration will not occur and tracing will never
1243 } while (node
!= NULL
);
1245 /* Futex wait on queue. Blocking call on futex() */
1246 futex_nto1_wait(&ust_cmd_queue
.futex
);
1250 DBG("Dispatch thread dying");
1255 * This thread manage application registration.
1257 static void *thread_registration_apps(void *data
)
1259 int sock
= 0, i
, ret
, pollfd
;
1260 uint32_t revents
, nb_fd
;
1261 struct lttng_poll_event events
;
1263 * Get allocated in this thread, enqueued to a global queue, dequeued and
1264 * freed in the manage apps thread.
1266 struct ust_command
*ust_cmd
= NULL
;
1268 DBG("[thread] Manage application registration started");
1270 ret
= lttcomm_listen_unix_sock(apps_sock
);
1276 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1277 * more will be added to this poll set.
1279 ret
= create_thread_poll_set(&events
, 2);
1284 /* Add the application registration socket */
1285 ret
= lttng_poll_add(&events
, apps_sock
, LPOLLIN
| LPOLLRDHUP
);
1290 /* Notify all applications to register */
1291 ret
= notify_ust_apps(1);
1293 ERR("Failed to notify applications or create the wait shared memory.\n"
1294 "Execution continues but there might be problem for already\n"
1295 "running applications that wishes to register.");
1299 DBG("Accepting application registration");
1301 nb_fd
= LTTNG_POLL_GETNB(&events
);
1303 /* Inifinite blocking call, waiting for transmission */
1304 ret
= lttng_poll_wait(&events
, -1);
1309 for (i
= 0; i
< nb_fd
; i
++) {
1310 /* Fetch once the poll data */
1311 revents
= LTTNG_POLL_GETEV(&events
, i
);
1312 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
1314 /* Thread quit pipe has been closed. Killing thread. */
1315 ret
= check_thread_quit_pipe(pollfd
, revents
);
1320 /* Event on the registration socket */
1321 if (pollfd
== apps_sock
) {
1322 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
1323 ERR("Register apps socket poll error");
1325 } else if (revents
& LPOLLIN
) {
1326 sock
= lttcomm_accept_unix_sock(apps_sock
);
1331 /* Create UST registration command for enqueuing */
1332 ust_cmd
= zmalloc(sizeof(struct ust_command
));
1333 if (ust_cmd
== NULL
) {
1334 perror("ust command zmalloc");
1339 * Using message-based transmissions to ensure we don't
1340 * have to deal with partially received messages.
1342 ret
= lttcomm_recv_unix_sock(sock
, &ust_cmd
->reg_msg
,
1343 sizeof(struct ust_register_msg
));
1344 if (ret
< 0 || ret
< sizeof(struct ust_register_msg
)) {
1346 perror("lttcomm_recv_unix_sock register apps");
1348 ERR("Wrong size received on apps register");
1355 ust_cmd
->sock
= sock
;
1357 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1358 " gid:%d sock:%d name:%s (version %d.%d)",
1359 ust_cmd
->reg_msg
.pid
, ust_cmd
->reg_msg
.ppid
,
1360 ust_cmd
->reg_msg
.uid
, ust_cmd
->reg_msg
.gid
,
1361 ust_cmd
->sock
, ust_cmd
->reg_msg
.name
,
1362 ust_cmd
->reg_msg
.major
, ust_cmd
->reg_msg
.minor
);
1365 * Lock free enqueue the registration request. The red pill
1366 * has been taken! This apps will be part of the *system*.
1368 cds_wfq_enqueue(&ust_cmd_queue
.queue
, &ust_cmd
->node
);
1371 * Wake the registration queue futex. Implicit memory
1372 * barrier with the exchange in cds_wfq_enqueue.
1374 futex_nto1_wake(&ust_cmd_queue
.futex
);
1381 DBG("UST Registration thread dying");
1383 /* Notify that the registration thread is gone */
1388 unlink(apps_unix_sock_path
);
1390 lttng_poll_clean(&events
);
1396 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
1397 * exec or it will fails.
1399 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
1402 struct timespec timeout
;
1404 timeout
.tv_sec
= DEFAULT_SEM_WAIT_TIMEOUT
;
1405 timeout
.tv_nsec
= 0;
1407 /* Setup semaphore */
1408 ret
= sem_init(&consumer_data
->sem
, 0, 0);
1410 PERROR("sem_init consumer semaphore");
1414 ret
= pthread_create(&consumer_data
->thread
, NULL
,
1415 thread_manage_consumer
, consumer_data
);
1417 PERROR("pthread_create consumer");
1422 /* Get time for sem_timedwait absolute timeout */
1423 ret
= clock_gettime(CLOCK_REALTIME
, &timeout
);
1425 PERROR("clock_gettime spawn consumer");
1426 /* Infinite wait for the kconsumerd thread to be ready */
1427 ret
= sem_wait(&consumer_data
->sem
);
1429 /* Normal timeout if the gettime was successful */
1430 timeout
.tv_sec
+= DEFAULT_SEM_WAIT_TIMEOUT
;
1431 ret
= sem_timedwait(&consumer_data
->sem
, &timeout
);
1435 if (errno
== ETIMEDOUT
) {
1437 * Call has timed out so we kill the kconsumerd_thread and return
1440 ERR("The consumer thread was never ready. Killing it");
1441 ret
= pthread_cancel(consumer_data
->thread
);
1443 PERROR("pthread_cancel consumer thread");
1446 PERROR("semaphore wait failed consumer thread");
1451 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1452 if (consumer_data
->pid
== 0) {
1453 ERR("Kconsumerd did not start");
1454 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1457 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1466 * Join consumer thread
1468 static int join_consumer_thread(struct consumer_data
*consumer_data
)
1473 if (consumer_data
->pid
!= 0) {
1474 ret
= kill(consumer_data
->pid
, SIGTERM
);
1476 ERR("Error killing consumer daemon");
1479 return pthread_join(consumer_data
->thread
, &status
);
1486 * Fork and exec a consumer daemon (consumerd).
1488 * Return pid if successful else -1.
1490 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
1494 const char *verbosity
;
1496 DBG("Spawning consumerd");
1503 if (opt_verbose
> 1 || opt_verbose_consumer
) {
1504 verbosity
= "--verbose";
1506 verbosity
= "--quiet";
1508 switch (consumer_data
->type
) {
1509 case LTTNG_CONSUMER_KERNEL
:
1510 execl(INSTALL_BIN_PATH
"/lttng-consumerd",
1511 "lttng-consumerd", verbosity
, "-k",
1512 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1513 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1516 case LTTNG_CONSUMER64_UST
:
1518 char path
[PATH_MAX
];
1520 snprintf(path
, PATH_MAX
, "%s/%s",
1521 consumerd64_bindir
, consumerd64_prog
);
1522 execl(path
, verbosity
, "-u",
1523 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1524 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1528 case LTTNG_CONSUMER32_UST
:
1530 char path
[PATH_MAX
];
1532 snprintf(path
, PATH_MAX
, "%s/%s",
1533 consumerd32_bindir
, consumerd32_prog
);
1534 execl(path
, verbosity
, "-u",
1535 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
1536 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
1541 perror("unknown consumer type");
1545 perror("kernel start consumer exec");
1548 } else if (pid
> 0) {
1551 perror("start consumer fork");
1558 * Spawn the consumerd daemon and session daemon thread.
1560 static int start_consumerd(struct consumer_data
*consumer_data
)
1564 pthread_mutex_lock(&consumer_data
->pid_mutex
);
1565 if (consumer_data
->pid
!= 0) {
1566 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1570 ret
= spawn_consumerd(consumer_data
);
1572 ERR("Spawning consumerd failed");
1573 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1577 /* Setting up the consumer_data pid */
1578 consumer_data
->pid
= ret
;
1579 DBG2("Consumer pid %d", consumer_data
->pid
);
1580 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
1582 DBG2("Spawning consumer control thread");
1583 ret
= spawn_consumer_thread(consumer_data
);
1585 ERR("Fatal error spawning consumer control thread");
1597 * modprobe_kernel_modules
1599 static int modprobe_kernel_modules(void)
1604 for (i
= 0; i
< ARRAY_SIZE(kernel_modules_list
); i
++) {
1605 ret
= snprintf(modprobe
, sizeof(modprobe
),
1606 "/sbin/modprobe %s%s",
1607 kernel_modules_list
[i
].required
? "" : "-q ",
1608 kernel_modules_list
[i
].name
);
1610 perror("snprintf modprobe");
1613 modprobe
[sizeof(modprobe
) - 1] = '\0';
1614 ret
= system(modprobe
);
1616 ERR("Unable to launch modprobe for module %s",
1617 kernel_modules_list
[i
].name
);
1618 } else if (kernel_modules_list
[i
].required
1619 && WEXITSTATUS(ret
) != 0) {
1620 ERR("Unable to load module %s",
1621 kernel_modules_list
[i
].name
);
1623 DBG("Modprobe successfully %s",
1624 kernel_modules_list
[i
].name
);
1635 static int mount_debugfs(char *path
)
1638 char *type
= "debugfs";
1640 ret
= mkdir_recursive(path
, S_IRWXU
| S_IRWXG
, geteuid(), getegid());
1642 PERROR("Cannot create debugfs path");
1646 ret
= mount(type
, path
, type
, 0, NULL
);
1648 PERROR("Cannot mount debugfs");
1652 DBG("Mounted debugfs successfully at %s", path
);
1659 * Setup necessary data for kernel tracer action.
1661 static void init_kernel_tracer(void)
1664 char *proc_mounts
= "/proc/mounts";
1666 char *debugfs_path
= NULL
, *lttng_path
= NULL
;
1669 /* Detect debugfs */
1670 fp
= fopen(proc_mounts
, "r");
1672 ERR("Unable to probe %s", proc_mounts
);
1676 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1677 if (strstr(line
, "debugfs") != NULL
) {
1678 /* Remove first string */
1680 /* Dup string here so we can reuse line later on */
1681 debugfs_path
= strdup(strtok(NULL
, " "));
1682 DBG("Got debugfs path : %s", debugfs_path
);
1689 /* Mount debugfs if needded */
1690 if (debugfs_path
== NULL
) {
1691 ret
= asprintf(&debugfs_path
, "/mnt/debugfs");
1693 perror("asprintf debugfs path");
1696 ret
= mount_debugfs(debugfs_path
);
1698 perror("Cannot mount debugfs");
1703 /* Modprobe lttng kernel modules */
1704 ret
= modprobe_kernel_modules();
1709 /* Setup lttng kernel path */
1710 ret
= asprintf(<tng_path
, "%s/lttng", debugfs_path
);
1712 perror("asprintf lttng path");
1716 /* Open debugfs lttng */
1717 kernel_tracer_fd
= open(lttng_path
, O_RDWR
);
1718 if (kernel_tracer_fd
< 0) {
1719 DBG("Failed to open %s", lttng_path
);
1725 DBG("Kernel tracer fd %d", kernel_tracer_fd
);
1735 WARN("No kernel tracer available");
1736 kernel_tracer_fd
= 0;
1741 * Init tracing by creating trace directory and sending fds kernel consumer.
1743 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
1747 if (session
->consumer_fds_sent
== 0) {
1749 * Assign default kernel consumer socket if no consumer assigned to the
1750 * kernel session. At this point, it's NOT suppose to be 0 but this is
1751 * an extra security check.
1753 if (session
->consumer_fd
== 0) {
1754 session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1757 ret
= send_kconsumer_session_streams(&kconsumer_data
, session
);
1759 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
1763 session
->consumer_fds_sent
= 1;
1771 * Create an UST session and add it to the session ust list.
1773 static int create_ust_session(struct ltt_session
*session
,
1774 struct lttng_domain
*domain
)
1778 struct ltt_ust_session
*lus
= NULL
;
1780 switch (domain
->type
) {
1781 case LTTNG_DOMAIN_UST
:
1784 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
1788 DBG("Creating UST session");
1791 lus
= trace_ust_create_session(session
->path
, uid
, domain
);
1793 ret
= LTTCOMM_UST_SESS_FAIL
;
1797 ret
= mkdir_recursive(lus
->pathname
, S_IRWXU
| S_IRWXG
,
1798 geteuid(), allowed_group());
1800 if (ret
!= -EEXIST
) {
1801 ERR("Trace directory creation error");
1802 ret
= LTTCOMM_UST_SESS_FAIL
;
1807 /* The domain type dictate different actions on session creation */
1808 switch (domain
->type
) {
1809 case LTTNG_DOMAIN_UST
:
1810 /* No ustctl for the global UST domain */
1813 ERR("Unknown UST domain on create session %d", domain
->type
);
1816 session
->ust_session
= lus
;
1826 * Create a kernel tracer session then create the default channel.
1828 static int create_kernel_session(struct ltt_session
*session
)
1832 DBG("Creating kernel session");
1834 ret
= kernel_create_session(session
, kernel_tracer_fd
);
1836 ret
= LTTCOMM_KERN_SESS_FAIL
;
1840 /* Set kernel consumer socket fd */
1841 if (kconsumer_data
.cmd_sock
) {
1842 session
->kernel_session
->consumer_fd
= kconsumer_data
.cmd_sock
;
1845 ret
= mkdir_recursive(session
->kernel_session
->trace_path
,
1846 S_IRWXU
| S_IRWXG
, geteuid(), allowed_group());
1848 if (ret
!= -EEXIST
) {
1849 ERR("Trace directory creation error");
1859 * Using the session list, filled a lttng_session array to send back to the
1860 * client for session listing.
1862 * The session list lock MUST be acquired before calling this function. Use
1863 * session_lock_list() and session_unlock_list().
1865 static void list_lttng_sessions(struct lttng_session
*sessions
)
1868 struct ltt_session
*session
;
1870 DBG("Getting all available session");
1872 * Iterate over session list and append data after the control struct in
1875 cds_list_for_each_entry(session
, &session_list_ptr
->head
, list
) {
1876 strncpy(sessions
[i
].path
, session
->path
, PATH_MAX
);
1877 sessions
[i
].path
[PATH_MAX
- 1] = '\0';
1878 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
1879 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
1880 sessions
[i
].enabled
= session
->enabled
;
1886 * Fill lttng_channel array of all channels.
1888 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
1889 struct lttng_channel
*channels
)
1892 struct ltt_kernel_channel
*kchan
;
1894 DBG("Listing channels for session %s", session
->name
);
1897 case LTTNG_DOMAIN_KERNEL
:
1898 /* Kernel channels */
1899 if (session
->kernel_session
!= NULL
) {
1900 cds_list_for_each_entry(kchan
,
1901 &session
->kernel_session
->channel_list
.head
, list
) {
1902 /* Copy lttng_channel struct to array */
1903 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
1904 channels
[i
].enabled
= kchan
->enabled
;
1909 case LTTNG_DOMAIN_UST
:
1911 struct cds_lfht_iter iter
;
1912 struct ltt_ust_channel
*uchan
;
1914 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
,
1915 &iter
, uchan
, node
) {
1916 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
1917 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
1918 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1919 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1920 channels
[i
].attr
.switch_timer_interval
=
1921 uchan
->attr
.switch_timer_interval
;
1922 channels
[i
].attr
.read_timer_interval
=
1923 uchan
->attr
.read_timer_interval
;
1924 channels
[i
].attr
.output
= uchan
->attr
.output
;
1925 channels
[i
].enabled
= uchan
->enabled
;
1936 * Create a list of ust global domain events.
1938 static int list_lttng_ust_global_events(char *channel_name
,
1939 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
1942 unsigned int nb_event
= 0;
1943 struct cds_lfht_iter iter
;
1944 struct ltt_ust_channel
*uchan
;
1945 struct ltt_ust_event
*uevent
;
1946 struct lttng_event
*tmp
;
1948 DBG("Listing UST global events for channel %s", channel_name
);
1952 /* Count events in all channels */
1953 cds_lfht_for_each_entry(ust_global
->channels
, &iter
, uchan
, node
) {
1954 nb_event
+= hashtable_get_count(uchan
->events
);
1957 if (nb_event
== 0) {
1962 DBG3("Listing UST global %d events", nb_event
);
1964 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
1966 ret
= -LTTCOMM_FATAL
;
1970 cds_lfht_for_each_entry(ust_global
->channels
, &iter
, uchan
, node
) {
1971 cds_lfht_for_each_entry(uchan
->events
, &iter
, uevent
, node
) {
1972 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
1973 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1974 tmp
[i
].enabled
= uevent
->enabled
;
1975 switch (uevent
->attr
.instrumentation
) {
1976 case LTTNG_UST_TRACEPOINT
:
1977 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
1979 case LTTNG_UST_PROBE
:
1980 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
1982 case LTTNG_UST_FUNCTION
:
1983 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
1999 * Fill lttng_event array of all kernel events in the channel.
2001 static int list_lttng_kernel_events(char *channel_name
,
2002 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
2005 unsigned int nb_event
;
2006 struct ltt_kernel_event
*event
;
2007 struct ltt_kernel_channel
*kchan
;
2009 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
2010 if (kchan
== NULL
) {
2011 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2015 nb_event
= kchan
->event_count
;
2017 DBG("Listing events for channel %s", kchan
->channel
->name
);
2019 if (nb_event
== 0) {
2024 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
2025 if (*events
== NULL
) {
2026 ret
= LTTCOMM_FATAL
;
2030 /* Kernel channels */
2031 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
2032 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
2033 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
2034 (*events
)[i
].enabled
= event
->enabled
;
2035 switch (event
->event
->instrumentation
) {
2036 case LTTNG_KERNEL_TRACEPOINT
:
2037 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
2039 case LTTNG_KERNEL_KPROBE
:
2040 case LTTNG_KERNEL_KRETPROBE
:
2041 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
2042 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
2043 sizeof(struct lttng_kernel_kprobe
));
2045 case LTTNG_KERNEL_FUNCTION
:
2046 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
2047 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
2048 sizeof(struct lttng_kernel_function
));
2050 case LTTNG_KERNEL_NOOP
:
2051 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
2053 case LTTNG_KERNEL_SYSCALL
:
2054 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
2056 case LTTNG_KERNEL_ALL
:
2070 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
2072 static int cmd_disable_channel(struct ltt_session
*session
,
2073 int domain
, char *channel_name
)
2078 case LTTNG_DOMAIN_KERNEL
:
2079 ret
= channel_kernel_disable(session
->kernel_session
,
2081 if (ret
!= LTTCOMM_OK
) {
2085 kernel_wait_quiescent(kernel_tracer_fd
);
2087 case LTTNG_DOMAIN_UST_PID
:
2090 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2101 * Copy channel from attributes and set it in the application channel list.
2104 static int copy_ust_channel_to_app(struct ltt_ust_session *usess,
2105 struct lttng_channel *attr, struct ust_app *app)
2108 struct ltt_ust_channel *uchan, *new_chan;
2110 uchan = trace_ust_get_channel_by_key(usess->channels, attr->name);
2111 if (uchan == NULL) {
2112 ret = LTTCOMM_FATAL;
2116 new_chan = trace_ust_create_channel(attr, usess->path);
2117 if (new_chan == NULL) {
2118 PERROR("malloc ltt_ust_channel");
2119 ret = LTTCOMM_FATAL;
2123 ret = channel_ust_copy(new_chan, uchan);
2125 ret = LTTCOMM_FATAL;
2135 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
2137 static int cmd_enable_channel(struct ltt_session
*session
,
2138 int domain
, struct lttng_channel
*attr
)
2141 struct ltt_ust_session
*usess
= session
->ust_session
;
2143 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
2146 case LTTNG_DOMAIN_KERNEL
:
2148 struct ltt_kernel_channel
*kchan
;
2150 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
2151 session
->kernel_session
);
2152 if (kchan
== NULL
) {
2153 ret
= channel_kernel_create(session
->kernel_session
,
2154 attr
, kernel_poll_pipe
[1]);
2156 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
2159 if (ret
!= LTTCOMM_OK
) {
2163 kernel_wait_quiescent(kernel_tracer_fd
);
2166 case LTTNG_DOMAIN_UST
:
2168 struct ltt_ust_channel
*uchan
;
2170 DBG2("Enabling channel for LTTNG_DOMAIN_UST");
2172 /* Get channel in global UST domain HT */
2173 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2175 if (uchan
== NULL
) {
2176 uchan
= trace_ust_create_channel(attr
, usess
->pathname
);
2177 if (uchan
== NULL
) {
2178 ret
= LTTCOMM_UST_CHAN_FAIL
;
2183 hashtable_add_unique(usess
->domain_global
.channels
, &uchan
->node
);
2185 DBG2("UST channel %s added to global domain HT", attr
->name
);
2187 ret
= LTTCOMM_UST_CHAN_EXIST
;
2191 /* Add channel to all registered applications */
2192 ret
= ust_app_create_channel_all(usess
, uchan
);
2201 case LTTNG_DOMAIN_UST_PID
:
2205 struct ltt_ust_channel *uchan;
2206 struct ltt_ust_session *usess;
2207 struct ust_app *app;
2209 usess = trace_ust_get_session_by_pid(&session->ust_session_list,
2211 if (usess == NULL) {
2212 ret = LTTCOMM_UST_CHAN_NOT_FOUND;
2216 app = ust_app_get_by_pid(domain->attr.pid);
2218 ret = LTTCOMM_APP_NOT_FOUND;
2223 uchan = trace_ust_get_channel_by_name(attr->name, usess);
2224 if (uchan == NULL) {
2225 ret = channel_ust_create(usess, attr, sock);
2227 ret = channel_ust_enable(usess, uchan, sock);
2230 if (ret != LTTCOMM_OK) {
2234 ret = copy_ust_channel_to_app(usess, attr, app);
2235 if (ret != LTTCOMM_OK) {
2239 DBG("UST channel %s created for app sock %d with pid %d",
2240 attr->name, app->sock, domain->attr.pid);
2242 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2246 ret
= LTTCOMM_UNKNOWN_DOMAIN
;
2257 * Command LTTNG_DISABLE_EVENT processed by the client thread.
2259 static int cmd_disable_event(struct ltt_session
*session
, int domain
,
2260 char *channel_name
, char *event_name
)
2265 case LTTNG_DOMAIN_KERNEL
:
2267 struct ltt_kernel_channel
*kchan
;
2269 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2270 session
->kernel_session
);
2271 if (kchan
== NULL
) {
2272 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2276 ret
= event_kernel_disable_tracepoint(session
->kernel_session
, kchan
, event_name
);
2277 if (ret
!= LTTCOMM_OK
) {
2281 kernel_wait_quiescent(kernel_tracer_fd
);
2284 case LTTNG_DOMAIN_UST
:
2285 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2286 case LTTNG_DOMAIN_UST_PID
:
2287 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2289 /* TODO: Other UST domains */
2290 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2301 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
2303 static int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
2307 struct ltt_kernel_channel
*kchan
;
2310 case LTTNG_DOMAIN_KERNEL
:
2311 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2312 session
->kernel_session
);
2313 if (kchan
== NULL
) {
2314 ret
= LTTCOMM_KERN_CHAN_NOT_FOUND
;
2318 ret
= event_kernel_disable_all(session
->kernel_session
, kchan
);
2319 if (ret
!= LTTCOMM_OK
) {
2323 kernel_wait_quiescent(kernel_tracer_fd
);
2326 /* TODO: Userspace tracing */
2327 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2338 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2340 static int cmd_add_context(struct ltt_session
*session
, int domain
,
2341 char *channel_name
, char *event_name
, struct lttng_event_context
*ctx
)
2346 case LTTNG_DOMAIN_KERNEL
:
2347 /* Add kernel context to kernel tracer */
2348 ret
= context_kernel_add(session
->kernel_session
, ctx
,
2349 event_name
, channel_name
);
2350 if (ret
!= LTTCOMM_OK
) {
2354 case LTTNG_DOMAIN_UST
:
2357 struct ltt_ust_session *usess;
2359 cds_list_for_each_entry(usess, &session->ust_session_list.head, list) {
2360 ret = context_ust_add(usess, ctx,
2361 event_name, channel_name, domain);
2362 if (ret != LTTCOMM_OK) {
2370 /* TODO: UST other domains */
2371 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2382 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2384 static int cmd_enable_event(struct ltt_session
*session
, int domain
,
2385 char *channel_name
, struct lttng_event
*event
)
2388 struct lttng_channel
*attr
;
2389 struct ltt_ust_session
*usess
= session
->ust_session
;
2392 case LTTNG_DOMAIN_KERNEL
:
2394 struct ltt_kernel_channel
*kchan
;
2396 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2397 session
->kernel_session
);
2398 if (kchan
== NULL
) {
2399 attr
= channel_new_default_attr(domain
);
2401 ret
= LTTCOMM_FATAL
;
2404 snprintf(attr
->name
, NAME_MAX
, "%s", channel_name
);
2406 /* This call will notify the kernel thread */
2407 ret
= channel_kernel_create(session
->kernel_session
,
2408 attr
, kernel_poll_pipe
[1]);
2409 if (ret
!= LTTCOMM_OK
) {
2414 /* Get the newly created kernel channel pointer */
2415 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2416 session
->kernel_session
);
2417 if (kchan
== NULL
) {
2418 /* This sould not happen... */
2419 ret
= LTTCOMM_FATAL
;
2423 ret
= event_kernel_enable_tracepoint(session
->kernel_session
, kchan
,
2425 if (ret
!= LTTCOMM_OK
) {
2429 kernel_wait_quiescent(kernel_tracer_fd
);
2432 case LTTNG_DOMAIN_UST
:
2434 struct ltt_ust_channel
*uchan
;
2435 struct ltt_ust_event
*uevent
;
2436 struct lttng_channel
*attr
;
2438 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2440 if (uchan
== NULL
) {
2441 /* Create default channel */
2442 attr
= channel_new_default_attr(domain
);
2444 ret
= LTTCOMM_FATAL
;
2448 /* Use the internal command enable channel */
2449 ret
= cmd_enable_channel(session
, domain
, attr
);
2456 /* Get the newly created channel reference back */
2457 uchan
= trace_ust_find_channel_by_name(
2458 usess
->domain_global
.channels
, channel_name
);
2459 if (uchan
== NULL
) {
2460 /* Something is really wrong */
2461 ret
= LTTCOMM_FATAL
;
2466 uevent
= trace_ust_find_event_by_name(uchan
->events
, event
->name
);
2467 if (uevent
== NULL
) {
2468 uevent
= trace_ust_create_event(event
);
2469 if (uevent
== NULL
) {
2470 ret
= LTTCOMM_FATAL
;
2476 ret
= ust_app_create_event_all(usess
, uchan
, uevent
);
2478 ret
= LTTCOMM_UST_ENABLE_FAIL
;
2482 /* Add ltt ust event to channel */
2484 hashtable_add_unique(uchan
->events
, &uevent
->node
);
2487 uevent
->enabled
= 1;
2489 DBG3("UST ltt event %s added to channel %s", uevent
->attr
.name
,
2493 case LTTNG_DOMAIN_UST_EXEC_NAME
:
2494 case LTTNG_DOMAIN_UST_PID
:
2495 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
2497 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2508 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2510 static int cmd_enable_event_all(struct ltt_session
*session
, int domain
,
2511 char *channel_name
, int event_type
)
2514 struct ltt_kernel_channel
*kchan
;
2517 case LTTNG_DOMAIN_KERNEL
:
2518 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2519 session
->kernel_session
);
2520 if (kchan
== NULL
) {
2521 /* This call will notify the kernel thread */
2522 ret
= channel_kernel_create(session
->kernel_session
, NULL
,
2523 kernel_poll_pipe
[1]);
2524 if (ret
!= LTTCOMM_OK
) {
2529 /* Get the newly created kernel channel pointer */
2530 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2531 session
->kernel_session
);
2532 if (kchan
== NULL
) {
2533 /* This sould not happen... */
2534 ret
= LTTCOMM_FATAL
;
2538 switch (event_type
) {
2539 case LTTNG_KERNEL_SYSCALL
:
2540 ret
= event_kernel_enable_all_syscalls(session
->kernel_session
,
2541 kchan
, kernel_tracer_fd
);
2543 case LTTNG_KERNEL_TRACEPOINT
:
2545 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2546 * events already registered to the channel.
2548 ret
= event_kernel_enable_all_tracepoints(session
->kernel_session
,
2549 kchan
, kernel_tracer_fd
);
2551 case LTTNG_KERNEL_ALL
:
2552 /* Enable syscalls and tracepoints */
2553 ret
= event_kernel_enable_all(session
->kernel_session
,
2554 kchan
, kernel_tracer_fd
);
2557 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2560 if (ret
!= LTTCOMM_OK
) {
2564 kernel_wait_quiescent(kernel_tracer_fd
);
2567 /* TODO: Userspace tracing */
2568 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2579 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2581 static ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
2584 ssize_t nb_events
= 0;
2587 case LTTNG_DOMAIN_KERNEL
:
2588 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
2589 if (nb_events
< 0) {
2590 ret
= LTTCOMM_KERN_LIST_FAIL
;
2594 case LTTNG_DOMAIN_UST
:
2595 nb_events
= ust_app_list_events(events
);
2596 if (nb_events
< 0) {
2597 ret
= LTTCOMM_UST_LIST_FAIL
;
2602 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2609 /* Return negative value to differentiate return code */
2614 * Command LTTNG_START_TRACE processed by the client thread.
2616 static int cmd_start_trace(struct ltt_session
*session
)
2619 struct ltt_kernel_session
*ksession
;
2620 struct ltt_ust_session
*usess
;
2623 ksession
= session
->kernel_session
;
2624 usess
= session
->ust_session
;
2626 if (session
->enabled
)
2627 return LTTCOMM_UST_START_FAIL
;
2628 session
->enabled
= 1;
2630 /* Kernel tracing */
2631 if (ksession
!= NULL
) {
2632 struct ltt_kernel_channel
*kchan
;
2634 /* Open kernel metadata */
2635 if (ksession
->metadata
== NULL
) {
2636 ret
= kernel_open_metadata(ksession
, ksession
->trace_path
);
2638 ret
= LTTCOMM_KERN_META_FAIL
;
2643 /* Open kernel metadata stream */
2644 if (ksession
->metadata_stream_fd
== 0) {
2645 ret
= kernel_open_metadata_stream(ksession
);
2647 ERR("Kernel create metadata stream failed");
2648 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2653 /* For each channel */
2654 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2655 if (kchan
->stream_count
== 0) {
2656 ret
= kernel_open_channel_stream(kchan
);
2658 ret
= LTTCOMM_KERN_STREAM_FAIL
;
2661 /* Update the stream global counter */
2662 ksession
->stream_count_global
+= ret
;
2666 /* Setup kernel consumer socket and send fds to it */
2667 ret
= init_kernel_tracing(ksession
);
2669 ret
= LTTCOMM_KERN_START_FAIL
;
2673 /* This start the kernel tracing */
2674 ret
= kernel_start_session(ksession
);
2676 ret
= LTTCOMM_KERN_START_FAIL
;
2680 /* Quiescent wait after starting trace */
2681 kernel_wait_quiescent(kernel_tracer_fd
);
2684 /* Flag session that trace should start automatically */
2686 usess
->start_trace
= 1;
2688 ret
= ust_app_start_trace_all(usess
);
2690 ret
= LTTCOMM_UST_START_FAIL
;
2702 * Command LTTNG_STOP_TRACE processed by the client thread.
2704 static int cmd_stop_trace(struct ltt_session
*session
)
2707 struct ltt_kernel_channel
*kchan
;
2708 struct ltt_kernel_session
*ksession
;
2709 struct ltt_ust_session
*usess
;
2712 ksession
= session
->kernel_session
;
2713 usess
= session
->ust_session
;
2715 if (!session
->enabled
)
2716 return LTTCOMM_UST_START_FAIL
;
2717 session
->enabled
= 0;
2720 if (ksession
!= NULL
) {
2721 DBG("Stop kernel tracing");
2723 /* Flush all buffers before stopping */
2724 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2726 ERR("Kernel metadata flush failed");
2729 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2730 ret
= kernel_flush_buffer(kchan
);
2732 ERR("Kernel flush buffer error");
2736 ret
= kernel_stop_session(ksession
);
2738 ret
= LTTCOMM_KERN_STOP_FAIL
;
2742 kernel_wait_quiescent(kernel_tracer_fd
);
2746 usess
->start_trace
= 0;
2748 ret
= ust_app_stop_trace_all(usess
);
2750 ret
= LTTCOMM_UST_START_FAIL
;
2762 * Command LTTNG_CREATE_SESSION processed by the client thread.
2764 static int cmd_create_session(char *name
, char *path
)
2768 ret
= session_create(name
, path
);
2769 if (ret
!= LTTCOMM_OK
) {
2780 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2782 static int cmd_destroy_session(struct ltt_session
*session
, char *name
)
2786 /* Clean kernel session teardown */
2787 teardown_kernel_session(session
);
2788 /* UST session teardown */
2789 teardown_ust_session(session
);
2792 * Must notify the kernel thread here to update it's poll setin order
2793 * to remove the channel(s)' fd just destroyed.
2795 ret
= notify_thread_pipe(kernel_poll_pipe
[1]);
2797 perror("write kernel poll pipe");
2800 ret
= session_destroy(session
);
2806 * Command LTTNG_CALIBRATE processed by the client thread.
2808 static int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2813 case LTTNG_DOMAIN_KERNEL
:
2815 struct lttng_kernel_calibrate kcalibrate
;
2817 kcalibrate
.type
= calibrate
->type
;
2818 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2820 ret
= LTTCOMM_KERN_ENABLE_FAIL
;
2826 /* TODO: Userspace tracing */
2827 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2838 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2840 static int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2846 case LTTNG_DOMAIN_KERNEL
:
2847 /* Can't register a consumer if there is already one */
2848 if (session
->kernel_session
->consumer_fd
!= 0) {
2849 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
2853 sock
= lttcomm_connect_unix_sock(sock_path
);
2855 ret
= LTTCOMM_CONNECT_FAIL
;
2859 session
->kernel_session
->consumer_fd
= sock
;
2862 /* TODO: Userspace tracing */
2863 ret
= LTTCOMM_NOT_IMPLEMENTED
;
2874 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2876 static ssize_t
cmd_list_domains(struct ltt_session
*session
,
2877 struct lttng_domain
**domains
)
2882 if (session
->kernel_session
!= NULL
) {
2883 DBG3("Listing domains found kernel domain");
2887 if (session
->ust_session
!= NULL
) {
2888 DBG3("Listing domains found UST global domain");
2892 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2893 if (*domains
== NULL
) {
2894 ret
= -LTTCOMM_FATAL
;
2898 if (session
->kernel_session
!= NULL
) {
2899 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2903 if (session
->ust_session
!= NULL
) {
2904 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2915 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2917 static ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2918 struct lttng_channel
**channels
)
2921 ssize_t nb_chan
= 0;
2924 case LTTNG_DOMAIN_KERNEL
:
2925 if (session
->kernel_session
!= NULL
) {
2926 nb_chan
= session
->kernel_session
->channel_count
;
2928 DBG3("Number of kernel channels %zd", nb_chan
);
2930 case LTTNG_DOMAIN_UST
:
2931 if (session
->ust_session
!= NULL
) {
2932 nb_chan
= hashtable_get_count(
2933 session
->ust_session
->domain_global
.channels
);
2935 DBG3("Number of UST global channels %zd", nb_chan
);
2939 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
2944 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2945 if (*channels
== NULL
) {
2946 ret
= -LTTCOMM_FATAL
;
2950 list_lttng_channels(domain
, session
, *channels
);
2962 * Command LTTNG_LIST_EVENTS processed by the client thread.
2964 static ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2965 char *channel_name
, struct lttng_event
**events
)
2968 ssize_t nb_event
= 0;
2971 case LTTNG_DOMAIN_KERNEL
:
2972 if (session
->kernel_session
!= NULL
) {
2973 nb_event
= list_lttng_kernel_events(channel_name
,
2974 session
->kernel_session
, events
);
2977 case LTTNG_DOMAIN_UST
:
2979 if (session
->ust_session
!= NULL
) {
2980 nb_event
= list_lttng_ust_global_events(channel_name
,
2981 &session
->ust_session
->domain_global
, events
);
2986 ret
= -LTTCOMM_NOT_IMPLEMENTED
;
2997 * Process the command requested by the lttng client within the command
2998 * context structure. This function make sure that the return structure (llm)
2999 * is set and ready for transmission before returning.
3001 * Return any error encountered or 0 for success.
3003 static int process_client_msg(struct command_ctx
*cmd_ctx
)
3005 int ret
= LTTCOMM_OK
;
3006 int need_tracing_session
= 1;
3008 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
3011 * Check for command that don't needs to allocate a returned payload. We do
3012 * this here so we don't have to make the call for no payload at each
3015 switch(cmd_ctx
->lsm
->cmd_type
) {
3016 case LTTNG_LIST_SESSIONS
:
3017 case LTTNG_LIST_TRACEPOINTS
:
3018 case LTTNG_LIST_DOMAINS
:
3019 case LTTNG_LIST_CHANNELS
:
3020 case LTTNG_LIST_EVENTS
:
3023 /* Setup lttng message with no payload */
3024 ret
= setup_lttng_msg(cmd_ctx
, 0);
3026 /* This label does not try to unlock the session */
3027 goto init_setup_error
;
3031 /* Commands that DO NOT need a session. */
3032 switch (cmd_ctx
->lsm
->cmd_type
) {
3033 case LTTNG_CALIBRATE
:
3034 case LTTNG_CREATE_SESSION
:
3035 case LTTNG_LIST_SESSIONS
:
3036 case LTTNG_LIST_TRACEPOINTS
:
3037 need_tracing_session
= 0;
3040 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
3041 session_lock_list();
3042 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
3043 session_unlock_list();
3044 if (cmd_ctx
->session
== NULL
) {
3045 if (cmd_ctx
->lsm
->session
.name
!= NULL
) {
3046 ret
= LTTCOMM_SESS_NOT_FOUND
;
3048 /* If no session name specified */
3049 ret
= LTTCOMM_SELECT_SESS
;
3053 /* Acquire lock for the session */
3054 session_lock(cmd_ctx
->session
);
3060 * Check domain type for specific "pre-action".
3062 switch (cmd_ctx
->lsm
->domain
.type
) {
3063 case LTTNG_DOMAIN_KERNEL
:
3064 /* Kernel tracer check */
3065 if (kernel_tracer_fd
== 0) {
3066 /* Basically, load kernel tracer modules */
3067 init_kernel_tracer();
3068 if (kernel_tracer_fd
== 0) {
3069 ret
= LTTCOMM_KERN_NA
;
3074 /* Need a session for kernel command */
3075 if (need_tracing_session
) {
3076 if (cmd_ctx
->session
->kernel_session
== NULL
) {
3077 ret
= create_kernel_session(cmd_ctx
->session
);
3079 ret
= LTTCOMM_KERN_SESS_FAIL
;
3084 /* Start the kernel consumer daemon */
3085 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
3086 if (kconsumer_data
.pid
== 0 &&
3087 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3088 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3089 ret
= start_consumerd(&kconsumer_data
);
3091 ret
= LTTCOMM_KERN_CONSUMER_FAIL
;
3095 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
3099 case LTTNG_DOMAIN_UST
:
3101 if (need_tracing_session
) {
3102 if (cmd_ctx
->session
->ust_session
== NULL
) {
3103 ret
= create_ust_session(cmd_ctx
->session
,
3104 &cmd_ctx
->lsm
->domain
);
3105 if (ret
!= LTTCOMM_OK
) {
3109 /* Start the UST consumer daemons */
3111 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
3112 if (consumerd64_bindir
[0] != '\0' &&
3113 ustconsumer64_data
.pid
== 0 &&
3114 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3115 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3116 ret
= start_consumerd(&ustconsumer64_data
);
3118 ret
= LTTCOMM_UST_CONSUMER64_FAIL
;
3119 ust_consumerd64_fd
= -EINVAL
;
3123 ust_consumerd64_fd
= ustconsumer64_data
.cmd_sock
;
3125 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
3128 if (consumerd32_bindir
[0] != '\0' &&
3129 ustconsumer32_data
.pid
== 0 &&
3130 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
3131 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3132 ret
= start_consumerd(&ustconsumer32_data
);
3134 ret
= LTTCOMM_UST_CONSUMER32_FAIL
;
3135 ust_consumerd32_fd
= -EINVAL
;
3138 ust_consumerd32_fd
= ustconsumer32_data
.cmd_sock
;
3140 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
3149 /* Process by command type */
3150 switch (cmd_ctx
->lsm
->cmd_type
) {
3151 case LTTNG_ADD_CONTEXT
:
3153 ret
= cmd_add_context(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3154 cmd_ctx
->lsm
->u
.context
.channel_name
,
3155 cmd_ctx
->lsm
->u
.context
.event_name
,
3156 &cmd_ctx
->lsm
->u
.context
.ctx
);
3159 case LTTNG_DISABLE_CHANNEL
:
3161 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3162 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3165 case LTTNG_DISABLE_EVENT
:
3167 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3168 cmd_ctx
->lsm
->u
.disable
.channel_name
,
3169 cmd_ctx
->lsm
->u
.disable
.name
);
3173 case LTTNG_DISABLE_ALL_EVENT
:
3175 DBG("Disabling all events");
3177 ret
= cmd_disable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3178 cmd_ctx
->lsm
->u
.disable
.channel_name
);
3181 case LTTNG_ENABLE_CHANNEL
:
3183 ret
= cmd_enable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3184 &cmd_ctx
->lsm
->u
.channel
.chan
);
3187 case LTTNG_ENABLE_EVENT
:
3189 ret
= cmd_enable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3190 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3191 &cmd_ctx
->lsm
->u
.enable
.event
);
3194 case LTTNG_ENABLE_ALL_EVENT
:
3196 DBG("Enabling all events");
3198 ret
= cmd_enable_event_all(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3199 cmd_ctx
->lsm
->u
.enable
.channel_name
,
3200 cmd_ctx
->lsm
->u
.enable
.event
.type
);
3203 case LTTNG_LIST_TRACEPOINTS
:
3205 struct lttng_event
*events
;
3208 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
3209 if (nb_events
< 0) {
3215 * Setup lttng message with payload size set to the event list size in
3216 * bytes and then copy list into the llm payload.
3218 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_event
) * nb_events
);
3224 /* Copy event list into message payload */
3225 memcpy(cmd_ctx
->llm
->payload
, events
,
3226 sizeof(struct lttng_event
) * nb_events
);
3233 case LTTNG_START_TRACE
:
3235 ret
= cmd_start_trace(cmd_ctx
->session
);
3238 case LTTNG_STOP_TRACE
:
3240 ret
= cmd_stop_trace(cmd_ctx
->session
);
3243 case LTTNG_CREATE_SESSION
:
3245 ret
= cmd_create_session(cmd_ctx
->lsm
->session
.name
,
3246 cmd_ctx
->lsm
->session
.path
);
3249 case LTTNG_DESTROY_SESSION
:
3251 ret
= cmd_destroy_session(cmd_ctx
->session
,
3252 cmd_ctx
->lsm
->session
.name
);
3255 case LTTNG_LIST_DOMAINS
:
3258 struct lttng_domain
*domains
;
3260 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
3266 ret
= setup_lttng_msg(cmd_ctx
, nb_dom
* sizeof(struct lttng_domain
));
3271 /* Copy event list into message payload */
3272 memcpy(cmd_ctx
->llm
->payload
, domains
,
3273 nb_dom
* sizeof(struct lttng_domain
));
3280 case LTTNG_LIST_CHANNELS
:
3283 struct lttng_channel
*channels
;
3285 nb_chan
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
3286 cmd_ctx
->session
, &channels
);
3292 ret
= setup_lttng_msg(cmd_ctx
, nb_chan
* sizeof(struct lttng_channel
));
3297 /* Copy event list into message payload */
3298 memcpy(cmd_ctx
->llm
->payload
, channels
,
3299 nb_chan
* sizeof(struct lttng_channel
));
3306 case LTTNG_LIST_EVENTS
:
3309 struct lttng_event
*events
= NULL
;
3311 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
, cmd_ctx
->session
,
3312 cmd_ctx
->lsm
->u
.list
.channel_name
, &events
);
3318 ret
= setup_lttng_msg(cmd_ctx
, nb_event
* sizeof(struct lttng_event
));
3323 /* Copy event list into message payload */
3324 memcpy(cmd_ctx
->llm
->payload
, events
,
3325 nb_event
* sizeof(struct lttng_event
));
3332 case LTTNG_LIST_SESSIONS
:
3334 session_lock_list();
3336 if (session_list_ptr
->count
== 0) {
3337 ret
= LTTCOMM_NO_SESSION
;
3338 session_unlock_list();
3342 ret
= setup_lttng_msg(cmd_ctx
, sizeof(struct lttng_session
) *
3343 session_list_ptr
->count
);
3345 session_unlock_list();
3349 /* Filled the session array */
3350 list_lttng_sessions((struct lttng_session
*)(cmd_ctx
->llm
->payload
));
3352 session_unlock_list();
3357 case LTTNG_CALIBRATE
:
3359 ret
= cmd_calibrate(cmd_ctx
->lsm
->domain
.type
,
3360 &cmd_ctx
->lsm
->u
.calibrate
);
3363 case LTTNG_REGISTER_CONSUMER
:
3365 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
3366 cmd_ctx
->lsm
->u
.reg
.path
);
3375 if (cmd_ctx
->llm
== NULL
) {
3376 DBG("Missing llm structure. Allocating one.");
3377 if (setup_lttng_msg(cmd_ctx
, 0) < 0) {
3381 /* Set return code */
3382 cmd_ctx
->llm
->ret_code
= ret
;
3384 if (cmd_ctx
->session
) {
3385 session_unlock(cmd_ctx
->session
);
3392 * This thread manage all clients request using the unix client socket for
3395 static void *thread_manage_clients(void *data
)
3397 int sock
= 0, ret
, i
, pollfd
;
3398 uint32_t revents
, nb_fd
;
3399 struct command_ctx
*cmd_ctx
= NULL
;
3400 struct lttng_poll_event events
;
3402 DBG("[thread] Manage client started");
3404 rcu_register_thread();
3406 ret
= lttcomm_listen_unix_sock(client_sock
);
3412 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
3413 * more will be added to this poll set.
3415 ret
= create_thread_poll_set(&events
, 2);
3420 /* Add the application registration socket */
3421 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
3427 * Notify parent pid that we are ready to accept command for client side.
3429 if (opt_sig_parent
) {
3430 kill(ppid
, SIGCHLD
);
3434 DBG("Accepting client command ...");
3436 nb_fd
= LTTNG_POLL_GETNB(&events
);
3438 /* Inifinite blocking call, waiting for transmission */
3439 ret
= lttng_poll_wait(&events
, -1);
3444 for (i
= 0; i
< nb_fd
; i
++) {
3445 /* Fetch once the poll data */
3446 revents
= LTTNG_POLL_GETEV(&events
, i
);
3447 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3449 /* Thread quit pipe has been closed. Killing thread. */
3450 ret
= check_thread_quit_pipe(pollfd
, revents
);
3455 /* Event on the registration socket */
3456 if (pollfd
== client_sock
) {
3457 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
3458 ERR("Client socket poll error");
3464 DBG("Wait for client response");
3466 sock
= lttcomm_accept_unix_sock(client_sock
);
3471 /* Allocate context command to process the client request */
3472 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
3473 if (cmd_ctx
== NULL
) {
3474 perror("zmalloc cmd_ctx");
3478 /* Allocate data buffer for reception */
3479 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
3480 if (cmd_ctx
->lsm
== NULL
) {
3481 perror("zmalloc cmd_ctx->lsm");
3485 cmd_ctx
->llm
= NULL
;
3486 cmd_ctx
->session
= NULL
;
3489 * Data is received from the lttng client. The struct
3490 * lttcomm_session_msg (lsm) contains the command and data request of
3493 DBG("Receiving data from client ...");
3494 ret
= lttcomm_recv_unix_sock(sock
, cmd_ctx
->lsm
,
3495 sizeof(struct lttcomm_session_msg
));
3497 DBG("Nothing recv() from client... continuing");
3503 // TODO: Validate cmd_ctx including sanity check for
3504 // security purpose.
3506 rcu_thread_online();
3508 * This function dispatch the work to the kernel or userspace tracer
3509 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3510 * informations for the client. The command context struct contains
3511 * everything this function may needs.
3513 ret
= process_client_msg(cmd_ctx
);
3514 rcu_thread_offline();
3517 * TODO: Inform client somehow of the fatal error. At
3518 * this point, ret < 0 means that a zmalloc failed
3519 * (ENOMEM). Error detected but still accept command.
3521 clean_command_ctx(&cmd_ctx
);
3525 DBG("Sending response (size: %d, retcode: %s)",
3526 cmd_ctx
->lttng_msg_size
,
3527 lttng_strerror(-cmd_ctx
->llm
->ret_code
));
3528 ret
= send_unix_sock(sock
, cmd_ctx
->llm
, cmd_ctx
->lttng_msg_size
);
3530 ERR("Failed to send data back to client");
3533 clean_command_ctx(&cmd_ctx
);
3535 /* End of transmission */
3540 DBG("Client thread dying");
3541 unlink(client_unix_sock_path
);
3545 lttng_poll_clean(&events
);
3546 clean_command_ctx(&cmd_ctx
);
3548 rcu_unregister_thread();
3554 * usage function on stderr
3556 static void usage(void)
3558 fprintf(stderr
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
3559 fprintf(stderr
, " -h, --help Display this usage.\n");
3560 fprintf(stderr
, " -c, --client-sock PATH Specify path for the client unix socket\n");
3561 fprintf(stderr
, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3562 fprintf(stderr
, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3563 fprintf(stderr
, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3564 fprintf(stderr
, " --ustconsumerd32-err-sock PATH Specify path for the 32-bit UST consumer error socket\n");
3565 fprintf(stderr
, " --ustconsumerd64-err-sock PATH Specify path for the 64-bit UST consumer error socket\n");
3566 fprintf(stderr
, " --ustconsumerd32-cmd-sock PATH Specify path for the 32-bit UST consumer command socket\n");
3567 fprintf(stderr
, " --ustconsumerd64-cmd-sock PATH Specify path for the 64-bit UST consumer command socket\n");
3568 fprintf(stderr
, " --ustconsumerd32 PATH Specify path for the 32-bit UST consumer daemon binary\n");
3569 fprintf(stderr
, " --ustconsumerd64 PATH Specify path for the 64-bit UST consumer daemon binary\n");
3570 fprintf(stderr
, " -d, --daemonize Start as a daemon.\n");
3571 fprintf(stderr
, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3572 fprintf(stderr
, " -V, --version Show version number.\n");
3573 fprintf(stderr
, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3574 fprintf(stderr
, " -q, --quiet No output at all.\n");
3575 fprintf(stderr
, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3576 fprintf(stderr
, " --verbose-consumer Verbose mode for consumer. Activate DBG() macro.\n");
3580 * daemon argument parsing
3582 static int parse_args(int argc
, char **argv
)
3586 static struct option long_options
[] = {
3587 { "client-sock", 1, 0, 'c' },
3588 { "apps-sock", 1, 0, 'a' },
3589 { "kconsumerd-cmd-sock", 1, 0, 'C' },
3590 { "kconsumerd-err-sock", 1, 0, 'E' },
3591 { "ustconsumerd64", 1, 0, 't' },
3592 { "ustconsumerd64-cmd-sock", 1, 0, 'D' },
3593 { "ustconsumerd64-err-sock", 1, 0, 'F' },
3594 { "ustconsumerd32", 1, 0, 'u' },
3595 { "ustconsumerd32-cmd-sock", 1, 0, 'G' },
3596 { "ustconsumerd32-err-sock", 1, 0, 'H' },
3597 { "daemonize", 0, 0, 'd' },
3598 { "sig-parent", 0, 0, 'S' },
3599 { "help", 0, 0, 'h' },
3600 { "group", 1, 0, 'g' },
3601 { "version", 0, 0, 'V' },
3602 { "quiet", 0, 0, 'q' },
3603 { "verbose", 0, 0, 'v' },
3604 { "verbose-consumer", 0, 0, 'Z' },
3609 int option_index
= 0;
3610 c
= getopt_long(argc
, argv
, "dhqvVS" "a:c:g:s:C:E:D:F:Z:u:t",
3611 long_options
, &option_index
);
3618 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
3620 fprintf(stderr
, " with arg %s\n", optarg
);
3624 snprintf(client_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3627 snprintf(apps_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3633 opt_tracing_group
= optarg
;
3639 fprintf(stdout
, "%s\n", VERSION
);
3645 snprintf(kconsumer_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3648 snprintf(kconsumer_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3651 snprintf(ustconsumer64_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3654 snprintf(ustconsumer64_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3657 snprintf(ustconsumer32_data
.err_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3660 snprintf(ustconsumer32_data
.cmd_unix_sock_path
, PATH_MAX
, "%s", optarg
);
3666 /* Verbose level can increase using multiple -v */
3670 opt_verbose_consumer
+= 1;
3673 consumerd32_bindir
= optarg
;
3676 consumerd64_bindir
= optarg
;
3679 /* Unknown option or other error.
3680 * Error is printed by getopt, just return */
3689 * Creates the two needed socket by the daemon.
3690 * apps_sock - The communication socket for all UST apps.
3691 * client_sock - The communication of the cli tool (lttng).
3693 static int init_daemon_socket(void)
3698 old_umask
= umask(0);
3700 /* Create client tool unix socket */
3701 client_sock
= lttcomm_create_unix_sock(client_unix_sock_path
);
3702 if (client_sock
< 0) {
3703 ERR("Create unix sock failed: %s", client_unix_sock_path
);
3708 /* File permission MUST be 660 */
3709 ret
= chmod(client_unix_sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3711 ERR("Set file permissions failed: %s", client_unix_sock_path
);
3716 /* Create the application unix socket */
3717 apps_sock
= lttcomm_create_unix_sock(apps_unix_sock_path
);
3718 if (apps_sock
< 0) {
3719 ERR("Create unix sock failed: %s", apps_unix_sock_path
);
3724 /* File permission MUST be 666 */
3725 ret
= chmod(apps_unix_sock_path
,
3726 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
| S_IWOTH
);
3728 ERR("Set file permissions failed: %s", apps_unix_sock_path
);
3739 * Check if the global socket is available, and if a daemon is answering at the
3740 * other side. If yes, error is returned.
3742 static int check_existing_daemon(void)
3744 if (access(client_unix_sock_path
, F_OK
) < 0 &&
3745 access(apps_unix_sock_path
, F_OK
) < 0) {
3749 /* Is there anybody out there ? */
3750 if (lttng_session_daemon_alive()) {
3758 * Set the tracing group gid onto the client socket.
3760 * Race window between mkdir and chown is OK because we are going from more
3761 * permissive (root.root) to les permissive (root.tracing).
3763 static int set_permissions(void)
3768 gid
= allowed_group();
3771 WARN("No tracing group detected");
3774 ERR("Missing tracing group. Aborting execution.");
3780 /* Set lttng run dir */
3781 ret
= chown(LTTNG_RUNDIR
, 0, gid
);
3783 ERR("Unable to set group on " LTTNG_RUNDIR
);
3787 /* lttng client socket path */
3788 ret
= chown(client_unix_sock_path
, 0, gid
);
3790 ERR("Unable to set group on %s", client_unix_sock_path
);
3794 /* kconsumer error socket path */
3795 ret
= chown(kconsumer_data
.err_unix_sock_path
, 0, gid
);
3797 ERR("Unable to set group on %s", kconsumer_data
.err_unix_sock_path
);
3801 /* 64-bit ustconsumer error socket path */
3802 ret
= chown(ustconsumer64_data
.err_unix_sock_path
, 0, gid
);
3804 ERR("Unable to set group on %s", ustconsumer64_data
.err_unix_sock_path
);
3808 /* 32-bit ustconsumer compat32 error socket path */
3809 ret
= chown(ustconsumer32_data
.err_unix_sock_path
, 0, gid
);
3811 ERR("Unable to set group on %s", ustconsumer32_data
.err_unix_sock_path
);
3815 DBG("All permissions are set");
3822 * Create the pipe used to wake up the kernel thread.
3824 static int create_kernel_poll_pipe(void)
3826 return pipe2(kernel_poll_pipe
, O_CLOEXEC
);
3830 * Create the application command pipe to wake thread_manage_apps.
3832 static int create_apps_cmd_pipe(void)
3834 return pipe2(apps_cmd_pipe
, O_CLOEXEC
);
3838 * Create the lttng run directory needed for all global sockets and pipe.
3840 static int create_lttng_rundir(void)
3844 ret
= mkdir(LTTNG_RUNDIR
, S_IRWXU
| S_IRWXG
);
3846 if (errno
!= EEXIST
) {
3847 ERR("Unable to create " LTTNG_RUNDIR
);
3859 * Setup sockets and directory needed by the kconsumerd communication with the
3862 static int set_consumer_sockets(struct consumer_data
*consumer_data
)
3867 switch (consumer_data
->type
) {
3868 case LTTNG_CONSUMER_KERNEL
:
3869 path
= KCONSUMERD_PATH
;
3871 case LTTNG_CONSUMER64_UST
:
3872 path
= USTCONSUMERD64_PATH
;
3874 case LTTNG_CONSUMER32_UST
:
3875 path
= USTCONSUMERD32_PATH
;
3878 ERR("Consumer type unknown");
3883 ret
= mkdir(path
, S_IRWXU
| S_IRWXG
);
3885 if (errno
!= EEXIST
) {
3886 ERR("Failed to create %s", path
);
3892 /* Create the kconsumerd error unix socket */
3893 consumer_data
->err_sock
=
3894 lttcomm_create_unix_sock(consumer_data
->err_unix_sock_path
);
3895 if (consumer_data
->err_sock
< 0) {
3896 ERR("Create unix sock failed: %s", consumer_data
->err_unix_sock_path
);
3901 /* File permission MUST be 660 */
3902 ret
= chmod(consumer_data
->err_unix_sock_path
,
3903 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
3905 ERR("Set file permissions failed: %s", consumer_data
->err_unix_sock_path
);
3915 * Signal handler for the daemon
3917 * Simply stop all worker threads, leaving main() return gracefully after
3918 * joining all threads and calling cleanup().
3920 static void sighandler(int sig
)
3924 DBG("SIGPIPE catched");
3927 DBG("SIGINT catched");
3931 DBG("SIGTERM catched");
3940 * Setup signal handler for :
3941 * SIGINT, SIGTERM, SIGPIPE
3943 static int set_signal_handler(void)
3946 struct sigaction sa
;
3949 if ((ret
= sigemptyset(&sigset
)) < 0) {
3950 perror("sigemptyset");
3954 sa
.sa_handler
= sighandler
;
3955 sa
.sa_mask
= sigset
;
3957 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
3958 perror("sigaction");
3962 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
3963 perror("sigaction");
3967 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
3968 perror("sigaction");
3972 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3978 * Set open files limit to unlimited. This daemon can open a large number of
3979 * file descriptors in order to consumer multiple kernel traces.
3981 static void set_ulimit(void)
3986 /* The kernel does not allowed an infinite limit for open files */
3987 lim
.rlim_cur
= 65535;
3988 lim
.rlim_max
= 65535;
3990 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
3992 perror("failed to set open files limit");
3999 int main(int argc
, char **argv
)
4003 const char *home_path
;
4005 rcu_register_thread();
4007 /* Create thread quit pipe */
4008 if ((ret
= init_thread_quit_pipe()) < 0) {
4012 setup_consumerd_path();
4014 /* Parse arguments */
4016 if ((ret
= parse_args(argc
, argv
) < 0)) {
4029 /* Check if daemon is UID = 0 */
4030 is_root
= !getuid();
4033 ret
= create_lttng_rundir();
4038 if (strlen(apps_unix_sock_path
) == 0) {
4039 snprintf(apps_unix_sock_path
, PATH_MAX
,
4040 DEFAULT_GLOBAL_APPS_UNIX_SOCK
);
4043 if (strlen(client_unix_sock_path
) == 0) {
4044 snprintf(client_unix_sock_path
, PATH_MAX
,
4045 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
);
4048 /* Set global SHM for ust */
4049 if (strlen(wait_shm_path
) == 0) {
4050 snprintf(wait_shm_path
, PATH_MAX
,
4051 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH
);
4054 home_path
= get_home_dir();
4055 if (home_path
== NULL
) {
4056 /* TODO: Add --socket PATH option */
4057 ERR("Can't get HOME directory for sockets creation.");
4062 if (strlen(apps_unix_sock_path
) == 0) {
4063 snprintf(apps_unix_sock_path
, PATH_MAX
,
4064 DEFAULT_HOME_APPS_UNIX_SOCK
, home_path
);
4067 /* Set the cli tool unix socket path */
4068 if (strlen(client_unix_sock_path
) == 0) {
4069 snprintf(client_unix_sock_path
, PATH_MAX
,
4070 DEFAULT_HOME_CLIENT_UNIX_SOCK
, home_path
);
4073 /* Set global SHM for ust */
4074 if (strlen(wait_shm_path
) == 0) {
4075 snprintf(wait_shm_path
, PATH_MAX
,
4076 DEFAULT_HOME_APPS_WAIT_SHM_PATH
, geteuid());
4080 DBG("Client socket path %s", client_unix_sock_path
);
4081 DBG("Application socket path %s", apps_unix_sock_path
);
4084 * See if daemon already exist.
4086 if ((ret
= check_existing_daemon()) < 0) {
4087 ERR("Already running daemon.\n");
4089 * We do not goto exit because we must not cleanup()
4090 * because a daemon is already running.
4095 /* After this point, we can safely call cleanup() with "goto exit" */
4098 * These actions must be executed as root. We do that *after* setting up
4099 * the sockets path because we MUST make the check for another daemon using
4100 * those paths *before* trying to set the kernel consumer sockets and init
4104 ret
= set_consumer_sockets(&kconsumer_data
);
4109 ret
= set_consumer_sockets(&ustconsumer64_data
);
4114 ret
= set_consumer_sockets(&ustconsumer32_data
);
4119 /* Setup kernel tracer */
4120 init_kernel_tracer();
4122 /* Set ulimit for open files */
4126 if ((ret
= set_signal_handler()) < 0) {
4130 /* Setup the needed unix socket */
4131 if ((ret
= init_daemon_socket()) < 0) {
4135 /* Set credentials to socket */
4136 if (is_root
&& ((ret
= set_permissions()) < 0)) {
4140 /* Get parent pid if -S, --sig-parent is specified. */
4141 if (opt_sig_parent
) {
4145 /* Setup the kernel pipe for waking up the kernel thread */
4146 if ((ret
= create_kernel_poll_pipe()) < 0) {
4150 /* Setup the thread apps communication pipe. */
4151 if ((ret
= create_apps_cmd_pipe()) < 0) {
4155 /* Init UST command queue. */
4156 cds_wfq_init(&ust_cmd_queue
.queue
);
4158 /* Init UST app hash table */
4162 * Get session list pointer. This pointer MUST NOT be free(). This list is
4163 * statically declared in session.c
4165 session_list_ptr
= session_get_list();
4167 /* Set up max poll set size */
4168 lttng_poll_set_max_size();
4170 /* Create thread to manage the client socket */
4171 ret
= pthread_create(&client_thread
, NULL
,
4172 thread_manage_clients
, (void *) NULL
);
4174 perror("pthread_create clients");
4178 /* Create thread to dispatch registration */
4179 ret
= pthread_create(&dispatch_thread
, NULL
,
4180 thread_dispatch_ust_registration
, (void *) NULL
);
4182 perror("pthread_create dispatch");
4186 /* Create thread to manage application registration. */
4187 ret
= pthread_create(®_apps_thread
, NULL
,
4188 thread_registration_apps
, (void *) NULL
);
4190 perror("pthread_create registration");
4194 /* Create thread to manage application socket */
4195 ret
= pthread_create(&apps_thread
, NULL
,
4196 thread_manage_apps
, (void *) NULL
);
4198 perror("pthread_create apps");
4202 /* Create kernel thread to manage kernel event */
4203 ret
= pthread_create(&kernel_thread
, NULL
,
4204 thread_manage_kernel
, (void *) NULL
);
4206 perror("pthread_create kernel");
4210 ret
= pthread_join(kernel_thread
, &status
);
4212 perror("pthread_join");
4213 goto error
; /* join error, exit without cleanup */
4217 ret
= pthread_join(apps_thread
, &status
);
4219 perror("pthread_join");
4220 goto error
; /* join error, exit without cleanup */
4224 ret
= pthread_join(reg_apps_thread
, &status
);
4226 perror("pthread_join");
4227 goto error
; /* join error, exit without cleanup */
4231 ret
= pthread_join(dispatch_thread
, &status
);
4233 perror("pthread_join");
4234 goto error
; /* join error, exit without cleanup */
4238 ret
= pthread_join(client_thread
, &status
);
4240 perror("pthread_join");
4241 goto error
; /* join error, exit without cleanup */
4244 ret
= join_consumer_thread(&kconsumer_data
);
4246 perror("join_consumer");
4247 goto error
; /* join error, exit without cleanup */
4253 * cleanup() is called when no other thread is running.
4255 rcu_thread_online();
4257 rcu_thread_offline();
4258 rcu_unregister_thread();