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/exception.hpp>
34 #include <common/tracker.hpp>
35 #include <common/unix.hpp>
36 #include <common/utils.hpp>
38 #include <lttng/error-query-internal.hpp>
39 #include <lttng/event-internal.hpp>
40 #include <lttng/session-descriptor-internal.hpp>
41 #include <lttng/session-internal.hpp>
42 #include <lttng/userspace-probe-internal.hpp>
62 static void set_thread_status(bool running
)
64 DBG("Marking client thread's state as %s", running
? "running" : "error");
65 thread_state
.running
= running
;
66 sem_post(&thread_state
.ready
);
69 static bool wait_thread_status()
71 DBG("Waiting for client thread to be ready");
72 sem_wait(&thread_state
.ready
);
73 if (thread_state
.running
) {
74 DBG("Client thread is ready");
76 ERR("Initialization of client thread failed");
79 return thread_state
.running
;
83 * Setup the outgoing data buffer for the response (llm) by allocating the
84 * right amount of memory and copying the original information from the lsm
87 * Return 0 on success, negative value on error.
89 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
90 const void *payload_buf
,
92 const void *cmd_header_buf
,
93 size_t cmd_header_len
)
96 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
97 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
98 lttcomm_lttng_msg llm
{};
100 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
101 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
102 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
103 llm
.data_size
= (uint32_t) payload_len
;
105 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
110 lttng_dynamic_pointer_array_clear(&cmd_ctx
->reply_payload
._fd_handles
);
112 cmd_ctx
->lttng_msg_size
= total_msg_size
;
114 /* Append reply header. */
115 ret
= lttng_dynamic_buffer_append(&cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
120 /* Append command header. */
121 if (cmd_header_len
) {
122 ret
= lttng_dynamic_buffer_append(
123 &cmd_ctx
->reply_payload
.buffer
, cmd_header_buf
, cmd_header_len
);
129 /* Append payload. */
131 ret
= lttng_dynamic_buffer_append(
132 &cmd_ctx
->reply_payload
.buffer
, payload_buf
, payload_len
);
142 static int setup_empty_lttng_msg(struct command_ctx
*cmd_ctx
)
145 const struct lttcomm_lttng_msg llm
= {};
147 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
152 /* Append place-holder reply header. */
153 ret
= lttng_dynamic_buffer_append(&cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
158 cmd_ctx
->lttng_msg_size
= sizeof(llm
);
163 static void update_lttng_msg(struct command_ctx
*cmd_ctx
, size_t cmd_header_len
, size_t payload_len
)
165 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
166 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
167 struct lttcomm_lttng_msg
*p_llm
;
168 lttcomm_lttng_msg llm
{};
170 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
171 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
172 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
173 llm
.data_size
= (uint32_t) payload_len
;
175 LTTNG_ASSERT(cmd_ctx
->reply_payload
.buffer
.size
>= sizeof(llm
));
177 p_llm
= (typeof(p_llm
)) cmd_ctx
->reply_payload
.buffer
.data
;
179 /* Update existing header. */
180 memcpy(p_llm
, &llm
, sizeof(llm
));
182 cmd_ctx
->lttng_msg_size
= total_msg_size
;
186 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
187 * exec or it will fail.
189 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
191 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
195 * Fork and exec a consumer daemon (consumerd).
197 * Return pid if successful else -1.
199 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
203 const char *consumer_to_use
;
204 const char *verbosity
;
207 DBG("Spawning consumerd");
214 if (the_config
.verbose_consumer
) {
215 verbosity
= "--verbose";
216 } else if (lttng_opt_quiet
) {
217 verbosity
= "--quiet";
222 switch (consumer_data
->type
) {
223 case LTTNG_CONSUMER_KERNEL
:
225 * Find out which consumerd to execute. We will first try the
226 * 64-bit path, then the sessiond's installation directory, and
227 * fallback on the 32-bit one,
229 DBG3("Looking for a kernel consumer at these locations:");
230 DBG3(" 1) %s", the_config
.consumerd64_bin_path
.value
?: "NULL");
231 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
232 DBG3(" 3) %s", the_config
.consumerd32_bin_path
.value
?: "NULL");
233 if (stat(the_config
.consumerd64_bin_path
.value
, &st
) == 0) {
234 DBG3("Found location #1");
235 consumer_to_use
= the_config
.consumerd64_bin_path
.value
;
236 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
237 DBG3("Found location #2");
238 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
239 } else if (the_config
.consumerd32_bin_path
.value
&&
240 stat(the_config
.consumerd32_bin_path
.value
, &st
) == 0) {
241 DBG3("Found location #3");
242 consumer_to_use
= the_config
.consumerd32_bin_path
.value
;
244 DBG("Could not find any valid consumerd executable");
248 DBG("Using kernel consumer at: %s", consumer_to_use
);
249 (void) execl(consumer_to_use
,
253 "--consumerd-cmd-sock",
254 consumer_data
->cmd_unix_sock_path
,
255 "--consumerd-err-sock",
256 consumer_data
->err_unix_sock_path
,
258 the_config
.tracing_group_name
.value
,
261 case LTTNG_CONSUMER64_UST
:
263 if (the_config
.consumerd64_lib_dir
.value
) {
268 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
272 tmplen
= strlen(the_config
.consumerd64_lib_dir
.value
) + 1 /* : */ +
274 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
279 strcat(tmpnew
, the_config
.consumerd64_lib_dir
.value
);
280 if (tmp
[0] != '\0') {
284 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
291 DBG("Using 64-bit UST consumer at: %s",
292 the_config
.consumerd64_bin_path
.value
);
293 (void) execl(the_config
.consumerd64_bin_path
.value
,
297 "--consumerd-cmd-sock",
298 consumer_data
->cmd_unix_sock_path
,
299 "--consumerd-err-sock",
300 consumer_data
->err_unix_sock_path
,
302 the_config
.tracing_group_name
.value
,
306 case LTTNG_CONSUMER32_UST
:
308 if (the_config
.consumerd32_lib_dir
.value
) {
313 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
317 tmplen
= strlen(the_config
.consumerd32_lib_dir
.value
) + 1 /* : */ +
319 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
324 strcat(tmpnew
, the_config
.consumerd32_lib_dir
.value
);
325 if (tmp
[0] != '\0') {
329 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
336 DBG("Using 32-bit UST consumer at: %s",
337 the_config
.consumerd32_bin_path
.value
);
338 (void) execl(the_config
.consumerd32_bin_path
.value
,
342 "--consumerd-cmd-sock",
343 consumer_data
->cmd_unix_sock_path
,
344 "--consumerd-err-sock",
345 consumer_data
->err_unix_sock_path
,
347 the_config
.tracing_group_name
.value
,
352 ERR("unknown consumer type");
356 PERROR("Consumer execl()");
358 /* Reaching this point, we got a failure on our execl(). */
360 } else if (pid
> 0) {
363 PERROR("start consumer fork");
371 * Spawn the consumerd daemon and session daemon thread.
373 static int start_consumerd(struct consumer_data
*consumer_data
)
378 * Set the listen() state on the socket since there is a possible race
379 * between the exec() of the consumer daemon and this call if place in the
380 * consumer thread. See bug #366 for more details.
382 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
387 pthread_mutex_lock(&consumer_data
->pid_mutex
);
388 if (consumer_data
->pid
!= 0) {
389 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
393 ret
= spawn_consumerd(consumer_data
);
395 ERR("Spawning consumerd failed");
396 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
400 /* Setting up the consumer_data pid */
401 consumer_data
->pid
= ret
;
402 DBG2("Consumer pid %d", consumer_data
->pid
);
403 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
405 DBG2("Spawning consumer control thread");
406 ret
= spawn_consumer_thread(consumer_data
);
408 ERR("Fatal error spawning consumer control thread");
416 /* Cleanup already created sockets on error. */
417 if (consumer_data
->err_sock
>= 0) {
420 err
= close(consumer_data
->err_sock
);
422 PERROR("close consumer data error socket");
429 * Copy consumer output from the tracing session to the domain session. The
430 * function also applies the right modification on a per domain basis for the
431 * trace files destination directory.
433 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
436 const char *dir_name
;
437 struct consumer_output
*consumer
;
439 LTTNG_ASSERT(session
);
440 LTTNG_ASSERT(session
->consumer
);
443 case LTTNG_DOMAIN_KERNEL
:
444 DBG3("Copying tracing session consumer output in kernel session");
446 * XXX: We should audit the session creation and what this function
447 * does "extra" in order to avoid a destroy since this function is used
448 * in the domain session creation (kernel and ust) only. Same for UST
451 if (session
->kernel_session
->consumer
) {
452 consumer_output_put(session
->kernel_session
->consumer
);
454 session
->kernel_session
->consumer
= consumer_copy_output(session
->consumer
);
455 /* Ease our life a bit for the next part */
456 consumer
= session
->kernel_session
->consumer
;
457 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
459 case LTTNG_DOMAIN_JUL
:
460 case LTTNG_DOMAIN_LOG4J
:
461 case LTTNG_DOMAIN_PYTHON
:
462 case LTTNG_DOMAIN_UST
:
463 DBG3("Copying tracing session consumer output in UST session");
464 if (session
->ust_session
->consumer
) {
465 consumer_output_put(session
->ust_session
->consumer
);
467 session
->ust_session
->consumer
= consumer_copy_output(session
->consumer
);
468 /* Ease our life a bit for the next part */
469 consumer
= session
->ust_session
->consumer
;
470 dir_name
= DEFAULT_UST_TRACE_DIR
;
473 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
477 /* Append correct directory to subdir */
478 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
, sizeof(consumer
->domain_subdir
));
483 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
491 * Create an UST session and add it to the session ust list.
493 static int create_ust_session(struct ltt_session
*session
, const struct lttng_domain
*domain
)
496 struct ltt_ust_session
*lus
= nullptr;
498 LTTNG_ASSERT(session
);
499 LTTNG_ASSERT(domain
);
500 LTTNG_ASSERT(session
->consumer
);
502 switch (domain
->type
) {
503 case LTTNG_DOMAIN_JUL
:
504 case LTTNG_DOMAIN_LOG4J
:
505 case LTTNG_DOMAIN_PYTHON
:
506 case LTTNG_DOMAIN_UST
:
509 ERR("Unknown UST domain on create session %d", domain
->type
);
510 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
514 DBG("Creating UST session");
516 lus
= trace_ust_create_session(session
->id
);
517 if (lus
== nullptr) {
518 ret
= LTTNG_ERR_UST_SESS_FAIL
;
522 lus
->uid
= session
->uid
;
523 lus
->gid
= session
->gid
;
524 lus
->output_traces
= session
->output_traces
;
525 lus
->snapshot_mode
= session
->snapshot_mode
;
526 lus
->live_timer_interval
= session
->live_timer
;
527 session
->ust_session
= lus
;
528 if (session
->shm_path
[0]) {
529 strncpy(lus
->root_shm_path
, session
->shm_path
, sizeof(lus
->root_shm_path
));
530 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
531 strncpy(lus
->shm_path
, session
->shm_path
, sizeof(lus
->shm_path
));
532 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
533 strncat(lus
->shm_path
, "/ust", sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
535 /* Copy session output to the newly created UST session */
536 ret
= copy_session_consumer(domain
->type
, session
);
537 if (ret
!= LTTNG_OK
) {
545 session
->ust_session
= nullptr;
550 * Create a kernel tracer session then create the default channel.
552 static int create_kernel_session(struct ltt_session
*session
)
556 DBG("Creating kernel session");
558 ret
= kernel_create_session(session
);
560 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
564 /* Code flow safety */
565 LTTNG_ASSERT(session
->kernel_session
);
567 /* Copy session output to the newly created Kernel session */
568 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
569 if (ret
!= LTTNG_OK
) {
573 session
->kernel_session
->uid
= session
->uid
;
574 session
->kernel_session
->gid
= session
->gid
;
575 session
->kernel_session
->output_traces
= session
->output_traces
;
576 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
577 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
582 trace_kernel_destroy_session(session
->kernel_session
);
583 session
->kernel_session
= nullptr;
589 * Count number of session permitted by uid/gid.
591 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
__attribute__((unused
)))
594 struct ltt_session
*session
;
595 const struct ltt_session_list
*session_list
= session_get_list();
597 DBG("Counting number of available session for UID %d", uid
);
598 cds_list_for_each_entry (session
, &session_list
->head
, list
) {
599 if (!session_get(session
)) {
602 session_lock(session
);
603 /* Only count the sessions the user can control. */
604 if (session_access_ok(session
, uid
) && !session
->destroyed
) {
607 session_unlock(session
);
608 session_put(session
);
613 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
616 struct lttng_trigger
**_trigger
)
620 ssize_t sock_recv_len
;
621 enum lttng_error_code ret_code
;
622 struct lttng_payload trigger_payload
;
623 struct lttng_trigger
*trigger
= nullptr;
625 lttng_payload_init(&trigger_payload
);
626 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
627 ret
= lttng_dynamic_buffer_set_size(&trigger_payload
.buffer
, trigger_len
);
629 ret_code
= LTTNG_ERR_NOMEM
;
633 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_payload
.buffer
.data
, trigger_len
);
634 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
635 ERR("Failed to receive trigger in command payload");
637 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
641 /* Receive fds, if any. */
642 if (cmd_ctx
->lsm
.fd_count
> 0) {
643 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
644 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
645 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
646 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
647 cmd_ctx
->lsm
.fd_count
,
649 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
652 } else if (sock_recv_len
<= 0) {
653 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
654 cmd_ctx
->lsm
.fd_count
,
656 ret_code
= LTTNG_ERR_FATAL
;
662 /* Deserialize trigger. */
664 struct lttng_payload_view view
=
665 lttng_payload_view_from_payload(&trigger_payload
, 0, -1);
667 if (lttng_trigger_create_from_payload(&view
, &trigger
) != trigger_len
) {
668 ERR("Invalid trigger received as part of command payload");
669 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
670 lttng_trigger_put(trigger
);
679 lttng_payload_reset(&trigger_payload
);
683 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
686 struct lttng_error_query
**_query
)
690 ssize_t sock_recv_len
;
691 enum lttng_error_code ret_code
;
692 struct lttng_payload query_payload
;
693 struct lttng_error_query
*query
= nullptr;
695 lttng_payload_init(&query_payload
);
696 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
697 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
699 ret_code
= LTTNG_ERR_NOMEM
;
703 sock_recv_len
= lttcomm_recv_unix_sock(sock
, query_payload
.buffer
.data
, query_len
);
704 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
705 ERR("Failed to receive error query in command payload");
707 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
711 /* Receive fds, if any. */
712 if (cmd_ctx
->lsm
.fd_count
> 0) {
713 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
714 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
715 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
716 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
717 cmd_ctx
->lsm
.fd_count
,
719 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
722 } else if (sock_recv_len
<= 0) {
723 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
724 cmd_ctx
->lsm
.fd_count
,
726 ret_code
= LTTNG_ERR_FATAL
;
732 /* Deserialize error query. */
734 struct lttng_payload_view view
=
735 lttng_payload_view_from_payload(&query_payload
, 0, -1);
737 if (lttng_error_query_create_from_payload(&view
, &query
) != query_len
) {
738 ERR("Invalid error query received as part of command payload");
739 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
748 lttng_payload_reset(&query_payload
);
752 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
755 struct lttng_event
**out_event
,
756 char **out_filter_expression
,
757 struct lttng_bytecode
**out_bytecode
,
758 struct lttng_event_exclusion
**out_exclusion
)
762 ssize_t sock_recv_len
;
763 enum lttng_error_code ret_code
;
764 struct lttng_payload event_payload
;
765 struct lttng_event
*local_event
= nullptr;
766 char *local_filter_expression
= nullptr;
767 struct lttng_bytecode
*local_bytecode
= nullptr;
768 struct lttng_event_exclusion
*local_exclusion
= nullptr;
770 lttng_payload_init(&event_payload
);
771 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
) {
772 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
773 } else if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
) {
774 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
779 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
781 ret_code
= LTTNG_ERR_NOMEM
;
785 sock_recv_len
= lttcomm_recv_unix_sock(sock
, event_payload
.buffer
.data
, event_len
);
786 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
787 ERR("Failed to receive event in command payload");
789 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
793 /* Receive fds, if any. */
794 if (cmd_ctx
->lsm
.fd_count
> 0) {
795 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
796 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
797 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
798 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
799 cmd_ctx
->lsm
.fd_count
,
801 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
804 } else if (sock_recv_len
<= 0) {
805 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
806 cmd_ctx
->lsm
.fd_count
,
808 ret_code
= LTTNG_ERR_FATAL
;
814 /* Deserialize event. */
817 struct lttng_payload_view event_view
=
818 lttng_payload_view_from_payload(&event_payload
, 0, -1);
820 len
= lttng_event_create_from_payload(&event_view
,
823 &local_filter_expression
,
827 ERR("Failed to create an event from the received buffer");
828 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
832 if (len
!= event_len
) {
833 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
834 ", payload length = %zd",
837 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
842 *out_event
= local_event
;
843 *out_exclusion
= local_exclusion
;
844 *out_filter_expression
= local_filter_expression
;
845 *out_bytecode
= local_bytecode
;
846 local_event
= nullptr;
847 local_exclusion
= nullptr;
848 local_filter_expression
= nullptr;
849 local_bytecode
= nullptr;
854 lttng_payload_reset(&event_payload
);
855 lttng_event_destroy(local_event
);
856 free(local_filter_expression
);
857 free(local_bytecode
);
858 free(local_exclusion
);
862 static enum lttng_error_code
863 receive_lttng_event_context(const struct command_ctx
*cmd_ctx
,
866 struct lttng_event_context
**out_event_context
)
869 const size_t event_context_len
= (size_t) cmd_ctx
->lsm
.u
.context
.length
;
870 ssize_t sock_recv_len
;
871 enum lttng_error_code ret_code
;
872 struct lttng_payload event_context_payload
;
873 struct lttng_event_context
*context
= nullptr;
875 lttng_payload_init(&event_context_payload
);
877 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
, event_context_len
);
879 ret_code
= LTTNG_ERR_NOMEM
;
884 lttcomm_recv_unix_sock(sock
, event_context_payload
.buffer
.data
, event_context_len
);
885 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
886 ERR("Failed to receive event context in command payload");
888 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
892 /* Deserialize event. */
895 struct lttng_payload_view event_context_view
=
896 lttng_payload_view_from_payload(&event_context_payload
, 0, -1);
898 len
= lttng_event_context_create_from_payload(&event_context_view
, &context
);
901 ERR("Failed to create a event context from the received buffer");
902 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
906 if (len
!= event_context_len
) {
907 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd",
910 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
915 *out_event_context
= context
;
920 lttng_event_context_destroy(context
);
921 lttng_payload_reset(&event_context_payload
);
926 * Version of setup_lttng_msg() without command header.
929 setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
, void *payload_buf
, size_t payload_len
)
931 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, nullptr, 0);
935 * Check if the current kernel tracer supports the session rotation feature.
936 * Return 1 if it does, 0 otherwise.
938 static int check_rotate_compatible()
942 if (the_kernel_tracer_version
.major
!= 2 || the_kernel_tracer_version
.minor
< 11) {
943 DBG("Kernel tracer version is not compatible with the rotation feature");
951 * Send data on a unix socket using the liblttsessiondcomm API.
953 * Return lttcomm error code.
955 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
958 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
960 /* Check valid length */
961 if (view
->buffer
.size
== 0) {
966 ret
= lttcomm_send_unix_sock(sock
, view
->buffer
.data
, view
->buffer
.size
);
972 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
983 * Process the command requested by the lttng client within the command
984 * context structure. This function make sure that the return structure (llm)
985 * is set and ready for transmission before returning.
987 * Return any error encountered or 0 for success.
989 * "sock" is only used for special-case var. len data.
990 * A command may assume the ownership of the socket, in which case its value
991 * should be set to -1.
993 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
, int *sock_error
)
996 bool need_tracing_session
= true;
1000 if (!lttcomm_sessiond_command_is_valid((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
)) {
1001 ERR("Unknown client command received: command id = %" PRIu32
,
1002 cmd_ctx
->lsm
.cmd_type
);
1003 ret
= LTTNG_ERR_UND
;
1007 DBG("Processing client command '%s\' (%d)",
1008 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
1009 cmd_ctx
->lsm
.cmd_type
);
1013 switch (cmd_ctx
->lsm
.cmd_type
) {
1014 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1015 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1016 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1017 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1018 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1019 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1020 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1021 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1022 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1023 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
1024 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
1025 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1026 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
1027 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
1028 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
1029 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1030 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1031 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
1032 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1033 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
1034 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1035 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1036 need_domain
= false;
1042 /* Needs a functioning consumerd? */
1043 switch (cmd_ctx
->lsm
.cmd_type
) {
1044 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1045 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1046 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1047 need_consumerd
= false;
1050 need_consumerd
= true;
1054 if (the_config
.no_kernel
&& need_domain
&&
1055 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1057 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1059 ret
= LTTNG_ERR_KERN_NA
;
1064 /* Deny register consumer if we already have a spawned consumer. */
1065 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1066 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1067 if (the_kconsumer_data
.pid
> 0) {
1068 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1069 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1072 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1076 * Check for command that don't needs to allocate a returned payload. We do
1077 * this here so we don't have to make the call for no payload at each
1080 switch (cmd_ctx
->lsm
.cmd_type
) {
1081 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1082 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1083 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1084 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1085 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1086 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1087 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1088 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1089 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1090 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1091 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1092 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1093 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1094 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1095 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1096 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1099 /* Setup lttng message with no payload */
1100 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, nullptr, 0);
1102 /* This label does not try to unlock the session */
1103 goto init_setup_error
;
1107 /* Commands that DO NOT need a session. */
1108 switch (cmd_ctx
->lsm
.cmd_type
) {
1109 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1110 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1111 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1112 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1113 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1114 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1115 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1116 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1117 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1118 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1119 need_tracing_session
= false;
1122 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1124 * We keep the session list lock across _all_ commands
1125 * for now, because the per-session lock does not
1126 * handle teardown properly.
1128 session_lock_list();
1129 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1130 if (cmd_ctx
->session
== nullptr) {
1131 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1134 /* Acquire lock for the session */
1135 session_lock(cmd_ctx
->session
);
1141 * Commands that need a valid session but should NOT create one if none
1142 * exists. Instead of creating one and destroying it when the command is
1143 * handled, process that right before so we save some round trip in useless
1146 switch (cmd_ctx
->lsm
.cmd_type
) {
1147 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1148 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1149 switch (cmd_ctx
->lsm
.domain
.type
) {
1150 case LTTNG_DOMAIN_KERNEL
:
1151 if (!cmd_ctx
->session
->kernel_session
) {
1152 ret
= LTTNG_ERR_NO_CHANNEL
;
1156 case LTTNG_DOMAIN_JUL
:
1157 case LTTNG_DOMAIN_LOG4J
:
1158 case LTTNG_DOMAIN_PYTHON
:
1159 case LTTNG_DOMAIN_UST
:
1160 if (!cmd_ctx
->session
->ust_session
) {
1161 ret
= LTTNG_ERR_NO_CHANNEL
;
1166 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1178 * Check domain type for specific "pre-action".
1180 switch (cmd_ctx
->lsm
.domain
.type
) {
1181 case LTTNG_DOMAIN_KERNEL
:
1183 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1187 /* Kernel tracer check */
1188 if (!kernel_tracer_is_initialized()) {
1189 /* Basically, load kernel tracer modules */
1190 ret
= init_kernel_tracer();
1196 /* Consumer is in an ERROR state. Report back to client */
1197 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) == CONSUMER_ERROR
) {
1198 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1202 /* Need a session for kernel command */
1203 if (need_tracing_session
) {
1204 if (cmd_ctx
->session
->kernel_session
== nullptr) {
1205 ret
= create_kernel_session(cmd_ctx
->session
);
1206 if (ret
!= LTTNG_OK
) {
1207 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1212 /* Start the kernel consumer daemon */
1213 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1214 if (the_kconsumer_data
.pid
== 0 &&
1215 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1216 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1217 ret
= start_consumerd(&the_kconsumer_data
);
1219 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1222 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1224 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1228 * The consumer was just spawned so we need to add the socket to
1229 * the consumer output of the session if exist.
1231 ret
= consumer_create_socket(&the_kconsumer_data
,
1232 cmd_ctx
->session
->kernel_session
->consumer
);
1239 case LTTNG_DOMAIN_JUL
:
1240 case LTTNG_DOMAIN_LOG4J
:
1241 case LTTNG_DOMAIN_PYTHON
:
1242 if (!agent_tracing_is_enabled()) {
1243 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1247 case LTTNG_DOMAIN_UST
:
1249 if (!ust_app_supported()) {
1250 ret
= LTTNG_ERR_NO_UST
;
1254 /* Consumer is in an ERROR state. Report back to client */
1255 if (need_consumerd
&& uatomic_read(&the_ust_consumerd_state
) == CONSUMER_ERROR
) {
1256 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1260 if (need_tracing_session
) {
1261 /* Create UST session if none exist. */
1262 if (cmd_ctx
->session
->ust_session
== nullptr) {
1263 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1264 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1265 if (ret
!= LTTNG_OK
) {
1270 /* Start the UST consumer daemons */
1272 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1273 if (the_config
.consumerd64_bin_path
.value
&&
1274 the_ustconsumer64_data
.pid
== 0 &&
1275 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1276 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1277 ret
= start_consumerd(&the_ustconsumer64_data
);
1279 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1280 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1284 uatomic_set(&the_ust_consumerd64_fd
,
1285 the_ustconsumer64_data
.cmd_sock
);
1286 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1288 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1292 * Setup socket for consumer 64 bit. No need for atomic access
1293 * since it was set above and can ONLY be set in this thread.
1295 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1296 cmd_ctx
->session
->ust_session
->consumer
);
1302 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1303 if (the_config
.consumerd32_bin_path
.value
&&
1304 the_ustconsumer32_data
.pid
== 0 &&
1305 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1306 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1307 ret
= start_consumerd(&the_ustconsumer32_data
);
1309 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1310 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1314 uatomic_set(&the_ust_consumerd32_fd
,
1315 the_ustconsumer32_data
.cmd_sock
);
1316 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1318 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1322 * Setup socket for consumer 32 bit. No need for atomic access
1323 * since it was set above and can ONLY be set in this thread.
1325 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1326 cmd_ctx
->session
->ust_session
->consumer
);
1338 /* Validate consumer daemon state when start/stop trace command */
1339 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_START_TRACE
||
1340 cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
) {
1341 switch (cmd_ctx
->lsm
.domain
.type
) {
1342 case LTTNG_DOMAIN_NONE
:
1344 case LTTNG_DOMAIN_JUL
:
1345 case LTTNG_DOMAIN_LOG4J
:
1346 case LTTNG_DOMAIN_PYTHON
:
1347 case LTTNG_DOMAIN_UST
:
1348 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1349 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1353 case LTTNG_DOMAIN_KERNEL
:
1354 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1355 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1360 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1366 * Check that the UID matches that of the tracing session.
1367 * The root user can interact with all sessions.
1369 if (need_tracing_session
) {
1370 if (!session_access_ok(cmd_ctx
->session
,
1371 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1372 cmd_ctx
->session
->destroyed
) {
1373 ret
= LTTNG_ERR_EPERM
;
1379 * Send relayd information to consumer as soon as we have a domain and a
1382 if (cmd_ctx
->session
&& need_domain
) {
1384 * Setup relayd if not done yet. If the relayd information was already
1385 * sent to the consumer, this call will gracefully return.
1387 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1388 if (ret
!= LTTNG_OK
) {
1393 /* Process by command type */
1394 switch (cmd_ctx
->lsm
.cmd_type
) {
1395 case LTTCOMM_SESSIOND_COMMAND_ADD_CONTEXT
:
1397 struct lttng_event_context
*event_context
= nullptr;
1398 const enum lttng_error_code ret_code
=
1399 receive_lttng_event_context(cmd_ctx
, *sock
, sock_error
, &event_context
);
1401 if (ret_code
!= LTTNG_OK
) {
1402 ret
= (int) ret_code
;
1406 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1407 lttng_event_context_destroy(event_context
);
1410 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1412 ret
= cmd_disable_channel(cmd_ctx
->session
,
1413 cmd_ctx
->lsm
.domain
.type
,
1414 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1417 case LTTCOMM_SESSIOND_COMMAND_ENABLE_CHANNEL
:
1419 ret
= cmd_enable_channel(cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1422 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1423 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1425 struct lttng_dynamic_buffer payload
;
1426 struct lttng_buffer_view payload_view
;
1427 const bool add_value
= cmd_ctx
->lsm
.cmd_type
==
1428 LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1429 const size_t name_len
=
1430 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
.name_len
;
1431 const enum lttng_domain_type domain_type
=
1432 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1433 const enum lttng_process_attr process_attr
=
1434 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1435 .process_attr_tracker_add_remove_include_value
.process_attr
;
1436 const enum lttng_process_attr_value_type value_type
=
1437 (enum lttng_process_attr_value_type
) cmd_ctx
->lsm
.u
1438 .process_attr_tracker_add_remove_include_value
.value_type
;
1439 struct process_attr_value
*value
;
1440 enum lttng_error_code ret_code
;
1441 long login_name_max
;
1443 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1444 if (login_name_max
< 0) {
1445 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1446 ret
= LTTNG_ERR_INVALID
;
1450 /* Receive remaining variable length payload if applicable. */
1451 if (name_len
> login_name_max
) {
1453 * POSIX mandates user and group names that are at least
1454 * 8 characters long. Note that although shadow-utils
1455 * (useradd, groupaadd, etc.) use 32 chars as their
1456 * limit (from bits/utmp.h, UT_NAMESIZE),
1457 * LOGIN_NAME_MAX is defined to 256.
1459 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1460 add_value
? "addition" : "removal",
1463 ret
= LTTNG_ERR_INVALID
;
1467 lttng_dynamic_buffer_init(&payload
);
1468 if (name_len
!= 0) {
1470 * Receive variable payload for user/group name
1473 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1475 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1476 add_value
? "add" : "remove");
1477 ret
= LTTNG_ERR_NOMEM
;
1478 goto error_add_remove_tracker_value
;
1481 ret
= lttcomm_recv_unix_sock(*sock
, payload
.data
, name_len
);
1483 ERR("Failed to receive payload of %s process attribute tracker value argument",
1484 add_value
? "add" : "remove");
1486 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1487 goto error_add_remove_tracker_value
;
1491 payload_view
= lttng_buffer_view_from_dynamic_buffer(&payload
, 0, name_len
);
1492 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1493 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1494 goto error_add_remove_tracker_value
;
1498 * Validate the value type and domains are legal for the process
1499 * attribute tracker that is specified and convert the value to
1500 * add/remove to the internal sessiond representation.
1502 ret_code
= process_attr_value_from_comm(
1506 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
.integral_value
,
1509 if (ret_code
!= LTTNG_OK
) {
1511 goto error_add_remove_tracker_value
;
1515 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1516 cmd_ctx
->session
, domain_type
, process_attr
, value
);
1518 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1519 cmd_ctx
->session
, domain_type
, process_attr
, value
);
1521 process_attr_value_destroy(value
);
1522 error_add_remove_tracker_value
:
1523 lttng_dynamic_buffer_reset(&payload
);
1526 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1528 enum lttng_tracking_policy tracking_policy
;
1529 const enum lttng_domain_type domain_type
=
1530 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1531 const enum lttng_process_attr process_attr
=
1532 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1533 .process_attr_tracker_get_tracking_policy
.process_attr
;
1535 ret
= cmd_process_attr_tracker_get_tracking_policy(
1536 cmd_ctx
->session
, domain_type
, process_attr
, &tracking_policy
);
1537 if (ret
!= LTTNG_OK
) {
1541 uint32_t tracking_policy_u32
= tracking_policy
;
1542 ret
= setup_lttng_msg_no_cmd_header(
1543 cmd_ctx
, &tracking_policy_u32
, sizeof(uint32_t));
1545 ret
= LTTNG_ERR_NOMEM
;
1551 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_SET_POLICY
:
1553 const enum lttng_tracking_policy tracking_policy
=
1554 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1555 .process_attr_tracker_set_tracking_policy
.tracking_policy
;
1556 const enum lttng_domain_type domain_type
=
1557 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1558 const enum lttng_process_attr process_attr
=
1559 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1560 .process_attr_tracker_set_tracking_policy
.process_attr
;
1562 ret
= cmd_process_attr_tracker_set_tracking_policy(
1563 cmd_ctx
->session
, domain_type
, process_attr
, tracking_policy
);
1564 if (ret
!= LTTNG_OK
) {
1569 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1571 struct lttng_process_attr_values
*values
;
1572 struct lttng_dynamic_buffer reply
;
1573 const enum lttng_domain_type domain_type
=
1574 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1575 const enum lttng_process_attr process_attr
=
1576 (enum lttng_process_attr
)
1577 cmd_ctx
->lsm
.u
.process_attr_tracker_get_inclusion_set
.process_attr
;
1579 ret
= cmd_process_attr_tracker_get_inclusion_set(
1580 cmd_ctx
->session
, domain_type
, process_attr
, &values
);
1581 if (ret
!= LTTNG_OK
) {
1585 lttng_dynamic_buffer_init(&reply
);
1586 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1588 goto error_tracker_get_inclusion_set
;
1591 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, reply
.data
, reply
.size
);
1593 ret
= LTTNG_ERR_NOMEM
;
1594 goto error_tracker_get_inclusion_set
;
1598 error_tracker_get_inclusion_set
:
1599 lttng_process_attr_values_destroy(values
);
1600 lttng_dynamic_buffer_reset(&reply
);
1603 case LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
:
1604 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1606 struct lttng_event
*event
;
1607 char *filter_expression
;
1608 struct lttng_event_exclusion
*exclusions
;
1609 struct lttng_bytecode
*bytecode
;
1610 const enum lttng_error_code ret_code
= receive_lttng_event(cmd_ctx
,
1618 if (ret_code
!= LTTNG_OK
) {
1619 ret
= (int) ret_code
;
1624 * Ownership of filter_expression, exclusions, and bytecode is
1625 * always transferred.
1627 ret
= cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
?
1628 cmd_enable_event(cmd_ctx
,
1633 the_kernel_poll_pipe
[1]) :
1634 cmd_disable_event(cmd_ctx
, event
, filter_expression
, bytecode
, exclusions
);
1635 lttng_event_destroy(event
);
1638 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1640 enum lttng_error_code ret_code
;
1641 size_t original_payload_size
;
1642 size_t payload_size
;
1643 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1645 ret
= setup_empty_lttng_msg(cmd_ctx
);
1647 ret
= LTTNG_ERR_NOMEM
;
1651 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1653 session_lock_list();
1654 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1655 session_unlock_list();
1656 if (ret_code
!= LTTNG_OK
) {
1657 ret
= (int) ret_code
;
1661 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1662 original_payload_size
;
1663 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1668 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1670 enum lttng_error_code ret_code
;
1671 size_t original_payload_size
;
1672 size_t payload_size
;
1673 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1675 ret
= setup_empty_lttng_msg(cmd_ctx
);
1677 ret
= LTTNG_ERR_NOMEM
;
1681 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1683 session_lock_list();
1684 ret_code
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1685 &cmd_ctx
->reply_payload
);
1686 session_unlock_list();
1687 if (ret_code
!= LTTNG_OK
) {
1688 ret
= (int) ret_code
;
1692 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1693 original_payload_size
;
1694 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1699 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1701 enum lttng_error_code ret_code
;
1702 size_t original_payload_size
;
1703 size_t payload_size
;
1704 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1706 ret
= setup_empty_lttng_msg(cmd_ctx
);
1708 ret
= LTTNG_ERR_NOMEM
;
1712 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1714 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1715 if (ret_code
!= LTTNG_OK
) {
1716 ret
= (int) ret_code
;
1720 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1721 original_payload_size
;
1722 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1727 case LTTCOMM_SESSIOND_COMMAND_SET_CONSUMER_URI
:
1730 struct lttng_uri
*uris
;
1732 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1733 len
= nb_uri
* sizeof(struct lttng_uri
);
1736 ret
= LTTNG_ERR_INVALID
;
1740 uris
= calloc
<lttng_uri
>(nb_uri
);
1741 if (uris
== nullptr) {
1742 ret
= LTTNG_ERR_FATAL
;
1746 /* Receive variable len data */
1747 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1748 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1750 DBG("No URIs received from client... continuing");
1752 ret
= LTTNG_ERR_SESSION_FAIL
;
1757 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1759 if (ret
!= LTTNG_OK
) {
1765 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1768 * On the first start, if we have a kernel session and we have
1769 * enabled time or size-based rotations, we have to make sure
1770 * the kernel tracer supports it.
1772 if (!cmd_ctx
->session
->has_been_started
&& cmd_ctx
->session
->kernel_session
&&
1773 (cmd_ctx
->session
->rotate_timer_period
|| cmd_ctx
->session
->rotate_size
) &&
1774 !check_rotate_compatible()) {
1775 DBG("Kernel tracer version is not compatible with the rotation feature");
1776 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1779 ret
= cmd_start_trace(cmd_ctx
->session
);
1782 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1784 ret
= cmd_stop_trace(cmd_ctx
->session
);
1787 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1789 ret
= cmd_destroy_session(cmd_ctx
->session
, sock
);
1792 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1795 struct lttng_domain
*domains
= nullptr;
1797 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1799 /* Return value is a negative lttng_error_code. */
1804 ret
= setup_lttng_msg_no_cmd_header(
1805 cmd_ctx
, domains
, nb_dom
* sizeof(struct lttng_domain
));
1815 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1817 enum lttng_error_code ret_code
;
1818 size_t original_payload_size
;
1819 size_t payload_size
;
1820 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1822 ret
= setup_empty_lttng_msg(cmd_ctx
);
1824 ret
= LTTNG_ERR_NOMEM
;
1828 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1830 ret_code
= cmd_list_channels(
1831 cmd_ctx
->lsm
.domain
.type
, cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1832 if (ret_code
!= LTTNG_OK
) {
1833 ret
= (int) ret_code
;
1837 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1838 original_payload_size
;
1839 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1844 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1846 enum lttng_error_code ret_code
;
1847 size_t original_payload_size
;
1848 size_t payload_size
;
1849 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1851 ret
= setup_empty_lttng_msg(cmd_ctx
);
1853 ret
= LTTNG_ERR_NOMEM
;
1857 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1859 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1861 cmd_ctx
->lsm
.u
.list
.channel_name
,
1862 &cmd_ctx
->reply_payload
);
1863 if (ret_code
!= LTTNG_OK
) {
1864 ret
= (int) ret_code
;
1868 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1869 original_payload_size
;
1870 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1875 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1877 unsigned int nr_sessions
;
1878 lttng_session
*sessions_payload
= nullptr;
1879 size_t payload_len
= 0;
1881 session_lock_list();
1882 nr_sessions
= lttng_sessions_count(LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1883 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1885 if (nr_sessions
> 0) {
1886 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1887 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1888 sessions_payload
= zmalloc
<lttng_session
>(payload_len
);
1889 if (!sessions_payload
) {
1890 session_unlock_list();
1895 cmd_list_lttng_sessions(sessions_payload
,
1897 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1898 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1901 session_unlock_list();
1903 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
, payload_len
);
1904 free(sessions_payload
);
1913 case LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
:
1915 struct consumer_data
*cdata
;
1917 switch (cmd_ctx
->lsm
.domain
.type
) {
1918 case LTTNG_DOMAIN_KERNEL
:
1919 cdata
= &the_kconsumer_data
;
1922 ret
= LTTNG_ERR_UND
;
1926 ret
= cmd_register_consumer(
1927 cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
, cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1930 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1933 uint8_t pending_ret_byte
;
1935 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1940 * This function may returns 0 or 1 to indicate whether or not
1941 * there is data pending. In case of error, it should return an
1942 * LTTNG_ERR code. However, some code paths may still return
1943 * a nondescript error code, which we handle by returning an
1946 if (pending_ret
== 0 || pending_ret
== 1) {
1948 * ret will be set to LTTNG_OK at the end of
1951 } else if (pending_ret
< 0) {
1952 ret
= LTTNG_ERR_UNK
;
1959 pending_ret_byte
= (uint8_t) pending_ret
;
1961 /* 1 byte to return whether or not data is pending */
1962 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &pending_ret_byte
, 1);
1971 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1973 uint32_t snapshot_id
;
1974 struct lttcomm_lttng_output_id reply
;
1975 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1977 ret
= cmd_snapshot_add_output(cmd_ctx
->session
, &output
, &snapshot_id
);
1978 if (ret
!= LTTNG_OK
) {
1981 reply
.id
= snapshot_id
;
1983 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
, sizeof(reply
));
1988 /* Copy output list into message payload */
1992 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1994 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1995 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
1998 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
2001 struct lttng_snapshot_output
*outputs
= nullptr;
2003 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2004 if (nb_output
< 0) {
2009 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2010 ret
= setup_lttng_msg_no_cmd_header(
2011 cmd_ctx
, outputs
, nb_output
* sizeof(struct lttng_snapshot_output
));
2021 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
2023 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2024 ret
= cmd_snapshot_record(cmd_ctx
->session
, &output
, 0); // RFC: set to zero since
2026 // cmd_snapshot_record
2029 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
2031 struct lttng_dynamic_buffer payload
;
2032 struct lttng_session_descriptor
*return_descriptor
= nullptr;
2034 lttng_dynamic_buffer_init(&payload
);
2035 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2036 if (ret
!= LTTNG_OK
) {
2040 ret
= lttng_session_descriptor_serialize(return_descriptor
, &payload
);
2042 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2043 lttng_session_descriptor_destroy(return_descriptor
);
2044 ret
= LTTNG_ERR_NOMEM
;
2047 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
, payload
.size
);
2049 lttng_session_descriptor_destroy(return_descriptor
);
2050 ret
= LTTNG_ERR_NOMEM
;
2053 lttng_dynamic_buffer_reset(&payload
);
2054 lttng_session_descriptor_destroy(return_descriptor
);
2058 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
2060 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
, &cmd_ctx
->creds
);
2063 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
2065 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2066 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2069 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
2071 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2074 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
2076 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2079 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
2081 struct lttng_trigger
*payload_trigger
;
2082 struct lttng_trigger
*return_trigger
;
2083 size_t original_reply_payload_size
;
2084 size_t reply_payload_size
;
2085 const struct lttng_credentials cmd_creds
= {
2086 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2087 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2090 ret
= setup_empty_lttng_msg(cmd_ctx
);
2092 ret
= LTTNG_ERR_NOMEM
;
2096 ret
= receive_lttng_trigger(cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2097 if (ret
!= LTTNG_OK
) {
2101 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2103 ret
= cmd_register_trigger(&cmd_creds
,
2105 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2106 the_notification_thread_handle
,
2108 if (ret
!= LTTNG_OK
) {
2109 lttng_trigger_put(payload_trigger
);
2113 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2114 lttng_trigger_put(payload_trigger
);
2115 lttng_trigger_put(return_trigger
);
2117 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2118 ret
= LTTNG_ERR_NOMEM
;
2122 reply_payload_size
=
2123 cmd_ctx
->reply_payload
.buffer
.size
- original_reply_payload_size
;
2125 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2130 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
2132 struct lttng_trigger
*payload_trigger
;
2133 const struct lttng_credentials cmd_creds
= {
2134 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2135 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2138 ret
= receive_lttng_trigger(cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2139 if (ret
!= LTTNG_OK
) {
2143 ret
= cmd_unregister_trigger(
2144 &cmd_creds
, payload_trigger
, the_notification_thread_handle
);
2145 lttng_trigger_put(payload_trigger
);
2148 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
2150 struct lttng_rotate_session_return rotate_return
;
2152 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2154 memset(&rotate_return
, 0, sizeof(rotate_return
));
2155 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2156 DBG("Kernel tracer version is not compatible with the rotation feature");
2157 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2161 ret
= cmd_rotate_session(cmd_ctx
->session
,
2164 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2170 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
, sizeof(rotate_return
));
2179 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
2181 struct lttng_rotation_get_info_return get_info_return
;
2183 memset(&get_info_return
, 0, sizeof(get_info_return
));
2184 ret
= cmd_rotate_get_info(cmd_ctx
->session
,
2186 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2192 ret
= setup_lttng_msg_no_cmd_header(
2193 cmd_ctx
, &get_info_return
, sizeof(get_info_return
));
2202 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
2205 enum lttng_rotation_schedule_type schedule_type
;
2208 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2209 DBG("Kernel tracer version does not support session rotations");
2210 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2214 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2215 schedule_type
= (enum lttng_rotation_schedule_type
)
2216 cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2217 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2219 ret
= cmd_rotation_set_schedule(
2220 cmd_ctx
->session
, set_schedule
, schedule_type
, value
);
2221 if (ret
!= LTTNG_OK
) {
2227 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
2229 lttng_session_list_schedules_return schedules
;
2231 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2232 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2233 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2234 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2236 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
, sizeof(schedules
));
2245 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
2247 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2250 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
2252 struct lttng_triggers
*return_triggers
= nullptr;
2253 size_t original_payload_size
;
2254 size_t payload_size
;
2256 ret
= setup_empty_lttng_msg(cmd_ctx
);
2258 ret
= LTTNG_ERR_NOMEM
;
2262 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2264 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
, &return_triggers
);
2265 if (ret
!= LTTNG_OK
) {
2269 LTTNG_ASSERT(return_triggers
);
2270 ret
= lttng_triggers_serialize(return_triggers
, &cmd_ctx
->reply_payload
);
2271 lttng_triggers_destroy(return_triggers
);
2273 ERR("Failed to serialize triggers in reply to `list triggers` command");
2274 ret
= LTTNG_ERR_NOMEM
;
2278 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- original_payload_size
;
2280 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2285 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
2287 struct lttng_error_query
*query
;
2288 const struct lttng_credentials cmd_creds
= {
2289 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2290 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2292 struct lttng_error_query_results
*results
= nullptr;
2293 size_t original_payload_size
;
2294 size_t payload_size
;
2296 ret
= setup_empty_lttng_msg(cmd_ctx
);
2298 ret
= LTTNG_ERR_NOMEM
;
2302 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2304 ret
= receive_lttng_error_query(cmd_ctx
, *sock
, sock_error
, &query
);
2305 if (ret
!= LTTNG_OK
) {
2309 ret
= cmd_execute_error_query(
2310 &cmd_creds
, query
, &results
, the_notification_thread_handle
);
2311 lttng_error_query_destroy(query
);
2312 if (ret
!= LTTNG_OK
) {
2316 LTTNG_ASSERT(results
);
2317 ret
= lttng_error_query_results_serialize(results
, &cmd_ctx
->reply_payload
);
2318 lttng_error_query_results_destroy(results
);
2320 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2321 ret
= LTTNG_ERR_NOMEM
;
2325 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- original_payload_size
;
2327 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2334 ret
= LTTNG_ERR_UND
;
2339 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2340 DBG("Missing llm header, creating one.");
2341 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, nullptr, 0) < 0) {
2345 /* Set return code */
2346 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2348 if (cmd_ctx
->session
) {
2349 session_unlock(cmd_ctx
->session
);
2350 session_put(cmd_ctx
->session
);
2351 cmd_ctx
->session
= nullptr;
2353 if (need_tracing_session
) {
2354 session_unlock_list();
2357 LTTNG_ASSERT(!rcu_read_ongoing());
2361 static int create_client_sock()
2363 int ret
, client_sock
;
2365 /* Create client tool unix socket */
2366 client_sock
= lttcomm_create_unix_sock(the_config
.client_unix_sock_path
.value
);
2367 if (client_sock
< 0) {
2368 ERR("Create unix sock failed: %s", the_config
.client_unix_sock_path
.value
);
2373 /* Set the cloexec flag */
2374 ret
= utils_set_fd_cloexec(client_sock
);
2376 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2377 "Continuing but note that the consumer daemon will have a "
2378 "reference to this socket on exec()",
2382 /* File permission MUST be 660 */
2383 ret
= chmod(the_config
.client_unix_sock_path
.value
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2385 ERR("Set file permissions failed: %s", the_config
.client_unix_sock_path
.value
);
2387 (void) lttcomm_close_unix_sock(client_sock
);
2391 DBG("Created client socket (fd = %i)", client_sock
);
2397 static void cleanup_client_thread(void *data
)
2399 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2401 lttng_pipe_destroy(quit_pipe
);
2404 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2406 set_thread_status(false);
2410 * This thread manage all clients request using the unix client socket for
2413 static void *thread_manage_clients(void *data
)
2415 int sock
= -1, ret
, i
, err
= -1;
2418 struct lttng_poll_event events
;
2419 const int client_sock
= thread_state
.client_sock
;
2420 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2421 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2422 struct command_ctx cmd_ctx
= {};
2424 DBG("[thread] Manage client started");
2426 lttng_payload_init(&cmd_ctx
.reply_payload
);
2428 is_root
= (getuid() == 0);
2430 pthread_cleanup_push(thread_init_cleanup
, nullptr);
2432 rcu_register_thread();
2434 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2436 health_code_update();
2438 ret
= lttcomm_listen_unix_sock(client_sock
);
2444 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2445 * more will be added to this poll set.
2447 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2449 goto error_create_poll
;
2452 /* Add the application registration socket */
2453 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2458 /* Add thread quit pipe */
2459 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
);
2464 /* Set state as running. */
2465 set_thread_status(true);
2466 pthread_cleanup_pop(0);
2468 /* This testpoint is after we signal readiness to the parent. */
2469 if (testpoint(sessiond_thread_manage_clients
)) {
2473 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2477 health_code_update();
2480 const struct cmd_completion_handler
*cmd_completion_handler
;
2482 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2483 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2484 cmd_ctx
.creds
.pid
= 0;
2485 cmd_ctx
.session
= nullptr;
2486 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2487 cmd_ctx
.lttng_msg_size
= 0;
2489 DBG("Accepting client command ...");
2491 /* Inifinite blocking call, waiting for transmission */
2493 health_poll_entry();
2494 ret
= lttng_poll_wait(&events
, -1);
2498 * Restart interrupted system call.
2500 if (errno
== EINTR
) {
2508 for (i
= 0; i
< nb_fd
; i
++) {
2509 /* Fetch once the poll data. */
2510 const auto revents
= LTTNG_POLL_GETEV(&events
, i
);
2511 const auto pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2513 health_code_update();
2515 /* Activity on thread quit pipe, exiting. */
2516 if (pollfd
== thread_quit_pipe_fd
) {
2517 DBG("Activity on thread quit pipe");
2522 /* Event on the registration socket */
2523 if (revents
& LPOLLIN
) {
2525 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2526 ERR("Client socket poll error");
2529 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2534 DBG("Wait for client response");
2536 health_code_update();
2538 sock
= lttcomm_accept_unix_sock(client_sock
);
2544 * Set the CLOEXEC flag. Return code is useless because either way, the
2547 (void) utils_set_fd_cloexec(sock
);
2549 /* Set socket option for credentials retrieval */
2550 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2555 health_code_update();
2558 * Data is received from the lttng client. The struct
2559 * lttcomm_session_msg (lsm) contains the command and data request of
2562 DBG("Receiving data from client ...");
2563 ret
= lttcomm_recv_creds_unix_sock(
2564 sock
, &cmd_ctx
.lsm
, sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2565 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2566 DBG("Incomplete recv() from client... continuing");
2575 health_code_update();
2577 // TODO: Validate cmd_ctx including sanity check for
2578 // security purpose.
2580 rcu_thread_online();
2582 * This function dispatch the work to the kernel or userspace tracer
2583 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2584 * informations for the client. The command context struct contains
2585 * everything this function may needs.
2588 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2589 rcu_thread_offline();
2599 * TODO: Inform client somehow of the fatal error. At
2600 * this point, ret < 0 means that a zmalloc failed
2601 * (ENOMEM). Error detected but still accept
2602 * command, unless a socket error has been
2607 } catch (const std::bad_alloc
& ex
) {
2608 WARN_FMT("Failed to allocate memory while handling client request: {}",
2610 ret
= LTTNG_ERR_NOMEM
;
2611 } catch (const lttng::ctl::error
& ex
) {
2612 WARN_FMT("Client request failed: {}", ex
.what());
2614 } catch (const std::exception
& ex
) {
2615 WARN_FMT("Client request failed: {}", ex
.what());
2616 ret
= LTTNG_ERR_UNK
;
2619 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2620 WARN("Command returned an invalid status code, returning unknown error: "
2621 "command type = %s (%d), ret = %d",
2622 lttcomm_sessiond_command_str(
2623 (lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2624 cmd_ctx
.lsm
.cmd_type
,
2626 ret
= LTTNG_ERR_UNK
;
2629 cmd_completion_handler
= cmd_pop_completion_handler();
2630 if (cmd_completion_handler
) {
2631 enum lttng_error_code completion_code
;
2633 completion_code
= cmd_completion_handler
->run(cmd_completion_handler
->data
);
2634 if (completion_code
!= LTTNG_OK
) {
2639 health_code_update();
2642 struct lttng_payload_view view
=
2643 lttng_payload_view_from_payload(&cmd_ctx
.reply_payload
, 0, -1);
2644 struct lttcomm_lttng_msg
*llm
=
2645 (typeof(llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2647 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2648 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2650 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2652 DBG("Sending response (size: %d, retcode: %s (%d))",
2653 cmd_ctx
.lttng_msg_size
,
2654 lttng_strerror(-llm
->ret_code
),
2656 ret
= send_unix_sock(sock
, &view
);
2658 ERR("Failed to send data back to client");
2661 /* End of transmission */
2669 health_code_update();
2681 lttng_poll_clean(&events
);
2685 unlink(the_config
.client_unix_sock_path
.value
);
2686 ret
= close(client_sock
);
2693 ERR("Health error occurred in %s", __func__
);
2696 health_unregister(the_health_sessiond
);
2698 DBG("Client thread dying");
2699 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2700 rcu_unregister_thread();
2704 static bool shutdown_client_thread(void *thread_data
)
2706 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2707 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2709 return notify_thread_pipe(write_fd
) == 1;
2712 struct lttng_thread
*launch_client_thread()
2714 bool thread_running
;
2715 struct lttng_pipe
*client_quit_pipe
;
2716 struct lttng_thread
*thread
= nullptr;
2717 int client_sock_fd
= -1;
2719 sem_init(&thread_state
.ready
, 0, 0);
2720 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2721 if (!client_quit_pipe
) {
2725 client_sock_fd
= create_client_sock();
2726 if (client_sock_fd
< 0) {
2730 thread_state
.client_sock
= client_sock_fd
;
2731 thread
= lttng_thread_create("Client management",
2732 thread_manage_clients
,
2733 shutdown_client_thread
,
2734 cleanup_client_thread
,
2739 /* The client thread now owns the client sock fd and the quit pipe. */
2740 client_sock_fd
= -1;
2741 client_quit_pipe
= nullptr;
2744 * This thread is part of the threads that need to be fully
2745 * initialized before the session daemon is marked as "ready".
2747 thread_running
= wait_thread_status();
2748 if (!thread_running
) {
2753 if (client_sock_fd
>= 0) {
2754 if (close(client_sock_fd
)) {
2755 PERROR("Failed to close client socket");
2758 lttng_thread_put(thread
);
2759 cleanup_client_thread(client_quit_pipe
);