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
) {
538 lus
->trace_format
= session
->trace_format
;
544 session
->ust_session
= NULL
;
549 * Create a kernel tracer session then create the default channel.
551 static int create_kernel_session(struct ltt_session
*session
)
555 DBG("Creating kernel session");
557 ret
= kernel_create_session(session
);
559 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
563 /* Code flow safety */
564 LTTNG_ASSERT(session
->kernel_session
);
566 /* Copy session output to the newly created Kernel session */
567 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
568 if (ret
!= LTTNG_OK
) {
572 session
->kernel_session
->uid
= session
->uid
;
573 session
->kernel_session
->gid
= session
->gid
;
574 session
->kernel_session
->output_traces
= session
->output_traces
;
575 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
576 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
581 trace_kernel_destroy_session(session
->kernel_session
);
582 session
->kernel_session
= NULL
;
587 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
590 struct lttng_trigger
**_trigger
)
594 ssize_t sock_recv_len
;
595 enum lttng_error_code ret_code
;
596 struct lttng_payload trigger_payload
;
597 struct lttng_trigger
*trigger
= NULL
;
599 lttng_payload_init(&trigger_payload
);
600 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
601 ret
= lttng_dynamic_buffer_set_size(
602 &trigger_payload
.buffer
, trigger_len
);
604 ret_code
= LTTNG_ERR_NOMEM
;
608 sock_recv_len
= lttcomm_recv_unix_sock(
609 sock
, trigger_payload
.buffer
.data
, trigger_len
);
610 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
611 ERR("Failed to receive trigger in command payload");
613 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
617 /* Receive fds, if any. */
618 if (cmd_ctx
->lsm
.fd_count
> 0) {
619 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
620 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
621 if (sock_recv_len
> 0 &&
622 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
623 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
624 cmd_ctx
->lsm
.fd_count
, (int) ret
);
625 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
628 } else if (sock_recv_len
<= 0) {
629 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
630 cmd_ctx
->lsm
.fd_count
, (int) ret
);
631 ret_code
= LTTNG_ERR_FATAL
;
637 /* Deserialize trigger. */
639 struct lttng_payload_view view
=
640 lttng_payload_view_from_payload(
641 &trigger_payload
, 0, -1);
643 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
645 ERR("Invalid trigger received as part of command payload");
646 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
647 lttng_trigger_put(trigger
);
656 lttng_payload_reset(&trigger_payload
);
660 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
663 struct lttng_error_query
**_query
)
667 ssize_t sock_recv_len
;
668 enum lttng_error_code ret_code
;
669 struct lttng_payload query_payload
;
670 struct lttng_error_query
*query
= NULL
;
672 lttng_payload_init(&query_payload
);
673 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
674 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
676 ret_code
= LTTNG_ERR_NOMEM
;
680 sock_recv_len
= lttcomm_recv_unix_sock(
681 sock
, query_payload
.buffer
.data
, query_len
);
682 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
683 ERR("Failed to receive error query in command payload");
685 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
689 /* Receive fds, if any. */
690 if (cmd_ctx
->lsm
.fd_count
> 0) {
691 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
692 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
693 if (sock_recv_len
> 0 &&
694 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
695 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
696 cmd_ctx
->lsm
.fd_count
, (int) ret
);
697 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
700 } else if (sock_recv_len
<= 0) {
701 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
702 cmd_ctx
->lsm
.fd_count
, (int) ret
);
703 ret_code
= LTTNG_ERR_FATAL
;
709 /* Deserialize error query. */
711 struct lttng_payload_view view
=
712 lttng_payload_view_from_payload(
713 &query_payload
, 0, -1);
715 if (lttng_error_query_create_from_payload(&view
, &query
) !=
717 ERR("Invalid error query received as part of command payload");
718 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
727 lttng_payload_reset(&query_payload
);
731 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
734 struct lttng_event
**out_event
,
735 char **out_filter_expression
,
736 struct lttng_bytecode
**out_bytecode
,
737 struct lttng_event_exclusion
**out_exclusion
)
741 ssize_t sock_recv_len
;
742 enum lttng_error_code ret_code
;
743 struct lttng_payload event_payload
;
744 struct lttng_event
*local_event
= NULL
;
745 char *local_filter_expression
= NULL
;
746 struct lttng_bytecode
*local_bytecode
= NULL
;
747 struct lttng_event_exclusion
*local_exclusion
= NULL
;
749 lttng_payload_init(&event_payload
);
750 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
) {
751 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
752 } else if (cmd_ctx
->lsm
.cmd_type
== LTTNG_DISABLE_EVENT
) {
753 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
758 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
760 ret_code
= LTTNG_ERR_NOMEM
;
764 sock_recv_len
= lttcomm_recv_unix_sock(
765 sock
, event_payload
.buffer
.data
, event_len
);
766 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
767 ERR("Failed to receive event in command payload");
769 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
773 /* Receive fds, if any. */
774 if (cmd_ctx
->lsm
.fd_count
> 0) {
775 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
776 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
777 if (sock_recv_len
> 0 &&
778 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
779 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
780 cmd_ctx
->lsm
.fd_count
, (int) ret
);
781 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
784 } else if (sock_recv_len
<= 0) {
785 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
786 cmd_ctx
->lsm
.fd_count
, (int) ret
);
787 ret_code
= LTTNG_ERR_FATAL
;
793 /* Deserialize event. */
796 struct lttng_payload_view event_view
=
797 lttng_payload_view_from_payload(
798 &event_payload
, 0, -1);
800 len
= lttng_event_create_from_payload(&event_view
, &local_event
,
801 &local_exclusion
, &local_filter_expression
,
805 ERR("Failed to create an event from the received buffer");
806 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
810 if (len
!= event_len
) {
811 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
", payload length = %zd", event_len
, len
);
812 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
817 *out_event
= local_event
;
818 *out_exclusion
= local_exclusion
;
819 *out_filter_expression
= local_filter_expression
;
820 *out_bytecode
= local_bytecode
;
822 local_exclusion
= NULL
;
823 local_filter_expression
= NULL
;
824 local_bytecode
= NULL
;
829 lttng_payload_reset(&event_payload
);
830 lttng_event_destroy(local_event
);
831 free(local_filter_expression
);
832 free(local_bytecode
);
833 free(local_exclusion
);
837 static enum lttng_error_code
receive_lttng_event_context(
838 const struct command_ctx
*cmd_ctx
,
841 struct lttng_event_context
**out_event_context
)
844 const size_t event_context_len
=
845 (size_t) cmd_ctx
->lsm
.u
.context
.length
;
846 ssize_t sock_recv_len
;
847 enum lttng_error_code ret_code
;
848 struct lttng_payload event_context_payload
;
849 struct lttng_event_context
*context
= NULL
;
851 lttng_payload_init(&event_context_payload
);
853 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
,
856 ret_code
= LTTNG_ERR_NOMEM
;
860 sock_recv_len
= lttcomm_recv_unix_sock(
861 sock
, event_context_payload
.buffer
.data
,
863 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
864 ERR("Failed to receive event context in command payload");
866 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
870 /* Deserialize event. */
873 struct lttng_payload_view event_context_view
=
874 lttng_payload_view_from_payload(
875 &event_context_payload
, 0, -1);
877 len
= lttng_event_context_create_from_payload(
878 &event_context_view
, &context
);
881 ERR("Failed to create a event context from the received buffer");
882 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
886 if (len
!= event_context_len
) {
887 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd", event_context_len
, len
);
888 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
893 *out_event_context
= context
;
898 lttng_event_context_destroy(context
);
899 lttng_payload_reset(&event_context_payload
);
904 * Version of setup_lttng_msg() without command header.
906 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
907 void *payload_buf
, size_t payload_len
)
909 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
913 * Check if the current kernel tracer supports the session rotation feature.
914 * Return 1 if it does, 0 otherwise.
916 static int check_rotate_compatible(void)
920 if (the_kernel_tracer_version
.major
!= 2 ||
921 the_kernel_tracer_version
.minor
< 11) {
922 DBG("Kernel tracer version is not compatible with the rotation feature");
930 * Send data on a unix socket using the liblttsessiondcomm API.
932 * Return lttcomm error code.
934 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
937 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
939 /* Check valid length */
940 if (view
->buffer
.size
== 0) {
945 ret
= lttcomm_send_unix_sock(
946 sock
, view
->buffer
.data
, view
->buffer
.size
);
952 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
963 * Process the command requested by the lttng client within the command
964 * context structure. This function make sure that the return structure (llm)
965 * is set and ready for transmission before returning.
967 * Return any error encountered or 0 for success.
969 * "sock" is only used for special-case var. len data.
970 * A command may assume the ownership of the socket, in which case its value
971 * should be set to -1.
973 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
977 bool need_tracing_session
= true;
981 DBG("Processing client command '%s\' (%d)",
982 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
983 cmd_ctx
->lsm
.cmd_type
);
987 switch (cmd_ctx
->lsm
.cmd_type
) {
988 case LTTNG_CREATE_SESSION_EXT
:
989 case LTTNG_DESTROY_SESSION
:
990 case LTTNG_LIST_SESSIONS
:
991 case LTTNG_LIST_DOMAINS
:
992 case LTTNG_START_TRACE
:
993 case LTTNG_STOP_TRACE
:
994 case LTTNG_DATA_PENDING
:
995 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
996 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
997 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
998 case LTTNG_SNAPSHOT_RECORD
:
999 case LTTNG_SAVE_SESSION
:
1000 case LTTNG_SET_SESSION_SHM_PATH
:
1001 case LTTNG_REGENERATE_METADATA
:
1002 case LTTNG_REGENERATE_STATEDUMP
:
1003 case LTTNG_ROTATE_SESSION
:
1004 case LTTNG_ROTATION_GET_INFO
:
1005 case LTTNG_ROTATION_SET_SCHEDULE
:
1006 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1007 case LTTNG_CLEAR_SESSION
:
1008 case LTTNG_LIST_TRIGGERS
:
1009 case LTTNG_EXECUTE_ERROR_QUERY
:
1010 need_domain
= false;
1012 case LTTNG_EXECUTE_TRACE_FORMAT_SUPPORT_QUERY
:
1013 need_domain
= cmd_ctx
->lsm
.u
.trace_format_support_query
.query_type
== 0;
1019 /* Needs a functioning consumerd? */
1020 switch (cmd_ctx
->lsm
.cmd_type
) {
1021 case LTTNG_REGISTER_TRIGGER
:
1022 case LTTNG_UNREGISTER_TRIGGER
:
1023 case LTTNG_EXECUTE_ERROR_QUERY
:
1024 case LTTNG_EXECUTE_TRACE_FORMAT_SUPPORT_QUERY
:
1025 need_consumerd
= false;
1028 need_consumerd
= true;
1032 if (the_config
.no_kernel
&& need_domain
&&
1033 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1035 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1037 ret
= LTTNG_ERR_KERN_NA
;
1042 /* Deny register consumer if we already have a spawned consumer. */
1043 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
1044 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1045 if (the_kconsumer_data
.pid
> 0) {
1046 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1047 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1050 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1054 * Check for command that don't needs to allocate a returned payload. We do
1055 * this here so we don't have to make the call for no payload at each
1058 switch(cmd_ctx
->lsm
.cmd_type
) {
1059 case LTTNG_LIST_SESSIONS
:
1060 case LTTNG_LIST_TRACEPOINTS
:
1061 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1062 case LTTNG_LIST_DOMAINS
:
1063 case LTTNG_LIST_CHANNELS
:
1064 case LTTNG_LIST_EVENTS
:
1065 case LTTNG_LIST_SYSCALLS
:
1066 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1067 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1068 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1069 case LTTNG_DATA_PENDING
:
1070 case LTTNG_ROTATE_SESSION
:
1071 case LTTNG_ROTATION_GET_INFO
:
1072 case LTTNG_REGISTER_TRIGGER
:
1073 case LTTNG_LIST_TRIGGERS
:
1074 case LTTNG_EXECUTE_ERROR_QUERY
:
1077 /* Setup lttng message with no payload */
1078 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1080 /* This label does not try to unlock the session */
1081 goto init_setup_error
;
1085 /* Commands that DO NOT need a session. */
1086 switch (cmd_ctx
->lsm
.cmd_type
) {
1087 case LTTNG_CREATE_SESSION_EXT
:
1088 case LTTNG_LIST_SESSIONS
:
1089 case LTTNG_LIST_TRACEPOINTS
:
1090 case LTTNG_LIST_SYSCALLS
:
1091 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1092 case LTTNG_SAVE_SESSION
:
1093 case LTTNG_REGISTER_TRIGGER
:
1094 case LTTNG_UNREGISTER_TRIGGER
:
1095 case LTTNG_LIST_TRIGGERS
:
1096 case LTTNG_EXECUTE_ERROR_QUERY
:
1097 case LTTNG_EXECUTE_TRACE_FORMAT_SUPPORT_QUERY
:
1098 need_tracing_session
= false;
1101 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1103 * We keep the session list lock across _all_ commands
1104 * for now, because the per-session lock does not
1105 * handle teardown properly.
1107 session_lock_list();
1108 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1109 if (cmd_ctx
->session
== NULL
) {
1110 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1113 /* Acquire lock for the session */
1114 session_lock(cmd_ctx
->session
);
1120 * Commands that need a valid session but should NOT create one if none
1121 * exists. Instead of creating one and destroying it when the command is
1122 * handled, process that right before so we save some round trip in useless
1125 switch (cmd_ctx
->lsm
.cmd_type
) {
1126 case LTTNG_DISABLE_CHANNEL
:
1127 case LTTNG_DISABLE_EVENT
:
1128 switch (cmd_ctx
->lsm
.domain
.type
) {
1129 case LTTNG_DOMAIN_KERNEL
:
1130 if (!cmd_ctx
->session
->kernel_session
) {
1131 ret
= LTTNG_ERR_NO_CHANNEL
;
1135 case LTTNG_DOMAIN_JUL
:
1136 case LTTNG_DOMAIN_LOG4J
:
1137 case LTTNG_DOMAIN_PYTHON
:
1138 case LTTNG_DOMAIN_UST
:
1139 if (!cmd_ctx
->session
->ust_session
) {
1140 ret
= LTTNG_ERR_NO_CHANNEL
;
1145 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1157 * Check domain type for specific "pre-action".
1159 switch (cmd_ctx
->lsm
.domain
.type
) {
1160 case LTTNG_DOMAIN_KERNEL
:
1162 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1166 /* Kernel tracer check */
1167 if (!kernel_tracer_is_initialized()) {
1168 /* Basically, load kernel tracer modules */
1169 ret
= init_kernel_tracer();
1175 /* Consumer is in an ERROR state. Report back to client */
1176 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1178 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1182 /* Need a session for kernel command */
1183 if (need_tracing_session
) {
1184 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1185 ret
= create_kernel_session(cmd_ctx
->session
);
1186 if (ret
!= LTTNG_OK
) {
1187 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1192 /* Start the kernel consumer daemon */
1193 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1194 if (the_kconsumer_data
.pid
== 0 &&
1195 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1196 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1197 ret
= start_consumerd(&the_kconsumer_data
);
1199 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1202 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1204 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1208 * The consumer was just spawned so we need to add the socket to
1209 * the consumer output of the session if exist.
1211 ret
= consumer_create_socket(&the_kconsumer_data
,
1212 cmd_ctx
->session
->kernel_session
->consumer
);
1219 case LTTNG_DOMAIN_JUL
:
1220 case LTTNG_DOMAIN_LOG4J
:
1221 case LTTNG_DOMAIN_PYTHON
:
1222 if (!agent_tracing_is_enabled()) {
1223 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1227 case LTTNG_DOMAIN_UST
:
1229 if (!ust_app_supported()) {
1230 ret
= LTTNG_ERR_NO_UST
;
1234 /* Consumer is in an ERROR state. Report back to client */
1235 if (need_consumerd
&&
1236 uatomic_read(&the_ust_consumerd_state
) ==
1238 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1242 if (need_tracing_session
) {
1243 /* Create UST session if none exist. */
1244 if (cmd_ctx
->session
->ust_session
== NULL
) {
1245 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1246 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1247 if (ret
!= LTTNG_OK
) {
1252 /* Start the UST consumer daemons */
1254 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1255 if (the_config
.consumerd64_bin_path
.value
&&
1256 the_ustconsumer64_data
.pid
== 0 &&
1257 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1258 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1259 ret
= start_consumerd(&the_ustconsumer64_data
);
1261 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1262 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1266 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1267 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1269 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1273 * Setup socket for consumer 64 bit. No need for atomic access
1274 * since it was set above and can ONLY be set in this thread.
1276 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1277 cmd_ctx
->session
->ust_session
->consumer
);
1283 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1284 if (the_config
.consumerd32_bin_path
.value
&&
1285 the_ustconsumer32_data
.pid
== 0 &&
1286 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1287 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1288 ret
= start_consumerd(&the_ustconsumer32_data
);
1290 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1291 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1295 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1296 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1298 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1302 * Setup socket for consumer 32 bit. No need for atomic access
1303 * since it was set above and can ONLY be set in this thread.
1305 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1306 cmd_ctx
->session
->ust_session
->consumer
);
1318 /* Validate consumer daemon state when start/stop trace command */
1319 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1320 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1321 switch (cmd_ctx
->lsm
.domain
.type
) {
1322 case LTTNG_DOMAIN_NONE
:
1324 case LTTNG_DOMAIN_JUL
:
1325 case LTTNG_DOMAIN_LOG4J
:
1326 case LTTNG_DOMAIN_PYTHON
:
1327 case LTTNG_DOMAIN_UST
:
1328 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1329 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1333 case LTTNG_DOMAIN_KERNEL
:
1334 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1335 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1340 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1346 * Check that the UID matches that of the tracing session.
1347 * The root user can interact with all sessions.
1349 if (need_tracing_session
) {
1350 if (!session_access_ok(cmd_ctx
->session
,
1351 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1352 cmd_ctx
->session
->destroyed
) {
1353 ret
= LTTNG_ERR_EPERM
;
1359 * Send relayd information to consumer as soon as we have a domain and a
1362 if (cmd_ctx
->session
&& need_domain
) {
1364 * Setup relayd if not done yet. If the relayd information was already
1365 * sent to the consumer, this call will gracefully return.
1367 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1368 if (ret
!= LTTNG_OK
) {
1373 /* Process by command type */
1374 switch (cmd_ctx
->lsm
.cmd_type
) {
1375 case LTTNG_ADD_CONTEXT
:
1377 struct lttng_event_context
*event_context
= NULL
;
1378 const enum lttng_error_code ret_code
=
1379 receive_lttng_event_context(
1380 cmd_ctx
, *sock
, sock_error
, &event_context
);
1382 if (ret_code
!= LTTNG_OK
) {
1383 ret
= (int) ret_code
;
1387 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1388 lttng_event_context_destroy(event_context
);
1391 case LTTNG_DISABLE_CHANNEL
:
1393 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1394 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1397 case LTTNG_ENABLE_CHANNEL
:
1399 ret
= cmd_enable_channel(
1400 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1403 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1404 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1406 struct lttng_dynamic_buffer payload
;
1407 struct lttng_buffer_view payload_view
;
1408 const bool add_value
=
1409 cmd_ctx
->lsm
.cmd_type
==
1410 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1411 const size_t name_len
=
1412 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1414 const enum lttng_domain_type domain_type
=
1415 (enum lttng_domain_type
)
1416 cmd_ctx
->lsm
.domain
.type
;
1417 const enum lttng_process_attr process_attr
=
1418 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1419 .process_attr_tracker_add_remove_include_value
1421 const enum lttng_process_attr_value_type value_type
=
1422 (enum lttng_process_attr_value_type
) cmd_ctx
1424 .process_attr_tracker_add_remove_include_value
1426 struct process_attr_value
*value
;
1427 enum lttng_error_code ret_code
;
1428 long login_name_max
;
1430 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1431 if (login_name_max
< 0) {
1432 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1433 ret
= LTTNG_ERR_INVALID
;
1437 /* Receive remaining variable length payload if applicable. */
1438 if (name_len
> login_name_max
) {
1440 * POSIX mandates user and group names that are at least
1441 * 8 characters long. Note that although shadow-utils
1442 * (useradd, groupaadd, etc.) use 32 chars as their
1443 * limit (from bits/utmp.h, UT_NAMESIZE),
1444 * LOGIN_NAME_MAX is defined to 256.
1446 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1447 add_value
? "addition" : "removal",
1448 name_len
, login_name_max
);
1449 ret
= LTTNG_ERR_INVALID
;
1453 lttng_dynamic_buffer_init(&payload
);
1454 if (name_len
!= 0) {
1456 * Receive variable payload for user/group name
1459 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1461 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1462 add_value
? "add" : "remove");
1463 ret
= LTTNG_ERR_NOMEM
;
1464 goto error_add_remove_tracker_value
;
1467 ret
= lttcomm_recv_unix_sock(
1468 *sock
, payload
.data
, name_len
);
1470 ERR("Failed to receive payload of %s process attribute tracker value argument",
1471 add_value
? "add" : "remove");
1473 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1474 goto error_add_remove_tracker_value
;
1478 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1479 &payload
, 0, name_len
);
1480 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1481 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1482 goto error_add_remove_tracker_value
;
1486 * Validate the value type and domains are legal for the process
1487 * attribute tracker that is specified and convert the value to
1488 * add/remove to the internal sessiond representation.
1490 ret_code
= process_attr_value_from_comm(domain_type
,
1491 process_attr
, value_type
,
1492 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1494 &payload_view
, &value
);
1495 if (ret_code
!= LTTNG_OK
) {
1497 goto error_add_remove_tracker_value
;
1501 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1502 cmd_ctx
->session
, domain_type
,
1503 process_attr
, value
);
1505 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1506 cmd_ctx
->session
, domain_type
,
1507 process_attr
, value
);
1509 process_attr_value_destroy(value
);
1510 error_add_remove_tracker_value
:
1511 lttng_dynamic_buffer_reset(&payload
);
1514 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1516 enum lttng_tracking_policy tracking_policy
;
1517 const enum lttng_domain_type domain_type
=
1518 (enum lttng_domain_type
)
1519 cmd_ctx
->lsm
.domain
.type
;
1520 const enum lttng_process_attr process_attr
=
1521 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1522 .process_attr_tracker_get_tracking_policy
1525 ret
= cmd_process_attr_tracker_get_tracking_policy(
1526 cmd_ctx
->session
, domain_type
, process_attr
,
1528 if (ret
!= LTTNG_OK
) {
1532 uint32_t tracking_policy_u32
= tracking_policy
;
1533 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1534 &tracking_policy_u32
, sizeof(uint32_t));
1536 ret
= LTTNG_ERR_NOMEM
;
1542 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1544 const enum lttng_tracking_policy tracking_policy
=
1545 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1546 .process_attr_tracker_set_tracking_policy
1548 const enum lttng_domain_type domain_type
=
1549 (enum lttng_domain_type
)
1550 cmd_ctx
->lsm
.domain
.type
;
1551 const enum lttng_process_attr process_attr
=
1552 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1553 .process_attr_tracker_set_tracking_policy
1556 ret
= cmd_process_attr_tracker_set_tracking_policy(
1557 cmd_ctx
->session
, domain_type
, process_attr
,
1559 if (ret
!= LTTNG_OK
) {
1564 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1566 struct lttng_process_attr_values
*values
;
1567 struct lttng_dynamic_buffer reply
;
1568 const enum lttng_domain_type domain_type
=
1569 (enum lttng_domain_type
)
1570 cmd_ctx
->lsm
.domain
.type
;
1571 const enum lttng_process_attr process_attr
=
1572 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1573 .process_attr_tracker_get_inclusion_set
1576 ret
= cmd_process_attr_tracker_get_inclusion_set(
1577 cmd_ctx
->session
, domain_type
, process_attr
,
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(
1590 cmd_ctx
, reply
.data
, reply
.size
);
1592 ret
= LTTNG_ERR_NOMEM
;
1593 goto error_tracker_get_inclusion_set
;
1597 error_tracker_get_inclusion_set
:
1598 lttng_process_attr_values_destroy(values
);
1599 lttng_dynamic_buffer_reset(&reply
);
1602 case LTTNG_ENABLE_EVENT
:
1603 case LTTNG_DISABLE_EVENT
:
1605 struct lttng_event
*event
;
1606 char *filter_expression
;
1607 struct lttng_event_exclusion
*exclusions
;
1608 struct lttng_bytecode
*bytecode
;
1609 const enum lttng_error_code ret_code
= receive_lttng_event(
1610 cmd_ctx
, *sock
, sock_error
, &event
,
1611 &filter_expression
, &bytecode
, &exclusions
);
1613 if (ret_code
!= LTTNG_OK
) {
1614 ret
= (int) ret_code
;
1619 * Ownership of filter_expression, exclusions, and bytecode is
1620 * always transferred.
1622 ret
= cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
?
1623 cmd_enable_event(cmd_ctx
, event
,
1624 filter_expression
, exclusions
,
1626 the_kernel_poll_pipe
[1]) :
1627 cmd_disable_event(cmd_ctx
, event
,
1628 filter_expression
, bytecode
,
1630 lttng_event_destroy(event
);
1633 case LTTNG_LIST_TRACEPOINTS
:
1635 enum lttng_error_code ret_code
;
1636 size_t original_payload_size
;
1637 size_t payload_size
;
1638 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1640 ret
= setup_empty_lttng_msg(cmd_ctx
);
1642 ret
= LTTNG_ERR_NOMEM
;
1646 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1648 session_lock_list();
1649 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1650 &cmd_ctx
->reply_payload
);
1651 session_unlock_list();
1652 if (ret_code
!= LTTNG_OK
) {
1653 ret
= (int) ret_code
;
1657 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1658 command_header_size
- original_payload_size
;
1659 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1664 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1666 enum lttng_error_code ret_code
;
1667 size_t original_payload_size
;
1668 size_t payload_size
;
1669 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1671 ret
= setup_empty_lttng_msg(cmd_ctx
);
1673 ret
= LTTNG_ERR_NOMEM
;
1677 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1679 session_lock_list();
1680 ret_code
= cmd_list_tracepoint_fields(
1681 cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1682 session_unlock_list();
1683 if (ret_code
!= LTTNG_OK
) {
1684 ret
= (int) ret_code
;
1688 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1689 command_header_size
- original_payload_size
;
1690 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1695 case LTTNG_LIST_SYSCALLS
:
1697 enum lttng_error_code ret_code
;
1698 size_t original_payload_size
;
1699 size_t payload_size
;
1700 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1702 ret
= setup_empty_lttng_msg(cmd_ctx
);
1704 ret
= LTTNG_ERR_NOMEM
;
1708 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1710 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1711 if (ret_code
!= LTTNG_OK
) {
1712 ret
= (int) ret_code
;
1716 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1717 command_header_size
- original_payload_size
;
1718 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1723 case LTTNG_SET_CONSUMER_URI
:
1726 struct lttng_uri
*uris
;
1728 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1729 len
= nb_uri
* sizeof(struct lttng_uri
);
1732 ret
= LTTNG_ERR_INVALID
;
1736 uris
= calloc
<lttng_uri
>(nb_uri
);
1738 ret
= LTTNG_ERR_FATAL
;
1742 /* Receive variable len data */
1743 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1744 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1746 DBG("No URIs received from client... continuing");
1748 ret
= LTTNG_ERR_SESSION_FAIL
;
1753 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1755 if (ret
!= LTTNG_OK
) {
1762 case LTTNG_START_TRACE
:
1765 * On the first start, if we have a kernel session and we have
1766 * enabled time or size-based rotations, we have to make sure
1767 * the kernel tracer supports it.
1769 if (!cmd_ctx
->session
->has_been_started
&& \
1770 cmd_ctx
->session
->kernel_session
&& \
1771 (cmd_ctx
->session
->rotate_timer_period
|| \
1772 cmd_ctx
->session
->rotate_size
) && \
1773 !check_rotate_compatible()) {
1774 DBG("Kernel tracer version is not compatible with the rotation feature");
1775 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1778 ret
= cmd_start_trace(cmd_ctx
->session
);
1781 case LTTNG_STOP_TRACE
:
1783 ret
= cmd_stop_trace(cmd_ctx
->session
);
1786 case LTTNG_DESTROY_SESSION
:
1788 ret
= cmd_destroy_session(cmd_ctx
->session
,
1789 the_notification_thread_handle
, sock
);
1792 case LTTNG_LIST_DOMAINS
:
1795 struct lttng_domain
*domains
= NULL
;
1797 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1799 /* Return value is a negative lttng_error_code. */
1804 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1805 nb_dom
* sizeof(struct lttng_domain
));
1815 case LTTNG_LIST_CHANNELS
:
1817 enum lttng_error_code ret_code
;
1818 size_t original_payload_size
;
1819 size_t payload_size
;
1820 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1822 ret
= setup_empty_lttng_msg(cmd_ctx
);
1824 ret
= LTTNG_ERR_NOMEM
;
1828 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1830 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1831 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1832 if (ret_code
!= LTTNG_OK
) {
1833 ret
= (int) ret_code
;
1837 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1838 command_header_size
- original_payload_size
;
1839 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1844 case LTTNG_LIST_EVENTS
:
1846 enum lttng_error_code ret_code
;
1847 size_t original_payload_size
;
1848 size_t payload_size
;
1849 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1851 ret
= setup_empty_lttng_msg(cmd_ctx
);
1853 ret
= LTTNG_ERR_NOMEM
;
1857 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1859 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1861 cmd_ctx
->lsm
.u
.list
.channel_name
, &cmd_ctx
->reply_payload
);
1862 if (ret_code
!= LTTNG_OK
) {
1863 ret
= (int) ret_code
;
1867 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1868 command_header_size
- original_payload_size
;
1869 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1874 case LTTNG_LIST_SESSIONS
:
1876 enum lttng_error_code ret_code
;
1877 size_t original_payload_size
;
1878 size_t payload_size
;
1879 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1881 ret
= setup_empty_lttng_msg(cmd_ctx
);
1883 ret
= LTTNG_ERR_NOMEM
;
1887 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1889 session_lock_list();
1890 ret_code
= cmd_list_lttng_sessions(&cmd_ctx
->reply_payload
,
1891 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1892 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1893 session_unlock_list();
1894 if (ret_code
!= LTTNG_OK
) {
1895 ret
= (int) ret_code
;
1899 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1900 original_payload_size
;
1901 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1906 case LTTNG_REGISTER_CONSUMER
:
1908 struct consumer_data
*cdata
;
1910 switch (cmd_ctx
->lsm
.domain
.type
) {
1911 case LTTNG_DOMAIN_KERNEL
:
1912 cdata
= &the_kconsumer_data
;
1915 ret
= LTTNG_ERR_UND
;
1919 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1920 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1923 case LTTNG_DATA_PENDING
:
1926 uint8_t pending_ret_byte
;
1928 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1933 * This function may returns 0 or 1 to indicate whether or not
1934 * there is data pending. In case of error, it should return an
1935 * LTTNG_ERR code. However, some code paths may still return
1936 * a nondescript error code, which we handle by returning an
1939 if (pending_ret
== 0 || pending_ret
== 1) {
1941 * ret will be set to LTTNG_OK at the end of
1944 } else if (pending_ret
< 0) {
1945 ret
= LTTNG_ERR_UNK
;
1952 pending_ret_byte
= (uint8_t) pending_ret
;
1954 /* 1 byte to return whether or not data is pending */
1955 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1956 &pending_ret_byte
, 1);
1965 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1967 uint32_t snapshot_id
;
1968 struct lttcomm_lttng_output_id reply
;
1969 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1971 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
1974 if (ret
!= LTTNG_OK
) {
1977 reply
.id
= snapshot_id
;
1979 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
1985 /* Copy output list into message payload */
1989 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1991 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1992 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
1995 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1998 struct lttng_snapshot_output
*outputs
= NULL
;
2000 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2001 if (nb_output
< 0) {
2006 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2007 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2008 nb_output
* sizeof(struct lttng_snapshot_output
));
2018 case LTTNG_SNAPSHOT_RECORD
:
2020 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2021 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2022 &output
, 0); // RFC: set to zero since it's ignored by cmd_snapshot_record
2025 case LTTNG_CREATE_SESSION_EXT
:
2027 struct lttng_payload payload
;
2028 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2030 lttng_payload_init(&payload
);
2031 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2032 if (ret
!= LTTNG_OK
) {
2036 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2039 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2040 lttng_session_descriptor_destroy(return_descriptor
);
2041 ret
= LTTNG_ERR_NOMEM
;
2044 ret
= setup_lttng_msg_no_cmd_header(
2045 cmd_ctx
, payload
.buffer
.data
, payload
.buffer
.size
);
2047 lttng_session_descriptor_destroy(return_descriptor
);
2048 ret
= LTTNG_ERR_NOMEM
;
2051 lttng_payload_reset(&payload
);
2052 lttng_session_descriptor_destroy(return_descriptor
);
2056 case LTTNG_SAVE_SESSION
:
2058 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2062 case LTTNG_SET_SESSION_SHM_PATH
:
2064 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2065 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2068 case LTTNG_REGENERATE_METADATA
:
2070 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2073 case LTTNG_REGENERATE_STATEDUMP
:
2075 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2078 case LTTNG_REGISTER_TRIGGER
:
2080 struct lttng_trigger
*payload_trigger
;
2081 struct lttng_trigger
*return_trigger
;
2082 size_t original_reply_payload_size
;
2083 size_t reply_payload_size
;
2084 const struct lttng_credentials cmd_creds
= {
2085 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2086 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2089 ret
= setup_empty_lttng_msg(cmd_ctx
);
2091 ret
= LTTNG_ERR_NOMEM
;
2095 ret
= receive_lttng_trigger(
2096 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2097 if (ret
!= LTTNG_OK
) {
2101 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2103 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2104 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2105 the_notification_thread_handle
,
2107 if (ret
!= LTTNG_OK
) {
2108 lttng_trigger_put(payload_trigger
);
2112 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2113 lttng_trigger_put(payload_trigger
);
2114 lttng_trigger_put(return_trigger
);
2116 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2117 ret
= LTTNG_ERR_NOMEM
;
2121 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2122 original_reply_payload_size
;
2124 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2129 case LTTNG_UNREGISTER_TRIGGER
:
2131 struct lttng_trigger
*payload_trigger
;
2132 const struct lttng_credentials cmd_creds
= {
2133 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2134 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2137 ret
= receive_lttng_trigger(
2138 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2139 if (ret
!= LTTNG_OK
) {
2143 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2144 the_notification_thread_handle
);
2145 lttng_trigger_put(payload_trigger
);
2148 case LTTNG_ROTATE_SESSION
:
2150 struct lttng_rotate_session_return rotate_return
;
2152 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2154 memset(&rotate_return
, 0, sizeof(rotate_return
));
2155 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2156 DBG("Kernel tracer version is not compatible with the rotation feature");
2157 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2161 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2163 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2169 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2170 sizeof(rotate_return
));
2179 case LTTNG_ROTATION_GET_INFO
:
2181 struct lttng_rotation_get_info_return get_info_return
;
2183 memset(&get_info_return
, 0, sizeof(get_info_return
));
2184 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2185 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2191 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2192 sizeof(get_info_return
));
2201 case LTTNG_ROTATION_SET_SCHEDULE
:
2204 enum lttng_rotation_schedule_type schedule_type
;
2207 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2208 DBG("Kernel tracer version does not support session rotations");
2209 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2213 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2214 schedule_type
= (enum lttng_rotation_schedule_type
) 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
, set_schedule
,
2218 schedule_type
, value
,
2219 the_notification_thread_handle
);
2220 if (ret
!= LTTNG_OK
) {
2226 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2228 lttng_session_list_schedules_return schedules
;
2230 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2231 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2232 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2233 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2235 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2245 case LTTNG_CLEAR_SESSION
:
2247 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2250 case LTTNG_LIST_TRIGGERS
:
2252 struct lttng_triggers
*return_triggers
= NULL
;
2253 size_t original_payload_size
;
2254 size_t payload_size
;
2256 ret
= setup_empty_lttng_msg(cmd_ctx
);
2258 ret
= LTTNG_ERR_NOMEM
;
2262 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2264 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2266 if (ret
!= LTTNG_OK
) {
2270 LTTNG_ASSERT(return_triggers
);
2271 ret
= lttng_triggers_serialize(
2272 return_triggers
, &cmd_ctx
->reply_payload
);
2273 lttng_triggers_destroy(return_triggers
);
2275 ERR("Failed to serialize triggers in reply to `list triggers` command");
2276 ret
= LTTNG_ERR_NOMEM
;
2280 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2281 original_payload_size
;
2283 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2288 case LTTNG_EXECUTE_ERROR_QUERY
:
2290 struct lttng_error_query
*query
;
2291 const struct lttng_credentials cmd_creds
= {
2292 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2293 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2295 struct lttng_error_query_results
*results
= NULL
;
2296 size_t original_payload_size
;
2297 size_t payload_size
;
2299 ret
= setup_empty_lttng_msg(cmd_ctx
);
2301 ret
= LTTNG_ERR_NOMEM
;
2305 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2307 ret
= receive_lttng_error_query(
2308 cmd_ctx
, *sock
, sock_error
, &query
);
2309 if (ret
!= LTTNG_OK
) {
2313 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2314 the_notification_thread_handle
);
2315 lttng_error_query_destroy(query
);
2316 if (ret
!= LTTNG_OK
) {
2320 LTTNG_ASSERT(results
);
2321 ret
= lttng_error_query_results_serialize(
2322 results
, &cmd_ctx
->reply_payload
);
2323 lttng_error_query_results_destroy(results
);
2325 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2326 ret
= LTTNG_ERR_NOMEM
;
2330 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2331 original_payload_size
;
2333 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2339 case LTTNG_EXECUTE_TRACE_FORMAT_SUPPORT_QUERY
:
2341 ret
= cmd_execute_trace_format_support_query(*cmd_ctx
, *sock
, *sock_error
);
2345 ret
= LTTNG_ERR_UND
;
2350 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2351 DBG("Missing llm header, creating one.");
2352 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2356 /* Set return code */
2357 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2359 if (cmd_ctx
->session
) {
2360 session_unlock(cmd_ctx
->session
);
2361 session_put(cmd_ctx
->session
);
2362 cmd_ctx
->session
= NULL
;
2364 if (need_tracing_session
) {
2365 session_unlock_list();
2368 LTTNG_ASSERT(!rcu_read_ongoing());
2372 static int create_client_sock(void)
2374 int ret
, client_sock
;
2375 const mode_t old_umask
= umask(0);
2377 /* Create client tool unix socket */
2378 client_sock
= lttcomm_create_unix_sock(
2379 the_config
.client_unix_sock_path
.value
);
2380 if (client_sock
< 0) {
2381 ERR("Create unix sock failed: %s",
2382 the_config
.client_unix_sock_path
.value
);
2387 /* Set the cloexec flag */
2388 ret
= utils_set_fd_cloexec(client_sock
);
2390 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2391 "Continuing but note that the consumer daemon will have a "
2392 "reference to this socket on exec()", client_sock
);
2395 /* File permission MUST be 660 */
2396 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2397 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2399 ERR("Set file permissions failed: %s",
2400 the_config
.client_unix_sock_path
.value
);
2402 (void) lttcomm_close_unix_sock(client_sock
);
2406 DBG("Created client socket (fd = %i)", client_sock
);
2413 static void cleanup_client_thread(void *data
)
2415 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2417 lttng_pipe_destroy(quit_pipe
);
2420 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2422 set_thread_status(false);
2426 * This thread manage all clients request using the unix client socket for
2429 static void *thread_manage_clients(void *data
)
2431 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2433 uint32_t revents
, nb_fd
;
2434 struct lttng_poll_event events
;
2435 const int client_sock
= thread_state
.client_sock
;
2436 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2437 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2438 struct command_ctx cmd_ctx
= {};
2440 DBG("[thread] Manage client started");
2442 lttng_payload_init(&cmd_ctx
.reply_payload
);
2444 is_root
= (getuid() == 0);
2446 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2448 rcu_register_thread();
2450 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2452 health_code_update();
2454 ret
= lttcomm_listen_unix_sock(client_sock
);
2460 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2461 * more will be added to this poll set.
2463 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2465 goto error_create_poll
;
2468 /* Add the application registration socket */
2469 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2474 /* Add thread quit pipe */
2475 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2480 /* Set state as running. */
2481 set_thread_status(true);
2482 pthread_cleanup_pop(0);
2484 /* This testpoint is after we signal readiness to the parent. */
2485 if (testpoint(sessiond_thread_manage_clients
)) {
2489 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2493 health_code_update();
2496 const struct cmd_completion_handler
*cmd_completion_handler
;
2498 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2499 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2500 cmd_ctx
.creds
.pid
= 0;
2501 cmd_ctx
.session
= NULL
;
2502 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2503 cmd_ctx
.lttng_msg_size
= 0;
2505 DBG("Accepting client command ...");
2507 /* Inifinite blocking call, waiting for transmission */
2509 health_poll_entry();
2510 ret
= lttng_poll_wait(&events
, -1);
2514 * Restart interrupted system call.
2516 if (errno
== EINTR
) {
2524 for (i
= 0; i
< nb_fd
; i
++) {
2525 revents
= LTTNG_POLL_GETEV(&events
, i
);
2526 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2528 health_code_update();
2530 if (pollfd
== thread_quit_pipe_fd
) {
2534 /* Event on the registration socket */
2535 if (revents
& LPOLLIN
) {
2537 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2538 ERR("Client socket poll error");
2541 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2547 DBG("Wait for client response");
2549 health_code_update();
2551 sock
= lttcomm_accept_unix_sock(client_sock
);
2557 * Set the CLOEXEC flag. Return code is useless because either way, the
2560 (void) utils_set_fd_cloexec(sock
);
2562 /* Set socket option for credentials retrieval */
2563 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2568 health_code_update();
2571 * Data is received from the lttng client. The struct
2572 * lttcomm_session_msg (lsm) contains the command and data request of
2575 DBG("Receiving data from client ...");
2576 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2577 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2578 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2579 DBG("Incomplete recv() from client... continuing");
2588 health_code_update();
2590 // TODO: Validate cmd_ctx including sanity check for
2591 // security purpose.
2593 rcu_thread_online();
2595 * This function dispatch the work to the kernel or userspace tracer
2596 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2597 * informations for the client. The command context struct contains
2598 * everything this function may needs.
2600 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2601 rcu_thread_offline();
2611 * TODO: Inform client somehow of the fatal error. At
2612 * this point, ret < 0 means that a zmalloc failed
2613 * (ENOMEM). Error detected but still accept
2614 * command, unless a socket error has been
2620 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2621 WARN("Command returned an invalid status code, returning unknown error: "
2622 "command type = %s (%d), ret = %d",
2623 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2624 cmd_ctx
.lsm
.cmd_type
, ret
);
2625 ret
= LTTNG_ERR_UNK
;
2628 cmd_completion_handler
= cmd_pop_completion_handler();
2629 if (cmd_completion_handler
) {
2630 enum lttng_error_code completion_code
;
2632 completion_code
= cmd_completion_handler
->run(
2633 cmd_completion_handler
->data
);
2634 if (completion_code
!= LTTNG_OK
) {
2639 health_code_update();
2642 struct lttng_payload_view view
=
2643 lttng_payload_view_from_payload(
2644 &cmd_ctx
.reply_payload
,
2646 struct lttcomm_lttng_msg
*llm
= (typeof(
2647 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2649 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2650 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2652 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2654 DBG("Sending response (size: %d, retcode: %s (%d))",
2655 cmd_ctx
.lttng_msg_size
,
2656 lttng_strerror(-llm
->ret_code
),
2658 ret
= send_unix_sock(sock
, &view
);
2660 ERR("Failed to send data back to client");
2663 /* End of transmission */
2671 health_code_update();
2683 lttng_poll_clean(&events
);
2687 unlink(the_config
.client_unix_sock_path
.value
);
2688 ret
= close(client_sock
);
2695 ERR("Health error occurred in %s", __func__
);
2698 health_unregister(the_health_sessiond
);
2700 DBG("Client thread dying");
2701 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2702 rcu_unregister_thread();
2707 bool shutdown_client_thread(void *thread_data
)
2709 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2710 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2712 return notify_thread_pipe(write_fd
) == 1;
2715 struct lttng_thread
*launch_client_thread(void)
2717 bool thread_running
;
2718 struct lttng_pipe
*client_quit_pipe
;
2719 struct lttng_thread
*thread
= NULL
;
2720 int client_sock_fd
= -1;
2722 sem_init(&thread_state
.ready
, 0, 0);
2723 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2724 if (!client_quit_pipe
) {
2728 client_sock_fd
= create_client_sock();
2729 if (client_sock_fd
< 0) {
2733 thread_state
.client_sock
= client_sock_fd
;
2734 thread
= lttng_thread_create("Client management",
2735 thread_manage_clients
,
2736 shutdown_client_thread
,
2737 cleanup_client_thread
,
2742 /* The client thread now owns the client sock fd and the quit pipe. */
2743 client_sock_fd
= -1;
2744 client_quit_pipe
= NULL
;
2747 * This thread is part of the threads that need to be fully
2748 * initialized before the session daemon is marked as "ready".
2750 thread_running
= wait_thread_status();
2751 if (!thread_running
) {
2756 if (client_sock_fd
>= 0) {
2757 if (close(client_sock_fd
)) {
2758 PERROR("Failed to close client socket");
2761 lttng_thread_put(thread
);
2762 cleanup_client_thread(client_quit_pipe
);