2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * SPDX-License-Identifier: GPL-2.0-only
10 #include "agent-thread.hpp"
14 #include "common/buffer-view.hpp"
15 #include "common/compat/socket.hpp"
16 #include "common/dynamic-array.hpp"
17 #include "common/dynamic-buffer.hpp"
18 #include "common/fd-handle.hpp"
19 #include "common/payload-view.hpp"
20 #include "common/payload.hpp"
21 #include "common/sessiond-comm/sessiond-comm.hpp"
22 #include "health-sessiond.hpp"
24 #include "lttng-sessiond.hpp"
25 #include "lttng/lttng-error.h"
26 #include "lttng/tracker.h"
27 #include "manage-consumer.hpp"
29 #include "testpoint.hpp"
32 #include <common/compat/getenv.hpp>
33 #include <common/tracker.hpp>
34 #include <common/unix.hpp>
35 #include <common/utils.hpp>
37 #include <lttng/error-query-internal.hpp>
38 #include <lttng/event-internal.hpp>
39 #include <lttng/session-descriptor-internal.hpp>
40 #include <lttng/session-internal.hpp>
41 #include <lttng/userspace-probe-internal.hpp>
61 static void set_thread_status(bool running
)
63 DBG("Marking client thread's state as %s", running
? "running" : "error");
64 thread_state
.running
= running
;
65 sem_post(&thread_state
.ready
);
68 static bool wait_thread_status()
70 DBG("Waiting for client thread to be ready");
71 sem_wait(&thread_state
.ready
);
72 if (thread_state
.running
) {
73 DBG("Client thread is ready");
75 ERR("Initialization of client thread failed");
78 return thread_state
.running
;
82 * Setup the outgoing data buffer for the response (llm) by allocating the
83 * right amount of memory and copying the original information from the lsm
86 * Return 0 on success, negative value on error.
88 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
89 const void *payload_buf
,
91 const void *cmd_header_buf
,
92 size_t cmd_header_len
)
95 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
96 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
97 lttcomm_lttng_msg llm
{};
99 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
100 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
101 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
102 llm
.data_size
= (uint32_t) payload_len
;
104 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
109 lttng_dynamic_pointer_array_clear(&cmd_ctx
->reply_payload
._fd_handles
);
111 cmd_ctx
->lttng_msg_size
= total_msg_size
;
113 /* Append reply header. */
114 ret
= lttng_dynamic_buffer_append(&cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
119 /* Append command header. */
120 if (cmd_header_len
) {
121 ret
= lttng_dynamic_buffer_append(
122 &cmd_ctx
->reply_payload
.buffer
, cmd_header_buf
, cmd_header_len
);
128 /* Append payload. */
130 ret
= lttng_dynamic_buffer_append(
131 &cmd_ctx
->reply_payload
.buffer
, payload_buf
, payload_len
);
141 static int setup_empty_lttng_msg(struct command_ctx
*cmd_ctx
)
144 const struct lttcomm_lttng_msg llm
= {};
146 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
151 /* Append place-holder reply header. */
152 ret
= lttng_dynamic_buffer_append(&cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
157 cmd_ctx
->lttng_msg_size
= sizeof(llm
);
162 static void update_lttng_msg(struct command_ctx
*cmd_ctx
, size_t cmd_header_len
, size_t payload_len
)
164 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
165 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
166 struct lttcomm_lttng_msg
*p_llm
;
167 lttcomm_lttng_msg llm
{};
169 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
170 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
171 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
172 llm
.data_size
= (uint32_t) payload_len
;
174 LTTNG_ASSERT(cmd_ctx
->reply_payload
.buffer
.size
>= sizeof(llm
));
176 p_llm
= (typeof(p_llm
)) cmd_ctx
->reply_payload
.buffer
.data
;
178 /* Update existing header. */
179 memcpy(p_llm
, &llm
, sizeof(llm
));
181 cmd_ctx
->lttng_msg_size
= total_msg_size
;
185 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
186 * exec or it will fail.
188 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
190 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
194 * Fork and exec a consumer daemon (consumerd).
196 * Return pid if successful else -1.
198 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
202 const char *consumer_to_use
;
203 const char *verbosity
;
206 DBG("Spawning consumerd");
213 if (the_config
.verbose_consumer
) {
214 verbosity
= "--verbose";
215 } else if (lttng_opt_quiet
) {
216 verbosity
= "--quiet";
221 switch (consumer_data
->type
) {
222 case LTTNG_CONSUMER_KERNEL
:
224 * Find out which consumerd to execute. We will first try the
225 * 64-bit path, then the sessiond's installation directory, and
226 * fallback on the 32-bit one,
228 DBG3("Looking for a kernel consumer at these locations:");
229 DBG3(" 1) %s", the_config
.consumerd64_bin_path
.value
?: "NULL");
230 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
231 DBG3(" 3) %s", the_config
.consumerd32_bin_path
.value
?: "NULL");
232 if (stat(the_config
.consumerd64_bin_path
.value
, &st
) == 0) {
233 DBG3("Found location #1");
234 consumer_to_use
= the_config
.consumerd64_bin_path
.value
;
235 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
236 DBG3("Found location #2");
237 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
238 } else if (the_config
.consumerd32_bin_path
.value
&&
239 stat(the_config
.consumerd32_bin_path
.value
, &st
) == 0) {
240 DBG3("Found location #3");
241 consumer_to_use
= the_config
.consumerd32_bin_path
.value
;
243 DBG("Could not find any valid consumerd executable");
247 DBG("Using kernel consumer at: %s", consumer_to_use
);
248 (void) execl(consumer_to_use
,
252 "--consumerd-cmd-sock",
253 consumer_data
->cmd_unix_sock_path
,
254 "--consumerd-err-sock",
255 consumer_data
->err_unix_sock_path
,
257 the_config
.tracing_group_name
.value
,
260 case LTTNG_CONSUMER64_UST
:
262 if (the_config
.consumerd64_lib_dir
.value
) {
267 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
271 tmplen
= strlen(the_config
.consumerd64_lib_dir
.value
) + 1 /* : */ +
273 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
278 strcat(tmpnew
, the_config
.consumerd64_lib_dir
.value
);
279 if (tmp
[0] != '\0') {
283 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
290 DBG("Using 64-bit UST consumer at: %s",
291 the_config
.consumerd64_bin_path
.value
);
292 (void) execl(the_config
.consumerd64_bin_path
.value
,
296 "--consumerd-cmd-sock",
297 consumer_data
->cmd_unix_sock_path
,
298 "--consumerd-err-sock",
299 consumer_data
->err_unix_sock_path
,
301 the_config
.tracing_group_name
.value
,
305 case LTTNG_CONSUMER32_UST
:
307 if (the_config
.consumerd32_lib_dir
.value
) {
312 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
316 tmplen
= strlen(the_config
.consumerd32_lib_dir
.value
) + 1 /* : */ +
318 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
323 strcat(tmpnew
, the_config
.consumerd32_lib_dir
.value
);
324 if (tmp
[0] != '\0') {
328 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
335 DBG("Using 32-bit UST consumer at: %s",
336 the_config
.consumerd32_bin_path
.value
);
337 (void) execl(the_config
.consumerd32_bin_path
.value
,
341 "--consumerd-cmd-sock",
342 consumer_data
->cmd_unix_sock_path
,
343 "--consumerd-err-sock",
344 consumer_data
->err_unix_sock_path
,
346 the_config
.tracing_group_name
.value
,
351 ERR("unknown consumer type");
355 PERROR("Consumer execl()");
357 /* Reaching this point, we got a failure on our execl(). */
359 } else if (pid
> 0) {
362 PERROR("start consumer fork");
370 * Spawn the consumerd daemon and session daemon thread.
372 static int start_consumerd(struct consumer_data
*consumer_data
)
377 * Set the listen() state on the socket since there is a possible race
378 * between the exec() of the consumer daemon and this call if place in the
379 * consumer thread. See bug #366 for more details.
381 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
386 pthread_mutex_lock(&consumer_data
->pid_mutex
);
387 if (consumer_data
->pid
!= 0) {
388 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
392 ret
= spawn_consumerd(consumer_data
);
394 ERR("Spawning consumerd failed");
395 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
399 /* Setting up the consumer_data pid */
400 consumer_data
->pid
= ret
;
401 DBG2("Consumer pid %d", consumer_data
->pid
);
402 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
404 DBG2("Spawning consumer control thread");
405 ret
= spawn_consumer_thread(consumer_data
);
407 ERR("Fatal error spawning consumer control thread");
415 /* Cleanup already created sockets on error. */
416 if (consumer_data
->err_sock
>= 0) {
419 err
= close(consumer_data
->err_sock
);
421 PERROR("close consumer data error socket");
428 * Copy consumer output from the tracing session to the domain session. The
429 * function also applies the right modification on a per domain basis for the
430 * trace files destination directory.
432 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
435 const char *dir_name
;
436 struct consumer_output
*consumer
;
438 LTTNG_ASSERT(session
);
439 LTTNG_ASSERT(session
->consumer
);
442 case LTTNG_DOMAIN_KERNEL
:
443 DBG3("Copying tracing session consumer output in kernel session");
445 * XXX: We should audit the session creation and what this function
446 * does "extra" in order to avoid a destroy since this function is used
447 * in the domain session creation (kernel and ust) only. Same for UST
450 if (session
->kernel_session
->consumer
) {
451 consumer_output_put(session
->kernel_session
->consumer
);
453 session
->kernel_session
->consumer
= consumer_copy_output(session
->consumer
);
454 /* Ease our life a bit for the next part */
455 consumer
= session
->kernel_session
->consumer
;
456 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
458 case LTTNG_DOMAIN_JUL
:
459 case LTTNG_DOMAIN_LOG4J
:
460 case LTTNG_DOMAIN_PYTHON
:
461 case LTTNG_DOMAIN_UST
:
462 DBG3("Copying tracing session consumer output in UST session");
463 if (session
->ust_session
->consumer
) {
464 consumer_output_put(session
->ust_session
->consumer
);
466 session
->ust_session
->consumer
= consumer_copy_output(session
->consumer
);
467 /* Ease our life a bit for the next part */
468 consumer
= session
->ust_session
->consumer
;
469 dir_name
= DEFAULT_UST_TRACE_DIR
;
472 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
476 /* Append correct directory to subdir */
477 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
, sizeof(consumer
->domain_subdir
));
482 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
490 * Create an UST session and add it to the session ust list.
492 static int create_ust_session(struct ltt_session
*session
, const struct lttng_domain
*domain
)
495 struct ltt_ust_session
*lus
= nullptr;
497 LTTNG_ASSERT(session
);
498 LTTNG_ASSERT(domain
);
499 LTTNG_ASSERT(session
->consumer
);
501 switch (domain
->type
) {
502 case LTTNG_DOMAIN_JUL
:
503 case LTTNG_DOMAIN_LOG4J
:
504 case LTTNG_DOMAIN_PYTHON
:
505 case LTTNG_DOMAIN_UST
:
508 ERR("Unknown UST domain on create session %d", domain
->type
);
509 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
513 DBG("Creating UST session");
515 lus
= trace_ust_create_session(session
->id
);
516 if (lus
== nullptr) {
517 ret
= LTTNG_ERR_UST_SESS_FAIL
;
521 lus
->uid
= session
->uid
;
522 lus
->gid
= session
->gid
;
523 lus
->output_traces
= session
->output_traces
;
524 lus
->snapshot_mode
= session
->snapshot_mode
;
525 lus
->live_timer_interval
= session
->live_timer
;
526 session
->ust_session
= lus
;
527 if (session
->shm_path
[0]) {
528 strncpy(lus
->root_shm_path
, session
->shm_path
, sizeof(lus
->root_shm_path
));
529 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
530 strncpy(lus
->shm_path
, session
->shm_path
, sizeof(lus
->shm_path
));
531 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
532 strncat(lus
->shm_path
, "/ust", sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
534 /* Copy session output to the newly created UST session */
535 ret
= copy_session_consumer(domain
->type
, session
);
536 if (ret
!= LTTNG_OK
) {
544 session
->ust_session
= nullptr;
549 * Create a kernel tracer session then create the default channel.
551 static int create_kernel_session(struct ltt_session
*session
)
555 DBG("Creating kernel session");
557 ret
= kernel_create_session(session
);
559 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
563 /* Code flow safety */
564 LTTNG_ASSERT(session
->kernel_session
);
566 /* Copy session output to the newly created Kernel session */
567 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
568 if (ret
!= LTTNG_OK
) {
572 session
->kernel_session
->uid
= session
->uid
;
573 session
->kernel_session
->gid
= session
->gid
;
574 session
->kernel_session
->output_traces
= session
->output_traces
;
575 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
576 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
581 trace_kernel_destroy_session(session
->kernel_session
);
582 session
->kernel_session
= nullptr;
588 * Count number of session permitted by uid/gid.
590 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
__attribute__((unused
)))
593 struct ltt_session
*session
;
594 const struct ltt_session_list
*session_list
= session_get_list();
596 DBG("Counting number of available session for UID %d", uid
);
597 cds_list_for_each_entry (session
, &session_list
->head
, list
) {
598 if (!session_get(session
)) {
601 session_lock(session
);
602 /* Only count the sessions the user can control. */
603 if (session_access_ok(session
, uid
) && !session
->destroyed
) {
606 session_unlock(session
);
607 session_put(session
);
612 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
615 struct lttng_trigger
**_trigger
)
619 ssize_t sock_recv_len
;
620 enum lttng_error_code ret_code
;
621 struct lttng_payload trigger_payload
;
622 struct lttng_trigger
*trigger
= nullptr;
624 lttng_payload_init(&trigger_payload
);
625 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
626 ret
= lttng_dynamic_buffer_set_size(&trigger_payload
.buffer
, trigger_len
);
628 ret_code
= LTTNG_ERR_NOMEM
;
632 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_payload
.buffer
.data
, trigger_len
);
633 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
634 ERR("Failed to receive trigger in command payload");
636 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
640 /* Receive fds, if any. */
641 if (cmd_ctx
->lsm
.fd_count
> 0) {
642 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
643 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
644 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
645 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
646 cmd_ctx
->lsm
.fd_count
,
648 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
651 } else if (sock_recv_len
<= 0) {
652 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
653 cmd_ctx
->lsm
.fd_count
,
655 ret_code
= LTTNG_ERR_FATAL
;
661 /* Deserialize trigger. */
663 struct lttng_payload_view view
=
664 lttng_payload_view_from_payload(&trigger_payload
, 0, -1);
666 if (lttng_trigger_create_from_payload(&view
, &trigger
) != trigger_len
) {
667 ERR("Invalid trigger received as part of command payload");
668 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
669 lttng_trigger_put(trigger
);
678 lttng_payload_reset(&trigger_payload
);
682 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
685 struct lttng_error_query
**_query
)
689 ssize_t sock_recv_len
;
690 enum lttng_error_code ret_code
;
691 struct lttng_payload query_payload
;
692 struct lttng_error_query
*query
= nullptr;
694 lttng_payload_init(&query_payload
);
695 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
696 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
698 ret_code
= LTTNG_ERR_NOMEM
;
702 sock_recv_len
= lttcomm_recv_unix_sock(sock
, query_payload
.buffer
.data
, query_len
);
703 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
704 ERR("Failed to receive error query in command payload");
706 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
710 /* Receive fds, if any. */
711 if (cmd_ctx
->lsm
.fd_count
> 0) {
712 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
713 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
714 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
715 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
716 cmd_ctx
->lsm
.fd_count
,
718 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
721 } else if (sock_recv_len
<= 0) {
722 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
723 cmd_ctx
->lsm
.fd_count
,
725 ret_code
= LTTNG_ERR_FATAL
;
731 /* Deserialize error query. */
733 struct lttng_payload_view view
=
734 lttng_payload_view_from_payload(&query_payload
, 0, -1);
736 if (lttng_error_query_create_from_payload(&view
, &query
) != query_len
) {
737 ERR("Invalid error query received as part of command payload");
738 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
747 lttng_payload_reset(&query_payload
);
751 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
754 struct lttng_event
**out_event
,
755 char **out_filter_expression
,
756 struct lttng_bytecode
**out_bytecode
,
757 struct lttng_event_exclusion
**out_exclusion
)
761 ssize_t sock_recv_len
;
762 enum lttng_error_code ret_code
;
763 struct lttng_payload event_payload
;
764 struct lttng_event
*local_event
= nullptr;
765 char *local_filter_expression
= nullptr;
766 struct lttng_bytecode
*local_bytecode
= nullptr;
767 struct lttng_event_exclusion
*local_exclusion
= nullptr;
769 lttng_payload_init(&event_payload
);
770 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
) {
771 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
772 } else if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
) {
773 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
778 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
780 ret_code
= LTTNG_ERR_NOMEM
;
784 sock_recv_len
= lttcomm_recv_unix_sock(sock
, event_payload
.buffer
.data
, event_len
);
785 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
786 ERR("Failed to receive event in command payload");
788 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
792 /* Receive fds, if any. */
793 if (cmd_ctx
->lsm
.fd_count
> 0) {
794 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
795 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
796 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
797 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
798 cmd_ctx
->lsm
.fd_count
,
800 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
803 } else if (sock_recv_len
<= 0) {
804 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
805 cmd_ctx
->lsm
.fd_count
,
807 ret_code
= LTTNG_ERR_FATAL
;
813 /* Deserialize event. */
816 struct lttng_payload_view event_view
=
817 lttng_payload_view_from_payload(&event_payload
, 0, -1);
819 len
= lttng_event_create_from_payload(&event_view
,
822 &local_filter_expression
,
826 ERR("Failed to create an event from the received buffer");
827 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
831 if (len
!= event_len
) {
832 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
833 ", payload length = %zd",
836 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
841 *out_event
= local_event
;
842 *out_exclusion
= local_exclusion
;
843 *out_filter_expression
= local_filter_expression
;
844 *out_bytecode
= local_bytecode
;
845 local_event
= nullptr;
846 local_exclusion
= nullptr;
847 local_filter_expression
= nullptr;
848 local_bytecode
= nullptr;
853 lttng_payload_reset(&event_payload
);
854 lttng_event_destroy(local_event
);
855 free(local_filter_expression
);
856 free(local_bytecode
);
857 free(local_exclusion
);
861 static enum lttng_error_code
862 receive_lttng_event_context(const struct command_ctx
*cmd_ctx
,
865 struct lttng_event_context
**out_event_context
)
868 const size_t event_context_len
= (size_t) cmd_ctx
->lsm
.u
.context
.length
;
869 ssize_t sock_recv_len
;
870 enum lttng_error_code ret_code
;
871 struct lttng_payload event_context_payload
;
872 struct lttng_event_context
*context
= nullptr;
874 lttng_payload_init(&event_context_payload
);
876 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
, event_context_len
);
878 ret_code
= LTTNG_ERR_NOMEM
;
883 lttcomm_recv_unix_sock(sock
, event_context_payload
.buffer
.data
, event_context_len
);
884 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
885 ERR("Failed to receive event context in command payload");
887 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
891 /* Deserialize event. */
894 struct lttng_payload_view event_context_view
=
895 lttng_payload_view_from_payload(&event_context_payload
, 0, -1);
897 len
= lttng_event_context_create_from_payload(&event_context_view
, &context
);
900 ERR("Failed to create a event context from the received buffer");
901 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
905 if (len
!= event_context_len
) {
906 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd",
909 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
914 *out_event_context
= context
;
919 lttng_event_context_destroy(context
);
920 lttng_payload_reset(&event_context_payload
);
925 * Version of setup_lttng_msg() without command header.
928 setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
, void *payload_buf
, size_t payload_len
)
930 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, nullptr, 0);
934 * Check if the current kernel tracer supports the session rotation feature.
935 * Return 1 if it does, 0 otherwise.
937 static int check_rotate_compatible()
941 if (the_kernel_tracer_version
.major
!= 2 || the_kernel_tracer_version
.minor
< 11) {
942 DBG("Kernel tracer version is not compatible with the rotation feature");
950 * Send data on a unix socket using the liblttsessiondcomm API.
952 * Return lttcomm error code.
954 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
957 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
959 /* Check valid length */
960 if (view
->buffer
.size
== 0) {
965 ret
= lttcomm_send_unix_sock(sock
, view
->buffer
.data
, view
->buffer
.size
);
971 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
982 * Process the command requested by the lttng client within the command
983 * context structure. This function make sure that the return structure (llm)
984 * is set and ready for transmission before returning.
986 * Return any error encountered or 0 for success.
988 * "sock" is only used for special-case var. len data.
989 * A command may assume the ownership of the socket, in which case its value
990 * should be set to -1.
992 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
, int *sock_error
)
995 bool need_tracing_session
= true;
999 if (!lttcomm_sessiond_command_is_valid((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
)) {
1000 ERR("Unknown client command received: command id = %" PRIu32
,
1001 cmd_ctx
->lsm
.cmd_type
);
1002 ret
= LTTNG_ERR_UND
;
1006 DBG("Processing client command '%s\' (%d)",
1007 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
1008 cmd_ctx
->lsm
.cmd_type
);
1012 switch (cmd_ctx
->lsm
.cmd_type
) {
1013 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1014 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1015 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1016 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1017 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1018 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1019 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1020 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1021 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1022 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
1023 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
1024 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1025 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
1026 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
1027 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
1028 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1029 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1030 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
1031 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1032 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
1033 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1034 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1035 need_domain
= false;
1041 /* Needs a functioning consumerd? */
1042 switch (cmd_ctx
->lsm
.cmd_type
) {
1043 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1044 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1045 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1046 need_consumerd
= false;
1049 need_consumerd
= true;
1053 if (the_config
.no_kernel
&& need_domain
&&
1054 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1056 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1058 ret
= LTTNG_ERR_KERN_NA
;
1063 /* Deny register consumer if we already have a spawned consumer. */
1064 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1065 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1066 if (the_kconsumer_data
.pid
> 0) {
1067 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1068 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1071 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1075 * Check for command that don't needs to allocate a returned payload. We do
1076 * this here so we don't have to make the call for no payload at each
1079 switch (cmd_ctx
->lsm
.cmd_type
) {
1080 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1081 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1082 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1083 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1084 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1085 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1086 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1087 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1088 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1089 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1090 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1091 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1092 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1093 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1094 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1095 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1098 /* Setup lttng message with no payload */
1099 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, nullptr, 0);
1101 /* This label does not try to unlock the session */
1102 goto init_setup_error
;
1106 /* Commands that DO NOT need a session. */
1107 switch (cmd_ctx
->lsm
.cmd_type
) {
1108 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1109 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1110 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1111 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1112 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1113 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1114 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1115 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1116 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1117 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1118 need_tracing_session
= false;
1121 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1123 * We keep the session list lock across _all_ commands
1124 * for now, because the per-session lock does not
1125 * handle teardown properly.
1127 session_lock_list();
1128 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1129 if (cmd_ctx
->session
== nullptr) {
1130 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1133 /* Acquire lock for the session */
1134 session_lock(cmd_ctx
->session
);
1140 * Commands that need a valid session but should NOT create one if none
1141 * exists. Instead of creating one and destroying it when the command is
1142 * handled, process that right before so we save some round trip in useless
1145 switch (cmd_ctx
->lsm
.cmd_type
) {
1146 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1147 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1148 switch (cmd_ctx
->lsm
.domain
.type
) {
1149 case LTTNG_DOMAIN_KERNEL
:
1150 if (!cmd_ctx
->session
->kernel_session
) {
1151 ret
= LTTNG_ERR_NO_CHANNEL
;
1155 case LTTNG_DOMAIN_JUL
:
1156 case LTTNG_DOMAIN_LOG4J
:
1157 case LTTNG_DOMAIN_PYTHON
:
1158 case LTTNG_DOMAIN_UST
:
1159 if (!cmd_ctx
->session
->ust_session
) {
1160 ret
= LTTNG_ERR_NO_CHANNEL
;
1165 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1177 * Check domain type for specific "pre-action".
1179 switch (cmd_ctx
->lsm
.domain
.type
) {
1180 case LTTNG_DOMAIN_KERNEL
:
1182 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1186 /* Kernel tracer check */
1187 if (!kernel_tracer_is_initialized()) {
1188 /* Basically, load kernel tracer modules */
1189 ret
= init_kernel_tracer();
1195 /* Consumer is in an ERROR state. Report back to client */
1196 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) == CONSUMER_ERROR
) {
1197 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1201 /* Need a session for kernel command */
1202 if (need_tracing_session
) {
1203 if (cmd_ctx
->session
->kernel_session
== nullptr) {
1204 ret
= create_kernel_session(cmd_ctx
->session
);
1205 if (ret
!= LTTNG_OK
) {
1206 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1211 /* Start the kernel consumer daemon */
1212 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1213 if (the_kconsumer_data
.pid
== 0 &&
1214 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1215 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1216 ret
= start_consumerd(&the_kconsumer_data
);
1218 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1221 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1223 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1227 * The consumer was just spawned so we need to add the socket to
1228 * the consumer output of the session if exist.
1230 ret
= consumer_create_socket(&the_kconsumer_data
,
1231 cmd_ctx
->session
->kernel_session
->consumer
);
1238 case LTTNG_DOMAIN_JUL
:
1239 case LTTNG_DOMAIN_LOG4J
:
1240 case LTTNG_DOMAIN_PYTHON
:
1241 if (!agent_tracing_is_enabled()) {
1242 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1246 case LTTNG_DOMAIN_UST
:
1248 if (!ust_app_supported()) {
1249 ret
= LTTNG_ERR_NO_UST
;
1253 /* Consumer is in an ERROR state. Report back to client */
1254 if (need_consumerd
&& uatomic_read(&the_ust_consumerd_state
) == CONSUMER_ERROR
) {
1255 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1259 if (need_tracing_session
) {
1260 /* Create UST session if none exist. */
1261 if (cmd_ctx
->session
->ust_session
== nullptr) {
1262 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1263 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1264 if (ret
!= LTTNG_OK
) {
1269 /* Start the UST consumer daemons */
1271 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1272 if (the_config
.consumerd64_bin_path
.value
&&
1273 the_ustconsumer64_data
.pid
== 0 &&
1274 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1275 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1276 ret
= start_consumerd(&the_ustconsumer64_data
);
1278 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1279 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1283 uatomic_set(&the_ust_consumerd64_fd
,
1284 the_ustconsumer64_data
.cmd_sock
);
1285 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1287 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1291 * Setup socket for consumer 64 bit. No need for atomic access
1292 * since it was set above and can ONLY be set in this thread.
1294 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1295 cmd_ctx
->session
->ust_session
->consumer
);
1301 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1302 if (the_config
.consumerd32_bin_path
.value
&&
1303 the_ustconsumer32_data
.pid
== 0 &&
1304 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1305 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1306 ret
= start_consumerd(&the_ustconsumer32_data
);
1308 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1309 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1313 uatomic_set(&the_ust_consumerd32_fd
,
1314 the_ustconsumer32_data
.cmd_sock
);
1315 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1317 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1321 * Setup socket for consumer 32 bit. No need for atomic access
1322 * since it was set above and can ONLY be set in this thread.
1324 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1325 cmd_ctx
->session
->ust_session
->consumer
);
1337 /* Validate consumer daemon state when start/stop trace command */
1338 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_START_TRACE
||
1339 cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
) {
1340 switch (cmd_ctx
->lsm
.domain
.type
) {
1341 case LTTNG_DOMAIN_NONE
:
1343 case LTTNG_DOMAIN_JUL
:
1344 case LTTNG_DOMAIN_LOG4J
:
1345 case LTTNG_DOMAIN_PYTHON
:
1346 case LTTNG_DOMAIN_UST
:
1347 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1348 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1352 case LTTNG_DOMAIN_KERNEL
:
1353 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1354 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1359 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1365 * Check that the UID matches that of the tracing session.
1366 * The root user can interact with all sessions.
1368 if (need_tracing_session
) {
1369 if (!session_access_ok(cmd_ctx
->session
,
1370 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1371 cmd_ctx
->session
->destroyed
) {
1372 ret
= LTTNG_ERR_EPERM
;
1378 * Send relayd information to consumer as soon as we have a domain and a
1381 if (cmd_ctx
->session
&& need_domain
) {
1383 * Setup relayd if not done yet. If the relayd information was already
1384 * sent to the consumer, this call will gracefully return.
1386 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1387 if (ret
!= LTTNG_OK
) {
1392 /* Process by command type */
1393 switch (cmd_ctx
->lsm
.cmd_type
) {
1394 case LTTCOMM_SESSIOND_COMMAND_ADD_CONTEXT
:
1396 struct lttng_event_context
*event_context
= nullptr;
1397 const enum lttng_error_code ret_code
=
1398 receive_lttng_event_context(cmd_ctx
, *sock
, sock_error
, &event_context
);
1400 if (ret_code
!= LTTNG_OK
) {
1401 ret
= (int) ret_code
;
1405 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1406 lttng_event_context_destroy(event_context
);
1409 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1411 ret
= cmd_disable_channel(cmd_ctx
->session
,
1412 cmd_ctx
->lsm
.domain
.type
,
1413 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1416 case LTTCOMM_SESSIOND_COMMAND_ENABLE_CHANNEL
:
1418 ret
= cmd_enable_channel(cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1421 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1422 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1424 struct lttng_dynamic_buffer payload
;
1425 struct lttng_buffer_view payload_view
;
1426 const bool add_value
= cmd_ctx
->lsm
.cmd_type
==
1427 LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1428 const size_t name_len
=
1429 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
.name_len
;
1430 const enum lttng_domain_type domain_type
=
1431 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1432 const enum lttng_process_attr process_attr
=
1433 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1434 .process_attr_tracker_add_remove_include_value
.process_attr
;
1435 const enum lttng_process_attr_value_type value_type
=
1436 (enum lttng_process_attr_value_type
) cmd_ctx
->lsm
.u
1437 .process_attr_tracker_add_remove_include_value
.value_type
;
1438 struct process_attr_value
*value
;
1439 enum lttng_error_code ret_code
;
1440 long login_name_max
;
1442 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1443 if (login_name_max
< 0) {
1444 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1445 ret
= LTTNG_ERR_INVALID
;
1449 /* Receive remaining variable length payload if applicable. */
1450 if (name_len
> login_name_max
) {
1452 * POSIX mandates user and group names that are at least
1453 * 8 characters long. Note that although shadow-utils
1454 * (useradd, groupaadd, etc.) use 32 chars as their
1455 * limit (from bits/utmp.h, UT_NAMESIZE),
1456 * LOGIN_NAME_MAX is defined to 256.
1458 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1459 add_value
? "addition" : "removal",
1462 ret
= LTTNG_ERR_INVALID
;
1466 lttng_dynamic_buffer_init(&payload
);
1467 if (name_len
!= 0) {
1469 * Receive variable payload for user/group name
1472 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1474 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1475 add_value
? "add" : "remove");
1476 ret
= LTTNG_ERR_NOMEM
;
1477 goto error_add_remove_tracker_value
;
1480 ret
= lttcomm_recv_unix_sock(*sock
, payload
.data
, name_len
);
1482 ERR("Failed to receive payload of %s process attribute tracker value argument",
1483 add_value
? "add" : "remove");
1485 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1486 goto error_add_remove_tracker_value
;
1490 payload_view
= lttng_buffer_view_from_dynamic_buffer(&payload
, 0, name_len
);
1491 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1492 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1493 goto error_add_remove_tracker_value
;
1497 * Validate the value type and domains are legal for the process
1498 * attribute tracker that is specified and convert the value to
1499 * add/remove to the internal sessiond representation.
1501 ret_code
= process_attr_value_from_comm(
1505 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
.integral_value
,
1508 if (ret_code
!= LTTNG_OK
) {
1510 goto error_add_remove_tracker_value
;
1514 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1515 cmd_ctx
->session
, domain_type
, process_attr
, value
);
1517 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1518 cmd_ctx
->session
, domain_type
, process_attr
, value
);
1520 process_attr_value_destroy(value
);
1521 error_add_remove_tracker_value
:
1522 lttng_dynamic_buffer_reset(&payload
);
1525 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1527 enum lttng_tracking_policy tracking_policy
;
1528 const enum lttng_domain_type domain_type
=
1529 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1530 const enum lttng_process_attr process_attr
=
1531 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1532 .process_attr_tracker_get_tracking_policy
.process_attr
;
1534 ret
= cmd_process_attr_tracker_get_tracking_policy(
1535 cmd_ctx
->session
, domain_type
, process_attr
, &tracking_policy
);
1536 if (ret
!= LTTNG_OK
) {
1540 uint32_t tracking_policy_u32
= tracking_policy
;
1541 ret
= setup_lttng_msg_no_cmd_header(
1542 cmd_ctx
, &tracking_policy_u32
, sizeof(uint32_t));
1544 ret
= LTTNG_ERR_NOMEM
;
1550 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_SET_POLICY
:
1552 const enum lttng_tracking_policy tracking_policy
=
1553 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1554 .process_attr_tracker_set_tracking_policy
.tracking_policy
;
1555 const enum lttng_domain_type domain_type
=
1556 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1557 const enum lttng_process_attr process_attr
=
1558 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1559 .process_attr_tracker_set_tracking_policy
.process_attr
;
1561 ret
= cmd_process_attr_tracker_set_tracking_policy(
1562 cmd_ctx
->session
, domain_type
, process_attr
, tracking_policy
);
1563 if (ret
!= LTTNG_OK
) {
1568 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1570 struct lttng_process_attr_values
*values
;
1571 struct lttng_dynamic_buffer reply
;
1572 const enum lttng_domain_type domain_type
=
1573 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1574 const enum lttng_process_attr process_attr
=
1575 (enum lttng_process_attr
)
1576 cmd_ctx
->lsm
.u
.process_attr_tracker_get_inclusion_set
.process_attr
;
1578 ret
= cmd_process_attr_tracker_get_inclusion_set(
1579 cmd_ctx
->session
, domain_type
, process_attr
, &values
);
1580 if (ret
!= LTTNG_OK
) {
1584 lttng_dynamic_buffer_init(&reply
);
1585 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1587 goto error_tracker_get_inclusion_set
;
1590 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, reply
.data
, reply
.size
);
1592 ret
= LTTNG_ERR_NOMEM
;
1593 goto error_tracker_get_inclusion_set
;
1597 error_tracker_get_inclusion_set
:
1598 lttng_process_attr_values_destroy(values
);
1599 lttng_dynamic_buffer_reset(&reply
);
1602 case LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
:
1603 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1605 struct lttng_event
*event
;
1606 char *filter_expression
;
1607 struct lttng_event_exclusion
*exclusions
;
1608 struct lttng_bytecode
*bytecode
;
1609 const enum lttng_error_code ret_code
= receive_lttng_event(cmd_ctx
,
1617 if (ret_code
!= LTTNG_OK
) {
1618 ret
= (int) ret_code
;
1623 * Ownership of filter_expression, exclusions, and bytecode is
1624 * always transferred.
1626 ret
= cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
?
1627 cmd_enable_event(cmd_ctx
,
1632 the_kernel_poll_pipe
[1]) :
1633 cmd_disable_event(cmd_ctx
, event
, filter_expression
, bytecode
, exclusions
);
1634 lttng_event_destroy(event
);
1637 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1639 enum lttng_error_code ret_code
;
1640 size_t original_payload_size
;
1641 size_t payload_size
;
1642 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1644 ret
= setup_empty_lttng_msg(cmd_ctx
);
1646 ret
= LTTNG_ERR_NOMEM
;
1650 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1652 session_lock_list();
1653 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1654 session_unlock_list();
1655 if (ret_code
!= LTTNG_OK
) {
1656 ret
= (int) ret_code
;
1660 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1661 original_payload_size
;
1662 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1667 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1669 enum lttng_error_code ret_code
;
1670 size_t original_payload_size
;
1671 size_t payload_size
;
1672 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1674 ret
= setup_empty_lttng_msg(cmd_ctx
);
1676 ret
= LTTNG_ERR_NOMEM
;
1680 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1682 session_lock_list();
1683 ret_code
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1684 &cmd_ctx
->reply_payload
);
1685 session_unlock_list();
1686 if (ret_code
!= LTTNG_OK
) {
1687 ret
= (int) ret_code
;
1691 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1692 original_payload_size
;
1693 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1698 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1700 enum lttng_error_code ret_code
;
1701 size_t original_payload_size
;
1702 size_t payload_size
;
1703 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1705 ret
= setup_empty_lttng_msg(cmd_ctx
);
1707 ret
= LTTNG_ERR_NOMEM
;
1711 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1713 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1714 if (ret_code
!= LTTNG_OK
) {
1715 ret
= (int) ret_code
;
1719 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1720 original_payload_size
;
1721 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1726 case LTTCOMM_SESSIOND_COMMAND_SET_CONSUMER_URI
:
1729 struct lttng_uri
*uris
;
1731 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1732 len
= nb_uri
* sizeof(struct lttng_uri
);
1735 ret
= LTTNG_ERR_INVALID
;
1739 uris
= calloc
<lttng_uri
>(nb_uri
);
1740 if (uris
== nullptr) {
1741 ret
= LTTNG_ERR_FATAL
;
1745 /* Receive variable len data */
1746 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1747 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1749 DBG("No URIs received from client... continuing");
1751 ret
= LTTNG_ERR_SESSION_FAIL
;
1756 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1758 if (ret
!= LTTNG_OK
) {
1764 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1767 * On the first start, if we have a kernel session and we have
1768 * enabled time or size-based rotations, we have to make sure
1769 * the kernel tracer supports it.
1771 if (!cmd_ctx
->session
->has_been_started
&& cmd_ctx
->session
->kernel_session
&&
1772 (cmd_ctx
->session
->rotate_timer_period
|| cmd_ctx
->session
->rotate_size
) &&
1773 !check_rotate_compatible()) {
1774 DBG("Kernel tracer version is not compatible with the rotation feature");
1775 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1778 ret
= cmd_start_trace(cmd_ctx
->session
);
1781 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1783 ret
= cmd_stop_trace(cmd_ctx
->session
);
1786 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1788 ret
= cmd_destroy_session(cmd_ctx
->session
, sock
);
1791 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1794 struct lttng_domain
*domains
= nullptr;
1796 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1798 /* Return value is a negative lttng_error_code. */
1803 ret
= setup_lttng_msg_no_cmd_header(
1804 cmd_ctx
, domains
, nb_dom
* sizeof(struct lttng_domain
));
1814 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1816 enum lttng_error_code ret_code
;
1817 size_t original_payload_size
;
1818 size_t payload_size
;
1819 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1821 ret
= setup_empty_lttng_msg(cmd_ctx
);
1823 ret
= LTTNG_ERR_NOMEM
;
1827 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1829 ret_code
= cmd_list_channels(
1830 cmd_ctx
->lsm
.domain
.type
, cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1831 if (ret_code
!= LTTNG_OK
) {
1832 ret
= (int) ret_code
;
1836 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1837 original_payload_size
;
1838 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1843 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1845 enum lttng_error_code ret_code
;
1846 size_t original_payload_size
;
1847 size_t payload_size
;
1848 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1850 ret
= setup_empty_lttng_msg(cmd_ctx
);
1852 ret
= LTTNG_ERR_NOMEM
;
1856 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1858 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1860 cmd_ctx
->lsm
.u
.list
.channel_name
,
1861 &cmd_ctx
->reply_payload
);
1862 if (ret_code
!= LTTNG_OK
) {
1863 ret
= (int) ret_code
;
1867 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1868 original_payload_size
;
1869 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1874 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1876 unsigned int nr_sessions
;
1877 lttng_session
*sessions_payload
= nullptr;
1878 size_t payload_len
= 0;
1880 session_lock_list();
1881 nr_sessions
= lttng_sessions_count(LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1882 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1884 if (nr_sessions
> 0) {
1885 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1886 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1887 sessions_payload
= zmalloc
<lttng_session
>(payload_len
);
1888 if (!sessions_payload
) {
1889 session_unlock_list();
1894 cmd_list_lttng_sessions(sessions_payload
,
1896 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1897 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1900 session_unlock_list();
1902 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
, payload_len
);
1903 free(sessions_payload
);
1912 case LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
:
1914 struct consumer_data
*cdata
;
1916 switch (cmd_ctx
->lsm
.domain
.type
) {
1917 case LTTNG_DOMAIN_KERNEL
:
1918 cdata
= &the_kconsumer_data
;
1921 ret
= LTTNG_ERR_UND
;
1925 ret
= cmd_register_consumer(
1926 cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
, cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1929 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1932 uint8_t pending_ret_byte
;
1934 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1939 * This function may returns 0 or 1 to indicate whether or not
1940 * there is data pending. In case of error, it should return an
1941 * LTTNG_ERR code. However, some code paths may still return
1942 * a nondescript error code, which we handle by returning an
1945 if (pending_ret
== 0 || pending_ret
== 1) {
1947 * ret will be set to LTTNG_OK at the end of
1950 } else if (pending_ret
< 0) {
1951 ret
= LTTNG_ERR_UNK
;
1958 pending_ret_byte
= (uint8_t) pending_ret
;
1960 /* 1 byte to return whether or not data is pending */
1961 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &pending_ret_byte
, 1);
1970 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1972 uint32_t snapshot_id
;
1973 struct lttcomm_lttng_output_id reply
;
1974 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1976 ret
= cmd_snapshot_add_output(cmd_ctx
->session
, &output
, &snapshot_id
);
1977 if (ret
!= LTTNG_OK
) {
1980 reply
.id
= snapshot_id
;
1982 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
, sizeof(reply
));
1987 /* Copy output list into message payload */
1991 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1993 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1994 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
1997 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
2000 struct lttng_snapshot_output
*outputs
= nullptr;
2002 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2003 if (nb_output
< 0) {
2008 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2009 ret
= setup_lttng_msg_no_cmd_header(
2010 cmd_ctx
, outputs
, nb_output
* sizeof(struct lttng_snapshot_output
));
2020 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
2022 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2023 ret
= cmd_snapshot_record(cmd_ctx
->session
, &output
, 0); // RFC: set to zero since
2025 // cmd_snapshot_record
2028 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
2030 struct lttng_dynamic_buffer payload
;
2031 struct lttng_session_descriptor
*return_descriptor
= nullptr;
2033 lttng_dynamic_buffer_init(&payload
);
2034 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2035 if (ret
!= LTTNG_OK
) {
2039 ret
= lttng_session_descriptor_serialize(return_descriptor
, &payload
);
2041 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2042 lttng_session_descriptor_destroy(return_descriptor
);
2043 ret
= LTTNG_ERR_NOMEM
;
2046 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
, payload
.size
);
2048 lttng_session_descriptor_destroy(return_descriptor
);
2049 ret
= LTTNG_ERR_NOMEM
;
2052 lttng_dynamic_buffer_reset(&payload
);
2053 lttng_session_descriptor_destroy(return_descriptor
);
2057 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
2059 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
, &cmd_ctx
->creds
);
2062 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
2064 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2065 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2068 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
2070 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2073 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
2075 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2078 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
2080 struct lttng_trigger
*payload_trigger
;
2081 struct lttng_trigger
*return_trigger
;
2082 size_t original_reply_payload_size
;
2083 size_t reply_payload_size
;
2084 const struct lttng_credentials cmd_creds
= {
2085 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2086 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2089 ret
= setup_empty_lttng_msg(cmd_ctx
);
2091 ret
= LTTNG_ERR_NOMEM
;
2095 ret
= receive_lttng_trigger(cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2096 if (ret
!= LTTNG_OK
) {
2100 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2102 ret
= cmd_register_trigger(&cmd_creds
,
2104 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2105 the_notification_thread_handle
,
2107 if (ret
!= LTTNG_OK
) {
2108 lttng_trigger_put(payload_trigger
);
2112 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2113 lttng_trigger_put(payload_trigger
);
2114 lttng_trigger_put(return_trigger
);
2116 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2117 ret
= LTTNG_ERR_NOMEM
;
2121 reply_payload_size
=
2122 cmd_ctx
->reply_payload
.buffer
.size
- original_reply_payload_size
;
2124 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2129 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
2131 struct lttng_trigger
*payload_trigger
;
2132 const struct lttng_credentials cmd_creds
= {
2133 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2134 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2137 ret
= receive_lttng_trigger(cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2138 if (ret
!= LTTNG_OK
) {
2142 ret
= cmd_unregister_trigger(
2143 &cmd_creds
, payload_trigger
, the_notification_thread_handle
);
2144 lttng_trigger_put(payload_trigger
);
2147 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
2149 struct lttng_rotate_session_return rotate_return
;
2151 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2153 memset(&rotate_return
, 0, sizeof(rotate_return
));
2154 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2155 DBG("Kernel tracer version is not compatible with the rotation feature");
2156 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2160 ret
= cmd_rotate_session(cmd_ctx
->session
,
2163 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2169 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
, sizeof(rotate_return
));
2178 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
2180 struct lttng_rotation_get_info_return get_info_return
;
2182 memset(&get_info_return
, 0, sizeof(get_info_return
));
2183 ret
= cmd_rotate_get_info(cmd_ctx
->session
,
2185 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2191 ret
= setup_lttng_msg_no_cmd_header(
2192 cmd_ctx
, &get_info_return
, sizeof(get_info_return
));
2201 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
2204 enum lttng_rotation_schedule_type schedule_type
;
2207 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2208 DBG("Kernel tracer version does not support session rotations");
2209 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2213 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2214 schedule_type
= (enum lttng_rotation_schedule_type
)
2215 cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2216 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2218 ret
= cmd_rotation_set_schedule(
2219 cmd_ctx
->session
, set_schedule
, schedule_type
, value
);
2220 if (ret
!= LTTNG_OK
) {
2226 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
2228 lttng_session_list_schedules_return schedules
;
2230 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2231 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2232 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2233 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2235 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
, sizeof(schedules
));
2244 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
2246 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2249 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
2251 struct lttng_triggers
*return_triggers
= nullptr;
2252 size_t original_payload_size
;
2253 size_t payload_size
;
2255 ret
= setup_empty_lttng_msg(cmd_ctx
);
2257 ret
= LTTNG_ERR_NOMEM
;
2261 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2263 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
, &return_triggers
);
2264 if (ret
!= LTTNG_OK
) {
2268 LTTNG_ASSERT(return_triggers
);
2269 ret
= lttng_triggers_serialize(return_triggers
, &cmd_ctx
->reply_payload
);
2270 lttng_triggers_destroy(return_triggers
);
2272 ERR("Failed to serialize triggers in reply to `list triggers` command");
2273 ret
= LTTNG_ERR_NOMEM
;
2277 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- original_payload_size
;
2279 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2284 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
2286 struct lttng_error_query
*query
;
2287 const struct lttng_credentials cmd_creds
= {
2288 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2289 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2291 struct lttng_error_query_results
*results
= nullptr;
2292 size_t original_payload_size
;
2293 size_t payload_size
;
2295 ret
= setup_empty_lttng_msg(cmd_ctx
);
2297 ret
= LTTNG_ERR_NOMEM
;
2301 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2303 ret
= receive_lttng_error_query(cmd_ctx
, *sock
, sock_error
, &query
);
2304 if (ret
!= LTTNG_OK
) {
2308 ret
= cmd_execute_error_query(
2309 &cmd_creds
, query
, &results
, the_notification_thread_handle
);
2310 lttng_error_query_destroy(query
);
2311 if (ret
!= LTTNG_OK
) {
2315 LTTNG_ASSERT(results
);
2316 ret
= lttng_error_query_results_serialize(results
, &cmd_ctx
->reply_payload
);
2317 lttng_error_query_results_destroy(results
);
2319 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2320 ret
= LTTNG_ERR_NOMEM
;
2324 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- original_payload_size
;
2326 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2333 ret
= LTTNG_ERR_UND
;
2338 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2339 DBG("Missing llm header, creating one.");
2340 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, nullptr, 0) < 0) {
2344 /* Set return code */
2345 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2347 if (cmd_ctx
->session
) {
2348 session_unlock(cmd_ctx
->session
);
2349 session_put(cmd_ctx
->session
);
2350 cmd_ctx
->session
= nullptr;
2352 if (need_tracing_session
) {
2353 session_unlock_list();
2356 LTTNG_ASSERT(!rcu_read_ongoing());
2360 static int create_client_sock()
2362 int ret
, client_sock
;
2364 /* Create client tool unix socket */
2365 client_sock
= lttcomm_create_unix_sock(the_config
.client_unix_sock_path
.value
);
2366 if (client_sock
< 0) {
2367 ERR("Create unix sock failed: %s", the_config
.client_unix_sock_path
.value
);
2372 /* Set the cloexec flag */
2373 ret
= utils_set_fd_cloexec(client_sock
);
2375 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2376 "Continuing but note that the consumer daemon will have a "
2377 "reference to this socket on exec()",
2381 /* File permission MUST be 660 */
2382 ret
= chmod(the_config
.client_unix_sock_path
.value
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2384 ERR("Set file permissions failed: %s", the_config
.client_unix_sock_path
.value
);
2386 (void) lttcomm_close_unix_sock(client_sock
);
2390 DBG("Created client socket (fd = %i)", client_sock
);
2396 static void cleanup_client_thread(void *data
)
2398 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2400 lttng_pipe_destroy(quit_pipe
);
2403 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2405 set_thread_status(false);
2409 * This thread manage all clients request using the unix client socket for
2412 static void *thread_manage_clients(void *data
)
2414 int sock
= -1, ret
, i
, err
= -1;
2417 struct lttng_poll_event events
;
2418 const int client_sock
= thread_state
.client_sock
;
2419 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2420 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2421 struct command_ctx cmd_ctx
= {};
2423 DBG("[thread] Manage client started");
2425 lttng_payload_init(&cmd_ctx
.reply_payload
);
2427 is_root
= (getuid() == 0);
2429 pthread_cleanup_push(thread_init_cleanup
, nullptr);
2431 rcu_register_thread();
2433 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2435 health_code_update();
2437 ret
= lttcomm_listen_unix_sock(client_sock
);
2443 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2444 * more will be added to this poll set.
2446 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2448 goto error_create_poll
;
2451 /* Add the application registration socket */
2452 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2457 /* Add thread quit pipe */
2458 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
);
2463 /* Set state as running. */
2464 set_thread_status(true);
2465 pthread_cleanup_pop(0);
2467 /* This testpoint is after we signal readiness to the parent. */
2468 if (testpoint(sessiond_thread_manage_clients
)) {
2472 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2476 health_code_update();
2479 const struct cmd_completion_handler
*cmd_completion_handler
;
2481 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2482 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2483 cmd_ctx
.creds
.pid
= 0;
2484 cmd_ctx
.session
= nullptr;
2485 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2486 cmd_ctx
.lttng_msg_size
= 0;
2488 DBG("Accepting client command ...");
2490 /* Inifinite blocking call, waiting for transmission */
2492 health_poll_entry();
2493 ret
= lttng_poll_wait(&events
, -1);
2497 * Restart interrupted system call.
2499 if (errno
== EINTR
) {
2507 for (i
= 0; i
< nb_fd
; i
++) {
2508 /* Fetch once the poll data. */
2509 const auto revents
= LTTNG_POLL_GETEV(&events
, i
);
2510 const auto pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2512 health_code_update();
2514 /* Activity on thread quit pipe, exiting. */
2515 if (pollfd
== thread_quit_pipe_fd
) {
2516 DBG("Activity on thread quit pipe");
2521 /* Event on the registration socket */
2522 if (revents
& LPOLLIN
) {
2524 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2525 ERR("Client socket poll error");
2528 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2533 DBG("Wait for client response");
2535 health_code_update();
2537 sock
= lttcomm_accept_unix_sock(client_sock
);
2543 * Set the CLOEXEC flag. Return code is useless because either way, the
2546 (void) utils_set_fd_cloexec(sock
);
2548 /* Set socket option for credentials retrieval */
2549 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2554 health_code_update();
2557 * Data is received from the lttng client. The struct
2558 * lttcomm_session_msg (lsm) contains the command and data request of
2561 DBG("Receiving data from client ...");
2562 ret
= lttcomm_recv_creds_unix_sock(
2563 sock
, &cmd_ctx
.lsm
, sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2564 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2565 DBG("Incomplete recv() from client... continuing");
2574 health_code_update();
2576 // TODO: Validate cmd_ctx including sanity check for
2577 // security purpose.
2579 rcu_thread_online();
2581 * This function dispatch the work to the kernel or userspace tracer
2582 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2583 * informations for the client. The command context struct contains
2584 * everything this function may needs.
2586 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2587 rcu_thread_offline();
2597 * TODO: Inform client somehow of the fatal error. At
2598 * this point, ret < 0 means that a zmalloc failed
2599 * (ENOMEM). Error detected but still accept
2600 * command, unless a socket error has been
2606 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2607 WARN("Command returned an invalid status code, returning unknown error: "
2608 "command type = %s (%d), ret = %d",
2609 lttcomm_sessiond_command_str(
2610 (lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2611 cmd_ctx
.lsm
.cmd_type
,
2613 ret
= LTTNG_ERR_UNK
;
2616 cmd_completion_handler
= cmd_pop_completion_handler();
2617 if (cmd_completion_handler
) {
2618 enum lttng_error_code completion_code
;
2620 completion_code
= cmd_completion_handler
->run(cmd_completion_handler
->data
);
2621 if (completion_code
!= LTTNG_OK
) {
2626 health_code_update();
2629 struct lttng_payload_view view
=
2630 lttng_payload_view_from_payload(&cmd_ctx
.reply_payload
, 0, -1);
2631 struct lttcomm_lttng_msg
*llm
=
2632 (typeof(llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2634 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2635 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2637 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2639 DBG("Sending response (size: %d, retcode: %s (%d))",
2640 cmd_ctx
.lttng_msg_size
,
2641 lttng_strerror(-llm
->ret_code
),
2643 ret
= send_unix_sock(sock
, &view
);
2645 ERR("Failed to send data back to client");
2648 /* End of transmission */
2656 health_code_update();
2668 lttng_poll_clean(&events
);
2672 unlink(the_config
.client_unix_sock_path
.value
);
2673 ret
= close(client_sock
);
2680 ERR("Health error occurred in %s", __func__
);
2683 health_unregister(the_health_sessiond
);
2685 DBG("Client thread dying");
2686 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2687 rcu_unregister_thread();
2691 static bool shutdown_client_thread(void *thread_data
)
2693 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2694 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2696 return notify_thread_pipe(write_fd
) == 1;
2699 struct lttng_thread
*launch_client_thread()
2701 bool thread_running
;
2702 struct lttng_pipe
*client_quit_pipe
;
2703 struct lttng_thread
*thread
= nullptr;
2704 int client_sock_fd
= -1;
2706 sem_init(&thread_state
.ready
, 0, 0);
2707 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2708 if (!client_quit_pipe
) {
2712 client_sock_fd
= create_client_sock();
2713 if (client_sock_fd
< 0) {
2717 thread_state
.client_sock
= client_sock_fd
;
2718 thread
= lttng_thread_create("Client management",
2719 thread_manage_clients
,
2720 shutdown_client_thread
,
2721 cleanup_client_thread
,
2726 /* The client thread now owns the client sock fd and the quit pipe. */
2727 client_sock_fd
= -1;
2728 client_quit_pipe
= nullptr;
2731 * This thread is part of the threads that need to be fully
2732 * initialized before the session daemon is marked as "ready".
2734 thread_running
= wait_thread_status();
2735 if (!thread_running
) {
2740 if (client_sock_fd
>= 0) {
2741 if (close(client_sock_fd
)) {
2742 PERROR("Failed to close client socket");
2745 lttng_thread_put(thread
);
2746 cleanup_client_thread(client_quit_pipe
);