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
;
585 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
588 struct lttng_trigger
**_trigger
)
592 ssize_t sock_recv_len
;
593 enum lttng_error_code ret_code
;
594 struct lttng_payload trigger_payload
;
595 struct lttng_trigger
*trigger
= NULL
;
597 lttng_payload_init(&trigger_payload
);
598 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
599 ret
= lttng_dynamic_buffer_set_size(
600 &trigger_payload
.buffer
, trigger_len
);
602 ret_code
= LTTNG_ERR_NOMEM
;
606 sock_recv_len
= lttcomm_recv_unix_sock(
607 sock
, trigger_payload
.buffer
.data
, trigger_len
);
608 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
609 ERR("Failed to receive trigger in command payload");
611 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
615 /* Receive fds, if any. */
616 if (cmd_ctx
->lsm
.fd_count
> 0) {
617 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
618 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
619 if (sock_recv_len
> 0 &&
620 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
621 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
622 cmd_ctx
->lsm
.fd_count
, (int) ret
);
623 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
626 } else if (sock_recv_len
<= 0) {
627 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
628 cmd_ctx
->lsm
.fd_count
, (int) ret
);
629 ret_code
= LTTNG_ERR_FATAL
;
635 /* Deserialize trigger. */
637 struct lttng_payload_view view
=
638 lttng_payload_view_from_payload(
639 &trigger_payload
, 0, -1);
641 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
643 ERR("Invalid trigger received as part of command payload");
644 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
645 lttng_trigger_put(trigger
);
654 lttng_payload_reset(&trigger_payload
);
658 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
661 struct lttng_error_query
**_query
)
665 ssize_t sock_recv_len
;
666 enum lttng_error_code ret_code
;
667 struct lttng_payload query_payload
;
668 struct lttng_error_query
*query
= NULL
;
670 lttng_payload_init(&query_payload
);
671 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
672 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
674 ret_code
= LTTNG_ERR_NOMEM
;
678 sock_recv_len
= lttcomm_recv_unix_sock(
679 sock
, query_payload
.buffer
.data
, query_len
);
680 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
681 ERR("Failed to receive error query in command payload");
683 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
687 /* Receive fds, if any. */
688 if (cmd_ctx
->lsm
.fd_count
> 0) {
689 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
690 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
691 if (sock_recv_len
> 0 &&
692 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
693 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
694 cmd_ctx
->lsm
.fd_count
, (int) ret
);
695 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
698 } else if (sock_recv_len
<= 0) {
699 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
700 cmd_ctx
->lsm
.fd_count
, (int) ret
);
701 ret_code
= LTTNG_ERR_FATAL
;
707 /* Deserialize error query. */
709 struct lttng_payload_view view
=
710 lttng_payload_view_from_payload(
711 &query_payload
, 0, -1);
713 if (lttng_error_query_create_from_payload(&view
, &query
) !=
715 ERR("Invalid error query received as part of command payload");
716 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
725 lttng_payload_reset(&query_payload
);
729 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
732 struct lttng_event
**out_event
,
733 char **out_filter_expression
,
734 struct lttng_bytecode
**out_bytecode
,
735 struct lttng_event_exclusion
**out_exclusion
)
739 ssize_t sock_recv_len
;
740 enum lttng_error_code ret_code
;
741 struct lttng_payload event_payload
;
742 struct lttng_event
*local_event
= NULL
;
743 char *local_filter_expression
= NULL
;
744 struct lttng_bytecode
*local_bytecode
= NULL
;
745 struct lttng_event_exclusion
*local_exclusion
= NULL
;
747 lttng_payload_init(&event_payload
);
748 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
) {
749 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
750 } else if (cmd_ctx
->lsm
.cmd_type
== LTTNG_DISABLE_EVENT
) {
751 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
756 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
758 ret_code
= LTTNG_ERR_NOMEM
;
762 sock_recv_len
= lttcomm_recv_unix_sock(
763 sock
, event_payload
.buffer
.data
, event_len
);
764 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
765 ERR("Failed to receive event in command payload");
767 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
771 /* Receive fds, if any. */
772 if (cmd_ctx
->lsm
.fd_count
> 0) {
773 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
774 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
775 if (sock_recv_len
> 0 &&
776 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
777 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
778 cmd_ctx
->lsm
.fd_count
, (int) ret
);
779 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
782 } else if (sock_recv_len
<= 0) {
783 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
784 cmd_ctx
->lsm
.fd_count
, (int) ret
);
785 ret_code
= LTTNG_ERR_FATAL
;
791 /* Deserialize event. */
794 struct lttng_payload_view event_view
=
795 lttng_payload_view_from_payload(
796 &event_payload
, 0, -1);
798 len
= lttng_event_create_from_payload(&event_view
, &local_event
,
799 &local_exclusion
, &local_filter_expression
,
803 ERR("Failed to create an event from the received buffer");
804 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
808 if (len
!= event_len
) {
809 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
", payload length = %zd", event_len
, len
);
810 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
815 *out_event
= local_event
;
816 *out_exclusion
= local_exclusion
;
817 *out_filter_expression
= local_filter_expression
;
818 *out_bytecode
= local_bytecode
;
820 local_exclusion
= NULL
;
821 local_filter_expression
= NULL
;
822 local_bytecode
= NULL
;
827 lttng_payload_reset(&event_payload
);
828 lttng_event_destroy(local_event
);
829 free(local_filter_expression
);
830 free(local_bytecode
);
831 free(local_exclusion
);
835 static enum lttng_error_code
receive_lttng_event_context(
836 const struct command_ctx
*cmd_ctx
,
839 struct lttng_event_context
**out_event_context
)
842 const size_t event_context_len
=
843 (size_t) cmd_ctx
->lsm
.u
.context
.length
;
844 ssize_t sock_recv_len
;
845 enum lttng_error_code ret_code
;
846 struct lttng_payload event_context_payload
;
847 struct lttng_event_context
*context
= NULL
;
849 lttng_payload_init(&event_context_payload
);
851 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
,
854 ret_code
= LTTNG_ERR_NOMEM
;
858 sock_recv_len
= lttcomm_recv_unix_sock(
859 sock
, event_context_payload
.buffer
.data
,
861 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
862 ERR("Failed to receive event context in command payload");
864 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
868 /* Deserialize event. */
871 struct lttng_payload_view event_context_view
=
872 lttng_payload_view_from_payload(
873 &event_context_payload
, 0, -1);
875 len
= lttng_event_context_create_from_payload(
876 &event_context_view
, &context
);
879 ERR("Failed to create a event context from the received buffer");
880 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
884 if (len
!= event_context_len
) {
885 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd", event_context_len
, len
);
886 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
891 *out_event_context
= context
;
896 lttng_event_context_destroy(context
);
897 lttng_payload_reset(&event_context_payload
);
902 * Version of setup_lttng_msg() without command header.
904 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
905 void *payload_buf
, size_t payload_len
)
907 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
911 * Check if the current kernel tracer supports the session rotation feature.
912 * Return 1 if it does, 0 otherwise.
914 static int check_rotate_compatible(void)
918 if (the_kernel_tracer_version
.major
!= 2 ||
919 the_kernel_tracer_version
.minor
< 11) {
920 DBG("Kernel tracer version is not compatible with the rotation feature");
928 * Send data on a unix socket using the liblttsessiondcomm API.
930 * Return lttcomm error code.
932 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
935 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
937 /* Check valid length */
938 if (view
->buffer
.size
== 0) {
943 ret
= lttcomm_send_unix_sock(
944 sock
, view
->buffer
.data
, view
->buffer
.size
);
950 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
961 * Process the command requested by the lttng client within the command
962 * context structure. This function make sure that the return structure (llm)
963 * is set and ready for transmission before returning.
965 * Return any error encountered or 0 for success.
967 * "sock" is only used for special-case var. len data.
968 * A command may assume the ownership of the socket, in which case its value
969 * should be set to -1.
971 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
975 bool need_tracing_session
= true;
979 DBG("Processing client command '%s\' (%d)",
980 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
981 cmd_ctx
->lsm
.cmd_type
);
985 switch (cmd_ctx
->lsm
.cmd_type
) {
986 case LTTNG_CREATE_SESSION_EXT
:
987 case LTTNG_DESTROY_SESSION
:
988 case LTTNG_LIST_SESSIONS
:
989 case LTTNG_LIST_DOMAINS
:
990 case LTTNG_START_TRACE
:
991 case LTTNG_STOP_TRACE
:
992 case LTTNG_DATA_PENDING
:
993 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
994 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
995 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
996 case LTTNG_SNAPSHOT_RECORD
:
997 case LTTNG_SAVE_SESSION
:
998 case LTTNG_SET_SESSION_SHM_PATH
:
999 case LTTNG_REGENERATE_METADATA
:
1000 case LTTNG_REGENERATE_STATEDUMP
:
1001 case LTTNG_ROTATE_SESSION
:
1002 case LTTNG_ROTATION_GET_INFO
:
1003 case LTTNG_ROTATION_SET_SCHEDULE
:
1004 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1005 case LTTNG_CLEAR_SESSION
:
1006 case LTTNG_LIST_TRIGGERS
:
1007 case LTTNG_EXECUTE_ERROR_QUERY
:
1008 need_domain
= false;
1014 /* Needs a functioning consumerd? */
1015 switch (cmd_ctx
->lsm
.cmd_type
) {
1016 case LTTNG_REGISTER_TRIGGER
:
1017 case LTTNG_UNREGISTER_TRIGGER
:
1018 case LTTNG_EXECUTE_ERROR_QUERY
:
1019 need_consumerd
= false;
1022 need_consumerd
= true;
1026 if (the_config
.no_kernel
&& need_domain
&&
1027 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1029 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1031 ret
= LTTNG_ERR_KERN_NA
;
1036 /* Deny register consumer if we already have a spawned consumer. */
1037 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
1038 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1039 if (the_kconsumer_data
.pid
> 0) {
1040 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1041 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1044 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1048 * Check for command that don't needs to allocate a returned payload. We do
1049 * this here so we don't have to make the call for no payload at each
1052 switch(cmd_ctx
->lsm
.cmd_type
) {
1053 case LTTNG_LIST_SESSIONS
:
1054 case LTTNG_LIST_TRACEPOINTS
:
1055 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1056 case LTTNG_LIST_DOMAINS
:
1057 case LTTNG_LIST_CHANNELS
:
1058 case LTTNG_LIST_EVENTS
:
1059 case LTTNG_LIST_SYSCALLS
:
1060 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1061 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1062 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1063 case LTTNG_DATA_PENDING
:
1064 case LTTNG_ROTATE_SESSION
:
1065 case LTTNG_ROTATION_GET_INFO
:
1066 case LTTNG_REGISTER_TRIGGER
:
1067 case LTTNG_LIST_TRIGGERS
:
1068 case LTTNG_EXECUTE_ERROR_QUERY
:
1071 /* Setup lttng message with no payload */
1072 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1074 /* This label does not try to unlock the session */
1075 goto init_setup_error
;
1079 /* Commands that DO NOT need a session. */
1080 switch (cmd_ctx
->lsm
.cmd_type
) {
1081 case LTTNG_CREATE_SESSION_EXT
:
1082 case LTTNG_LIST_SESSIONS
:
1083 case LTTNG_LIST_TRACEPOINTS
:
1084 case LTTNG_LIST_SYSCALLS
:
1085 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1086 case LTTNG_SAVE_SESSION
:
1087 case LTTNG_REGISTER_TRIGGER
:
1088 case LTTNG_UNREGISTER_TRIGGER
:
1089 case LTTNG_LIST_TRIGGERS
:
1090 case LTTNG_EXECUTE_ERROR_QUERY
:
1091 need_tracing_session
= false;
1094 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1096 * We keep the session list lock across _all_ commands
1097 * for now, because the per-session lock does not
1098 * handle teardown properly.
1100 session_lock_list();
1101 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1102 if (cmd_ctx
->session
== NULL
) {
1103 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1106 /* Acquire lock for the session */
1107 session_lock(cmd_ctx
->session
);
1113 * Commands that need a valid session but should NOT create one if none
1114 * exists. Instead of creating one and destroying it when the command is
1115 * handled, process that right before so we save some round trip in useless
1118 switch (cmd_ctx
->lsm
.cmd_type
) {
1119 case LTTNG_DISABLE_CHANNEL
:
1120 case LTTNG_DISABLE_EVENT
:
1121 switch (cmd_ctx
->lsm
.domain
.type
) {
1122 case LTTNG_DOMAIN_KERNEL
:
1123 if (!cmd_ctx
->session
->kernel_session
) {
1124 ret
= LTTNG_ERR_NO_CHANNEL
;
1128 case LTTNG_DOMAIN_JUL
:
1129 case LTTNG_DOMAIN_LOG4J
:
1130 case LTTNG_DOMAIN_PYTHON
:
1131 case LTTNG_DOMAIN_UST
:
1132 if (!cmd_ctx
->session
->ust_session
) {
1133 ret
= LTTNG_ERR_NO_CHANNEL
;
1138 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1150 * Check domain type for specific "pre-action".
1152 switch (cmd_ctx
->lsm
.domain
.type
) {
1153 case LTTNG_DOMAIN_KERNEL
:
1155 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1159 /* Kernel tracer check */
1160 if (!kernel_tracer_is_initialized()) {
1161 /* Basically, load kernel tracer modules */
1162 ret
= init_kernel_tracer();
1168 /* Consumer is in an ERROR state. Report back to client */
1169 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1171 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1175 /* Need a session for kernel command */
1176 if (need_tracing_session
) {
1177 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1178 ret
= create_kernel_session(cmd_ctx
->session
);
1179 if (ret
!= LTTNG_OK
) {
1180 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1185 /* Start the kernel consumer daemon */
1186 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1187 if (the_kconsumer_data
.pid
== 0 &&
1188 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1189 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1190 ret
= start_consumerd(&the_kconsumer_data
);
1192 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1195 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1197 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1201 * The consumer was just spawned so we need to add the socket to
1202 * the consumer output of the session if exist.
1204 ret
= consumer_create_socket(&the_kconsumer_data
,
1205 cmd_ctx
->session
->kernel_session
->consumer
);
1212 case LTTNG_DOMAIN_JUL
:
1213 case LTTNG_DOMAIN_LOG4J
:
1214 case LTTNG_DOMAIN_PYTHON
:
1215 if (!agent_tracing_is_enabled()) {
1216 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1220 case LTTNG_DOMAIN_UST
:
1222 if (!ust_app_supported()) {
1223 ret
= LTTNG_ERR_NO_UST
;
1227 /* Consumer is in an ERROR state. Report back to client */
1228 if (need_consumerd
&&
1229 uatomic_read(&the_ust_consumerd_state
) ==
1231 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1235 if (need_tracing_session
) {
1236 /* Create UST session if none exist. */
1237 if (cmd_ctx
->session
->ust_session
== NULL
) {
1238 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1239 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1240 if (ret
!= LTTNG_OK
) {
1245 /* Start the UST consumer daemons */
1247 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1248 if (the_config
.consumerd64_bin_path
.value
&&
1249 the_ustconsumer64_data
.pid
== 0 &&
1250 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1251 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1252 ret
= start_consumerd(&the_ustconsumer64_data
);
1254 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1255 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1259 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1260 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1262 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1266 * Setup socket for consumer 64 bit. No need for atomic access
1267 * since it was set above and can ONLY be set in this thread.
1269 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1270 cmd_ctx
->session
->ust_session
->consumer
);
1276 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1277 if (the_config
.consumerd32_bin_path
.value
&&
1278 the_ustconsumer32_data
.pid
== 0 &&
1279 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1280 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1281 ret
= start_consumerd(&the_ustconsumer32_data
);
1283 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1284 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1288 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1289 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1291 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1295 * Setup socket for consumer 32 bit. No need for atomic access
1296 * since it was set above and can ONLY be set in this thread.
1298 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1299 cmd_ctx
->session
->ust_session
->consumer
);
1311 /* Validate consumer daemon state when start/stop trace command */
1312 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1313 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1314 switch (cmd_ctx
->lsm
.domain
.type
) {
1315 case LTTNG_DOMAIN_NONE
:
1317 case LTTNG_DOMAIN_JUL
:
1318 case LTTNG_DOMAIN_LOG4J
:
1319 case LTTNG_DOMAIN_PYTHON
:
1320 case LTTNG_DOMAIN_UST
:
1321 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1322 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1326 case LTTNG_DOMAIN_KERNEL
:
1327 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1328 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1333 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1339 * Check that the UID matches that of the tracing session.
1340 * The root user can interact with all sessions.
1342 if (need_tracing_session
) {
1343 if (!session_access_ok(cmd_ctx
->session
,
1344 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1345 cmd_ctx
->session
->destroyed
) {
1346 ret
= LTTNG_ERR_EPERM
;
1352 * Send relayd information to consumer as soon as we have a domain and a
1355 if (cmd_ctx
->session
&& need_domain
) {
1357 * Setup relayd if not done yet. If the relayd information was already
1358 * sent to the consumer, this call will gracefully return.
1360 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1361 if (ret
!= LTTNG_OK
) {
1366 /* Process by command type */
1367 switch (cmd_ctx
->lsm
.cmd_type
) {
1368 case LTTNG_ADD_CONTEXT
:
1370 struct lttng_event_context
*event_context
= NULL
;
1371 const enum lttng_error_code ret_code
=
1372 receive_lttng_event_context(
1373 cmd_ctx
, *sock
, sock_error
, &event_context
);
1375 if (ret_code
!= LTTNG_OK
) {
1376 ret
= (int) ret_code
;
1380 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1381 lttng_event_context_destroy(event_context
);
1384 case LTTNG_DISABLE_CHANNEL
:
1386 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1387 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1390 case LTTNG_ENABLE_CHANNEL
:
1392 ret
= cmd_enable_channel(
1393 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1396 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1397 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1399 struct lttng_dynamic_buffer payload
;
1400 struct lttng_buffer_view payload_view
;
1401 const bool add_value
=
1402 cmd_ctx
->lsm
.cmd_type
==
1403 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1404 const size_t name_len
=
1405 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1407 const enum lttng_domain_type domain_type
=
1408 (enum lttng_domain_type
)
1409 cmd_ctx
->lsm
.domain
.type
;
1410 const enum lttng_process_attr process_attr
=
1411 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1412 .process_attr_tracker_add_remove_include_value
1414 const enum lttng_process_attr_value_type value_type
=
1415 (enum lttng_process_attr_value_type
) cmd_ctx
1417 .process_attr_tracker_add_remove_include_value
1419 struct process_attr_value
*value
;
1420 enum lttng_error_code ret_code
;
1421 long login_name_max
;
1423 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1424 if (login_name_max
< 0) {
1425 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1426 ret
= LTTNG_ERR_INVALID
;
1430 /* Receive remaining variable length payload if applicable. */
1431 if (name_len
> login_name_max
) {
1433 * POSIX mandates user and group names that are at least
1434 * 8 characters long. Note that although shadow-utils
1435 * (useradd, groupaadd, etc.) use 32 chars as their
1436 * limit (from bits/utmp.h, UT_NAMESIZE),
1437 * LOGIN_NAME_MAX is defined to 256.
1439 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1440 add_value
? "addition" : "removal",
1441 name_len
, login_name_max
);
1442 ret
= LTTNG_ERR_INVALID
;
1446 lttng_dynamic_buffer_init(&payload
);
1447 if (name_len
!= 0) {
1449 * Receive variable payload for user/group name
1452 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1454 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1455 add_value
? "add" : "remove");
1456 ret
= LTTNG_ERR_NOMEM
;
1457 goto error_add_remove_tracker_value
;
1460 ret
= lttcomm_recv_unix_sock(
1461 *sock
, payload
.data
, name_len
);
1463 ERR("Failed to receive payload of %s process attribute tracker value argument",
1464 add_value
? "add" : "remove");
1466 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1467 goto error_add_remove_tracker_value
;
1471 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1472 &payload
, 0, name_len
);
1473 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1474 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1475 goto error_add_remove_tracker_value
;
1479 * Validate the value type and domains are legal for the process
1480 * attribute tracker that is specified and convert the value to
1481 * add/remove to the internal sessiond representation.
1483 ret_code
= process_attr_value_from_comm(domain_type
,
1484 process_attr
, value_type
,
1485 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1487 &payload_view
, &value
);
1488 if (ret_code
!= LTTNG_OK
) {
1490 goto error_add_remove_tracker_value
;
1494 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1495 cmd_ctx
->session
, domain_type
,
1496 process_attr
, value
);
1498 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1499 cmd_ctx
->session
, domain_type
,
1500 process_attr
, value
);
1502 process_attr_value_destroy(value
);
1503 error_add_remove_tracker_value
:
1504 lttng_dynamic_buffer_reset(&payload
);
1507 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1509 enum lttng_tracking_policy tracking_policy
;
1510 const enum lttng_domain_type domain_type
=
1511 (enum lttng_domain_type
)
1512 cmd_ctx
->lsm
.domain
.type
;
1513 const enum lttng_process_attr process_attr
=
1514 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1515 .process_attr_tracker_get_tracking_policy
1518 ret
= cmd_process_attr_tracker_get_tracking_policy(
1519 cmd_ctx
->session
, domain_type
, process_attr
,
1521 if (ret
!= LTTNG_OK
) {
1525 uint32_t tracking_policy_u32
= tracking_policy
;
1526 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1527 &tracking_policy_u32
, sizeof(uint32_t));
1529 ret
= LTTNG_ERR_NOMEM
;
1535 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1537 const enum lttng_tracking_policy tracking_policy
=
1538 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1539 .process_attr_tracker_set_tracking_policy
1541 const enum lttng_domain_type domain_type
=
1542 (enum lttng_domain_type
)
1543 cmd_ctx
->lsm
.domain
.type
;
1544 const enum lttng_process_attr process_attr
=
1545 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1546 .process_attr_tracker_set_tracking_policy
1549 ret
= cmd_process_attr_tracker_set_tracking_policy(
1550 cmd_ctx
->session
, domain_type
, process_attr
,
1552 if (ret
!= LTTNG_OK
) {
1557 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1559 struct lttng_process_attr_values
*values
;
1560 struct lttng_dynamic_buffer reply
;
1561 const enum lttng_domain_type domain_type
=
1562 (enum lttng_domain_type
)
1563 cmd_ctx
->lsm
.domain
.type
;
1564 const enum lttng_process_attr process_attr
=
1565 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1566 .process_attr_tracker_get_inclusion_set
1569 ret
= cmd_process_attr_tracker_get_inclusion_set(
1570 cmd_ctx
->session
, domain_type
, process_attr
,
1572 if (ret
!= LTTNG_OK
) {
1576 lttng_dynamic_buffer_init(&reply
);
1577 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1579 goto error_tracker_get_inclusion_set
;
1582 ret
= setup_lttng_msg_no_cmd_header(
1583 cmd_ctx
, reply
.data
, reply
.size
);
1585 ret
= LTTNG_ERR_NOMEM
;
1586 goto error_tracker_get_inclusion_set
;
1590 error_tracker_get_inclusion_set
:
1591 lttng_process_attr_values_destroy(values
);
1592 lttng_dynamic_buffer_reset(&reply
);
1595 case LTTNG_ENABLE_EVENT
:
1596 case LTTNG_DISABLE_EVENT
:
1598 struct lttng_event
*event
;
1599 char *filter_expression
;
1600 struct lttng_event_exclusion
*exclusions
;
1601 struct lttng_bytecode
*bytecode
;
1602 const enum lttng_error_code ret_code
= receive_lttng_event(
1603 cmd_ctx
, *sock
, sock_error
, &event
,
1604 &filter_expression
, &bytecode
, &exclusions
);
1606 if (ret_code
!= LTTNG_OK
) {
1607 ret
= (int) ret_code
;
1612 * Ownership of filter_expression, exclusions, and bytecode is
1613 * always transferred.
1615 ret
= cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
?
1616 cmd_enable_event(cmd_ctx
, event
,
1617 filter_expression
, exclusions
,
1619 the_kernel_poll_pipe
[1]) :
1620 cmd_disable_event(cmd_ctx
, event
,
1621 filter_expression
, bytecode
,
1623 lttng_event_destroy(event
);
1626 case LTTNG_LIST_TRACEPOINTS
:
1628 enum lttng_error_code ret_code
;
1629 size_t original_payload_size
;
1630 size_t payload_size
;
1631 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1633 ret
= setup_empty_lttng_msg(cmd_ctx
);
1635 ret
= LTTNG_ERR_NOMEM
;
1639 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1641 session_lock_list();
1642 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1643 &cmd_ctx
->reply_payload
);
1644 session_unlock_list();
1645 if (ret_code
!= LTTNG_OK
) {
1646 ret
= (int) ret_code
;
1650 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1651 command_header_size
- original_payload_size
;
1652 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1657 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1659 enum lttng_error_code ret_code
;
1660 size_t original_payload_size
;
1661 size_t payload_size
;
1662 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1664 ret
= setup_empty_lttng_msg(cmd_ctx
);
1666 ret
= LTTNG_ERR_NOMEM
;
1670 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1672 session_lock_list();
1673 ret_code
= cmd_list_tracepoint_fields(
1674 cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1675 session_unlock_list();
1676 if (ret_code
!= LTTNG_OK
) {
1677 ret
= (int) ret_code
;
1681 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1682 command_header_size
- original_payload_size
;
1683 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1688 case LTTNG_LIST_SYSCALLS
:
1690 enum lttng_error_code ret_code
;
1691 size_t original_payload_size
;
1692 size_t payload_size
;
1693 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1695 ret
= setup_empty_lttng_msg(cmd_ctx
);
1697 ret
= LTTNG_ERR_NOMEM
;
1701 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1703 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1704 if (ret_code
!= LTTNG_OK
) {
1705 ret
= (int) ret_code
;
1709 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1710 command_header_size
- original_payload_size
;
1711 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1716 case LTTNG_SET_CONSUMER_URI
:
1719 struct lttng_uri
*uris
;
1721 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1722 len
= nb_uri
* sizeof(struct lttng_uri
);
1725 ret
= LTTNG_ERR_INVALID
;
1729 uris
= calloc
<lttng_uri
>(nb_uri
);
1731 ret
= LTTNG_ERR_FATAL
;
1735 /* Receive variable len data */
1736 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1737 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1739 DBG("No URIs received from client... continuing");
1741 ret
= LTTNG_ERR_SESSION_FAIL
;
1746 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1748 if (ret
!= LTTNG_OK
) {
1755 case LTTNG_START_TRACE
:
1758 * On the first start, if we have a kernel session and we have
1759 * enabled time or size-based rotations, we have to make sure
1760 * the kernel tracer supports it.
1762 if (!cmd_ctx
->session
->has_been_started
&& \
1763 cmd_ctx
->session
->kernel_session
&& \
1764 (cmd_ctx
->session
->rotate_timer_period
|| \
1765 cmd_ctx
->session
->rotate_size
) && \
1766 !check_rotate_compatible()) {
1767 DBG("Kernel tracer version is not compatible with the rotation feature");
1768 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1771 ret
= cmd_start_trace(cmd_ctx
->session
);
1774 case LTTNG_STOP_TRACE
:
1776 ret
= cmd_stop_trace(cmd_ctx
->session
);
1779 case LTTNG_DESTROY_SESSION
:
1781 ret
= cmd_destroy_session(cmd_ctx
->session
,
1782 the_notification_thread_handle
, sock
);
1785 case LTTNG_LIST_DOMAINS
:
1788 struct lttng_domain
*domains
= NULL
;
1790 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1792 /* Return value is a negative lttng_error_code. */
1797 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1798 nb_dom
* sizeof(struct lttng_domain
));
1808 case LTTNG_LIST_CHANNELS
:
1810 enum lttng_error_code ret_code
;
1811 size_t original_payload_size
;
1812 size_t payload_size
;
1813 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1815 ret
= setup_empty_lttng_msg(cmd_ctx
);
1817 ret
= LTTNG_ERR_NOMEM
;
1821 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1823 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1824 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1825 if (ret_code
!= LTTNG_OK
) {
1826 ret
= (int) ret_code
;
1830 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1831 command_header_size
- original_payload_size
;
1832 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1837 case LTTNG_LIST_EVENTS
:
1839 enum lttng_error_code ret_code
;
1840 size_t original_payload_size
;
1841 size_t payload_size
;
1842 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1844 ret
= setup_empty_lttng_msg(cmd_ctx
);
1846 ret
= LTTNG_ERR_NOMEM
;
1850 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1852 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1854 cmd_ctx
->lsm
.u
.list
.channel_name
, &cmd_ctx
->reply_payload
);
1855 if (ret_code
!= LTTNG_OK
) {
1856 ret
= (int) ret_code
;
1860 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1861 command_header_size
- original_payload_size
;
1862 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1867 case LTTNG_LIST_SESSIONS
:
1869 enum lttng_error_code ret_code
;
1870 size_t original_payload_size
;
1871 size_t payload_size
;
1872 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1874 ret
= setup_empty_lttng_msg(cmd_ctx
);
1876 ret
= LTTNG_ERR_NOMEM
;
1880 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1882 session_lock_list();
1883 ret_code
= cmd_list_lttng_sessions(&cmd_ctx
->reply_payload
,
1884 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1885 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1886 session_unlock_list();
1887 if (ret_code
!= LTTNG_OK
) {
1888 ret
= (int) ret_code
;
1892 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
- command_header_size
-
1893 original_payload_size
;
1894 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1899 case LTTNG_REGISTER_CONSUMER
:
1901 struct consumer_data
*cdata
;
1903 switch (cmd_ctx
->lsm
.domain
.type
) {
1904 case LTTNG_DOMAIN_KERNEL
:
1905 cdata
= &the_kconsumer_data
;
1908 ret
= LTTNG_ERR_UND
;
1912 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1913 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1916 case LTTNG_DATA_PENDING
:
1919 uint8_t pending_ret_byte
;
1921 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1926 * This function may returns 0 or 1 to indicate whether or not
1927 * there is data pending. In case of error, it should return an
1928 * LTTNG_ERR code. However, some code paths may still return
1929 * a nondescript error code, which we handle by returning an
1932 if (pending_ret
== 0 || pending_ret
== 1) {
1934 * ret will be set to LTTNG_OK at the end of
1937 } else if (pending_ret
< 0) {
1938 ret
= LTTNG_ERR_UNK
;
1945 pending_ret_byte
= (uint8_t) pending_ret
;
1947 /* 1 byte to return whether or not data is pending */
1948 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1949 &pending_ret_byte
, 1);
1958 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1960 uint32_t snapshot_id
;
1961 struct lttcomm_lttng_output_id reply
;
1962 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1964 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
1967 if (ret
!= LTTNG_OK
) {
1970 reply
.id
= snapshot_id
;
1972 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
1978 /* Copy output list into message payload */
1982 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1984 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1985 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
1988 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1991 struct lttng_snapshot_output
*outputs
= NULL
;
1993 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
1994 if (nb_output
< 0) {
1999 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2000 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2001 nb_output
* sizeof(struct lttng_snapshot_output
));
2011 case LTTNG_SNAPSHOT_RECORD
:
2013 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2014 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2015 &output
, 0); // RFC: set to zero since it's ignored by cmd_snapshot_record
2018 case LTTNG_CREATE_SESSION_EXT
:
2020 struct lttng_dynamic_buffer payload
;
2021 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2023 lttng_dynamic_buffer_init(&payload
);
2024 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2025 if (ret
!= LTTNG_OK
) {
2029 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2032 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2033 lttng_session_descriptor_destroy(return_descriptor
);
2034 ret
= LTTNG_ERR_NOMEM
;
2037 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2040 lttng_session_descriptor_destroy(return_descriptor
);
2041 ret
= LTTNG_ERR_NOMEM
;
2044 lttng_dynamic_buffer_reset(&payload
);
2045 lttng_session_descriptor_destroy(return_descriptor
);
2049 case LTTNG_SAVE_SESSION
:
2051 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2055 case LTTNG_SET_SESSION_SHM_PATH
:
2057 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2058 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2061 case LTTNG_REGENERATE_METADATA
:
2063 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2066 case LTTNG_REGENERATE_STATEDUMP
:
2068 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2071 case LTTNG_REGISTER_TRIGGER
:
2073 struct lttng_trigger
*payload_trigger
;
2074 struct lttng_trigger
*return_trigger
;
2075 size_t original_reply_payload_size
;
2076 size_t reply_payload_size
;
2077 const struct lttng_credentials cmd_creds
= {
2078 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2079 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2082 ret
= setup_empty_lttng_msg(cmd_ctx
);
2084 ret
= LTTNG_ERR_NOMEM
;
2088 ret
= receive_lttng_trigger(
2089 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2090 if (ret
!= LTTNG_OK
) {
2094 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2096 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2097 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2098 the_notification_thread_handle
,
2100 if (ret
!= LTTNG_OK
) {
2101 lttng_trigger_put(payload_trigger
);
2105 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2106 lttng_trigger_put(payload_trigger
);
2107 lttng_trigger_put(return_trigger
);
2109 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2110 ret
= LTTNG_ERR_NOMEM
;
2114 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2115 original_reply_payload_size
;
2117 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2122 case LTTNG_UNREGISTER_TRIGGER
:
2124 struct lttng_trigger
*payload_trigger
;
2125 const struct lttng_credentials cmd_creds
= {
2126 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2127 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2130 ret
= receive_lttng_trigger(
2131 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2132 if (ret
!= LTTNG_OK
) {
2136 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2137 the_notification_thread_handle
);
2138 lttng_trigger_put(payload_trigger
);
2141 case LTTNG_ROTATE_SESSION
:
2143 struct lttng_rotate_session_return rotate_return
;
2145 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2147 memset(&rotate_return
, 0, sizeof(rotate_return
));
2148 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2149 DBG("Kernel tracer version is not compatible with the rotation feature");
2150 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2154 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2156 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2162 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2163 sizeof(rotate_return
));
2172 case LTTNG_ROTATION_GET_INFO
:
2174 struct lttng_rotation_get_info_return get_info_return
;
2176 memset(&get_info_return
, 0, sizeof(get_info_return
));
2177 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2178 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2184 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2185 sizeof(get_info_return
));
2194 case LTTNG_ROTATION_SET_SCHEDULE
:
2197 enum lttng_rotation_schedule_type schedule_type
;
2200 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2201 DBG("Kernel tracer version does not support session rotations");
2202 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2206 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2207 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2208 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2210 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2211 schedule_type
, value
,
2212 the_notification_thread_handle
);
2213 if (ret
!= LTTNG_OK
) {
2219 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2221 lttng_session_list_schedules_return schedules
;
2223 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2224 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2225 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2226 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2228 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2238 case LTTNG_CLEAR_SESSION
:
2240 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2243 case LTTNG_LIST_TRIGGERS
:
2245 struct lttng_triggers
*return_triggers
= NULL
;
2246 size_t original_payload_size
;
2247 size_t payload_size
;
2249 ret
= setup_empty_lttng_msg(cmd_ctx
);
2251 ret
= LTTNG_ERR_NOMEM
;
2255 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2257 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2259 if (ret
!= LTTNG_OK
) {
2263 LTTNG_ASSERT(return_triggers
);
2264 ret
= lttng_triggers_serialize(
2265 return_triggers
, &cmd_ctx
->reply_payload
);
2266 lttng_triggers_destroy(return_triggers
);
2268 ERR("Failed to serialize triggers in reply to `list triggers` command");
2269 ret
= LTTNG_ERR_NOMEM
;
2273 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2274 original_payload_size
;
2276 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2281 case LTTNG_EXECUTE_ERROR_QUERY
:
2283 struct lttng_error_query
*query
;
2284 const struct lttng_credentials cmd_creds
= {
2285 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2286 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2288 struct lttng_error_query_results
*results
= 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
= receive_lttng_error_query(
2301 cmd_ctx
, *sock
, sock_error
, &query
);
2302 if (ret
!= LTTNG_OK
) {
2306 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2307 the_notification_thread_handle
);
2308 lttng_error_query_destroy(query
);
2309 if (ret
!= LTTNG_OK
) {
2313 LTTNG_ASSERT(results
);
2314 ret
= lttng_error_query_results_serialize(
2315 results
, &cmd_ctx
->reply_payload
);
2316 lttng_error_query_results_destroy(results
);
2318 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2319 ret
= LTTNG_ERR_NOMEM
;
2323 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2324 original_payload_size
;
2326 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2333 ret
= LTTNG_ERR_UND
;
2338 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2339 DBG("Missing llm header, creating one.");
2340 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2344 /* Set return code */
2345 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2347 if (cmd_ctx
->session
) {
2348 session_unlock(cmd_ctx
->session
);
2349 session_put(cmd_ctx
->session
);
2350 cmd_ctx
->session
= NULL
;
2352 if (need_tracing_session
) {
2353 session_unlock_list();
2356 LTTNG_ASSERT(!rcu_read_ongoing());
2360 static int create_client_sock(void)
2362 int ret
, client_sock
;
2363 const mode_t old_umask
= umask(0);
2365 /* Create client tool unix socket */
2366 client_sock
= lttcomm_create_unix_sock(
2367 the_config
.client_unix_sock_path
.value
);
2368 if (client_sock
< 0) {
2369 ERR("Create unix sock failed: %s",
2370 the_config
.client_unix_sock_path
.value
);
2375 /* Set the cloexec flag */
2376 ret
= utils_set_fd_cloexec(client_sock
);
2378 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2379 "Continuing but note that the consumer daemon will have a "
2380 "reference to this socket on exec()", client_sock
);
2383 /* File permission MUST be 660 */
2384 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2385 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2387 ERR("Set file permissions failed: %s",
2388 the_config
.client_unix_sock_path
.value
);
2390 (void) lttcomm_close_unix_sock(client_sock
);
2394 DBG("Created client socket (fd = %i)", client_sock
);
2401 static void cleanup_client_thread(void *data
)
2403 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2405 lttng_pipe_destroy(quit_pipe
);
2408 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2410 set_thread_status(false);
2414 * This thread manage all clients request using the unix client socket for
2417 static void *thread_manage_clients(void *data
)
2419 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2421 uint32_t revents
, nb_fd
;
2422 struct lttng_poll_event events
;
2423 const int client_sock
= thread_state
.client_sock
;
2424 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2425 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2426 struct command_ctx cmd_ctx
= {};
2428 DBG("[thread] Manage client started");
2430 lttng_payload_init(&cmd_ctx
.reply_payload
);
2432 is_root
= (getuid() == 0);
2434 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2436 rcu_register_thread();
2438 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2440 health_code_update();
2442 ret
= lttcomm_listen_unix_sock(client_sock
);
2448 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2449 * more will be added to this poll set.
2451 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2453 goto error_create_poll
;
2456 /* Add the application registration socket */
2457 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2462 /* Add thread quit pipe */
2463 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2468 /* Set state as running. */
2469 set_thread_status(true);
2470 pthread_cleanup_pop(0);
2472 /* This testpoint is after we signal readiness to the parent. */
2473 if (testpoint(sessiond_thread_manage_clients
)) {
2477 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2481 health_code_update();
2484 const struct cmd_completion_handler
*cmd_completion_handler
;
2486 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2487 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2488 cmd_ctx
.creds
.pid
= 0;
2489 cmd_ctx
.session
= NULL
;
2490 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2491 cmd_ctx
.lttng_msg_size
= 0;
2493 DBG("Accepting client command ...");
2495 /* Inifinite blocking call, waiting for transmission */
2497 health_poll_entry();
2498 ret
= lttng_poll_wait(&events
, -1);
2502 * Restart interrupted system call.
2504 if (errno
== EINTR
) {
2512 for (i
= 0; i
< nb_fd
; i
++) {
2513 revents
= LTTNG_POLL_GETEV(&events
, i
);
2514 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2516 health_code_update();
2518 if (pollfd
== thread_quit_pipe_fd
) {
2522 /* Event on the registration socket */
2523 if (revents
& LPOLLIN
) {
2525 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2526 ERR("Client socket poll error");
2529 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2535 DBG("Wait for client response");
2537 health_code_update();
2539 sock
= lttcomm_accept_unix_sock(client_sock
);
2545 * Set the CLOEXEC flag. Return code is useless because either way, the
2548 (void) utils_set_fd_cloexec(sock
);
2550 /* Set socket option for credentials retrieval */
2551 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2556 health_code_update();
2559 * Data is received from the lttng client. The struct
2560 * lttcomm_session_msg (lsm) contains the command and data request of
2563 DBG("Receiving data from client ...");
2564 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2565 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2566 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2567 DBG("Incomplete recv() from client... continuing");
2576 health_code_update();
2578 // TODO: Validate cmd_ctx including sanity check for
2579 // security purpose.
2581 rcu_thread_online();
2583 * This function dispatch the work to the kernel or userspace tracer
2584 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2585 * informations for the client. The command context struct contains
2586 * everything this function may needs.
2588 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2589 rcu_thread_offline();
2599 * TODO: Inform client somehow of the fatal error. At
2600 * this point, ret < 0 means that a zmalloc failed
2601 * (ENOMEM). Error detected but still accept
2602 * command, unless a socket error has been
2608 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2609 WARN("Command returned an invalid status code, returning unknown error: "
2610 "command type = %s (%d), ret = %d",
2611 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2612 cmd_ctx
.lsm
.cmd_type
, ret
);
2613 ret
= LTTNG_ERR_UNK
;
2616 cmd_completion_handler
= cmd_pop_completion_handler();
2617 if (cmd_completion_handler
) {
2618 enum lttng_error_code completion_code
;
2620 completion_code
= cmd_completion_handler
->run(
2621 cmd_completion_handler
->data
);
2622 if (completion_code
!= LTTNG_OK
) {
2627 health_code_update();
2630 struct lttng_payload_view view
=
2631 lttng_payload_view_from_payload(
2632 &cmd_ctx
.reply_payload
,
2634 struct lttcomm_lttng_msg
*llm
= (typeof(
2635 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2637 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2638 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2640 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2642 DBG("Sending response (size: %d, retcode: %s (%d))",
2643 cmd_ctx
.lttng_msg_size
,
2644 lttng_strerror(-llm
->ret_code
),
2646 ret
= send_unix_sock(sock
, &view
);
2648 ERR("Failed to send data back to client");
2651 /* End of transmission */
2659 health_code_update();
2671 lttng_poll_clean(&events
);
2675 unlink(the_config
.client_unix_sock_path
.value
);
2676 ret
= close(client_sock
);
2683 ERR("Health error occurred in %s", __func__
);
2686 health_unregister(the_health_sessiond
);
2688 DBG("Client thread dying");
2689 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2690 rcu_unregister_thread();
2695 bool shutdown_client_thread(void *thread_data
)
2697 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2698 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2700 return notify_thread_pipe(write_fd
) == 1;
2703 struct lttng_thread
*launch_client_thread(void)
2705 bool thread_running
;
2706 struct lttng_pipe
*client_quit_pipe
;
2707 struct lttng_thread
*thread
= NULL
;
2708 int client_sock_fd
= -1;
2710 sem_init(&thread_state
.ready
, 0, 0);
2711 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2712 if (!client_quit_pipe
) {
2716 client_sock_fd
= create_client_sock();
2717 if (client_sock_fd
< 0) {
2721 thread_state
.client_sock
= client_sock_fd
;
2722 thread
= lttng_thread_create("Client management",
2723 thread_manage_clients
,
2724 shutdown_client_thread
,
2725 cleanup_client_thread
,
2730 /* The client thread now owns the client sock fd and the quit pipe. */
2731 client_sock_fd
= -1;
2732 client_quit_pipe
= NULL
;
2735 * This thread is part of the threads that need to be fully
2736 * initialized before the session daemon is marked as "ready".
2738 thread_running
= wait_thread_status();
2739 if (!thread_running
) {
2744 if (client_sock_fd
>= 0) {
2745 if (close(client_sock_fd
)) {
2746 PERROR("Failed to close client socket");
2749 lttng_thread_put(thread
);
2750 cleanup_client_thread(client_quit_pipe
);