2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <common/compat/getenv.h>
25 #include <common/unix.h>
26 #include <common/utils.h>
27 #include <lttng/userspace-probe-internal.h>
28 #include <lttng/event-internal.h>
29 #include <lttng/session-internal.h>
30 #include <lttng/session-descriptor-internal.h>
33 #include "lttng-sessiond.h"
37 #include "health-sessiond.h"
38 #include "testpoint.h"
40 #include "manage-consumer.h"
44 static struct thread_state
{
49 static void set_thread_status(bool running
)
51 DBG("Marking client thread's state as %s", running
? "running" : "error");
52 thread_state
.running
= running
;
53 sem_post(&thread_state
.ready
);
56 static bool wait_thread_status(void)
58 DBG("Waiting for client thread to be ready");
59 sem_wait(&thread_state
.ready
);
60 if (thread_state
.running
) {
61 DBG("Client thread is ready");
63 ERR("Initialization of client thread failed");
66 return thread_state
.running
;
70 * Setup the outgoing data buffer for the response (llm) by allocating the
71 * right amount of memory and copying the original information from the lsm
74 * Return 0 on success, negative value on error.
76 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
77 const void *payload_buf
, size_t payload_len
,
78 const void *cmd_header_buf
, size_t cmd_header_len
)
81 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
82 const size_t cmd_header_offset
= header_len
;
83 const size_t payload_offset
= cmd_header_offset
+ cmd_header_len
;
84 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
87 cmd_ctx
->llm
= zmalloc(total_msg_size
);
89 if (cmd_ctx
->llm
== NULL
) {
95 /* Copy common data */
96 cmd_ctx
->llm
->cmd_type
= cmd_ctx
->lsm
->cmd_type
;
97 cmd_ctx
->llm
->pid
= cmd_ctx
->lsm
->domain
.attr
.pid
;
98 cmd_ctx
->llm
->cmd_header_size
= cmd_header_len
;
99 cmd_ctx
->llm
->data_size
= payload_len
;
100 cmd_ctx
->lttng_msg_size
= total_msg_size
;
102 /* Copy command header */
103 if (cmd_header_len
) {
104 memcpy(((uint8_t *) cmd_ctx
->llm
) + cmd_header_offset
, cmd_header_buf
,
110 memcpy(((uint8_t *) cmd_ctx
->llm
) + payload_offset
, payload_buf
,
119 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
120 * exec or it will fail.
122 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
124 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
128 * Fork and exec a consumer daemon (consumerd).
130 * Return pid if successful else -1.
132 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
136 const char *consumer_to_use
;
137 const char *verbosity
;
140 DBG("Spawning consumerd");
147 if (config
.verbose_consumer
) {
148 verbosity
= "--verbose";
149 } else if (lttng_opt_quiet
) {
150 verbosity
= "--quiet";
155 switch (consumer_data
->type
) {
156 case LTTNG_CONSUMER_KERNEL
:
158 * Find out which consumerd to execute. We will first try the
159 * 64-bit path, then the sessiond's installation directory, and
160 * fallback on the 32-bit one,
162 DBG3("Looking for a kernel consumer at these locations:");
163 DBG3(" 1) %s", config
.consumerd64_bin_path
.value
? : "NULL");
164 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
165 DBG3(" 3) %s", config
.consumerd32_bin_path
.value
? : "NULL");
166 if (stat(config
.consumerd64_bin_path
.value
, &st
) == 0) {
167 DBG3("Found location #1");
168 consumer_to_use
= config
.consumerd64_bin_path
.value
;
169 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
170 DBG3("Found location #2");
171 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
172 } else if (config
.consumerd32_bin_path
.value
&&
173 stat(config
.consumerd32_bin_path
.value
, &st
) == 0) {
174 DBG3("Found location #3");
175 consumer_to_use
= config
.consumerd32_bin_path
.value
;
177 DBG("Could not find any valid consumerd executable");
181 DBG("Using kernel consumer at: %s", consumer_to_use
);
182 (void) execl(consumer_to_use
,
183 "lttng-consumerd", verbosity
, "-k",
184 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
185 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
186 "--group", config
.tracing_group_name
.value
,
189 case LTTNG_CONSUMER64_UST
:
191 if (config
.consumerd64_lib_dir
.value
) {
196 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
200 tmplen
= strlen(config
.consumerd64_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
201 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
206 strcat(tmpnew
, config
.consumerd64_lib_dir
.value
);
207 if (tmp
[0] != '\0') {
211 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
218 DBG("Using 64-bit UST consumer at: %s", config
.consumerd64_bin_path
.value
);
219 (void) execl(config
.consumerd64_bin_path
.value
, "lttng-consumerd", verbosity
, "-u",
220 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
221 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
222 "--group", config
.tracing_group_name
.value
,
226 case LTTNG_CONSUMER32_UST
:
228 if (config
.consumerd32_lib_dir
.value
) {
233 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
237 tmplen
= strlen(config
.consumerd32_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
238 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
243 strcat(tmpnew
, config
.consumerd32_lib_dir
.value
);
244 if (tmp
[0] != '\0') {
248 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
255 DBG("Using 32-bit UST consumer at: %s", config
.consumerd32_bin_path
.value
);
256 (void) execl(config
.consumerd32_bin_path
.value
, "lttng-consumerd", verbosity
, "-u",
257 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
258 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
259 "--group", config
.tracing_group_name
.value
,
264 ERR("unknown consumer type");
268 PERROR("Consumer execl()");
270 /* Reaching this point, we got a failure on our execl(). */
272 } else if (pid
> 0) {
275 PERROR("start consumer fork");
283 * Spawn the consumerd daemon and session daemon thread.
285 static int start_consumerd(struct consumer_data
*consumer_data
)
290 * Set the listen() state on the socket since there is a possible race
291 * between the exec() of the consumer daemon and this call if place in the
292 * consumer thread. See bug #366 for more details.
294 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
299 pthread_mutex_lock(&consumer_data
->pid_mutex
);
300 if (consumer_data
->pid
!= 0) {
301 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
305 ret
= spawn_consumerd(consumer_data
);
307 ERR("Spawning consumerd failed");
308 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
312 /* Setting up the consumer_data pid */
313 consumer_data
->pid
= ret
;
314 DBG2("Consumer pid %d", consumer_data
->pid
);
315 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
317 DBG2("Spawning consumer control thread");
318 ret
= spawn_consumer_thread(consumer_data
);
320 ERR("Fatal error spawning consumer control thread");
328 /* Cleanup already created sockets on error. */
329 if (consumer_data
->err_sock
>= 0) {
332 err
= close(consumer_data
->err_sock
);
334 PERROR("close consumer data error socket");
341 * Copy consumer output from the tracing session to the domain session. The
342 * function also applies the right modification on a per domain basis for the
343 * trace files destination directory.
345 * Should *NOT* be called with RCU read-side lock held.
347 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
350 const char *dir_name
;
351 struct consumer_output
*consumer
;
354 assert(session
->consumer
);
357 case LTTNG_DOMAIN_KERNEL
:
358 DBG3("Copying tracing session consumer output in kernel session");
360 * XXX: We should audit the session creation and what this function
361 * does "extra" in order to avoid a destroy since this function is used
362 * in the domain session creation (kernel and ust) only. Same for UST
365 if (session
->kernel_session
->consumer
) {
366 consumer_output_put(session
->kernel_session
->consumer
);
368 session
->kernel_session
->consumer
=
369 consumer_copy_output(session
->consumer
);
370 /* Ease our life a bit for the next part */
371 consumer
= session
->kernel_session
->consumer
;
372 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
374 case LTTNG_DOMAIN_JUL
:
375 case LTTNG_DOMAIN_LOG4J
:
376 case LTTNG_DOMAIN_PYTHON
:
377 case LTTNG_DOMAIN_UST
:
378 DBG3("Copying tracing session consumer output in UST session");
379 if (session
->ust_session
->consumer
) {
380 consumer_output_put(session
->ust_session
->consumer
);
382 session
->ust_session
->consumer
=
383 consumer_copy_output(session
->consumer
);
384 /* Ease our life a bit for the next part */
385 consumer
= session
->ust_session
->consumer
;
386 dir_name
= DEFAULT_UST_TRACE_DIR
;
389 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
393 /* Append correct directory to subdir */
394 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
,
395 sizeof(consumer
->domain_subdir
));
400 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
408 * Create an UST session and add it to the session ust list.
410 * Should *NOT* be called with RCU read-side lock held.
412 static int create_ust_session(struct ltt_session
*session
,
413 struct lttng_domain
*domain
)
416 struct ltt_ust_session
*lus
= NULL
;
420 assert(session
->consumer
);
422 switch (domain
->type
) {
423 case LTTNG_DOMAIN_JUL
:
424 case LTTNG_DOMAIN_LOG4J
:
425 case LTTNG_DOMAIN_PYTHON
:
426 case LTTNG_DOMAIN_UST
:
429 ERR("Unknown UST domain on create session %d", domain
->type
);
430 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
434 DBG("Creating UST session");
436 lus
= trace_ust_create_session(session
->id
);
438 ret
= LTTNG_ERR_UST_SESS_FAIL
;
442 lus
->uid
= session
->uid
;
443 lus
->gid
= session
->gid
;
444 lus
->output_traces
= session
->output_traces
;
445 lus
->snapshot_mode
= session
->snapshot_mode
;
446 lus
->live_timer_interval
= session
->live_timer
;
447 session
->ust_session
= lus
;
448 if (session
->shm_path
[0]) {
449 strncpy(lus
->root_shm_path
, session
->shm_path
,
450 sizeof(lus
->root_shm_path
));
451 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
452 strncpy(lus
->shm_path
, session
->shm_path
,
453 sizeof(lus
->shm_path
));
454 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
455 strncat(lus
->shm_path
, "/ust",
456 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
458 /* Copy session output to the newly created UST session */
459 ret
= copy_session_consumer(domain
->type
, session
);
460 if (ret
!= LTTNG_OK
) {
468 session
->ust_session
= NULL
;
473 * Create a kernel tracer session then create the default channel.
475 static int create_kernel_session(struct ltt_session
*session
)
479 DBG("Creating kernel session");
481 ret
= kernel_create_session(session
);
483 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
487 /* Code flow safety */
488 assert(session
->kernel_session
);
490 /* Copy session output to the newly created Kernel session */
491 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
492 if (ret
!= LTTNG_OK
) {
496 session
->kernel_session
->uid
= session
->uid
;
497 session
->kernel_session
->gid
= session
->gid
;
498 session
->kernel_session
->output_traces
= session
->output_traces
;
499 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
504 trace_kernel_destroy_session(session
->kernel_session
);
505 session
->kernel_session
= NULL
;
511 * Count number of session permitted by uid/gid.
513 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
516 struct ltt_session
*session
;
517 const struct ltt_session_list
*session_list
= session_get_list();
519 DBG("Counting number of available session for UID %d GID %d",
521 cds_list_for_each_entry(session
, &session_list
->head
, list
) {
522 if (!session_get(session
)) {
525 session_lock(session
);
526 /* Only count the sessions the user can control. */
527 if (session_access_ok(session
, uid
, gid
) &&
528 !session
->destroyed
) {
531 session_unlock(session
);
532 session_put(session
);
537 static int receive_userspace_probe(struct command_ctx
*cmd_ctx
, int sock
,
538 int *sock_error
, struct lttng_event
*event
)
541 struct lttng_userspace_probe_location
*probe_location
;
542 const struct lttng_userspace_probe_location_lookup_method
*lookup
= NULL
;
543 struct lttng_dynamic_buffer probe_location_buffer
;
544 struct lttng_buffer_view buffer_view
;
547 * Create a buffer to store the serialized version of the probe
550 lttng_dynamic_buffer_init(&probe_location_buffer
);
551 ret
= lttng_dynamic_buffer_set_size(&probe_location_buffer
,
552 cmd_ctx
->lsm
->u
.enable
.userspace_probe_location_len
);
554 ret
= LTTNG_ERR_NOMEM
;
559 * Receive the probe location.
561 ret
= lttcomm_recv_unix_sock(sock
, probe_location_buffer
.data
,
562 probe_location_buffer
.size
);
564 DBG("Nothing recv() from client var len data... continuing");
566 lttng_dynamic_buffer_reset(&probe_location_buffer
);
567 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
571 buffer_view
= lttng_buffer_view_from_dynamic_buffer(
572 &probe_location_buffer
, 0, probe_location_buffer
.size
);
575 * Extract the probe location from the serialized version.
577 ret
= lttng_userspace_probe_location_create_from_buffer(
578 &buffer_view
, &probe_location
);
580 WARN("Failed to create a userspace probe location from the received buffer");
581 lttng_dynamic_buffer_reset( &probe_location_buffer
);
582 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
587 * Receive the file descriptor to the target binary from the client.
589 DBG("Receiving userspace probe target FD from client ...");
590 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
592 DBG("Nothing recv() from client userspace probe fd... continuing");
594 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
599 * Set the file descriptor received from the client through the unix
600 * socket in the probe location.
602 lookup
= lttng_userspace_probe_location_get_lookup_method(probe_location
);
604 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
609 * From the kernel tracer's perspective, all userspace probe event types
610 * are all the same: a file and an offset.
612 switch (lttng_userspace_probe_location_lookup_method_get_type(lookup
)) {
613 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF
:
614 ret
= lttng_userspace_probe_location_function_set_binary_fd(
617 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT
:
618 ret
= lttng_userspace_probe_location_tracepoint_set_binary_fd(
622 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
627 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
631 /* Attach the probe location to the event. */
632 ret
= lttng_event_set_userspace_probe_location(event
, probe_location
);
634 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
638 lttng_dynamic_buffer_reset(&probe_location_buffer
);
644 * Version of setup_lttng_msg() without command header.
646 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
647 void *payload_buf
, size_t payload_len
)
649 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
653 * Free memory of a command context structure.
655 static void clean_command_ctx(struct command_ctx
**cmd_ctx
)
657 DBG("Clean command context structure");
659 if ((*cmd_ctx
)->llm
) {
660 free((*cmd_ctx
)->llm
);
662 if ((*cmd_ctx
)->lsm
) {
663 free((*cmd_ctx
)->lsm
);
671 * Check if the current kernel tracer supports the session rotation feature.
672 * Return 1 if it does, 0 otherwise.
674 static int check_rotate_compatible(void)
678 if (kernel_tracer_version
.major
!= 2 || kernel_tracer_version
.minor
< 11) {
679 DBG("Kernel tracer version is not compatible with the rotation feature");
687 * Send data on a unix socket using the liblttsessiondcomm API.
689 * Return lttcomm error code.
691 static int send_unix_sock(int sock
, void *buf
, size_t len
)
693 /* Check valid length */
698 return lttcomm_send_unix_sock(sock
, buf
, len
);
702 * Process the command requested by the lttng client within the command
703 * context structure. This function make sure that the return structure (llm)
704 * is set and ready for transmission before returning.
706 * Return any error encountered or 0 for success.
708 * "sock" is only used for special-case var. len data.
709 * A command may assume the ownership of the socket, in which case its value
710 * should be set to -1.
712 * Should *NOT* be called with RCU read-side lock held.
714 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
718 int need_tracing_session
= 1;
721 DBG("Processing client command %d", cmd_ctx
->lsm
->cmd_type
);
723 assert(!rcu_read_ongoing());
727 switch (cmd_ctx
->lsm
->cmd_type
) {
728 case LTTNG_CREATE_SESSION_EXT
:
729 case LTTNG_DESTROY_SESSION
:
730 case LTTNG_LIST_SESSIONS
:
731 case LTTNG_LIST_DOMAINS
:
732 case LTTNG_START_TRACE
:
733 case LTTNG_STOP_TRACE
:
734 case LTTNG_DATA_PENDING
:
735 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
736 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
737 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
738 case LTTNG_SNAPSHOT_RECORD
:
739 case LTTNG_SAVE_SESSION
:
740 case LTTNG_SET_SESSION_SHM_PATH
:
741 case LTTNG_REGENERATE_METADATA
:
742 case LTTNG_REGENERATE_STATEDUMP
:
743 case LTTNG_REGISTER_TRIGGER
:
744 case LTTNG_UNREGISTER_TRIGGER
:
745 case LTTNG_ROTATE_SESSION
:
746 case LTTNG_ROTATION_GET_INFO
:
747 case LTTNG_ROTATION_SET_SCHEDULE
:
748 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
755 if (config
.no_kernel
&& need_domain
756 && cmd_ctx
->lsm
->domain
.type
== LTTNG_DOMAIN_KERNEL
) {
758 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
760 ret
= LTTNG_ERR_KERN_NA
;
765 /* Deny register consumer if we already have a spawned consumer. */
766 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_REGISTER_CONSUMER
) {
767 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
768 if (kconsumer_data
.pid
> 0) {
769 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
770 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
773 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
777 * Check for command that don't needs to allocate a returned payload. We do
778 * this here so we don't have to make the call for no payload at each
781 switch(cmd_ctx
->lsm
->cmd_type
) {
782 case LTTNG_LIST_SESSIONS
:
783 case LTTNG_LIST_TRACEPOINTS
:
784 case LTTNG_LIST_TRACEPOINT_FIELDS
:
785 case LTTNG_LIST_DOMAINS
:
786 case LTTNG_LIST_CHANNELS
:
787 case LTTNG_LIST_EVENTS
:
788 case LTTNG_LIST_SYSCALLS
:
789 case LTTNG_LIST_TRACKER_PIDS
:
790 case LTTNG_DATA_PENDING
:
791 case LTTNG_ROTATE_SESSION
:
792 case LTTNG_ROTATION_GET_INFO
:
793 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
796 /* Setup lttng message with no payload */
797 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
799 /* This label does not try to unlock the session */
800 goto init_setup_error
;
804 /* Commands that DO NOT need a session. */
805 switch (cmd_ctx
->lsm
->cmd_type
) {
806 case LTTNG_CREATE_SESSION_EXT
:
807 case LTTNG_LIST_SESSIONS
:
808 case LTTNG_LIST_TRACEPOINTS
:
809 case LTTNG_LIST_SYSCALLS
:
810 case LTTNG_LIST_TRACEPOINT_FIELDS
:
811 case LTTNG_SAVE_SESSION
:
812 case LTTNG_REGISTER_TRIGGER
:
813 case LTTNG_UNREGISTER_TRIGGER
:
814 need_tracing_session
= 0;
817 DBG("Getting session %s by name", cmd_ctx
->lsm
->session
.name
);
819 * We keep the session list lock across _all_ commands
820 * for now, because the per-session lock does not
821 * handle teardown properly.
824 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
->session
.name
);
825 if (cmd_ctx
->session
== NULL
) {
826 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
829 /* Acquire lock for the session */
830 session_lock(cmd_ctx
->session
);
836 * Commands that need a valid session but should NOT create one if none
837 * exists. Instead of creating one and destroying it when the command is
838 * handled, process that right before so we save some round trip in useless
841 switch (cmd_ctx
->lsm
->cmd_type
) {
842 case LTTNG_DISABLE_CHANNEL
:
843 case LTTNG_DISABLE_EVENT
:
844 switch (cmd_ctx
->lsm
->domain
.type
) {
845 case LTTNG_DOMAIN_KERNEL
:
846 if (!cmd_ctx
->session
->kernel_session
) {
847 ret
= LTTNG_ERR_NO_CHANNEL
;
851 case LTTNG_DOMAIN_JUL
:
852 case LTTNG_DOMAIN_LOG4J
:
853 case LTTNG_DOMAIN_PYTHON
:
854 case LTTNG_DOMAIN_UST
:
855 if (!cmd_ctx
->session
->ust_session
) {
856 ret
= LTTNG_ERR_NO_CHANNEL
;
861 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
873 * Check domain type for specific "pre-action".
875 switch (cmd_ctx
->lsm
->domain
.type
) {
876 case LTTNG_DOMAIN_KERNEL
:
878 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
882 /* Kernel tracer check */
883 if (!kernel_tracer_is_initialized()) {
884 /* Basically, load kernel tracer modules */
885 ret
= init_kernel_tracer();
891 /* Consumer is in an ERROR state. Report back to client */
892 if (uatomic_read(&kernel_consumerd_state
) == CONSUMER_ERROR
) {
893 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
897 /* Need a session for kernel command */
898 if (need_tracing_session
) {
899 if (cmd_ctx
->session
->kernel_session
== NULL
) {
900 ret
= create_kernel_session(cmd_ctx
->session
);
901 if (ret
!= LTTNG_OK
) {
902 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
907 /* Start the kernel consumer daemon */
908 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
909 if (kconsumer_data
.pid
== 0 &&
910 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
911 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
912 ret
= start_consumerd(&kconsumer_data
);
914 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
917 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
919 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
923 * The consumer was just spawned so we need to add the socket to
924 * the consumer output of the session if exist.
926 ret
= consumer_create_socket(&kconsumer_data
,
927 cmd_ctx
->session
->kernel_session
->consumer
);
934 case LTTNG_DOMAIN_JUL
:
935 case LTTNG_DOMAIN_LOG4J
:
936 case LTTNG_DOMAIN_PYTHON
:
937 case LTTNG_DOMAIN_UST
:
939 if (!ust_app_supported()) {
940 ret
= LTTNG_ERR_NO_UST
;
943 /* Consumer is in an ERROR state. Report back to client */
944 if (uatomic_read(&ust_consumerd_state
) == CONSUMER_ERROR
) {
945 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
949 if (need_tracing_session
) {
950 /* Create UST session if none exist. */
951 if (cmd_ctx
->session
->ust_session
== NULL
) {
952 ret
= create_ust_session(cmd_ctx
->session
,
953 &cmd_ctx
->lsm
->domain
);
954 if (ret
!= LTTNG_OK
) {
959 /* Start the UST consumer daemons */
961 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
962 if (config
.consumerd64_bin_path
.value
&&
963 ustconsumer64_data
.pid
== 0 &&
964 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
965 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
966 ret
= start_consumerd(&ustconsumer64_data
);
968 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
969 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
973 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
974 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
976 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
980 * Setup socket for consumer 64 bit. No need for atomic access
981 * since it was set above and can ONLY be set in this thread.
983 ret
= consumer_create_socket(&ustconsumer64_data
,
984 cmd_ctx
->session
->ust_session
->consumer
);
990 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
991 if (config
.consumerd32_bin_path
.value
&&
992 ustconsumer32_data
.pid
== 0 &&
993 cmd_ctx
->lsm
->cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
994 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
995 ret
= start_consumerd(&ustconsumer32_data
);
997 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
998 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
1002 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
1003 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
1005 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
1009 * Setup socket for consumer 32 bit. No need for atomic access
1010 * since it was set above and can ONLY be set in this thread.
1012 ret
= consumer_create_socket(&ustconsumer32_data
,
1013 cmd_ctx
->session
->ust_session
->consumer
);
1025 /* Validate consumer daemon state when start/stop trace command */
1026 if (cmd_ctx
->lsm
->cmd_type
== LTTNG_START_TRACE
||
1027 cmd_ctx
->lsm
->cmd_type
== LTTNG_STOP_TRACE
) {
1028 switch (cmd_ctx
->lsm
->domain
.type
) {
1029 case LTTNG_DOMAIN_NONE
:
1031 case LTTNG_DOMAIN_JUL
:
1032 case LTTNG_DOMAIN_LOG4J
:
1033 case LTTNG_DOMAIN_PYTHON
:
1034 case LTTNG_DOMAIN_UST
:
1035 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
1036 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1040 case LTTNG_DOMAIN_KERNEL
:
1041 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
1042 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1047 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1053 * Check that the UID or GID match that of the tracing session.
1054 * The root user can interact with all sessions.
1056 if (need_tracing_session
) {
1057 if (!session_access_ok(cmd_ctx
->session
,
1058 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1059 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
)) ||
1060 cmd_ctx
->session
->destroyed
) {
1061 ret
= LTTNG_ERR_EPERM
;
1067 * Send relayd information to consumer as soon as we have a domain and a
1070 if (cmd_ctx
->session
&& need_domain
) {
1072 * Setup relayd if not done yet. If the relayd information was already
1073 * sent to the consumer, this call will gracefully return.
1075 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1076 if (ret
!= LTTNG_OK
) {
1081 /* Process by command type */
1082 switch (cmd_ctx
->lsm
->cmd_type
) {
1083 case LTTNG_ADD_CONTEXT
:
1086 * An LTTNG_ADD_CONTEXT command might have a supplementary
1087 * payload if the context being added is an application context.
1089 if (cmd_ctx
->lsm
->u
.context
.ctx
.ctx
==
1090 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1091 char *provider_name
= NULL
, *context_name
= NULL
;
1092 size_t provider_name_len
=
1093 cmd_ctx
->lsm
->u
.context
.provider_name_len
;
1094 size_t context_name_len
=
1095 cmd_ctx
->lsm
->u
.context
.context_name_len
;
1097 if (provider_name_len
== 0 || context_name_len
== 0) {
1099 * Application provider and context names MUST
1102 ret
= -LTTNG_ERR_INVALID
;
1106 provider_name
= zmalloc(provider_name_len
+ 1);
1107 if (!provider_name
) {
1108 ret
= -LTTNG_ERR_NOMEM
;
1111 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
=
1114 context_name
= zmalloc(context_name_len
+ 1);
1115 if (!context_name
) {
1116 ret
= -LTTNG_ERR_NOMEM
;
1117 goto error_add_context
;
1119 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
=
1122 ret
= lttcomm_recv_unix_sock(*sock
, provider_name
,
1125 goto error_add_context
;
1128 ret
= lttcomm_recv_unix_sock(*sock
, context_name
,
1131 goto error_add_context
;
1136 * cmd_add_context assumes ownership of the provider and context
1139 ret
= cmd_add_context(cmd_ctx
->session
,
1140 cmd_ctx
->lsm
->domain
.type
,
1141 cmd_ctx
->lsm
->u
.context
.channel_name
,
1142 &cmd_ctx
->lsm
->u
.context
.ctx
,
1143 kernel_poll_pipe
[1]);
1145 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
1146 cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
1148 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.provider_name
);
1149 free(cmd_ctx
->lsm
->u
.context
.ctx
.u
.app_ctx
.ctx_name
);
1155 case LTTNG_DISABLE_CHANNEL
:
1157 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
1158 cmd_ctx
->lsm
->u
.disable
.channel_name
);
1161 case LTTNG_DISABLE_EVENT
:
1165 * FIXME: handle filter; for now we just receive the filter's
1166 * bytecode along with the filter expression which are sent by
1167 * liblttng-ctl and discard them.
1169 * This fixes an issue where the client may block while sending
1170 * the filter payload and encounter an error because the session
1171 * daemon closes the socket without ever handling this data.
1173 size_t count
= cmd_ctx
->lsm
->u
.disable
.expression_len
+
1174 cmd_ctx
->lsm
->u
.disable
.bytecode_len
;
1177 char data
[LTTNG_FILTER_MAX_LEN
];
1179 DBG("Discarding disable event command payload of size %zu", count
);
1181 ret
= lttcomm_recv_unix_sock(*sock
, data
,
1182 count
> sizeof(data
) ? sizeof(data
) : count
);
1187 count
-= (size_t) ret
;
1190 /* FIXME: passing packed structure to non-packed pointer */
1191 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
1192 cmd_ctx
->lsm
->u
.disable
.channel_name
,
1193 &cmd_ctx
->lsm
->u
.disable
.event
);
1196 case LTTNG_ENABLE_CHANNEL
:
1198 cmd_ctx
->lsm
->u
.channel
.chan
.attr
.extended
.ptr
=
1199 (struct lttng_channel_extended
*) &cmd_ctx
->lsm
->u
.channel
.extended
;
1200 ret
= cmd_enable_channel(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
1201 &cmd_ctx
->lsm
->u
.channel
.chan
,
1202 kernel_poll_pipe
[1]);
1205 case LTTNG_TRACK_PID
:
1207 ret
= cmd_track_pid(cmd_ctx
->session
,
1208 cmd_ctx
->lsm
->domain
.type
,
1209 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
1212 case LTTNG_UNTRACK_PID
:
1214 ret
= cmd_untrack_pid(cmd_ctx
->session
,
1215 cmd_ctx
->lsm
->domain
.type
,
1216 cmd_ctx
->lsm
->u
.pid_tracker
.pid
);
1219 case LTTNG_ENABLE_EVENT
:
1221 struct lttng_event
*ev
= NULL
;
1222 struct lttng_event_exclusion
*exclusion
= NULL
;
1223 struct lttng_filter_bytecode
*bytecode
= NULL
;
1224 char *filter_expression
= NULL
;
1226 /* Handle exclusion events and receive it from the client. */
1227 if (cmd_ctx
->lsm
->u
.enable
.exclusion_count
> 0) {
1228 size_t count
= cmd_ctx
->lsm
->u
.enable
.exclusion_count
;
1230 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
1231 (count
* LTTNG_SYMBOL_NAME_LEN
));
1233 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
1237 DBG("Receiving var len exclusion event list from client ...");
1238 exclusion
->count
= count
;
1239 ret
= lttcomm_recv_unix_sock(*sock
, exclusion
->names
,
1240 count
* LTTNG_SYMBOL_NAME_LEN
);
1242 DBG("Nothing recv() from client var len data... continuing");
1245 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
1250 /* Get filter expression from client. */
1251 if (cmd_ctx
->lsm
->u
.enable
.expression_len
> 0) {
1252 size_t expression_len
=
1253 cmd_ctx
->lsm
->u
.enable
.expression_len
;
1255 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
1256 ret
= LTTNG_ERR_FILTER_INVAL
;
1261 filter_expression
= zmalloc(expression_len
);
1262 if (!filter_expression
) {
1264 ret
= LTTNG_ERR_FILTER_NOMEM
;
1268 /* Receive var. len. data */
1269 DBG("Receiving var len filter's expression from client ...");
1270 ret
= lttcomm_recv_unix_sock(*sock
, filter_expression
,
1273 DBG("Nothing recv() from client var len data... continuing");
1275 free(filter_expression
);
1277 ret
= LTTNG_ERR_FILTER_INVAL
;
1282 /* Handle filter and get bytecode from client. */
1283 if (cmd_ctx
->lsm
->u
.enable
.bytecode_len
> 0) {
1284 size_t bytecode_len
= cmd_ctx
->lsm
->u
.enable
.bytecode_len
;
1286 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
1287 ret
= LTTNG_ERR_FILTER_INVAL
;
1288 free(filter_expression
);
1293 bytecode
= zmalloc(bytecode_len
);
1295 free(filter_expression
);
1297 ret
= LTTNG_ERR_FILTER_NOMEM
;
1301 /* Receive var. len. data */
1302 DBG("Receiving var len filter's bytecode from client ...");
1303 ret
= lttcomm_recv_unix_sock(*sock
, bytecode
, bytecode_len
);
1305 DBG("Nothing recv() from client var len data... continuing");
1307 free(filter_expression
);
1310 ret
= LTTNG_ERR_FILTER_INVAL
;
1314 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
1315 free(filter_expression
);
1318 ret
= LTTNG_ERR_FILTER_INVAL
;
1323 ev
= lttng_event_copy(&cmd_ctx
->lsm
->u
.enable
.event
);
1325 DBG("Failed to copy event: %s",
1326 cmd_ctx
->lsm
->u
.enable
.event
.name
);
1327 free(filter_expression
);
1330 ret
= LTTNG_ERR_NOMEM
;
1335 if (cmd_ctx
->lsm
->u
.enable
.userspace_probe_location_len
> 0) {
1336 /* Expect a userspace probe description. */
1337 ret
= receive_userspace_probe(cmd_ctx
, *sock
, sock_error
, ev
);
1339 free(filter_expression
);
1342 lttng_event_destroy(ev
);
1347 ret
= cmd_enable_event(cmd_ctx
->session
, &cmd_ctx
->lsm
->domain
,
1348 cmd_ctx
->lsm
->u
.enable
.channel_name
,
1350 filter_expression
, bytecode
, exclusion
,
1351 kernel_poll_pipe
[1]);
1352 lttng_event_destroy(ev
);
1355 case LTTNG_LIST_TRACEPOINTS
:
1357 struct lttng_event
*events
;
1360 session_lock_list();
1361 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
->domain
.type
, &events
);
1362 session_unlock_list();
1363 if (nb_events
< 0) {
1364 /* Return value is a negative lttng_error_code. */
1370 * Setup lttng message with payload size set to the event list size in
1371 * bytes and then copy list into the llm payload.
1373 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1374 sizeof(struct lttng_event
) * nb_events
);
1384 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1386 struct lttng_event_field
*fields
;
1389 session_lock_list();
1390 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
->domain
.type
,
1392 session_unlock_list();
1393 if (nb_fields
< 0) {
1394 /* Return value is a negative lttng_error_code. */
1400 * Setup lttng message with payload size set to the event list size in
1401 * bytes and then copy list into the llm payload.
1403 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
1404 sizeof(struct lttng_event_field
) * nb_fields
);
1414 case LTTNG_LIST_SYSCALLS
:
1416 struct lttng_event
*events
;
1419 nb_events
= cmd_list_syscalls(&events
);
1420 if (nb_events
< 0) {
1421 /* Return value is a negative lttng_error_code. */
1427 * Setup lttng message with payload size set to the event list size in
1428 * bytes and then copy list into the llm payload.
1430 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1431 sizeof(struct lttng_event
) * nb_events
);
1441 case LTTNG_LIST_TRACKER_PIDS
:
1443 int32_t *pids
= NULL
;
1446 nr_pids
= cmd_list_tracker_pids(cmd_ctx
->session
,
1447 cmd_ctx
->lsm
->domain
.type
, &pids
);
1449 /* Return value is a negative lttng_error_code. */
1455 * Setup lttng message with payload size set to the event list size in
1456 * bytes and then copy list into the llm payload.
1458 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, pids
,
1459 sizeof(int32_t) * nr_pids
);
1469 case LTTNG_SET_CONSUMER_URI
:
1472 struct lttng_uri
*uris
;
1474 nb_uri
= cmd_ctx
->lsm
->u
.uri
.size
;
1475 len
= nb_uri
* sizeof(struct lttng_uri
);
1478 ret
= LTTNG_ERR_INVALID
;
1482 uris
= zmalloc(len
);
1484 ret
= LTTNG_ERR_FATAL
;
1488 /* Receive variable len data */
1489 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1490 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1492 DBG("No URIs received from client... continuing");
1494 ret
= LTTNG_ERR_SESSION_FAIL
;
1499 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1501 if (ret
!= LTTNG_OK
) {
1508 case LTTNG_START_TRACE
:
1511 * On the first start, if we have a kernel session and we have
1512 * enabled time or size-based rotations, we have to make sure
1513 * the kernel tracer supports it.
1515 if (!cmd_ctx
->session
->has_been_started
&& \
1516 cmd_ctx
->session
->kernel_session
&& \
1517 (cmd_ctx
->session
->rotate_timer_period
|| \
1518 cmd_ctx
->session
->rotate_size
) && \
1519 !check_rotate_compatible()) {
1520 DBG("Kernel tracer version is not compatible with the rotation feature");
1521 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1524 ret
= cmd_start_trace(cmd_ctx
->session
);
1527 case LTTNG_STOP_TRACE
:
1529 ret
= cmd_stop_trace(cmd_ctx
->session
);
1532 case LTTNG_DESTROY_SESSION
:
1534 ret
= cmd_destroy_session(cmd_ctx
->session
,
1535 notification_thread_handle
,
1539 case LTTNG_LIST_DOMAINS
:
1542 struct lttng_domain
*domains
= NULL
;
1544 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1546 /* Return value is a negative lttng_error_code. */
1551 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1552 nb_dom
* sizeof(struct lttng_domain
));
1562 case LTTNG_LIST_CHANNELS
:
1564 ssize_t payload_size
;
1565 struct lttng_channel
*channels
= NULL
;
1567 payload_size
= cmd_list_channels(cmd_ctx
->lsm
->domain
.type
,
1568 cmd_ctx
->session
, &channels
);
1569 if (payload_size
< 0) {
1570 /* Return value is a negative lttng_error_code. */
1571 ret
= -payload_size
;
1575 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, channels
,
1586 case LTTNG_LIST_EVENTS
:
1589 struct lttng_event
*events
= NULL
;
1590 struct lttcomm_event_command_header cmd_header
;
1593 memset(&cmd_header
, 0, sizeof(cmd_header
));
1594 /* Extended infos are included at the end of events */
1595 nb_event
= cmd_list_events(cmd_ctx
->lsm
->domain
.type
,
1596 cmd_ctx
->session
, cmd_ctx
->lsm
->u
.list
.channel_name
,
1597 &events
, &total_size
);
1600 /* Return value is a negative lttng_error_code. */
1605 cmd_header
.nb_events
= nb_event
;
1606 ret
= setup_lttng_msg(cmd_ctx
, events
, total_size
,
1607 &cmd_header
, sizeof(cmd_header
));
1617 case LTTNG_LIST_SESSIONS
:
1619 unsigned int nr_sessions
;
1620 void *sessions_payload
;
1623 session_lock_list();
1624 nr_sessions
= lttng_sessions_count(
1625 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1626 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1628 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1629 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1630 sessions_payload
= zmalloc(payload_len
);
1632 if (!sessions_payload
) {
1633 session_unlock_list();
1638 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1639 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1640 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1641 session_unlock_list();
1643 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
1645 free(sessions_payload
);
1654 case LTTNG_REGISTER_CONSUMER
:
1656 struct consumer_data
*cdata
;
1658 switch (cmd_ctx
->lsm
->domain
.type
) {
1659 case LTTNG_DOMAIN_KERNEL
:
1660 cdata
= &kconsumer_data
;
1663 ret
= LTTNG_ERR_UND
;
1667 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
->domain
.type
,
1668 cmd_ctx
->lsm
->u
.reg
.path
, cdata
);
1671 case LTTNG_DATA_PENDING
:
1674 uint8_t pending_ret_byte
;
1676 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1681 * This function may returns 0 or 1 to indicate whether or not
1682 * there is data pending. In case of error, it should return an
1683 * LTTNG_ERR code. However, some code paths may still return
1684 * a nondescript error code, which we handle by returning an
1687 if (pending_ret
== 0 || pending_ret
== 1) {
1689 * ret will be set to LTTNG_OK at the end of
1692 } else if (pending_ret
< 0) {
1693 ret
= LTTNG_ERR_UNK
;
1700 pending_ret_byte
= (uint8_t) pending_ret
;
1702 /* 1 byte to return whether or not data is pending */
1703 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1704 &pending_ret_byte
, 1);
1713 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1715 struct lttcomm_lttng_output_id reply
;
1717 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
1718 &cmd_ctx
->lsm
->u
.snapshot_output
.output
, &reply
.id
);
1719 if (ret
!= LTTNG_OK
) {
1723 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
1729 /* Copy output list into message payload */
1733 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1735 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
1736 &cmd_ctx
->lsm
->u
.snapshot_output
.output
);
1739 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1742 struct lttng_snapshot_output
*outputs
= NULL
;
1744 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
1745 if (nb_output
< 0) {
1750 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
1751 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
1752 nb_output
* sizeof(struct lttng_snapshot_output
));
1762 case LTTNG_SNAPSHOT_RECORD
:
1764 ret
= cmd_snapshot_record(cmd_ctx
->session
,
1765 &cmd_ctx
->lsm
->u
.snapshot_record
.output
,
1766 cmd_ctx
->lsm
->u
.snapshot_record
.wait
);
1769 case LTTNG_CREATE_SESSION_EXT
:
1771 struct lttng_dynamic_buffer payload
;
1772 struct lttng_session_descriptor
*return_descriptor
= NULL
;
1774 lttng_dynamic_buffer_init(&payload
);
1775 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
1776 if (ret
!= LTTNG_OK
) {
1780 ret
= lttng_session_descriptor_serialize(return_descriptor
,
1783 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
1784 lttng_session_descriptor_destroy(return_descriptor
);
1785 ret
= LTTNG_ERR_NOMEM
;
1788 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
1791 lttng_session_descriptor_destroy(return_descriptor
);
1792 ret
= LTTNG_ERR_NOMEM
;
1795 lttng_dynamic_buffer_reset(&payload
);
1796 lttng_session_descriptor_destroy(return_descriptor
);
1800 case LTTNG_SAVE_SESSION
:
1802 ret
= cmd_save_sessions(&cmd_ctx
->lsm
->u
.save_session
.attr
,
1806 case LTTNG_SET_SESSION_SHM_PATH
:
1808 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
1809 cmd_ctx
->lsm
->u
.set_shm_path
.shm_path
);
1812 case LTTNG_REGENERATE_METADATA
:
1814 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
1817 case LTTNG_REGENERATE_STATEDUMP
:
1819 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
1822 case LTTNG_REGISTER_TRIGGER
:
1824 ret
= cmd_register_trigger(cmd_ctx
, *sock
,
1825 notification_thread_handle
);
1828 case LTTNG_UNREGISTER_TRIGGER
:
1830 ret
= cmd_unregister_trigger(cmd_ctx
, *sock
,
1831 notification_thread_handle
);
1834 case LTTNG_ROTATE_SESSION
:
1836 struct lttng_rotate_session_return rotate_return
;
1838 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
1840 memset(&rotate_return
, 0, sizeof(rotate_return
));
1841 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
1842 DBG("Kernel tracer version is not compatible with the rotation feature");
1843 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1847 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
1854 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
1855 sizeof(rotate_return
));
1864 case LTTNG_ROTATION_GET_INFO
:
1866 struct lttng_rotation_get_info_return get_info_return
;
1868 memset(&get_info_return
, 0, sizeof(get_info_return
));
1869 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
1870 cmd_ctx
->lsm
->u
.get_rotation_info
.rotation_id
);
1876 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
1877 sizeof(get_info_return
));
1886 case LTTNG_ROTATION_SET_SCHEDULE
:
1889 enum lttng_rotation_schedule_type schedule_type
;
1892 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
1893 DBG("Kernel tracer version does not support session rotations");
1894 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1898 set_schedule
= cmd_ctx
->lsm
->u
.rotation_set_schedule
.set
== 1;
1899 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
->u
.rotation_set_schedule
.type
;
1900 value
= cmd_ctx
->lsm
->u
.rotation_set_schedule
.value
;
1902 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
,
1906 notification_thread_handle
);
1907 if (ret
!= LTTNG_OK
) {
1913 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1915 struct lttng_session_list_schedules_return schedules
= {
1916 .periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
,
1917 .periodic
.value
= cmd_ctx
->session
->rotate_timer_period
,
1918 .size
.set
= !!cmd_ctx
->session
->rotate_size
,
1919 .size
.value
= cmd_ctx
->session
->rotate_size
,
1922 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
1933 ret
= LTTNG_ERR_UND
;
1938 if (cmd_ctx
->llm
== NULL
) {
1939 DBG("Missing llm structure. Allocating one.");
1940 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
1944 /* Set return code */
1945 cmd_ctx
->llm
->ret_code
= ret
;
1947 if (cmd_ctx
->session
) {
1948 session_unlock(cmd_ctx
->session
);
1949 session_put(cmd_ctx
->session
);
1950 cmd_ctx
->session
= NULL
;
1952 if (need_tracing_session
) {
1953 session_unlock_list();
1956 assert(!rcu_read_ongoing());
1960 static int create_client_sock(void)
1962 int ret
, client_sock
;
1963 const mode_t old_umask
= umask(0);
1965 /* Create client tool unix socket */
1966 client_sock
= lttcomm_create_unix_sock(config
.client_unix_sock_path
.value
);
1967 if (client_sock
< 0) {
1968 ERR("Create unix sock failed: %s", config
.client_unix_sock_path
.value
);
1973 /* Set the cloexec flag */
1974 ret
= utils_set_fd_cloexec(client_sock
);
1976 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
1977 "Continuing but note that the consumer daemon will have a "
1978 "reference to this socket on exec()", client_sock
);
1981 /* File permission MUST be 660 */
1982 ret
= chmod(config
.client_unix_sock_path
.value
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
1984 ERR("Set file permissions failed: %s", config
.client_unix_sock_path
.value
);
1988 DBG("Created client socket (fd = %i)", client_sock
);
1995 static void cleanup_client_thread(void *data
)
1997 struct lttng_pipe
*quit_pipe
= data
;
1999 lttng_pipe_destroy(quit_pipe
);
2002 static void thread_init_cleanup(void *data
)
2004 set_thread_status(false);
2008 * This thread manage all clients request using the unix client socket for
2011 static void *thread_manage_clients(void *data
)
2013 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2015 uint32_t revents
, nb_fd
;
2016 struct command_ctx
*cmd_ctx
= NULL
;
2017 struct lttng_poll_event events
;
2018 int client_sock
= -1;
2019 struct lttng_pipe
*quit_pipe
= data
;
2020 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2022 DBG("[thread] Manage client started");
2024 is_root
= (getuid() == 0);
2026 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2027 client_sock
= create_client_sock();
2028 if (client_sock
< 0) {
2032 rcu_register_thread();
2034 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2036 health_code_update();
2038 ret
= lttcomm_listen_unix_sock(client_sock
);
2044 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2045 * more will be added to this poll set.
2047 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2049 goto error_create_poll
;
2052 /* Add the application registration socket */
2053 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2058 /* Add thread quit pipe */
2059 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2064 /* Set state as running. */
2065 set_thread_status(true);
2066 pthread_cleanup_pop(0);
2068 /* This testpoint is after we signal readiness to the parent. */
2069 if (testpoint(sessiond_thread_manage_clients
)) {
2073 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2077 health_code_update();
2080 const struct cmd_completion_handler
*cmd_completion_handler
;
2082 DBG("Accepting client command ...");
2084 /* Inifinite blocking call, waiting for transmission */
2086 health_poll_entry();
2087 ret
= lttng_poll_wait(&events
, -1);
2091 * Restart interrupted system call.
2093 if (errno
== EINTR
) {
2101 for (i
= 0; i
< nb_fd
; i
++) {
2102 revents
= LTTNG_POLL_GETEV(&events
, i
);
2103 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2105 health_code_update();
2107 if (pollfd
== thread_quit_pipe_fd
) {
2111 /* Event on the registration socket */
2112 if (revents
& LPOLLIN
) {
2114 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2115 ERR("Client socket poll error");
2118 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2124 DBG("Wait for client response");
2126 health_code_update();
2128 sock
= lttcomm_accept_unix_sock(client_sock
);
2134 * Set the CLOEXEC flag. Return code is useless because either way, the
2137 (void) utils_set_fd_cloexec(sock
);
2139 /* Set socket option for credentials retrieval */
2140 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2145 /* Allocate context command to process the client request */
2146 cmd_ctx
= zmalloc(sizeof(struct command_ctx
));
2147 if (cmd_ctx
== NULL
) {
2148 PERROR("zmalloc cmd_ctx");
2152 /* Allocate data buffer for reception */
2153 cmd_ctx
->lsm
= zmalloc(sizeof(struct lttcomm_session_msg
));
2154 if (cmd_ctx
->lsm
== NULL
) {
2155 PERROR("zmalloc cmd_ctx->lsm");
2159 cmd_ctx
->llm
= NULL
;
2160 cmd_ctx
->session
= NULL
;
2162 health_code_update();
2165 * Data is received from the lttng client. The struct
2166 * lttcomm_session_msg (lsm) contains the command and data request of
2169 DBG("Receiving data from client ...");
2170 ret
= lttcomm_recv_creds_unix_sock(sock
, cmd_ctx
->lsm
,
2171 sizeof(struct lttcomm_session_msg
), &cmd_ctx
->creds
);
2173 DBG("Nothing recv() from client... continuing");
2179 clean_command_ctx(&cmd_ctx
);
2183 health_code_update();
2185 // TODO: Validate cmd_ctx including sanity check for
2186 // security purpose.
2188 rcu_thread_online();
2190 * This function dispatch the work to the kernel or userspace tracer
2191 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2192 * informations for the client. The command context struct contains
2193 * everything this function may needs.
2195 ret
= process_client_msg(cmd_ctx
, &sock
, &sock_error
);
2196 rcu_thread_offline();
2206 * TODO: Inform client somehow of the fatal error. At
2207 * this point, ret < 0 means that a zmalloc failed
2208 * (ENOMEM). Error detected but still accept
2209 * command, unless a socket error has been
2212 clean_command_ctx(&cmd_ctx
);
2216 cmd_completion_handler
= cmd_pop_completion_handler();
2217 if (cmd_completion_handler
) {
2218 enum lttng_error_code completion_code
;
2220 completion_code
= cmd_completion_handler
->run(
2221 cmd_completion_handler
->data
);
2222 if (completion_code
!= LTTNG_OK
) {
2223 clean_command_ctx(&cmd_ctx
);
2228 health_code_update();
2231 DBG("Sending response (size: %d, retcode: %s (%d))",
2232 cmd_ctx
->lttng_msg_size
,
2233 lttng_strerror(-cmd_ctx
->llm
->ret_code
),
2234 cmd_ctx
->llm
->ret_code
);
2235 ret
= send_unix_sock(sock
, cmd_ctx
->llm
,
2236 cmd_ctx
->lttng_msg_size
);
2238 ERR("Failed to send data back to client");
2241 /* End of transmission */
2249 clean_command_ctx(&cmd_ctx
);
2251 health_code_update();
2263 lttng_poll_clean(&events
);
2264 clean_command_ctx(&cmd_ctx
);
2268 unlink(config
.client_unix_sock_path
.value
);
2269 if (client_sock
>= 0) {
2270 ret
= close(client_sock
);
2278 ERR("Health error occurred in %s", __func__
);
2281 health_unregister(health_sessiond
);
2283 DBG("Client thread dying");
2285 rcu_unregister_thread();
2290 bool shutdown_client_thread(void *thread_data
)
2292 struct lttng_pipe
*client_quit_pipe
= thread_data
;
2293 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2295 return notify_thread_pipe(write_fd
) == 1;
2298 struct lttng_thread
*launch_client_thread(void)
2300 bool thread_running
;
2301 struct lttng_pipe
*client_quit_pipe
;
2302 struct lttng_thread
*thread
;
2304 sem_init(&thread_state
.ready
, 0, 0);
2305 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2306 if (!client_quit_pipe
) {
2310 thread
= lttng_thread_create("Client management",
2311 thread_manage_clients
,
2312 shutdown_client_thread
,
2313 cleanup_client_thread
,
2320 * This thread is part of the threads that need to be fully
2321 * initialized before the session daemon is marked as "ready".
2323 thread_running
= wait_thread_status();
2324 if (!thread_running
) {
2325 lttng_thread_put(thread
);
2330 cleanup_client_thread(client_quit_pipe
);