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 "common/buffer-view.hpp"
11 #include "common/compat/socket.hpp"
12 #include "common/dynamic-array.hpp"
13 #include "common/dynamic-buffer.hpp"
14 #include "common/fd-handle.hpp"
15 #include "common/payload-view.hpp"
16 #include "common/payload.hpp"
17 #include "common/sessiond-comm/sessiond-comm.hpp"
18 #include "lttng/lttng-error.h"
19 #include "lttng/tracker.h"
20 #include <common/compat/getenv.hpp>
21 #include <common/tracker.hpp>
22 #include <common/unix.hpp>
23 #include <common/utils.hpp>
24 #include <lttng/error-query-internal.hpp>
25 #include <lttng/event-internal.hpp>
26 #include <lttng/session-descriptor-internal.hpp>
27 #include <lttng/session-internal.hpp>
28 #include <lttng/userspace-probe-internal.hpp>
36 #include "agent-thread.hpp"
40 #include "health-sessiond.hpp"
42 #include "lttng-sessiond.hpp"
43 #include "manage-consumer.hpp"
45 #include "testpoint.hpp"
58 static void set_thread_status(bool running
)
60 DBG("Marking client thread's state as %s", running
? "running" : "error");
61 thread_state
.running
= running
;
62 sem_post(&thread_state
.ready
);
65 static bool wait_thread_status(void)
67 DBG("Waiting for client thread to be ready");
68 sem_wait(&thread_state
.ready
);
69 if (thread_state
.running
) {
70 DBG("Client thread is ready");
72 ERR("Initialization of client thread failed");
75 return thread_state
.running
;
79 * Setup the outgoing data buffer for the response (llm) by allocating the
80 * right amount of memory and copying the original information from the lsm
83 * Return 0 on success, negative value on error.
85 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
86 const void *payload_buf
, size_t payload_len
,
87 const void *cmd_header_buf
, size_t cmd_header_len
)
90 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
91 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
92 lttcomm_lttng_msg llm
{};
94 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
95 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
96 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
97 llm
.data_size
= (uint32_t) payload_len
;
99 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
104 lttng_dynamic_pointer_array_clear(&cmd_ctx
->reply_payload
._fd_handles
);
106 cmd_ctx
->lttng_msg_size
= total_msg_size
;
108 /* Append reply header. */
109 ret
= lttng_dynamic_buffer_append(
110 &cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
115 /* Append command header. */
116 if (cmd_header_len
) {
117 ret
= lttng_dynamic_buffer_append(
118 &cmd_ctx
->reply_payload
.buffer
, cmd_header_buf
,
125 /* Append payload. */
127 ret
= lttng_dynamic_buffer_append(
128 &cmd_ctx
->reply_payload
.buffer
, payload_buf
,
139 static int setup_empty_lttng_msg(struct command_ctx
*cmd_ctx
)
142 const struct lttcomm_lttng_msg llm
= {};
144 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
149 /* Append place-holder reply header. */
150 ret
= lttng_dynamic_buffer_append(
151 &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
,
164 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
165 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
166 struct lttcomm_lttng_msg
*p_llm
;
167 lttcomm_lttng_msg llm
{};
169 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
170 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
171 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
172 llm
.data_size
= (uint32_t) payload_len
;
174 LTTNG_ASSERT(cmd_ctx
->reply_payload
.buffer
.size
>= sizeof(llm
));
176 p_llm
= (typeof(p_llm
)) cmd_ctx
->reply_payload
.buffer
.data
;
178 /* Update existing header. */
179 memcpy(p_llm
, &llm
, sizeof(llm
));
181 cmd_ctx
->lttng_msg_size
= total_msg_size
;
185 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
186 * exec or it will fail.
188 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
190 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
194 * Fork and exec a consumer daemon (consumerd).
196 * Return pid if successful else -1.
198 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
202 const char *consumer_to_use
;
203 const char *verbosity
;
206 DBG("Spawning consumerd");
213 if (the_config
.verbose_consumer
) {
214 verbosity
= "--verbose";
215 } else if (lttng_opt_quiet
) {
216 verbosity
= "--quiet";
221 switch (consumer_data
->type
) {
222 case LTTNG_CONSUMER_KERNEL
:
224 * Find out which consumerd to execute. We will first try the
225 * 64-bit path, then the sessiond's installation directory, and
226 * fallback on the 32-bit one,
228 DBG3("Looking for a kernel consumer at these locations:");
229 DBG3(" 1) %s", the_config
.consumerd64_bin_path
.value
? : "NULL");
230 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
231 DBG3(" 3) %s", the_config
.consumerd32_bin_path
.value
? : "NULL");
232 if (stat(the_config
.consumerd64_bin_path
.value
, &st
) == 0) {
233 DBG3("Found location #1");
234 consumer_to_use
= the_config
.consumerd64_bin_path
.value
;
235 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
236 DBG3("Found location #2");
237 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
238 } else if (the_config
.consumerd32_bin_path
.value
&&
239 stat(the_config
.consumerd32_bin_path
.value
, &st
) == 0) {
240 DBG3("Found location #3");
241 consumer_to_use
= the_config
.consumerd32_bin_path
.value
;
243 DBG("Could not find any valid consumerd executable");
247 DBG("Using kernel consumer at: %s", consumer_to_use
);
248 (void) execl(consumer_to_use
, "lttng-consumerd",
249 verbosity
, "-k", "--consumerd-cmd-sock",
250 consumer_data
->cmd_unix_sock_path
,
251 "--consumerd-err-sock",
252 consumer_data
->err_unix_sock_path
,
254 the_config
.tracing_group_name
.value
,
257 case LTTNG_CONSUMER64_UST
:
259 if (the_config
.consumerd64_lib_dir
.value
) {
264 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
268 tmplen
= strlen(the_config
.consumerd64_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
269 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
274 strcat(tmpnew
, the_config
.consumerd64_lib_dir
.value
);
275 if (tmp
[0] != '\0') {
279 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
286 DBG("Using 64-bit UST consumer at: %s",
287 the_config
.consumerd64_bin_path
.value
);
288 (void) execl(the_config
.consumerd64_bin_path
.value
,
289 "lttng-consumerd", verbosity
, "-u",
290 "--consumerd-cmd-sock",
291 consumer_data
->cmd_unix_sock_path
,
292 "--consumerd-err-sock",
293 consumer_data
->err_unix_sock_path
,
295 the_config
.tracing_group_name
.value
,
299 case LTTNG_CONSUMER32_UST
:
301 if (the_config
.consumerd32_lib_dir
.value
) {
306 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
310 tmplen
= strlen(the_config
.consumerd32_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
311 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
316 strcat(tmpnew
, the_config
.consumerd32_lib_dir
.value
);
317 if (tmp
[0] != '\0') {
321 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
328 DBG("Using 32-bit UST consumer at: %s",
329 the_config
.consumerd32_bin_path
.value
);
330 (void) execl(the_config
.consumerd32_bin_path
.value
,
331 "lttng-consumerd", verbosity
, "-u",
332 "--consumerd-cmd-sock",
333 consumer_data
->cmd_unix_sock_path
,
334 "--consumerd-err-sock",
335 consumer_data
->err_unix_sock_path
,
337 the_config
.tracing_group_name
.value
,
342 ERR("unknown consumer type");
346 PERROR("Consumer execl()");
348 /* Reaching this point, we got a failure on our execl(). */
350 } else if (pid
> 0) {
353 PERROR("start consumer fork");
361 * Spawn the consumerd daemon and session daemon thread.
363 static int start_consumerd(struct consumer_data
*consumer_data
)
368 * Set the listen() state on the socket since there is a possible race
369 * between the exec() of the consumer daemon and this call if place in the
370 * consumer thread. See bug #366 for more details.
372 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
377 pthread_mutex_lock(&consumer_data
->pid_mutex
);
378 if (consumer_data
->pid
!= 0) {
379 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
383 ret
= spawn_consumerd(consumer_data
);
385 ERR("Spawning consumerd failed");
386 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
390 /* Setting up the consumer_data pid */
391 consumer_data
->pid
= ret
;
392 DBG2("Consumer pid %d", consumer_data
->pid
);
393 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
395 DBG2("Spawning consumer control thread");
396 ret
= spawn_consumer_thread(consumer_data
);
398 ERR("Fatal error spawning consumer control thread");
406 /* Cleanup already created sockets on error. */
407 if (consumer_data
->err_sock
>= 0) {
410 err
= close(consumer_data
->err_sock
);
412 PERROR("close consumer data error socket");
419 * Copy consumer output from the tracing session to the domain session. The
420 * function also applies the right modification on a per domain basis for the
421 * trace files destination directory.
423 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
426 const char *dir_name
;
427 struct consumer_output
*consumer
;
429 LTTNG_ASSERT(session
);
430 LTTNG_ASSERT(session
->consumer
);
433 case LTTNG_DOMAIN_KERNEL
:
434 DBG3("Copying tracing session consumer output in kernel session");
436 * XXX: We should audit the session creation and what this function
437 * does "extra" in order to avoid a destroy since this function is used
438 * in the domain session creation (kernel and ust) only. Same for UST
441 if (session
->kernel_session
->consumer
) {
442 consumer_output_put(session
->kernel_session
->consumer
);
444 session
->kernel_session
->consumer
=
445 consumer_copy_output(session
->consumer
);
446 /* Ease our life a bit for the next part */
447 consumer
= session
->kernel_session
->consumer
;
448 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
450 case LTTNG_DOMAIN_JUL
:
451 case LTTNG_DOMAIN_LOG4J
:
452 case LTTNG_DOMAIN_PYTHON
:
453 case LTTNG_DOMAIN_UST
:
454 DBG3("Copying tracing session consumer output in UST session");
455 if (session
->ust_session
->consumer
) {
456 consumer_output_put(session
->ust_session
->consumer
);
458 session
->ust_session
->consumer
=
459 consumer_copy_output(session
->consumer
);
460 /* Ease our life a bit for the next part */
461 consumer
= session
->ust_session
->consumer
;
462 dir_name
= DEFAULT_UST_TRACE_DIR
;
465 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
469 /* Append correct directory to subdir */
470 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
,
471 sizeof(consumer
->domain_subdir
));
476 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
484 * Create an UST session and add it to the session ust list.
486 static int create_ust_session(struct ltt_session
*session
,
487 const struct lttng_domain
*domain
)
490 struct ltt_ust_session
*lus
= NULL
;
492 LTTNG_ASSERT(session
);
493 LTTNG_ASSERT(domain
);
494 LTTNG_ASSERT(session
->consumer
);
496 switch (domain
->type
) {
497 case LTTNG_DOMAIN_JUL
:
498 case LTTNG_DOMAIN_LOG4J
:
499 case LTTNG_DOMAIN_PYTHON
:
500 case LTTNG_DOMAIN_UST
:
503 ERR("Unknown UST domain on create session %d", domain
->type
);
504 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
508 DBG("Creating UST session");
510 lus
= trace_ust_create_session(session
->id
);
512 ret
= LTTNG_ERR_UST_SESS_FAIL
;
516 lus
->uid
= session
->uid
;
517 lus
->gid
= session
->gid
;
518 lus
->output_traces
= session
->output_traces
;
519 lus
->snapshot_mode
= session
->snapshot_mode
;
520 lus
->live_timer_interval
= session
->live_timer
;
521 session
->ust_session
= lus
;
522 if (session
->shm_path
[0]) {
523 strncpy(lus
->root_shm_path
, session
->shm_path
,
524 sizeof(lus
->root_shm_path
));
525 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
526 strncpy(lus
->shm_path
, session
->shm_path
,
527 sizeof(lus
->shm_path
));
528 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
529 strncat(lus
->shm_path
, "/ust",
530 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
532 /* Copy session output to the newly created UST session */
533 ret
= copy_session_consumer(domain
->type
, session
);
534 if (ret
!= LTTNG_OK
) {
542 session
->ust_session
= NULL
;
547 * Create a kernel tracer session then create the default channel.
549 static int create_kernel_session(struct ltt_session
*session
)
553 DBG("Creating kernel session");
555 ret
= kernel_create_session(session
);
557 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
561 /* Code flow safety */
562 LTTNG_ASSERT(session
->kernel_session
);
564 /* Copy session output to the newly created Kernel session */
565 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
566 if (ret
!= LTTNG_OK
) {
570 session
->kernel_session
->uid
= session
->uid
;
571 session
->kernel_session
->gid
= session
->gid
;
572 session
->kernel_session
->output_traces
= session
->output_traces
;
573 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
574 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
579 trace_kernel_destroy_session(session
->kernel_session
);
580 session
->kernel_session
= NULL
;
586 * Count number of session permitted by uid/gid.
588 static unsigned int lttng_sessions_count(uid_t uid
,
589 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
) &&
603 !session
->destroyed
) {
606 session_unlock(session
);
607 session_put(session
);
612 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
615 struct lttng_trigger
**_trigger
)
619 ssize_t sock_recv_len
;
620 enum lttng_error_code ret_code
;
621 struct lttng_payload trigger_payload
;
622 struct lttng_trigger
*trigger
= NULL
;
624 lttng_payload_init(&trigger_payload
);
625 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
626 ret
= lttng_dynamic_buffer_set_size(
627 &trigger_payload
.buffer
, trigger_len
);
629 ret_code
= LTTNG_ERR_NOMEM
;
633 sock_recv_len
= lttcomm_recv_unix_sock(
634 sock
, trigger_payload
.buffer
.data
, trigger_len
);
635 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
636 ERR("Failed to receive trigger in command payload");
638 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
642 /* Receive fds, if any. */
643 if (cmd_ctx
->lsm
.fd_count
> 0) {
644 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
645 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
646 if (sock_recv_len
> 0 &&
647 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
648 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
649 cmd_ctx
->lsm
.fd_count
, (int) ret
);
650 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
653 } else if (sock_recv_len
<= 0) {
654 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
655 cmd_ctx
->lsm
.fd_count
, (int) ret
);
656 ret_code
= LTTNG_ERR_FATAL
;
662 /* Deserialize trigger. */
664 struct lttng_payload_view view
=
665 lttng_payload_view_from_payload(
666 &trigger_payload
, 0, -1);
668 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
670 ERR("Invalid trigger received as part of command payload");
671 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
672 lttng_trigger_put(trigger
);
681 lttng_payload_reset(&trigger_payload
);
685 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
688 struct lttng_error_query
**_query
)
692 ssize_t sock_recv_len
;
693 enum lttng_error_code ret_code
;
694 struct lttng_payload query_payload
;
695 struct lttng_error_query
*query
= NULL
;
697 lttng_payload_init(&query_payload
);
698 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
699 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
701 ret_code
= LTTNG_ERR_NOMEM
;
705 sock_recv_len
= lttcomm_recv_unix_sock(
706 sock
, query_payload
.buffer
.data
, query_len
);
707 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
708 ERR("Failed to receive error query in command payload");
710 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
714 /* Receive fds, if any. */
715 if (cmd_ctx
->lsm
.fd_count
> 0) {
716 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
717 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
718 if (sock_recv_len
> 0 &&
719 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
720 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
721 cmd_ctx
->lsm
.fd_count
, (int) ret
);
722 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
725 } else if (sock_recv_len
<= 0) {
726 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
727 cmd_ctx
->lsm
.fd_count
, (int) ret
);
728 ret_code
= LTTNG_ERR_FATAL
;
734 /* Deserialize error query. */
736 struct lttng_payload_view view
=
737 lttng_payload_view_from_payload(
738 &query_payload
, 0, -1);
740 if (lttng_error_query_create_from_payload(&view
, &query
) !=
742 ERR("Invalid error query received as part of command payload");
743 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
752 lttng_payload_reset(&query_payload
);
756 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
759 struct lttng_event
**out_event
,
760 char **out_filter_expression
,
761 struct lttng_bytecode
**out_bytecode
,
762 struct lttng_event_exclusion
**out_exclusion
)
766 ssize_t sock_recv_len
;
767 enum lttng_error_code ret_code
;
768 struct lttng_payload event_payload
;
769 struct lttng_event
*local_event
= NULL
;
770 char *local_filter_expression
= NULL
;
771 struct lttng_bytecode
*local_bytecode
= NULL
;
772 struct lttng_event_exclusion
*local_exclusion
= NULL
;
774 lttng_payload_init(&event_payload
);
775 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
) {
776 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
777 } else if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
) {
778 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
783 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
785 ret_code
= LTTNG_ERR_NOMEM
;
789 sock_recv_len
= lttcomm_recv_unix_sock(
790 sock
, event_payload
.buffer
.data
, event_len
);
791 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
792 ERR("Failed to receive event in command payload");
794 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
798 /* Receive fds, if any. */
799 if (cmd_ctx
->lsm
.fd_count
> 0) {
800 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
801 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
802 if (sock_recv_len
> 0 &&
803 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
804 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
805 cmd_ctx
->lsm
.fd_count
, (int) ret
);
806 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
809 } else if (sock_recv_len
<= 0) {
810 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
811 cmd_ctx
->lsm
.fd_count
, (int) ret
);
812 ret_code
= LTTNG_ERR_FATAL
;
818 /* Deserialize event. */
821 struct lttng_payload_view event_view
=
822 lttng_payload_view_from_payload(
823 &event_payload
, 0, -1);
825 len
= lttng_event_create_from_payload(&event_view
, &local_event
,
826 &local_exclusion
, &local_filter_expression
,
830 ERR("Failed to create an event from the received buffer");
831 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
835 if (len
!= event_len
) {
836 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
", payload length = %zd", event_len
, len
);
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
;
847 local_exclusion
= NULL
;
848 local_filter_expression
= NULL
;
849 local_bytecode
= NULL
;
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
receive_lttng_event_context(
863 const struct command_ctx
*cmd_ctx
,
866 struct lttng_event_context
**out_event_context
)
869 const size_t event_context_len
=
870 (size_t) cmd_ctx
->lsm
.u
.context
.length
;
871 ssize_t sock_recv_len
;
872 enum lttng_error_code ret_code
;
873 struct lttng_payload event_context_payload
;
874 struct lttng_event_context
*context
= NULL
;
876 lttng_payload_init(&event_context_payload
);
878 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
,
881 ret_code
= LTTNG_ERR_NOMEM
;
885 sock_recv_len
= lttcomm_recv_unix_sock(
886 sock
, event_context_payload
.buffer
.data
,
888 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
889 ERR("Failed to receive event context in command payload");
891 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
895 /* Deserialize event. */
898 struct lttng_payload_view event_context_view
=
899 lttng_payload_view_from_payload(
900 &event_context_payload
, 0, -1);
902 len
= lttng_event_context_create_from_payload(
903 &event_context_view
, &context
);
906 ERR("Failed to create a event context from the received buffer");
907 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
911 if (len
!= event_context_len
) {
912 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd", event_context_len
, len
);
913 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
918 *out_event_context
= context
;
923 lttng_event_context_destroy(context
);
924 lttng_payload_reset(&event_context_payload
);
929 * Version of setup_lttng_msg() without command header.
931 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
932 void *payload_buf
, size_t payload_len
)
934 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
938 * Check if the current kernel tracer supports the session rotation feature.
939 * Return 1 if it does, 0 otherwise.
941 static int check_rotate_compatible(void)
945 if (the_kernel_tracer_version
.major
!= 2 ||
946 the_kernel_tracer_version
.minor
< 11) {
947 DBG("Kernel tracer version is not compatible with the rotation feature");
955 * Send data on a unix socket using the liblttsessiondcomm API.
957 * Return lttcomm error code.
959 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
962 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
964 /* Check valid length */
965 if (view
->buffer
.size
== 0) {
970 ret
= lttcomm_send_unix_sock(
971 sock
, view
->buffer
.data
, view
->buffer
.size
);
977 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
988 * Process the command requested by the lttng client within the command
989 * context structure. This function make sure that the return structure (llm)
990 * is set and ready for transmission before returning.
992 * Return any error encountered or 0 for success.
994 * "sock" is only used for special-case var. len data.
995 * A command may assume the ownership of the socket, in which case its value
996 * should be set to -1.
998 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
1002 bool need_tracing_session
= true;
1004 bool need_consumerd
;
1006 if (!lttcomm_sessiond_command_is_valid((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
)) {
1007 ERR("Unknown client command received: command id = %" PRIu32
,
1008 cmd_ctx
->lsm
.cmd_type
);
1009 ret
= LTTNG_ERR_UND
;
1013 DBG("Processing client command '%s\' (%d)",
1014 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
1015 cmd_ctx
->lsm
.cmd_type
);
1019 switch (cmd_ctx
->lsm
.cmd_type
) {
1020 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1021 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1022 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1023 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1024 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1025 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1026 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1027 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
1028 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
1029 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
1030 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
1031 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1032 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
1033 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
1034 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
1035 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1036 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1037 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
1038 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1039 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
1040 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1041 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1042 need_domain
= false;
1048 /* Needs a functioning consumerd? */
1049 switch (cmd_ctx
->lsm
.cmd_type
) {
1050 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1051 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1052 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1053 need_consumerd
= false;
1056 need_consumerd
= true;
1060 if (the_config
.no_kernel
&& need_domain
&&
1061 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1063 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1065 ret
= LTTNG_ERR_KERN_NA
;
1070 /* Deny register consumer if we already have a spawned consumer. */
1071 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1072 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1073 if (the_kconsumer_data
.pid
> 0) {
1074 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1075 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1078 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1082 * Check for command that don't needs to allocate a returned payload. We do
1083 * this here so we don't have to make the call for no payload at each
1086 switch(cmd_ctx
->lsm
.cmd_type
) {
1087 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1088 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1089 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1090 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1091 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
1092 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1093 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1094 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
1095 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1096 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1097 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1098 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
1099 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
1100 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1101 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1102 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1105 /* Setup lttng message with no payload */
1106 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1108 /* This label does not try to unlock the session */
1109 goto init_setup_error
;
1113 /* Commands that DO NOT need a session. */
1114 switch (cmd_ctx
->lsm
.cmd_type
) {
1115 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
1116 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1117 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1118 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1119 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1120 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
1121 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
1122 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
1123 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
1124 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
1125 need_tracing_session
= false;
1128 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1130 * We keep the session list lock across _all_ commands
1131 * for now, because the per-session lock does not
1132 * handle teardown properly.
1134 session_lock_list();
1135 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1136 if (cmd_ctx
->session
== NULL
) {
1137 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1140 /* Acquire lock for the session */
1141 session_lock(cmd_ctx
->session
);
1147 * Commands that need a valid session but should NOT create one if none
1148 * exists. Instead of creating one and destroying it when the command is
1149 * handled, process that right before so we save some round trip in useless
1152 switch (cmd_ctx
->lsm
.cmd_type
) {
1153 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1154 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1155 switch (cmd_ctx
->lsm
.domain
.type
) {
1156 case LTTNG_DOMAIN_KERNEL
:
1157 if (!cmd_ctx
->session
->kernel_session
) {
1158 ret
= LTTNG_ERR_NO_CHANNEL
;
1162 case LTTNG_DOMAIN_JUL
:
1163 case LTTNG_DOMAIN_LOG4J
:
1164 case LTTNG_DOMAIN_PYTHON
:
1165 case LTTNG_DOMAIN_UST
:
1166 if (!cmd_ctx
->session
->ust_session
) {
1167 ret
= LTTNG_ERR_NO_CHANNEL
;
1172 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1184 * Check domain type for specific "pre-action".
1186 switch (cmd_ctx
->lsm
.domain
.type
) {
1187 case LTTNG_DOMAIN_KERNEL
:
1189 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1193 /* Kernel tracer check */
1194 if (!kernel_tracer_is_initialized()) {
1195 /* Basically, load kernel tracer modules */
1196 ret
= init_kernel_tracer();
1202 /* Consumer is in an ERROR state. Report back to client */
1203 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1205 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1209 /* Need a session for kernel command */
1210 if (need_tracing_session
) {
1211 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1212 ret
= create_kernel_session(cmd_ctx
->session
);
1213 if (ret
!= LTTNG_OK
) {
1214 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1219 /* Start the kernel consumer daemon */
1220 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1221 if (the_kconsumer_data
.pid
== 0 &&
1222 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1223 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1224 ret
= start_consumerd(&the_kconsumer_data
);
1226 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1229 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1231 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1235 * The consumer was just spawned so we need to add the socket to
1236 * the consumer output of the session if exist.
1238 ret
= consumer_create_socket(&the_kconsumer_data
,
1239 cmd_ctx
->session
->kernel_session
->consumer
);
1246 case LTTNG_DOMAIN_JUL
:
1247 case LTTNG_DOMAIN_LOG4J
:
1248 case LTTNG_DOMAIN_PYTHON
:
1249 if (!agent_tracing_is_enabled()) {
1250 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1254 case LTTNG_DOMAIN_UST
:
1256 if (!ust_app_supported()) {
1257 ret
= LTTNG_ERR_NO_UST
;
1261 /* Consumer is in an ERROR state. Report back to client */
1262 if (need_consumerd
&&
1263 uatomic_read(&the_ust_consumerd_state
) ==
1265 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1269 if (need_tracing_session
) {
1270 /* Create UST session if none exist. */
1271 if (cmd_ctx
->session
->ust_session
== NULL
) {
1272 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1273 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1274 if (ret
!= LTTNG_OK
) {
1279 /* Start the UST consumer daemons */
1281 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1282 if (the_config
.consumerd64_bin_path
.value
&&
1283 the_ustconsumer64_data
.pid
== 0 &&
1284 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1285 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1286 ret
= start_consumerd(&the_ustconsumer64_data
);
1288 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1289 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1293 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1294 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1296 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1300 * Setup socket for consumer 64 bit. No need for atomic access
1301 * since it was set above and can ONLY be set in this thread.
1303 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1304 cmd_ctx
->session
->ust_session
->consumer
);
1310 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1311 if (the_config
.consumerd32_bin_path
.value
&&
1312 the_ustconsumer32_data
.pid
== 0 &&
1313 cmd_ctx
->lsm
.cmd_type
!= LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
) {
1314 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1315 ret
= start_consumerd(&the_ustconsumer32_data
);
1317 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1318 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1322 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1323 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1325 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1329 * Setup socket for consumer 32 bit. No need for atomic access
1330 * since it was set above and can ONLY be set in this thread.
1332 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1333 cmd_ctx
->session
->ust_session
->consumer
);
1345 /* Validate consumer daemon state when start/stop trace command */
1346 if (cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_START_TRACE
||
1347 cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
) {
1348 switch (cmd_ctx
->lsm
.domain
.type
) {
1349 case LTTNG_DOMAIN_NONE
:
1351 case LTTNG_DOMAIN_JUL
:
1352 case LTTNG_DOMAIN_LOG4J
:
1353 case LTTNG_DOMAIN_PYTHON
:
1354 case LTTNG_DOMAIN_UST
:
1355 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1356 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1360 case LTTNG_DOMAIN_KERNEL
:
1361 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1362 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1367 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1373 * Check that the UID matches that of the tracing session.
1374 * The root user can interact with all sessions.
1376 if (need_tracing_session
) {
1377 if (!session_access_ok(cmd_ctx
->session
,
1378 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1379 cmd_ctx
->session
->destroyed
) {
1380 ret
= LTTNG_ERR_EPERM
;
1386 * Send relayd information to consumer as soon as we have a domain and a
1389 if (cmd_ctx
->session
&& need_domain
) {
1391 * Setup relayd if not done yet. If the relayd information was already
1392 * sent to the consumer, this call will gracefully return.
1394 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1395 if (ret
!= LTTNG_OK
) {
1400 /* Process by command type */
1401 switch (cmd_ctx
->lsm
.cmd_type
) {
1402 case LTTCOMM_SESSIOND_COMMAND_ADD_CONTEXT
:
1404 struct lttng_event_context
*event_context
= NULL
;
1405 const enum lttng_error_code ret_code
=
1406 receive_lttng_event_context(
1407 cmd_ctx
, *sock
, sock_error
, &event_context
);
1409 if (ret_code
!= LTTNG_OK
) {
1410 ret
= (int) ret_code
;
1414 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1415 lttng_event_context_destroy(event_context
);
1418 case LTTCOMM_SESSIOND_COMMAND_DISABLE_CHANNEL
:
1420 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1421 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1424 case LTTCOMM_SESSIOND_COMMAND_ENABLE_CHANNEL
:
1426 ret
= cmd_enable_channel(
1427 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1430 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1431 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1433 struct lttng_dynamic_buffer payload
;
1434 struct lttng_buffer_view payload_view
;
1435 const bool add_value
=
1436 cmd_ctx
->lsm
.cmd_type
==
1437 LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1438 const size_t name_len
=
1439 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1441 const enum lttng_domain_type domain_type
=
1442 (enum lttng_domain_type
)
1443 cmd_ctx
->lsm
.domain
.type
;
1444 const enum lttng_process_attr process_attr
=
1445 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1446 .process_attr_tracker_add_remove_include_value
1448 const enum lttng_process_attr_value_type value_type
=
1449 (enum lttng_process_attr_value_type
) cmd_ctx
1451 .process_attr_tracker_add_remove_include_value
1453 struct process_attr_value
*value
;
1454 enum lttng_error_code ret_code
;
1455 long login_name_max
;
1457 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1458 if (login_name_max
< 0) {
1459 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1460 ret
= LTTNG_ERR_INVALID
;
1464 /* Receive remaining variable length payload if applicable. */
1465 if (name_len
> login_name_max
) {
1467 * POSIX mandates user and group names that are at least
1468 * 8 characters long. Note that although shadow-utils
1469 * (useradd, groupaadd, etc.) use 32 chars as their
1470 * limit (from bits/utmp.h, UT_NAMESIZE),
1471 * LOGIN_NAME_MAX is defined to 256.
1473 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1474 add_value
? "addition" : "removal",
1475 name_len
, login_name_max
);
1476 ret
= LTTNG_ERR_INVALID
;
1480 lttng_dynamic_buffer_init(&payload
);
1481 if (name_len
!= 0) {
1483 * Receive variable payload for user/group name
1486 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1488 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1489 add_value
? "add" : "remove");
1490 ret
= LTTNG_ERR_NOMEM
;
1491 goto error_add_remove_tracker_value
;
1494 ret
= lttcomm_recv_unix_sock(
1495 *sock
, payload
.data
, name_len
);
1497 ERR("Failed to receive payload of %s process attribute tracker value argument",
1498 add_value
? "add" : "remove");
1500 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1501 goto error_add_remove_tracker_value
;
1505 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1506 &payload
, 0, name_len
);
1507 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1508 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1509 goto error_add_remove_tracker_value
;
1513 * Validate the value type and domains are legal for the process
1514 * attribute tracker that is specified and convert the value to
1515 * add/remove to the internal sessiond representation.
1517 ret_code
= process_attr_value_from_comm(domain_type
,
1518 process_attr
, value_type
,
1519 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1521 &payload_view
, &value
);
1522 if (ret_code
!= LTTNG_OK
) {
1524 goto error_add_remove_tracker_value
;
1528 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1529 cmd_ctx
->session
, domain_type
,
1530 process_attr
, value
);
1532 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1533 cmd_ctx
->session
, domain_type
,
1534 process_attr
, value
);
1536 process_attr_value_destroy(value
);
1537 error_add_remove_tracker_value
:
1538 lttng_dynamic_buffer_reset(&payload
);
1541 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_POLICY
:
1543 enum lttng_tracking_policy tracking_policy
;
1544 const enum lttng_domain_type domain_type
=
1545 (enum lttng_domain_type
)
1546 cmd_ctx
->lsm
.domain
.type
;
1547 const enum lttng_process_attr process_attr
=
1548 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1549 .process_attr_tracker_get_tracking_policy
1552 ret
= cmd_process_attr_tracker_get_tracking_policy(
1553 cmd_ctx
->session
, domain_type
, process_attr
,
1555 if (ret
!= LTTNG_OK
) {
1559 uint32_t tracking_policy_u32
= tracking_policy
;
1560 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1561 &tracking_policy_u32
, sizeof(uint32_t));
1563 ret
= LTTNG_ERR_NOMEM
;
1569 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_SET_POLICY
:
1571 const enum lttng_tracking_policy tracking_policy
=
1572 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1573 .process_attr_tracker_set_tracking_policy
1575 const enum lttng_domain_type domain_type
=
1576 (enum lttng_domain_type
)
1577 cmd_ctx
->lsm
.domain
.type
;
1578 const enum lttng_process_attr process_attr
=
1579 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1580 .process_attr_tracker_set_tracking_policy
1583 ret
= cmd_process_attr_tracker_set_tracking_policy(
1584 cmd_ctx
->session
, domain_type
, process_attr
,
1586 if (ret
!= LTTNG_OK
) {
1591 case LTTCOMM_SESSIOND_COMMAND_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1593 struct lttng_process_attr_values
*values
;
1594 struct lttng_dynamic_buffer reply
;
1595 const enum lttng_domain_type domain_type
=
1596 (enum lttng_domain_type
)
1597 cmd_ctx
->lsm
.domain
.type
;
1598 const enum lttng_process_attr process_attr
=
1599 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1600 .process_attr_tracker_get_inclusion_set
1603 ret
= cmd_process_attr_tracker_get_inclusion_set(
1604 cmd_ctx
->session
, domain_type
, process_attr
,
1606 if (ret
!= LTTNG_OK
) {
1610 lttng_dynamic_buffer_init(&reply
);
1611 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1613 goto error_tracker_get_inclusion_set
;
1616 ret
= setup_lttng_msg_no_cmd_header(
1617 cmd_ctx
, reply
.data
, reply
.size
);
1619 ret
= LTTNG_ERR_NOMEM
;
1620 goto error_tracker_get_inclusion_set
;
1624 error_tracker_get_inclusion_set
:
1625 lttng_process_attr_values_destroy(values
);
1626 lttng_dynamic_buffer_reset(&reply
);
1629 case LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
:
1630 case LTTCOMM_SESSIOND_COMMAND_DISABLE_EVENT
:
1632 struct lttng_event
*event
;
1633 char *filter_expression
;
1634 struct lttng_event_exclusion
*exclusions
;
1635 struct lttng_bytecode
*bytecode
;
1636 const enum lttng_error_code ret_code
= receive_lttng_event(
1637 cmd_ctx
, *sock
, sock_error
, &event
,
1638 &filter_expression
, &bytecode
, &exclusions
);
1640 if (ret_code
!= LTTNG_OK
) {
1641 ret
= (int) ret_code
;
1646 * Ownership of filter_expression, exclusions, and bytecode is
1647 * always transferred.
1649 ret
= cmd_ctx
->lsm
.cmd_type
== LTTCOMM_SESSIOND_COMMAND_ENABLE_EVENT
?
1650 cmd_enable_event(cmd_ctx
, event
,
1651 filter_expression
, exclusions
,
1653 the_kernel_poll_pipe
[1]) :
1654 cmd_disable_event(cmd_ctx
, event
,
1655 filter_expression
, bytecode
,
1657 lttng_event_destroy(event
);
1660 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINTS
:
1662 enum lttng_error_code ret_code
;
1663 size_t original_payload_size
;
1664 size_t payload_size
;
1665 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1667 ret
= setup_empty_lttng_msg(cmd_ctx
);
1669 ret
= LTTNG_ERR_NOMEM
;
1673 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1675 session_lock_list();
1676 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1677 &cmd_ctx
->reply_payload
);
1678 session_unlock_list();
1679 if (ret_code
!= LTTNG_OK
) {
1680 ret
= (int) ret_code
;
1684 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1685 command_header_size
- original_payload_size
;
1686 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1691 case LTTCOMM_SESSIOND_COMMAND_LIST_TRACEPOINT_FIELDS
:
1693 enum lttng_error_code ret_code
;
1694 size_t original_payload_size
;
1695 size_t payload_size
;
1696 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1698 ret
= setup_empty_lttng_msg(cmd_ctx
);
1700 ret
= LTTNG_ERR_NOMEM
;
1704 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1706 session_lock_list();
1707 ret_code
= cmd_list_tracepoint_fields(
1708 cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1709 session_unlock_list();
1710 if (ret_code
!= LTTNG_OK
) {
1711 ret
= (int) ret_code
;
1715 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1716 command_header_size
- original_payload_size
;
1717 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1722 case LTTCOMM_SESSIOND_COMMAND_LIST_SYSCALLS
:
1724 enum lttng_error_code ret_code
;
1725 size_t original_payload_size
;
1726 size_t payload_size
;
1727 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1729 ret
= setup_empty_lttng_msg(cmd_ctx
);
1731 ret
= LTTNG_ERR_NOMEM
;
1735 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1737 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1738 if (ret_code
!= LTTNG_OK
) {
1739 ret
= (int) ret_code
;
1743 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1744 command_header_size
- original_payload_size
;
1745 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1750 case LTTCOMM_SESSIOND_COMMAND_SET_CONSUMER_URI
:
1753 struct lttng_uri
*uris
;
1755 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1756 len
= nb_uri
* sizeof(struct lttng_uri
);
1759 ret
= LTTNG_ERR_INVALID
;
1763 uris
= calloc
<lttng_uri
>(nb_uri
);
1765 ret
= LTTNG_ERR_FATAL
;
1769 /* Receive variable len data */
1770 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1771 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1773 DBG("No URIs received from client... continuing");
1775 ret
= LTTNG_ERR_SESSION_FAIL
;
1780 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1782 if (ret
!= LTTNG_OK
) {
1789 case LTTCOMM_SESSIOND_COMMAND_START_TRACE
:
1792 * On the first start, if we have a kernel session and we have
1793 * enabled time or size-based rotations, we have to make sure
1794 * the kernel tracer supports it.
1796 if (!cmd_ctx
->session
->has_been_started
&& \
1797 cmd_ctx
->session
->kernel_session
&& \
1798 (cmd_ctx
->session
->rotate_timer_period
|| \
1799 cmd_ctx
->session
->rotate_size
) && \
1800 !check_rotate_compatible()) {
1801 DBG("Kernel tracer version is not compatible with the rotation feature");
1802 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1805 ret
= cmd_start_trace(cmd_ctx
->session
);
1808 case LTTCOMM_SESSIOND_COMMAND_STOP_TRACE
:
1810 ret
= cmd_stop_trace(cmd_ctx
->session
);
1813 case LTTCOMM_SESSIOND_COMMAND_DESTROY_SESSION
:
1815 ret
= cmd_destroy_session(cmd_ctx
->session
,
1816 the_notification_thread_handle
, sock
);
1819 case LTTCOMM_SESSIOND_COMMAND_LIST_DOMAINS
:
1822 struct lttng_domain
*domains
= NULL
;
1824 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1826 /* Return value is a negative lttng_error_code. */
1831 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1832 nb_dom
* sizeof(struct lttng_domain
));
1842 case LTTCOMM_SESSIOND_COMMAND_LIST_CHANNELS
:
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_channels(cmd_ctx
->lsm
.domain
.type
,
1858 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1859 if (ret_code
!= LTTNG_OK
) {
1860 ret
= (int) ret_code
;
1864 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1865 command_header_size
- original_payload_size
;
1866 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1871 case LTTCOMM_SESSIOND_COMMAND_LIST_EVENTS
:
1873 enum lttng_error_code ret_code
;
1874 size_t original_payload_size
;
1875 size_t payload_size
;
1876 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1878 ret
= setup_empty_lttng_msg(cmd_ctx
);
1880 ret
= LTTNG_ERR_NOMEM
;
1884 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1886 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1888 cmd_ctx
->lsm
.u
.list
.channel_name
, &cmd_ctx
->reply_payload
);
1889 if (ret_code
!= LTTNG_OK
) {
1890 ret
= (int) ret_code
;
1894 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1895 command_header_size
- original_payload_size
;
1896 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1901 case LTTCOMM_SESSIOND_COMMAND_LIST_SESSIONS
:
1903 unsigned int nr_sessions
;
1904 lttng_session
*sessions_payload
= nullptr;
1905 size_t payload_len
= 0;
1907 session_lock_list();
1908 nr_sessions
= lttng_sessions_count(
1909 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1910 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1912 if (nr_sessions
> 0) {
1913 payload_len
= (sizeof(struct lttng_session
) *
1915 (sizeof(struct lttng_session_extended
) *
1917 sessions_payload
= zmalloc
<lttng_session
>(payload_len
);
1918 if (!sessions_payload
) {
1919 session_unlock_list();
1924 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1925 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1926 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1929 session_unlock_list();
1931 ret
= setup_lttng_msg_no_cmd_header(
1932 cmd_ctx
, sessions_payload
, payload_len
);
1933 free(sessions_payload
);
1942 case LTTCOMM_SESSIOND_COMMAND_REGISTER_CONSUMER
:
1944 struct consumer_data
*cdata
;
1946 switch (cmd_ctx
->lsm
.domain
.type
) {
1947 case LTTNG_DOMAIN_KERNEL
:
1948 cdata
= &the_kconsumer_data
;
1951 ret
= LTTNG_ERR_UND
;
1955 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1956 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1959 case LTTCOMM_SESSIOND_COMMAND_DATA_PENDING
:
1962 uint8_t pending_ret_byte
;
1964 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1969 * This function may returns 0 or 1 to indicate whether or not
1970 * there is data pending. In case of error, it should return an
1971 * LTTNG_ERR code. However, some code paths may still return
1972 * a nondescript error code, which we handle by returning an
1975 if (pending_ret
== 0 || pending_ret
== 1) {
1977 * ret will be set to LTTNG_OK at the end of
1980 } else if (pending_ret
< 0) {
1981 ret
= LTTNG_ERR_UNK
;
1988 pending_ret_byte
= (uint8_t) pending_ret
;
1990 /* 1 byte to return whether or not data is pending */
1991 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1992 &pending_ret_byte
, 1);
2001 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_ADD_OUTPUT
:
2003 uint32_t snapshot_id
;
2004 struct lttcomm_lttng_output_id reply
;
2005 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
2007 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
2010 if (ret
!= LTTNG_OK
) {
2013 reply
.id
= snapshot_id
;
2015 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2021 /* Copy output list into message payload */
2025 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_DEL_OUTPUT
:
2027 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
2028 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
2031 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_LIST_OUTPUT
:
2034 struct lttng_snapshot_output
*outputs
= NULL
;
2036 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2037 if (nb_output
< 0) {
2042 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2043 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2044 nb_output
* sizeof(struct lttng_snapshot_output
));
2054 case LTTCOMM_SESSIOND_COMMAND_SNAPSHOT_RECORD
:
2056 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2057 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2058 &output
, 0); // RFC: set to zero since it's ignored by cmd_snapshot_record
2061 case LTTCOMM_SESSIOND_COMMAND_CREATE_SESSION_EXT
:
2063 struct lttng_dynamic_buffer payload
;
2064 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2066 lttng_dynamic_buffer_init(&payload
);
2067 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2068 if (ret
!= LTTNG_OK
) {
2072 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2075 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2076 lttng_session_descriptor_destroy(return_descriptor
);
2077 ret
= LTTNG_ERR_NOMEM
;
2080 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2083 lttng_session_descriptor_destroy(return_descriptor
);
2084 ret
= LTTNG_ERR_NOMEM
;
2087 lttng_dynamic_buffer_reset(&payload
);
2088 lttng_session_descriptor_destroy(return_descriptor
);
2092 case LTTCOMM_SESSIOND_COMMAND_SAVE_SESSION
:
2094 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2098 case LTTCOMM_SESSIOND_COMMAND_SET_SESSION_SHM_PATH
:
2100 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2101 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2104 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_METADATA
:
2106 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2109 case LTTCOMM_SESSIOND_COMMAND_REGENERATE_STATEDUMP
:
2111 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2114 case LTTCOMM_SESSIOND_COMMAND_REGISTER_TRIGGER
:
2116 struct lttng_trigger
*payload_trigger
;
2117 struct lttng_trigger
*return_trigger
;
2118 size_t original_reply_payload_size
;
2119 size_t reply_payload_size
;
2120 const struct lttng_credentials cmd_creds
= {
2121 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2122 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2125 ret
= setup_empty_lttng_msg(cmd_ctx
);
2127 ret
= LTTNG_ERR_NOMEM
;
2131 ret
= receive_lttng_trigger(
2132 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2133 if (ret
!= LTTNG_OK
) {
2137 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2139 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2140 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2141 the_notification_thread_handle
,
2143 if (ret
!= LTTNG_OK
) {
2144 lttng_trigger_put(payload_trigger
);
2148 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2149 lttng_trigger_put(payload_trigger
);
2150 lttng_trigger_put(return_trigger
);
2152 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2153 ret
= LTTNG_ERR_NOMEM
;
2157 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2158 original_reply_payload_size
;
2160 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2165 case LTTCOMM_SESSIOND_COMMAND_UNREGISTER_TRIGGER
:
2167 struct lttng_trigger
*payload_trigger
;
2168 const struct lttng_credentials cmd_creds
= {
2169 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2170 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2173 ret
= receive_lttng_trigger(
2174 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2175 if (ret
!= LTTNG_OK
) {
2179 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2180 the_notification_thread_handle
);
2181 lttng_trigger_put(payload_trigger
);
2184 case LTTCOMM_SESSIOND_COMMAND_ROTATE_SESSION
:
2186 struct lttng_rotate_session_return rotate_return
;
2188 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2190 memset(&rotate_return
, 0, sizeof(rotate_return
));
2191 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2192 DBG("Kernel tracer version is not compatible with the rotation feature");
2193 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2197 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2199 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2205 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2206 sizeof(rotate_return
));
2215 case LTTCOMM_SESSIOND_COMMAND_ROTATION_GET_INFO
:
2217 struct lttng_rotation_get_info_return get_info_return
;
2219 memset(&get_info_return
, 0, sizeof(get_info_return
));
2220 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2221 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2227 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2228 sizeof(get_info_return
));
2237 case LTTCOMM_SESSIOND_COMMAND_ROTATION_SET_SCHEDULE
:
2240 enum lttng_rotation_schedule_type schedule_type
;
2243 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2244 DBG("Kernel tracer version does not support session rotations");
2245 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2249 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2250 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2251 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2253 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2254 schedule_type
, value
,
2255 the_notification_thread_handle
);
2256 if (ret
!= LTTNG_OK
) {
2262 case LTTCOMM_SESSIOND_COMMAND_SESSION_LIST_ROTATION_SCHEDULES
:
2264 lttng_session_list_schedules_return schedules
;
2266 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2267 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2268 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2269 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2271 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2281 case LTTCOMM_SESSIOND_COMMAND_CLEAR_SESSION
:
2283 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2286 case LTTCOMM_SESSIOND_COMMAND_LIST_TRIGGERS
:
2288 struct lttng_triggers
*return_triggers
= NULL
;
2289 size_t original_payload_size
;
2290 size_t payload_size
;
2292 ret
= setup_empty_lttng_msg(cmd_ctx
);
2294 ret
= LTTNG_ERR_NOMEM
;
2298 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2300 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2302 if (ret
!= LTTNG_OK
) {
2306 LTTNG_ASSERT(return_triggers
);
2307 ret
= lttng_triggers_serialize(
2308 return_triggers
, &cmd_ctx
->reply_payload
);
2309 lttng_triggers_destroy(return_triggers
);
2311 ERR("Failed to serialize triggers in reply to `list triggers` command");
2312 ret
= LTTNG_ERR_NOMEM
;
2316 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2317 original_payload_size
;
2319 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2324 case LTTCOMM_SESSIOND_COMMAND_EXECUTE_ERROR_QUERY
:
2326 struct lttng_error_query
*query
;
2327 const struct lttng_credentials cmd_creds
= {
2328 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2329 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2331 struct lttng_error_query_results
*results
= NULL
;
2332 size_t original_payload_size
;
2333 size_t payload_size
;
2335 ret
= setup_empty_lttng_msg(cmd_ctx
);
2337 ret
= LTTNG_ERR_NOMEM
;
2341 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2343 ret
= receive_lttng_error_query(
2344 cmd_ctx
, *sock
, sock_error
, &query
);
2345 if (ret
!= LTTNG_OK
) {
2349 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2350 the_notification_thread_handle
);
2351 lttng_error_query_destroy(query
);
2352 if (ret
!= LTTNG_OK
) {
2356 LTTNG_ASSERT(results
);
2357 ret
= lttng_error_query_results_serialize(
2358 results
, &cmd_ctx
->reply_payload
);
2359 lttng_error_query_results_destroy(results
);
2361 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2362 ret
= LTTNG_ERR_NOMEM
;
2366 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2367 original_payload_size
;
2369 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2376 ret
= LTTNG_ERR_UND
;
2381 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2382 DBG("Missing llm header, creating one.");
2383 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2387 /* Set return code */
2388 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2390 if (cmd_ctx
->session
) {
2391 session_unlock(cmd_ctx
->session
);
2392 session_put(cmd_ctx
->session
);
2393 cmd_ctx
->session
= NULL
;
2395 if (need_tracing_session
) {
2396 session_unlock_list();
2399 LTTNG_ASSERT(!rcu_read_ongoing());
2403 static int create_client_sock(void)
2405 int ret
, client_sock
;
2407 /* Create client tool unix socket */
2408 client_sock
= lttcomm_create_unix_sock(
2409 the_config
.client_unix_sock_path
.value
);
2410 if (client_sock
< 0) {
2411 ERR("Create unix sock failed: %s",
2412 the_config
.client_unix_sock_path
.value
);
2417 /* Set the cloexec flag */
2418 ret
= utils_set_fd_cloexec(client_sock
);
2420 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2421 "Continuing but note that the consumer daemon will have a "
2422 "reference to this socket on exec()", client_sock
);
2425 /* File permission MUST be 660 */
2426 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2427 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2429 ERR("Set file permissions failed: %s",
2430 the_config
.client_unix_sock_path
.value
);
2432 (void) lttcomm_close_unix_sock(client_sock
);
2436 DBG("Created client socket (fd = %i)", client_sock
);
2442 static void cleanup_client_thread(void *data
)
2444 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2446 lttng_pipe_destroy(quit_pipe
);
2449 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2451 set_thread_status(false);
2455 * This thread manage all clients request using the unix client socket for
2458 static void *thread_manage_clients(void *data
)
2460 int sock
= -1, ret
, i
, err
= -1;
2463 struct lttng_poll_event events
;
2464 const int client_sock
= thread_state
.client_sock
;
2465 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2466 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2467 struct command_ctx cmd_ctx
= {};
2469 DBG("[thread] Manage client started");
2471 lttng_payload_init(&cmd_ctx
.reply_payload
);
2473 is_root
= (getuid() == 0);
2475 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2477 rcu_register_thread();
2479 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2481 health_code_update();
2483 ret
= lttcomm_listen_unix_sock(client_sock
);
2489 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2490 * more will be added to this poll set.
2492 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2494 goto error_create_poll
;
2497 /* Add the application registration socket */
2498 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2503 /* Add thread quit pipe */
2504 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2509 /* Set state as running. */
2510 set_thread_status(true);
2511 pthread_cleanup_pop(0);
2513 /* This testpoint is after we signal readiness to the parent. */
2514 if (testpoint(sessiond_thread_manage_clients
)) {
2518 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2522 health_code_update();
2525 const struct cmd_completion_handler
*cmd_completion_handler
;
2527 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2528 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2529 cmd_ctx
.creds
.pid
= 0;
2530 cmd_ctx
.session
= NULL
;
2531 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2532 cmd_ctx
.lttng_msg_size
= 0;
2534 DBG("Accepting client command ...");
2536 /* Inifinite blocking call, waiting for transmission */
2538 health_poll_entry();
2539 ret
= lttng_poll_wait(&events
, -1);
2543 * Restart interrupted system call.
2545 if (errno
== EINTR
) {
2553 for (i
= 0; i
< nb_fd
; i
++) {
2554 /* Fetch once the poll data. */
2555 const auto revents
= LTTNG_POLL_GETEV(&events
, i
);
2556 const auto pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2558 health_code_update();
2560 /* Activity on thread quit pipe, exiting. */
2561 if (pollfd
== thread_quit_pipe_fd
) {
2562 DBG("Activity on thread quit pipe");
2567 /* Event on the registration socket */
2568 if (revents
& LPOLLIN
) {
2570 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2571 ERR("Client socket poll error");
2574 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2579 DBG("Wait for client response");
2581 health_code_update();
2583 sock
= lttcomm_accept_unix_sock(client_sock
);
2589 * Set the CLOEXEC flag. Return code is useless because either way, the
2592 (void) utils_set_fd_cloexec(sock
);
2594 /* Set socket option for credentials retrieval */
2595 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2600 health_code_update();
2603 * Data is received from the lttng client. The struct
2604 * lttcomm_session_msg (lsm) contains the command and data request of
2607 DBG("Receiving data from client ...");
2608 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2609 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2610 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2611 DBG("Incomplete recv() from client... continuing");
2620 health_code_update();
2622 // TODO: Validate cmd_ctx including sanity check for
2623 // security purpose.
2625 rcu_thread_online();
2627 * This function dispatch the work to the kernel or userspace tracer
2628 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2629 * informations for the client. The command context struct contains
2630 * everything this function may needs.
2632 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2633 rcu_thread_offline();
2643 * TODO: Inform client somehow of the fatal error. At
2644 * this point, ret < 0 means that a zmalloc failed
2645 * (ENOMEM). Error detected but still accept
2646 * command, unless a socket error has been
2652 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2653 WARN("Command returned an invalid status code, returning unknown error: "
2654 "command type = %s (%d), ret = %d",
2655 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2656 cmd_ctx
.lsm
.cmd_type
, ret
);
2657 ret
= LTTNG_ERR_UNK
;
2660 cmd_completion_handler
= cmd_pop_completion_handler();
2661 if (cmd_completion_handler
) {
2662 enum lttng_error_code completion_code
;
2664 completion_code
= cmd_completion_handler
->run(
2665 cmd_completion_handler
->data
);
2666 if (completion_code
!= LTTNG_OK
) {
2671 health_code_update();
2674 struct lttng_payload_view view
=
2675 lttng_payload_view_from_payload(
2676 &cmd_ctx
.reply_payload
,
2678 struct lttcomm_lttng_msg
*llm
= (typeof(
2679 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2681 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2682 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2684 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2686 DBG("Sending response (size: %d, retcode: %s (%d))",
2687 cmd_ctx
.lttng_msg_size
,
2688 lttng_strerror(-llm
->ret_code
),
2690 ret
= send_unix_sock(sock
, &view
);
2692 ERR("Failed to send data back to client");
2695 /* End of transmission */
2703 health_code_update();
2715 lttng_poll_clean(&events
);
2719 unlink(the_config
.client_unix_sock_path
.value
);
2720 ret
= close(client_sock
);
2727 ERR("Health error occurred in %s", __func__
);
2730 health_unregister(the_health_sessiond
);
2732 DBG("Client thread dying");
2733 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2734 rcu_unregister_thread();
2739 bool shutdown_client_thread(void *thread_data
)
2741 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2742 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2744 return notify_thread_pipe(write_fd
) == 1;
2747 struct lttng_thread
*launch_client_thread(void)
2749 bool thread_running
;
2750 struct lttng_pipe
*client_quit_pipe
;
2751 struct lttng_thread
*thread
= NULL
;
2752 int client_sock_fd
= -1;
2754 sem_init(&thread_state
.ready
, 0, 0);
2755 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2756 if (!client_quit_pipe
) {
2760 client_sock_fd
= create_client_sock();
2761 if (client_sock_fd
< 0) {
2765 thread_state
.client_sock
= client_sock_fd
;
2766 thread
= lttng_thread_create("Client management",
2767 thread_manage_clients
,
2768 shutdown_client_thread
,
2769 cleanup_client_thread
,
2774 /* The client thread now owns the client sock fd and the quit pipe. */
2775 client_sock_fd
= -1;
2776 client_quit_pipe
= NULL
;
2779 * This thread is part of the threads that need to be fully
2780 * initialized before the session daemon is marked as "ready".
2782 thread_running
= wait_thread_status();
2783 if (!thread_running
) {
2788 if (client_sock_fd
>= 0) {
2789 if (close(client_sock_fd
)) {
2790 PERROR("Failed to close client socket");
2793 lttng_thread_put(thread
);
2794 cleanup_client_thread(client_quit_pipe
);