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>
60 static void set_thread_status(bool running
)
62 DBG("Marking client thread's state as %s", running
? "running" : "error");
63 thread_state
.running
= running
;
64 sem_post(&thread_state
.ready
);
67 static bool wait_thread_status()
69 DBG("Waiting for client thread to be ready");
70 sem_wait(&thread_state
.ready
);
71 if (thread_state
.running
) {
72 DBG("Client thread is ready");
74 ERR("Initialization of client thread failed");
77 return thread_state
.running
;
81 * Setup the outgoing data buffer for the response (llm) by allocating the
82 * right amount of memory and copying the original information from the lsm
85 * Return 0 on success, negative value on error.
87 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
88 const void *payload_buf
,
90 const void *cmd_header_buf
,
91 size_t cmd_header_len
)
94 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
95 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
96 lttcomm_lttng_msg llm
{};
98 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
99 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
100 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
101 llm
.data_size
= (uint32_t) payload_len
;
103 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
108 lttng_dynamic_pointer_array_clear(&cmd_ctx
->reply_payload
._fd_handles
);
110 cmd_ctx
->lttng_msg_size
= total_msg_size
;
112 /* Append reply header. */
113 ret
= lttng_dynamic_buffer_append(&cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
118 /* Append command header. */
119 if (cmd_header_len
) {
120 ret
= lttng_dynamic_buffer_append(
121 &cmd_ctx
->reply_payload
.buffer
, cmd_header_buf
, cmd_header_len
);
127 /* Append payload. */
129 ret
= lttng_dynamic_buffer_append(
130 &cmd_ctx
->reply_payload
.buffer
, payload_buf
, payload_len
);
140 static int setup_empty_lttng_msg(struct command_ctx
*cmd_ctx
)
143 const struct lttcomm_lttng_msg llm
= {};
145 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
150 /* Append place-holder reply header. */
151 ret
= lttng_dynamic_buffer_append(&cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
156 cmd_ctx
->lttng_msg_size
= sizeof(llm
);
161 static void update_lttng_msg(struct command_ctx
*cmd_ctx
, size_t cmd_header_len
, size_t payload_len
)
163 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
164 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
165 struct lttcomm_lttng_msg
*p_llm
;
166 lttcomm_lttng_msg llm
{};
168 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
169 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
170 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
171 llm
.data_size
= (uint32_t) payload_len
;
173 LTTNG_ASSERT(cmd_ctx
->reply_payload
.buffer
.size
>= sizeof(llm
));
175 p_llm
= (typeof(p_llm
)) cmd_ctx
->reply_payload
.buffer
.data
;
177 /* Update existing header. */
178 memcpy(p_llm
, &llm
, sizeof(llm
));
180 cmd_ctx
->lttng_msg_size
= total_msg_size
;
184 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
185 * exec or it will fail.
187 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
189 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
193 * Fork and exec a consumer daemon (consumerd).
195 * Return pid if successful else -1.
197 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
201 const char *consumer_to_use
;
202 const char *verbosity
;
205 DBG("Spawning consumerd");
212 if (the_config
.verbose_consumer
) {
213 verbosity
= "--verbose";
214 } else if (lttng_opt_quiet
) {
215 verbosity
= "--quiet";
220 switch (consumer_data
->type
) {
221 case LTTNG_CONSUMER_KERNEL
:
223 * Find out which consumerd to execute. We will first try the
224 * 64-bit path, then the sessiond's installation directory, and
225 * fallback on the 32-bit one,
227 DBG3("Looking for a kernel consumer at these locations:");
228 DBG3(" 1) %s", the_config
.consumerd64_bin_path
.value
?: "NULL");
229 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
230 DBG3(" 3) %s", the_config
.consumerd32_bin_path
.value
?: "NULL");
231 if (stat(the_config
.consumerd64_bin_path
.value
, &st
) == 0) {
232 DBG3("Found location #1");
233 consumer_to_use
= the_config
.consumerd64_bin_path
.value
;
234 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
235 DBG3("Found location #2");
236 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
237 } else if (the_config
.consumerd32_bin_path
.value
&&
238 stat(the_config
.consumerd32_bin_path
.value
, &st
) == 0) {
239 DBG3("Found location #3");
240 consumer_to_use
= the_config
.consumerd32_bin_path
.value
;
242 DBG("Could not find any valid consumerd executable");
246 DBG("Using kernel consumer at: %s", consumer_to_use
);
247 (void) execl(consumer_to_use
,
251 "--consumerd-cmd-sock",
252 consumer_data
->cmd_unix_sock_path
,
253 "--consumerd-err-sock",
254 consumer_data
->err_unix_sock_path
,
256 the_config
.tracing_group_name
.value
,
259 case LTTNG_CONSUMER64_UST
:
261 if (the_config
.consumerd64_lib_dir
.value
) {
266 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
270 tmplen
= strlen(the_config
.consumerd64_lib_dir
.value
) + 1 /* : */ +
272 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
277 strcat(tmpnew
, the_config
.consumerd64_lib_dir
.value
);
278 if (tmp
[0] != '\0') {
282 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
289 DBG("Using 64-bit UST consumer at: %s",
290 the_config
.consumerd64_bin_path
.value
);
291 (void) execl(the_config
.consumerd64_bin_path
.value
,
295 "--consumerd-cmd-sock",
296 consumer_data
->cmd_unix_sock_path
,
297 "--consumerd-err-sock",
298 consumer_data
->err_unix_sock_path
,
300 the_config
.tracing_group_name
.value
,
304 case LTTNG_CONSUMER32_UST
:
306 if (the_config
.consumerd32_lib_dir
.value
) {
311 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
315 tmplen
= strlen(the_config
.consumerd32_lib_dir
.value
) + 1 /* : */ +
317 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
322 strcat(tmpnew
, the_config
.consumerd32_lib_dir
.value
);
323 if (tmp
[0] != '\0') {
327 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
334 DBG("Using 32-bit UST consumer at: %s",
335 the_config
.consumerd32_bin_path
.value
);
336 (void) execl(the_config
.consumerd32_bin_path
.value
,
340 "--consumerd-cmd-sock",
341 consumer_data
->cmd_unix_sock_path
,
342 "--consumerd-err-sock",
343 consumer_data
->err_unix_sock_path
,
345 the_config
.tracing_group_name
.value
,
350 ERR("unknown consumer type");
354 PERROR("Consumer execl()");
356 /* Reaching this point, we got a failure on our execl(). */
358 } else if (pid
> 0) {
361 PERROR("start consumer fork");
369 * Spawn the consumerd daemon and session daemon thread.
371 static int start_consumerd(struct consumer_data
*consumer_data
)
376 * Set the listen() state on the socket since there is a possible race
377 * between the exec() of the consumer daemon and this call if place in the
378 * consumer thread. See bug #366 for more details.
380 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
385 pthread_mutex_lock(&consumer_data
->pid_mutex
);
386 if (consumer_data
->pid
!= 0) {
387 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
391 ret
= spawn_consumerd(consumer_data
);
393 ERR("Spawning consumerd failed");
394 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
398 /* Setting up the consumer_data pid */
399 consumer_data
->pid
= ret
;
400 DBG2("Consumer pid %d", consumer_data
->pid
);
401 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
403 DBG2("Spawning consumer control thread");
404 ret
= spawn_consumer_thread(consumer_data
);
406 ERR("Fatal error spawning consumer control thread");
414 /* Cleanup already created sockets on error. */
415 if (consumer_data
->err_sock
>= 0) {
418 err
= close(consumer_data
->err_sock
);
420 PERROR("close consumer data error socket");
427 * Copy consumer output from the tracing session to the domain session. The
428 * function also applies the right modification on a per domain basis for the
429 * trace files destination directory.
431 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
434 const char *dir_name
;
435 struct consumer_output
*consumer
;
437 LTTNG_ASSERT(session
);
438 LTTNG_ASSERT(session
->consumer
);
441 case LTTNG_DOMAIN_KERNEL
:
442 DBG3("Copying tracing session consumer output in kernel session");
444 * XXX: We should audit the session creation and what this function
445 * does "extra" in order to avoid a destroy since this function is used
446 * in the domain session creation (kernel and ust) only. Same for UST
449 if (session
->kernel_session
->consumer
) {
450 consumer_output_put(session
->kernel_session
->consumer
);
452 session
->kernel_session
->consumer
= consumer_copy_output(session
->consumer
);
453 /* Ease our life a bit for the next part */
454 consumer
= session
->kernel_session
->consumer
;
455 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
457 case LTTNG_DOMAIN_JUL
:
458 case LTTNG_DOMAIN_LOG4J
:
459 case LTTNG_DOMAIN_PYTHON
:
460 case LTTNG_DOMAIN_UST
:
461 DBG3("Copying tracing session consumer output in UST session");
462 if (session
->ust_session
->consumer
) {
463 consumer_output_put(session
->ust_session
->consumer
);
465 session
->ust_session
->consumer
= consumer_copy_output(session
->consumer
);
466 /* Ease our life a bit for the next part */
467 consumer
= session
->ust_session
->consumer
;
468 dir_name
= DEFAULT_UST_TRACE_DIR
;
471 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
475 /* Append correct directory to subdir */
476 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
, sizeof(consumer
->domain_subdir
));
481 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
489 * Create an UST session and add it to the session ust list.
491 static int create_ust_session(struct ltt_session
*session
, const struct lttng_domain
*domain
)
494 struct ltt_ust_session
*lus
= nullptr;
496 LTTNG_ASSERT(session
);
497 LTTNG_ASSERT(domain
);
498 LTTNG_ASSERT(session
->consumer
);
500 switch (domain
->type
) {
501 case LTTNG_DOMAIN_JUL
:
502 case LTTNG_DOMAIN_LOG4J
:
503 case LTTNG_DOMAIN_PYTHON
:
504 case LTTNG_DOMAIN_UST
:
507 ERR("Unknown UST domain on create session %d", domain
->type
);
508 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
512 DBG("Creating UST session");
514 lus
= trace_ust_create_session(session
->id
);
515 if (lus
== nullptr) {
516 ret
= LTTNG_ERR_UST_SESS_FAIL
;
520 lus
->uid
= session
->uid
;
521 lus
->gid
= session
->gid
;
522 lus
->output_traces
= session
->output_traces
;
523 lus
->snapshot_mode
= session
->snapshot_mode
;
524 lus
->live_timer_interval
= session
->live_timer
;
525 session
->ust_session
= lus
;
526 if (session
->shm_path
[0]) {
527 strncpy(lus
->root_shm_path
, session
->shm_path
, sizeof(lus
->root_shm_path
));
528 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
529 strncpy(lus
->shm_path
, session
->shm_path
, sizeof(lus
->shm_path
));
530 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
531 strncat(lus
->shm_path
, "/ust", sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
533 /* Copy session output to the newly created UST session */
534 ret
= copy_session_consumer(domain
->type
, session
);
535 if (ret
!= LTTNG_OK
) {
543 session
->ust_session
= nullptr;
548 * Create a kernel tracer session then create the default channel.
550 static int create_kernel_session(struct ltt_session
*session
)
554 DBG("Creating kernel session");
556 ret
= kernel_create_session(session
);
558 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
562 /* Code flow safety */
563 LTTNG_ASSERT(session
->kernel_session
);
565 /* Copy session output to the newly created Kernel session */
566 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
567 if (ret
!= LTTNG_OK
) {
571 session
->kernel_session
->uid
= session
->uid
;
572 session
->kernel_session
->gid
= session
->gid
;
573 session
->kernel_session
->output_traces
= session
->output_traces
;
574 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
575 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
580 trace_kernel_destroy_session(session
->kernel_session
);
581 session
->kernel_session
= nullptr;
587 * Count number of session permitted by uid/gid.
589 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
__attribute__((unused
)))
592 struct ltt_session
*session
;
593 const struct ltt_session_list
*session_list
= session_get_list();
595 DBG("Counting number of available session for UID %d", uid
);
596 cds_list_for_each_entry (session
, &session_list
->head
, list
) {
597 if (!session_get(session
)) {
600 session_lock(session
);
601 /* Only count the sessions the user can control. */
602 if (session_access_ok(session
, uid
) && !session
->destroyed
) {
605 session_unlock(session
);
606 session_put(session
);
611 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
614 struct lttng_trigger
**_trigger
)
618 ssize_t sock_recv_len
;
619 enum lttng_error_code ret_code
;
620 struct lttng_payload trigger_payload
;
621 struct lttng_trigger
*trigger
= nullptr;
623 lttng_payload_init(&trigger_payload
);
624 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
625 ret
= lttng_dynamic_buffer_set_size(&trigger_payload
.buffer
, trigger_len
);
627 ret_code
= LTTNG_ERR_NOMEM
;
631 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_payload
.buffer
.data
, trigger_len
);
632 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
633 ERR("Failed to receive trigger in command payload");
635 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
639 /* Receive fds, if any. */
640 if (cmd_ctx
->lsm
.fd_count
> 0) {
641 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
642 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
643 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
644 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
645 cmd_ctx
->lsm
.fd_count
,
647 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
650 } else if (sock_recv_len
<= 0) {
651 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
652 cmd_ctx
->lsm
.fd_count
,
654 ret_code
= LTTNG_ERR_FATAL
;
660 /* Deserialize trigger. */
662 struct lttng_payload_view view
=
663 lttng_payload_view_from_payload(&trigger_payload
, 0, -1);
665 if (lttng_trigger_create_from_payload(&view
, &trigger
) != trigger_len
) {
666 ERR("Invalid trigger received as part of command payload");
667 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
668 lttng_trigger_put(trigger
);
677 lttng_payload_reset(&trigger_payload
);
681 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
684 struct lttng_error_query
**_query
)
688 ssize_t sock_recv_len
;
689 enum lttng_error_code ret_code
;
690 struct lttng_payload query_payload
;
691 struct lttng_error_query
*query
= nullptr;
693 lttng_payload_init(&query_payload
);
694 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
695 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
697 ret_code
= LTTNG_ERR_NOMEM
;
701 sock_recv_len
= lttcomm_recv_unix_sock(sock
, query_payload
.buffer
.data
, query_len
);
702 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
703 ERR("Failed to receive error query in command payload");
705 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
709 /* Receive fds, if any. */
710 if (cmd_ctx
->lsm
.fd_count
> 0) {
711 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
712 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
713 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
714 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
715 cmd_ctx
->lsm
.fd_count
,
717 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
720 } else if (sock_recv_len
<= 0) {
721 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
722 cmd_ctx
->lsm
.fd_count
,
724 ret_code
= LTTNG_ERR_FATAL
;
730 /* Deserialize error query. */
732 struct lttng_payload_view view
=
733 lttng_payload_view_from_payload(&query_payload
, 0, -1);
735 if (lttng_error_query_create_from_payload(&view
, &query
) != query_len
) {
736 ERR("Invalid error query received as part of command payload");
737 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
746 lttng_payload_reset(&query_payload
);
750 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
753 struct lttng_event
**out_event
,
754 char **out_filter_expression
,
755 struct lttng_bytecode
**out_bytecode
,
756 struct lttng_event_exclusion
**out_exclusion
)
760 ssize_t sock_recv_len
;
761 enum lttng_error_code ret_code
;
762 struct lttng_payload event_payload
;
763 struct lttng_event
*local_event
= nullptr;
764 char *local_filter_expression
= nullptr;
765 struct lttng_bytecode
*local_bytecode
= nullptr;
766 struct lttng_event_exclusion
*local_exclusion
= nullptr;
768 lttng_payload_init(&event_payload
);
769 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
) {
770 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
771 } else if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
) {
772 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
777 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
779 ret_code
= LTTNG_ERR_NOMEM
;
783 sock_recv_len
= lttcomm_recv_unix_sock(sock
, event_payload
.buffer
.data
, event_len
);
784 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
785 ERR("Failed to receive event in command payload");
787 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
791 /* Receive fds, if any. */
792 if (cmd_ctx
->lsm
.fd_count
> 0) {
793 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
794 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
795 if (sock_recv_len
> 0 && sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
796 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
797 cmd_ctx
->lsm
.fd_count
,
799 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
802 } else if (sock_recv_len
<= 0) {
803 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
804 cmd_ctx
->lsm
.fd_count
,
806 ret_code
= LTTNG_ERR_FATAL
;
812 /* Deserialize event. */
815 struct lttng_payload_view event_view
=
816 lttng_payload_view_from_payload(&event_payload
, 0, -1);
818 len
= lttng_event_create_from_payload(&event_view
,
821 &local_filter_expression
,
825 ERR("Failed to create an event from the received buffer");
826 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
830 if (len
!= event_len
) {
831 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
832 ", payload length = %zd",
835 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
840 *out_event
= local_event
;
841 *out_exclusion
= local_exclusion
;
842 *out_filter_expression
= local_filter_expression
;
843 *out_bytecode
= local_bytecode
;
844 local_event
= nullptr;
845 local_exclusion
= nullptr;
846 local_filter_expression
= nullptr;
847 local_bytecode
= nullptr;
852 lttng_payload_reset(&event_payload
);
853 lttng_event_destroy(local_event
);
854 free(local_filter_expression
);
855 free(local_bytecode
);
856 free(local_exclusion
);
860 static enum lttng_error_code
861 receive_lttng_event_context(const struct command_ctx
*cmd_ctx
,
864 struct lttng_event_context
**out_event_context
)
867 const size_t event_context_len
= (size_t) cmd_ctx
->lsm
.u
.context
.length
;
868 ssize_t sock_recv_len
;
869 enum lttng_error_code ret_code
;
870 struct lttng_payload event_context_payload
;
871 struct lttng_event_context
*context
= nullptr;
873 lttng_payload_init(&event_context_payload
);
875 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
, event_context_len
);
877 ret_code
= LTTNG_ERR_NOMEM
;
882 lttcomm_recv_unix_sock(sock
, event_context_payload
.buffer
.data
, event_context_len
);
883 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
884 ERR("Failed to receive event context in command payload");
886 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
890 /* Deserialize event. */
893 struct lttng_payload_view event_context_view
=
894 lttng_payload_view_from_payload(&event_context_payload
, 0, -1);
896 len
= lttng_event_context_create_from_payload(&event_context_view
, &context
);
899 ERR("Failed to create a event context from the received buffer");
900 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
904 if (len
!= event_context_len
) {
905 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd",
908 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
913 *out_event_context
= context
;
918 lttng_event_context_destroy(context
);
919 lttng_payload_reset(&event_context_payload
);
924 * Version of setup_lttng_msg() without command header.
927 setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
, void *payload_buf
, size_t payload_len
)
929 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, nullptr, 0);
933 * Check if the current kernel tracer supports the session rotation feature.
934 * Return 1 if it does, 0 otherwise.
936 static int check_rotate_compatible()
940 if (the_kernel_tracer_version
.major
!= 2 || the_kernel_tracer_version
.minor
< 11) {
941 DBG("Kernel tracer version is not compatible with the rotation feature");
949 * Send data on a unix socket using the liblttsessiondcomm API.
951 * Return lttcomm error code.
953 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
956 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
958 /* Check valid length */
959 if (view
->buffer
.size
== 0) {
964 ret
= lttcomm_send_unix_sock(sock
, view
->buffer
.data
, view
->buffer
.size
);
970 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
981 * Process the command requested by the lttng client within the command
982 * context structure. This function make sure that the return structure (llm)
983 * is set and ready for transmission before returning.
985 * Return any error encountered or 0 for success.
987 * "sock" is only used for special-case var. len data.
988 * A command may assume the ownership of the socket, in which case its value
989 * should be set to -1.
991 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
, int *sock_error
)
994 bool need_tracing_session
= true;
998 if (!lttcomm_sessiond_command_is_valid((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
)) {
999 ERR("Unknown client command received: command id = %" PRIu32
,
1000 cmd_ctx
->lsm
.cmd_type
);
1001 ret
= LTTNG_ERR_UND
;
1005 DBG("Processing client command '%s\' (%d)",
1006 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
1007 cmd_ctx
->lsm
.cmd_type
);
1011 switch (cmd_ctx
->lsm
.cmd_type
) {
1012 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1013 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1014 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1015 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1016 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1017 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1018 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1019 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1020 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1021 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
1022 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
1023 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1024 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
1025 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
1026 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
1027 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1028 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1029 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
1030 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1031 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
1032 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1033 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1034 need_domain
= false;
1040 /* Needs a functioning consumerd? */
1041 switch (cmd_ctx
->lsm
.cmd_type
) {
1042 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1043 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1044 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1045 need_consumerd
= false;
1048 need_consumerd
= true;
1052 if (the_config
.no_kernel
&& need_domain
&&
1053 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1055 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1057 ret
= LTTNG_ERR_KERN_NA
;
1062 /* Deny register consumer if we already have a spawned consumer. */
1063 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1064 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1065 if (the_kconsumer_data
.pid
> 0) {
1066 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1067 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1070 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1074 * Check for command that don't needs to allocate a returned payload. We do
1075 * this here so we don't have to make the call for no payload at each
1078 switch (cmd_ctx
->lsm
.cmd_type
) {
1079 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1080 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1081 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1082 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1083 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1084 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1085 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1086 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1087 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1088 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1089 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1090 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1091 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1092 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1093 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1094 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1097 /* Setup lttng message with no payload */
1098 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, nullptr, 0);
1100 /* This label does not try to unlock the session */
1101 goto init_setup_error
;
1105 /* Commands that DO NOT need a session. */
1106 switch (cmd_ctx
->lsm
.cmd_type
) {
1107 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1108 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1109 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1110 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1111 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1112 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1113 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1114 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1115 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1116 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1117 need_tracing_session
= false;
1120 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1122 * We keep the session list lock across _all_ commands
1123 * for now, because the per-session lock does not
1124 * handle teardown properly.
1126 session_lock_list();
1127 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1128 if (cmd_ctx
->session
== nullptr) {
1129 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1132 /* Acquire lock for the session */
1133 session_lock(cmd_ctx
->session
);
1139 * Commands that need a valid session but should NOT create one if none
1140 * exists. Instead of creating one and destroying it when the command is
1141 * handled, process that right before so we save some round trip in useless
1144 switch (cmd_ctx
->lsm
.cmd_type
) {
1145 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1146 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1147 switch (cmd_ctx
->lsm
.domain
.type
) {
1148 case LTTNG_DOMAIN_KERNEL
:
1149 if (!cmd_ctx
->session
->kernel_session
) {
1150 ret
= LTTNG_ERR_NO_CHANNEL
;
1154 case LTTNG_DOMAIN_JUL
:
1155 case LTTNG_DOMAIN_LOG4J
:
1156 case LTTNG_DOMAIN_PYTHON
:
1157 case LTTNG_DOMAIN_UST
:
1158 if (!cmd_ctx
->session
->ust_session
) {
1159 ret
= LTTNG_ERR_NO_CHANNEL
;
1164 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1176 * Check domain type for specific "pre-action".
1178 switch (cmd_ctx
->lsm
.domain
.type
) {
1179 case LTTNG_DOMAIN_KERNEL
:
1181 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1185 /* Kernel tracer check */
1186 if (!kernel_tracer_is_initialized()) {
1187 /* Basically, load kernel tracer modules */
1188 ret
= init_kernel_tracer();
1194 /* Consumer is in an ERROR state. Report back to client */
1195 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) == CONSUMER_ERROR
) {
1196 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1200 /* Need a session for kernel command */
1201 if (need_tracing_session
) {
1202 if (cmd_ctx
->session
->kernel_session
== nullptr) {
1203 ret
= create_kernel_session(cmd_ctx
->session
);
1204 if (ret
!= LTTNG_OK
) {
1205 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1210 /* Start the kernel consumer daemon */
1211 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1212 if (the_kconsumer_data
.pid
== 0 &&
1213 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1214 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1215 ret
= start_consumerd(&the_kconsumer_data
);
1217 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1220 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1222 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1226 * The consumer was just spawned so we need to add the socket to
1227 * the consumer output of the session if exist.
1229 ret
= consumer_create_socket(&the_kconsumer_data
,
1230 cmd_ctx
->session
->kernel_session
->consumer
);
1237 case LTTNG_DOMAIN_JUL
:
1238 case LTTNG_DOMAIN_LOG4J
:
1239 case LTTNG_DOMAIN_PYTHON
:
1240 if (!agent_tracing_is_enabled()) {
1241 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1245 case LTTNG_DOMAIN_UST
:
1247 if (!ust_app_supported()) {
1248 ret
= LTTNG_ERR_NO_UST
;
1252 /* Consumer is in an ERROR state. Report back to client */
1253 if (need_consumerd
&& uatomic_read(&the_ust_consumerd_state
) == CONSUMER_ERROR
) {
1254 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1258 if (need_tracing_session
) {
1259 /* Create UST session if none exist. */
1260 if (cmd_ctx
->session
->ust_session
== nullptr) {
1261 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1262 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1263 if (ret
!= LTTNG_OK
) {
1268 /* Start the UST consumer daemons */
1270 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1271 if (the_config
.consumerd64_bin_path
.value
&&
1272 the_ustconsumer64_data
.pid
== 0 &&
1273 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1274 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1275 ret
= start_consumerd(&the_ustconsumer64_data
);
1277 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1278 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1282 uatomic_set(&the_ust_consumerd64_fd
,
1283 the_ustconsumer64_data
.cmd_sock
);
1284 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1286 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1290 * Setup socket for consumer 64 bit. No need for atomic access
1291 * since it was set above and can ONLY be set in this thread.
1293 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1294 cmd_ctx
->session
->ust_session
->consumer
);
1300 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1301 if (the_config
.consumerd32_bin_path
.value
&&
1302 the_ustconsumer32_data
.pid
== 0 &&
1303 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1304 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1305 ret
= start_consumerd(&the_ustconsumer32_data
);
1307 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1308 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1312 uatomic_set(&the_ust_consumerd32_fd
,
1313 the_ustconsumer32_data
.cmd_sock
);
1314 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1316 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1320 * Setup socket for consumer 32 bit. No need for atomic access
1321 * since it was set above and can ONLY be set in this thread.
1323 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1324 cmd_ctx
->session
->ust_session
->consumer
);
1336 /* Validate consumer daemon state when start/stop trace command */
1337 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_START_TRACE
||
1338 cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
) {
1339 switch (cmd_ctx
->lsm
.domain
.type
) {
1340 case LTTNG_DOMAIN_NONE
:
1342 case LTTNG_DOMAIN_JUL
:
1343 case LTTNG_DOMAIN_LOG4J
:
1344 case LTTNG_DOMAIN_PYTHON
:
1345 case LTTNG_DOMAIN_UST
:
1346 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1347 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1351 case LTTNG_DOMAIN_KERNEL
:
1352 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1353 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1358 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1364 * Check that the UID matches that of the tracing session.
1365 * The root user can interact with all sessions.
1367 if (need_tracing_session
) {
1368 if (!session_access_ok(cmd_ctx
->session
,
1369 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1370 cmd_ctx
->session
->destroyed
) {
1371 ret
= LTTNG_ERR_EPERM
;
1377 * Send relayd information to consumer as soon as we have a domain and a
1380 if (cmd_ctx
->session
&& need_domain
) {
1382 * Setup relayd if not done yet. If the relayd information was already
1383 * sent to the consumer, this call will gracefully return.
1385 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1386 if (ret
!= LTTNG_OK
) {
1391 /* Process by command type */
1392 switch (cmd_ctx
->lsm
.cmd_type
) {
1393 case LTTCOMM_SESSIOND_COMMAND_ADD_CONTEXT
:
1395 struct lttng_event_context
*event_context
= nullptr;
1396 const enum lttng_error_code ret_code
=
1397 receive_lttng_event_context(cmd_ctx
, *sock
, sock_error
, &event_context
);
1399 if (ret_code
!= LTTNG_OK
) {
1400 ret
= (int) ret_code
;
1404 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1405 lttng_event_context_destroy(event_context
);
1408 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1410 ret
= cmd_disable_channel(cmd_ctx
->session
,
1411 cmd_ctx
->lsm
.domain
.type
,
1412 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1415 case LTTCOMM_SESSIOND_COMMAND_ENABLE_CHANNEL
:
1417 ret
= cmd_enable_channel(cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1420 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1421 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1423 struct lttng_dynamic_buffer payload
;
1424 struct lttng_buffer_view payload_view
;
1425 const bool add_value
= cmd_ctx
->lsm
.cmd_type
==
1426 LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1427 const size_t name_len
=
1428 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
.name_len
;
1429 const enum lttng_domain_type domain_type
=
1430 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1431 const enum lttng_process_attr process_attr
=
1432 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1433 .process_attr_tracker_add_remove_include_value
.process_attr
;
1434 const enum lttng_process_attr_value_type value_type
=
1435 (enum lttng_process_attr_value_type
) cmd_ctx
->lsm
.u
1436 .process_attr_tracker_add_remove_include_value
.value_type
;
1437 struct process_attr_value
*value
;
1438 enum lttng_error_code ret_code
;
1439 long login_name_max
;
1441 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1442 if (login_name_max
< 0) {
1443 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1444 ret
= LTTNG_ERR_INVALID
;
1448 /* Receive remaining variable length payload if applicable. */
1449 if (name_len
> login_name_max
) {
1451 * POSIX mandates user and group names that are at least
1452 * 8 characters long. Note that although shadow-utils
1453 * (useradd, groupaadd, etc.) use 32 chars as their
1454 * limit (from bits/utmp.h, UT_NAMESIZE),
1455 * LOGIN_NAME_MAX is defined to 256.
1457 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1458 add_value
? "addition" : "removal",
1461 ret
= LTTNG_ERR_INVALID
;
1465 lttng_dynamic_buffer_init(&payload
);
1466 if (name_len
!= 0) {
1468 * Receive variable payload for user/group name
1471 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1473 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1474 add_value
? "add" : "remove");
1475 ret
= LTTNG_ERR_NOMEM
;
1476 goto error_add_remove_tracker_value
;
1479 ret
= lttcomm_recv_unix_sock(*sock
, payload
.data
, name_len
);
1481 ERR("Failed to receive payload of %s process attribute tracker value argument",
1482 add_value
? "add" : "remove");
1484 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1485 goto error_add_remove_tracker_value
;
1489 payload_view
= lttng_buffer_view_from_dynamic_buffer(&payload
, 0, name_len
);
1490 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1491 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1492 goto error_add_remove_tracker_value
;
1496 * Validate the value type and domains are legal for the process
1497 * attribute tracker that is specified and convert the value to
1498 * add/remove to the internal sessiond representation.
1500 ret_code
= process_attr_value_from_comm(
1504 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
.integral_value
,
1507 if (ret_code
!= LTTNG_OK
) {
1509 goto error_add_remove_tracker_value
;
1513 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1514 cmd_ctx
->session
, domain_type
, process_attr
, value
);
1516 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1517 cmd_ctx
->session
, domain_type
, process_attr
, value
);
1519 process_attr_value_destroy(value
);
1520 error_add_remove_tracker_value
:
1521 lttng_dynamic_buffer_reset(&payload
);
1524 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1526 enum lttng_tracking_policy tracking_policy
;
1527 const enum lttng_domain_type domain_type
=
1528 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1529 const enum lttng_process_attr process_attr
=
1530 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1531 .process_attr_tracker_get_tracking_policy
.process_attr
;
1533 ret
= cmd_process_attr_tracker_get_tracking_policy(
1534 cmd_ctx
->session
, domain_type
, process_attr
, &tracking_policy
);
1535 if (ret
!= LTTNG_OK
) {
1539 uint32_t tracking_policy_u32
= tracking_policy
;
1540 ret
= setup_lttng_msg_no_cmd_header(
1541 cmd_ctx
, &tracking_policy_u32
, sizeof(uint32_t));
1543 ret
= LTTNG_ERR_NOMEM
;
1549 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_SET_POLICY
:
1551 const enum lttng_tracking_policy tracking_policy
=
1552 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1553 .process_attr_tracker_set_tracking_policy
.tracking_policy
;
1554 const enum lttng_domain_type domain_type
=
1555 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1556 const enum lttng_process_attr process_attr
=
1557 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1558 .process_attr_tracker_set_tracking_policy
.process_attr
;
1560 ret
= cmd_process_attr_tracker_set_tracking_policy(
1561 cmd_ctx
->session
, domain_type
, process_attr
, tracking_policy
);
1562 if (ret
!= LTTNG_OK
) {
1567 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1569 struct lttng_process_attr_values
*values
;
1570 struct lttng_dynamic_buffer reply
;
1571 const enum lttng_domain_type domain_type
=
1572 (enum lttng_domain_type
) cmd_ctx
->lsm
.domain
.type
;
1573 const enum lttng_process_attr process_attr
=
1574 (enum lttng_process_attr
)
1575 cmd_ctx
->lsm
.u
.process_attr_tracker_get_inclusion_set
.process_attr
;
1577 ret
= cmd_process_attr_tracker_get_inclusion_set(
1578 cmd_ctx
->session
, domain_type
, process_attr
, &values
);
1579 if (ret
!= LTTNG_OK
) {
1583 lttng_dynamic_buffer_init(&reply
);
1584 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1586 goto error_tracker_get_inclusion_set
;
1589 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, reply
.data
, reply
.size
);
1591 ret
= LTTNG_ERR_NOMEM
;
1592 goto error_tracker_get_inclusion_set
;
1596 error_tracker_get_inclusion_set
:
1597 lttng_process_attr_values_destroy(values
);
1598 lttng_dynamic_buffer_reset(&reply
);
1601 case LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
:
1602 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1604 struct lttng_event
*event
;
1605 char *filter_expression
;
1606 struct lttng_event_exclusion
*exclusions
;
1607 struct lttng_bytecode
*bytecode
;
1608 const enum lttng_error_code ret_code
= receive_lttng_event(cmd_ctx
,
1616 if (ret_code
!= LTTNG_OK
) {
1617 ret
= (int) ret_code
;
1622 * Ownership of filter_expression, exclusions, and bytecode is
1623 * always transferred.
1625 ret
= cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
?
1626 cmd_enable_event(cmd_ctx
,
1631 the_kernel_poll_pipe
[1]) :
1632 cmd_disable_event(cmd_ctx
, event
, filter_expression
, bytecode
, exclusions
);
1633 lttng_event_destroy(event
);
1636 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1638 enum lttng_error_code ret_code
;
1639 size_t original_payload_size
;
1640 size_t payload_size
;
1641 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1643 ret
= setup_empty_lttng_msg(cmd_ctx
);
1645 ret
= LTTNG_ERR_NOMEM
;
1649 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1651 session_lock_list();
1652 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1653 session_unlock_list();
1654 if (ret_code
!= LTTNG_OK
) {
1655 ret
= (int) ret_code
;
1659 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1660 original_payload_size
;
1661 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1666 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1668 enum lttng_error_code ret_code
;
1669 size_t original_payload_size
;
1670 size_t payload_size
;
1671 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1673 ret
= setup_empty_lttng_msg(cmd_ctx
);
1675 ret
= LTTNG_ERR_NOMEM
;
1679 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1681 session_lock_list();
1682 ret_code
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1683 &cmd_ctx
->reply_payload
);
1684 session_unlock_list();
1685 if (ret_code
!= LTTNG_OK
) {
1686 ret
= (int) ret_code
;
1690 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1691 original_payload_size
;
1692 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1697 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1699 enum lttng_error_code ret_code
;
1700 size_t original_payload_size
;
1701 size_t payload_size
;
1702 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1704 ret
= setup_empty_lttng_msg(cmd_ctx
);
1706 ret
= LTTNG_ERR_NOMEM
;
1710 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1712 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1713 if (ret_code
!= LTTNG_OK
) {
1714 ret
= (int) ret_code
;
1718 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1719 original_payload_size
;
1720 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1725 case LTTCOMM_SESSIOND_COMMAND_SET_CONSUMER_URI
:
1728 struct lttng_uri
*uris
;
1730 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1731 len
= nb_uri
* sizeof(struct lttng_uri
);
1734 ret
= LTTNG_ERR_INVALID
;
1738 uris
= calloc
<lttng_uri
>(nb_uri
);
1739 if (uris
== nullptr) {
1740 ret
= LTTNG_ERR_FATAL
;
1744 /* Receive variable len data */
1745 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1746 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1748 DBG("No URIs received from client... continuing");
1750 ret
= LTTNG_ERR_SESSION_FAIL
;
1755 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1757 if (ret
!= LTTNG_OK
) {
1763 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1766 * On the first start, if we have a kernel session and we have
1767 * enabled time or size-based rotations, we have to make sure
1768 * the kernel tracer supports it.
1770 if (!cmd_ctx
->session
->has_been_started
&& cmd_ctx
->session
->kernel_session
&&
1771 (cmd_ctx
->session
->rotate_timer_period
|| cmd_ctx
->session
->rotate_size
) &&
1772 !check_rotate_compatible()) {
1773 DBG("Kernel tracer version is not compatible with the rotation feature");
1774 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1777 ret
= cmd_start_trace(cmd_ctx
->session
);
1780 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1782 ret
= cmd_stop_trace(cmd_ctx
->session
);
1785 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1787 ret
= cmd_destroy_session(cmd_ctx
->session
, the_notification_thread_handle
, sock
);
1790 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1793 struct lttng_domain
*domains
= nullptr;
1795 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1797 /* Return value is a negative lttng_error_code. */
1802 ret
= setup_lttng_msg_no_cmd_header(
1803 cmd_ctx
, domains
, nb_dom
* sizeof(struct lttng_domain
));
1813 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1815 enum lttng_error_code ret_code
;
1816 size_t original_payload_size
;
1817 size_t payload_size
;
1818 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1820 ret
= setup_empty_lttng_msg(cmd_ctx
);
1822 ret
= LTTNG_ERR_NOMEM
;
1826 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1828 ret_code
= cmd_list_channels(
1829 cmd_ctx
->lsm
.domain
.type
, cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1830 if (ret_code
!= LTTNG_OK
) {
1831 ret
= (int) ret_code
;
1835 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1836 original_payload_size
;
1837 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1842 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1844 enum lttng_error_code ret_code
;
1845 size_t original_payload_size
;
1846 size_t payload_size
;
1847 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1849 ret
= setup_empty_lttng_msg(cmd_ctx
);
1851 ret
= LTTNG_ERR_NOMEM
;
1855 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1857 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1859 cmd_ctx
->lsm
.u
.list
.channel_name
,
1860 &cmd_ctx
->reply_payload
);
1861 if (ret_code
!= LTTNG_OK
) {
1862 ret
= (int) ret_code
;
1866 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1867 original_payload_size
;
1868 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1873 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1875 unsigned int nr_sessions
;
1876 lttng_session
*sessions_payload
= nullptr;
1877 size_t payload_len
= 0;
1879 session_lock_list();
1880 nr_sessions
= lttng_sessions_count(LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1881 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1883 if (nr_sessions
> 0) {
1884 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1885 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1886 sessions_payload
= zmalloc
<lttng_session
>(payload_len
);
1887 if (!sessions_payload
) {
1888 session_unlock_list();
1893 cmd_list_lttng_sessions(sessions_payload
,
1895 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1896 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1899 session_unlock_list();
1901 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
, payload_len
);
1902 free(sessions_payload
);
1911 case LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
:
1913 struct consumer_data
*cdata
;
1915 switch (cmd_ctx
->lsm
.domain
.type
) {
1916 case LTTNG_DOMAIN_KERNEL
:
1917 cdata
= &the_kconsumer_data
;
1920 ret
= LTTNG_ERR_UND
;
1924 ret
= cmd_register_consumer(
1925 cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
, cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1928 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1931 uint8_t pending_ret_byte
;
1933 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1938 * This function may returns 0 or 1 to indicate whether or not
1939 * there is data pending. In case of error, it should return an
1940 * LTTNG_ERR code. However, some code paths may still return
1941 * a nondescript error code, which we handle by returning an
1944 if (pending_ret
== 0 || pending_ret
== 1) {
1946 * ret will be set to LTTNG_OK at the end of
1949 } else if (pending_ret
< 0) {
1950 ret
= LTTNG_ERR_UNK
;
1957 pending_ret_byte
= (uint8_t) pending_ret
;
1959 /* 1 byte to return whether or not data is pending */
1960 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &pending_ret_byte
, 1);
1969 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1971 uint32_t snapshot_id
;
1972 struct lttcomm_lttng_output_id reply
;
1973 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1975 ret
= cmd_snapshot_add_output(cmd_ctx
->session
, &output
, &snapshot_id
);
1976 if (ret
!= LTTNG_OK
) {
1979 reply
.id
= snapshot_id
;
1981 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
, sizeof(reply
));
1986 /* Copy output list into message payload */
1990 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1992 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1993 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
1996 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
1999 struct lttng_snapshot_output
*outputs
= nullptr;
2001 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2002 if (nb_output
< 0) {
2007 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2008 ret
= setup_lttng_msg_no_cmd_header(
2009 cmd_ctx
, outputs
, nb_output
* sizeof(struct lttng_snapshot_output
));
2019 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
2021 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2022 ret
= cmd_snapshot_record(cmd_ctx
->session
, &output
, 0); // RFC: set to zero since
2024 // cmd_snapshot_record
2027 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
2029 struct lttng_dynamic_buffer payload
;
2030 struct lttng_session_descriptor
*return_descriptor
= nullptr;
2032 lttng_dynamic_buffer_init(&payload
);
2033 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2034 if (ret
!= LTTNG_OK
) {
2038 ret
= lttng_session_descriptor_serialize(return_descriptor
, &payload
);
2040 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2041 lttng_session_descriptor_destroy(return_descriptor
);
2042 ret
= LTTNG_ERR_NOMEM
;
2045 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
, payload
.size
);
2047 lttng_session_descriptor_destroy(return_descriptor
);
2048 ret
= LTTNG_ERR_NOMEM
;
2051 lttng_dynamic_buffer_reset(&payload
);
2052 lttng_session_descriptor_destroy(return_descriptor
);
2056 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
2058 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
, &cmd_ctx
->creds
);
2061 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
2063 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2064 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2067 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
2069 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2072 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
2074 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2077 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
2079 struct lttng_trigger
*payload_trigger
;
2080 struct lttng_trigger
*return_trigger
;
2081 size_t original_reply_payload_size
;
2082 size_t reply_payload_size
;
2083 const struct lttng_credentials cmd_creds
= {
2084 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2085 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2088 ret
= setup_empty_lttng_msg(cmd_ctx
);
2090 ret
= LTTNG_ERR_NOMEM
;
2094 ret
= receive_lttng_trigger(cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2095 if (ret
!= LTTNG_OK
) {
2099 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2101 ret
= cmd_register_trigger(&cmd_creds
,
2103 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2104 the_notification_thread_handle
,
2106 if (ret
!= LTTNG_OK
) {
2107 lttng_trigger_put(payload_trigger
);
2111 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2112 lttng_trigger_put(payload_trigger
);
2113 lttng_trigger_put(return_trigger
);
2115 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2116 ret
= LTTNG_ERR_NOMEM
;
2120 reply_payload_size
=
2121 cmd_ctx
->reply_payload
.buffer
.size
- original_reply_payload_size
;
2123 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2128 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
2130 struct lttng_trigger
*payload_trigger
;
2131 const struct lttng_credentials cmd_creds
= {
2132 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2133 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2136 ret
= receive_lttng_trigger(cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2137 if (ret
!= LTTNG_OK
) {
2141 ret
= cmd_unregister_trigger(
2142 &cmd_creds
, payload_trigger
, the_notification_thread_handle
);
2143 lttng_trigger_put(payload_trigger
);
2146 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
2148 struct lttng_rotate_session_return rotate_return
;
2150 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2152 memset(&rotate_return
, 0, sizeof(rotate_return
));
2153 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2154 DBG("Kernel tracer version is not compatible with the rotation feature");
2155 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2159 ret
= cmd_rotate_session(cmd_ctx
->session
,
2162 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2168 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
, sizeof(rotate_return
));
2177 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
2179 struct lttng_rotation_get_info_return get_info_return
;
2181 memset(&get_info_return
, 0, sizeof(get_info_return
));
2182 ret
= cmd_rotate_get_info(cmd_ctx
->session
,
2184 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2190 ret
= setup_lttng_msg_no_cmd_header(
2191 cmd_ctx
, &get_info_return
, sizeof(get_info_return
));
2200 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
2203 enum lttng_rotation_schedule_type schedule_type
;
2206 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2207 DBG("Kernel tracer version does not support session rotations");
2208 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2212 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2213 schedule_type
= (enum lttng_rotation_schedule_type
)
2214 cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2215 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2217 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
,
2221 the_notification_thread_handle
);
2222 if (ret
!= LTTNG_OK
) {
2228 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
2230 lttng_session_list_schedules_return schedules
;
2232 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2233 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2234 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2235 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2237 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
, sizeof(schedules
));
2246 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
2248 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2251 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
2253 struct lttng_triggers
*return_triggers
= nullptr;
2254 size_t original_payload_size
;
2255 size_t payload_size
;
2257 ret
= setup_empty_lttng_msg(cmd_ctx
);
2259 ret
= LTTNG_ERR_NOMEM
;
2263 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2265 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
, &return_triggers
);
2266 if (ret
!= LTTNG_OK
) {
2270 LTTNG_ASSERT(return_triggers
);
2271 ret
= lttng_triggers_serialize(return_triggers
, &cmd_ctx
->reply_payload
);
2272 lttng_triggers_destroy(return_triggers
);
2274 ERR("Failed to serialize triggers in reply to `list triggers` command");
2275 ret
= LTTNG_ERR_NOMEM
;
2279 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- original_payload_size
;
2281 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2286 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
2288 struct lttng_error_query
*query
;
2289 const struct lttng_credentials cmd_creds
= {
2290 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2291 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2293 struct lttng_error_query_results
*results
= nullptr;
2294 size_t original_payload_size
;
2295 size_t payload_size
;
2297 ret
= setup_empty_lttng_msg(cmd_ctx
);
2299 ret
= LTTNG_ERR_NOMEM
;
2303 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2305 ret
= receive_lttng_error_query(cmd_ctx
, *sock
, sock_error
, &query
);
2306 if (ret
!= LTTNG_OK
) {
2310 ret
= cmd_execute_error_query(
2311 &cmd_creds
, query
, &results
, the_notification_thread_handle
);
2312 lttng_error_query_destroy(query
);
2313 if (ret
!= LTTNG_OK
) {
2317 LTTNG_ASSERT(results
);
2318 ret
= lttng_error_query_results_serialize(results
, &cmd_ctx
->reply_payload
);
2319 lttng_error_query_results_destroy(results
);
2321 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2322 ret
= LTTNG_ERR_NOMEM
;
2326 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- original_payload_size
;
2328 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2335 ret
= LTTNG_ERR_UND
;
2340 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2341 DBG("Missing llm header, creating one.");
2342 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, nullptr, 0) < 0) {
2346 /* Set return code */
2347 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2349 if (cmd_ctx
->session
) {
2350 session_unlock(cmd_ctx
->session
);
2351 session_put(cmd_ctx
->session
);
2352 cmd_ctx
->session
= nullptr;
2354 if (need_tracing_session
) {
2355 session_unlock_list();
2358 LTTNG_ASSERT(!rcu_read_ongoing());
2362 static int create_client_sock()
2364 int ret
, client_sock
;
2366 /* Create client tool unix socket */
2367 client_sock
= lttcomm_create_unix_sock(the_config
.client_unix_sock_path
.value
);
2368 if (client_sock
< 0) {
2369 ERR("Create unix sock failed: %s", the_config
.client_unix_sock_path
.value
);
2374 /* Set the cloexec flag */
2375 ret
= utils_set_fd_cloexec(client_sock
);
2377 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2378 "Continuing but note that the consumer daemon will have a "
2379 "reference to this socket on exec()",
2383 /* File permission MUST be 660 */
2384 ret
= chmod(the_config
.client_unix_sock_path
.value
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2386 ERR("Set file permissions failed: %s", the_config
.client_unix_sock_path
.value
);
2388 (void) lttcomm_close_unix_sock(client_sock
);
2392 DBG("Created client socket (fd = %i)", client_sock
);
2398 static void cleanup_client_thread(void *data
)
2400 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2402 lttng_pipe_destroy(quit_pipe
);
2405 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2407 set_thread_status(false);
2411 * This thread manage all clients request using the unix client socket for
2414 static void *thread_manage_clients(void *data
)
2416 int sock
= -1, ret
, i
, err
= -1;
2419 struct lttng_poll_event events
;
2420 const int client_sock
= thread_state
.client_sock
;
2421 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2422 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2423 struct command_ctx cmd_ctx
= {};
2425 DBG("[thread] Manage client started");
2427 lttng_payload_init(&cmd_ctx
.reply_payload
);
2429 is_root
= (getuid() == 0);
2431 pthread_cleanup_push(thread_init_cleanup
, nullptr);
2433 rcu_register_thread();
2435 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2437 health_code_update();
2439 ret
= lttcomm_listen_unix_sock(client_sock
);
2445 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2446 * more will be added to this poll set.
2448 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2450 goto error_create_poll
;
2453 /* Add the application registration socket */
2454 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2459 /* Add thread quit pipe */
2460 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
);
2465 /* Set state as running. */
2466 set_thread_status(true);
2467 pthread_cleanup_pop(0);
2469 /* This testpoint is after we signal readiness to the parent. */
2470 if (testpoint(sessiond_thread_manage_clients
)) {
2474 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2478 health_code_update();
2481 const struct cmd_completion_handler
*cmd_completion_handler
;
2483 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2484 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2485 cmd_ctx
.creds
.pid
= 0;
2486 cmd_ctx
.session
= nullptr;
2487 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2488 cmd_ctx
.lttng_msg_size
= 0;
2490 DBG("Accepting client command ...");
2492 /* Inifinite blocking call, waiting for transmission */
2494 health_poll_entry();
2495 ret
= lttng_poll_wait(&events
, -1);
2499 * Restart interrupted system call.
2501 if (errno
== EINTR
) {
2509 for (i
= 0; i
< nb_fd
; i
++) {
2510 /* Fetch once the poll data. */
2511 const auto revents
= LTTNG_POLL_GETEV(&events
, i
);
2512 const auto pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2514 health_code_update();
2516 /* Activity on thread quit pipe, exiting. */
2517 if (pollfd
== thread_quit_pipe_fd
) {
2518 DBG("Activity on thread quit pipe");
2523 /* Event on the registration socket */
2524 if (revents
& LPOLLIN
) {
2526 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2527 ERR("Client socket poll error");
2530 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2535 DBG("Wait for client response");
2537 health_code_update();
2539 sock
= lttcomm_accept_unix_sock(client_sock
);
2545 * Set the CLOEXEC flag. Return code is useless because either way, the
2548 (void) utils_set_fd_cloexec(sock
);
2550 /* Set socket option for credentials retrieval */
2551 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2556 health_code_update();
2559 * Data is received from the lttng client. The struct
2560 * lttcomm_session_msg (lsm) contains the command and data request of
2563 DBG("Receiving data from client ...");
2564 ret
= lttcomm_recv_creds_unix_sock(
2565 sock
, &cmd_ctx
.lsm
, sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2566 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2567 DBG("Incomplete recv() from client... continuing");
2576 health_code_update();
2578 // TODO: Validate cmd_ctx including sanity check for
2579 // security purpose.
2581 rcu_thread_online();
2583 * This function dispatch the work to the kernel or userspace tracer
2584 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2585 * informations for the client. The command context struct contains
2586 * 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
2608 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2609 WARN("Command returned an invalid status code, returning unknown error: "
2610 "command type = %s (%d), ret = %d",
2611 lttcomm_sessiond_command_str(
2612 (lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2613 cmd_ctx
.lsm
.cmd_type
,
2615 ret
= LTTNG_ERR_UNK
;
2618 cmd_completion_handler
= cmd_pop_completion_handler();
2619 if (cmd_completion_handler
) {
2620 enum lttng_error_code completion_code
;
2622 completion_code
= cmd_completion_handler
->run(cmd_completion_handler
->data
);
2623 if (completion_code
!= LTTNG_OK
) {
2628 health_code_update();
2631 struct lttng_payload_view view
=
2632 lttng_payload_view_from_payload(&cmd_ctx
.reply_payload
, 0, -1);
2633 struct lttcomm_lttng_msg
*llm
=
2634 (typeof(llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2636 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2637 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2639 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2641 DBG("Sending response (size: %d, retcode: %s (%d))",
2642 cmd_ctx
.lttng_msg_size
,
2643 lttng_strerror(-llm
->ret_code
),
2645 ret
= send_unix_sock(sock
, &view
);
2647 ERR("Failed to send data back to client");
2650 /* End of transmission */
2658 health_code_update();
2670 lttng_poll_clean(&events
);
2674 unlink(the_config
.client_unix_sock_path
.value
);
2675 ret
= close(client_sock
);
2682 ERR("Health error occurred in %s", __func__
);
2685 health_unregister(the_health_sessiond
);
2687 DBG("Client thread dying");
2688 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2689 rcu_unregister_thread();
2693 static bool shutdown_client_thread(void *thread_data
)
2695 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2696 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2698 return notify_thread_pipe(write_fd
) == 1;
2701 struct lttng_thread
*launch_client_thread()
2703 bool thread_running
;
2704 struct lttng_pipe
*client_quit_pipe
;
2705 struct lttng_thread
*thread
= nullptr;
2706 int client_sock_fd
= -1;
2708 sem_init(&thread_state
.ready
, 0, 0);
2709 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2710 if (!client_quit_pipe
) {
2714 client_sock_fd
= create_client_sock();
2715 if (client_sock_fd
< 0) {
2719 thread_state
.client_sock
= client_sock_fd
;
2720 thread
= lttng_thread_create("Client management",
2721 thread_manage_clients
,
2722 shutdown_client_thread
,
2723 cleanup_client_thread
,
2728 /* The client thread now owns the client sock fd and the quit pipe. */
2729 client_sock_fd
= -1;
2730 client_quit_pipe
= nullptr;
2733 * This thread is part of the threads that need to be fully
2734 * initialized before the session daemon is marked as "ready".
2736 thread_running
= wait_thread_status();
2737 if (!thread_running
) {
2742 if (client_sock_fd
>= 0) {
2743 if (close(client_sock_fd
)) {
2744 PERROR("Failed to close client socket");
2747 lttng_thread_put(thread
);
2748 cleanup_client_thread(client_quit_pipe
);