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"
50 static struct thread_state
{
56 static void set_thread_status(bool running
)
58 DBG("Marking client thread's state as %s", running
? "running" : "error");
59 thread_state
.running
= running
;
60 sem_post(&thread_state
.ready
);
63 static bool wait_thread_status(void)
65 DBG("Waiting for client thread to be ready");
66 sem_wait(&thread_state
.ready
);
67 if (thread_state
.running
) {
68 DBG("Client thread is ready");
70 ERR("Initialization of client thread failed");
73 return thread_state
.running
;
77 * Setup the outgoing data buffer for the response (llm) by allocating the
78 * right amount of memory and copying the original information from the lsm
81 * Return 0 on success, negative value on error.
83 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
84 const void *payload_buf
, size_t payload_len
,
85 const void *cmd_header_buf
, size_t cmd_header_len
)
88 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
89 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
90 lttcomm_lttng_msg llm
{};
92 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
93 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
94 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
95 llm
.data_size
= (uint32_t) payload_len
;
97 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
102 lttng_dynamic_pointer_array_clear(&cmd_ctx
->reply_payload
._fd_handles
);
104 cmd_ctx
->lttng_msg_size
= total_msg_size
;
106 /* Append reply header. */
107 ret
= lttng_dynamic_buffer_append(
108 &cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
113 /* Append command header. */
114 if (cmd_header_len
) {
115 ret
= lttng_dynamic_buffer_append(
116 &cmd_ctx
->reply_payload
.buffer
, cmd_header_buf
,
123 /* Append payload. */
125 ret
= lttng_dynamic_buffer_append(
126 &cmd_ctx
->reply_payload
.buffer
, payload_buf
,
137 static int setup_empty_lttng_msg(struct command_ctx
*cmd_ctx
)
140 const struct lttcomm_lttng_msg llm
= {};
142 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
147 /* Append place-holder reply header. */
148 ret
= lttng_dynamic_buffer_append(
149 &cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
154 cmd_ctx
->lttng_msg_size
= sizeof(llm
);
159 static void update_lttng_msg(struct command_ctx
*cmd_ctx
, size_t cmd_header_len
,
162 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
163 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
164 struct lttcomm_lttng_msg
*p_llm
;
165 lttcomm_lttng_msg llm
{};
167 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
168 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
169 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
170 llm
.data_size
= (uint32_t) payload_len
;
172 LTTNG_ASSERT(cmd_ctx
->reply_payload
.buffer
.size
>= sizeof(llm
));
174 p_llm
= (typeof(p_llm
)) cmd_ctx
->reply_payload
.buffer
.data
;
176 /* Update existing header. */
177 memcpy(p_llm
, &llm
, sizeof(llm
));
179 cmd_ctx
->lttng_msg_size
= total_msg_size
;
183 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
184 * exec or it will fail.
186 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
188 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
192 * Fork and exec a consumer daemon (consumerd).
194 * Return pid if successful else -1.
196 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
200 const char *consumer_to_use
;
201 const char *verbosity
;
204 DBG("Spawning consumerd");
211 if (the_config
.verbose_consumer
) {
212 verbosity
= "--verbose";
213 } else if (lttng_opt_quiet
) {
214 verbosity
= "--quiet";
219 switch (consumer_data
->type
) {
220 case LTTNG_CONSUMER_KERNEL
:
222 * Find out which consumerd to execute. We will first try the
223 * 64-bit path, then the sessiond's installation directory, and
224 * fallback on the 32-bit one,
226 DBG3("Looking for a kernel consumer at these locations:");
227 DBG3(" 1) %s", the_config
.consumerd64_bin_path
.value
? : "NULL");
228 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
229 DBG3(" 3) %s", the_config
.consumerd32_bin_path
.value
? : "NULL");
230 if (stat(the_config
.consumerd64_bin_path
.value
, &st
) == 0) {
231 DBG3("Found location #1");
232 consumer_to_use
= the_config
.consumerd64_bin_path
.value
;
233 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
234 DBG3("Found location #2");
235 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
236 } else if (the_config
.consumerd32_bin_path
.value
&&
237 stat(the_config
.consumerd32_bin_path
.value
, &st
) == 0) {
238 DBG3("Found location #3");
239 consumer_to_use
= the_config
.consumerd32_bin_path
.value
;
241 DBG("Could not find any valid consumerd executable");
245 DBG("Using kernel consumer at: %s", consumer_to_use
);
246 (void) execl(consumer_to_use
, "lttng-consumerd",
247 verbosity
, "-k", "--consumerd-cmd-sock",
248 consumer_data
->cmd_unix_sock_path
,
249 "--consumerd-err-sock",
250 consumer_data
->err_unix_sock_path
,
252 the_config
.tracing_group_name
.value
,
255 case LTTNG_CONSUMER64_UST
:
257 if (the_config
.consumerd64_lib_dir
.value
) {
262 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
266 tmplen
= strlen(the_config
.consumerd64_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
267 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
272 strcat(tmpnew
, the_config
.consumerd64_lib_dir
.value
);
273 if (tmp
[0] != '\0') {
277 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
284 DBG("Using 64-bit UST consumer at: %s",
285 the_config
.consumerd64_bin_path
.value
);
286 (void) execl(the_config
.consumerd64_bin_path
.value
,
287 "lttng-consumerd", verbosity
, "-u",
288 "--consumerd-cmd-sock",
289 consumer_data
->cmd_unix_sock_path
,
290 "--consumerd-err-sock",
291 consumer_data
->err_unix_sock_path
,
293 the_config
.tracing_group_name
.value
,
297 case LTTNG_CONSUMER32_UST
:
299 if (the_config
.consumerd32_lib_dir
.value
) {
304 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
308 tmplen
= strlen(the_config
.consumerd32_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
309 tmpnew
= zmalloc
<char>(tmplen
+ 1 /* \0 */);
314 strcat(tmpnew
, the_config
.consumerd32_lib_dir
.value
);
315 if (tmp
[0] != '\0') {
319 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
326 DBG("Using 32-bit UST consumer at: %s",
327 the_config
.consumerd32_bin_path
.value
);
328 (void) execl(the_config
.consumerd32_bin_path
.value
,
329 "lttng-consumerd", verbosity
, "-u",
330 "--consumerd-cmd-sock",
331 consumer_data
->cmd_unix_sock_path
,
332 "--consumerd-err-sock",
333 consumer_data
->err_unix_sock_path
,
335 the_config
.tracing_group_name
.value
,
340 ERR("unknown consumer type");
344 PERROR("Consumer execl()");
346 /* Reaching this point, we got a failure on our execl(). */
348 } else if (pid
> 0) {
351 PERROR("start consumer fork");
359 * Spawn the consumerd daemon and session daemon thread.
361 static int start_consumerd(struct consumer_data
*consumer_data
)
366 * Set the listen() state on the socket since there is a possible race
367 * between the exec() of the consumer daemon and this call if place in the
368 * consumer thread. See bug #366 for more details.
370 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
375 pthread_mutex_lock(&consumer_data
->pid_mutex
);
376 if (consumer_data
->pid
!= 0) {
377 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
381 ret
= spawn_consumerd(consumer_data
);
383 ERR("Spawning consumerd failed");
384 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
388 /* Setting up the consumer_data pid */
389 consumer_data
->pid
= ret
;
390 DBG2("Consumer pid %d", consumer_data
->pid
);
391 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
393 DBG2("Spawning consumer control thread");
394 ret
= spawn_consumer_thread(consumer_data
);
396 ERR("Fatal error spawning consumer control thread");
404 /* Cleanup already created sockets on error. */
405 if (consumer_data
->err_sock
>= 0) {
408 err
= close(consumer_data
->err_sock
);
410 PERROR("close consumer data error socket");
417 * Copy consumer output from the tracing session to the domain session. The
418 * function also applies the right modification on a per domain basis for the
419 * trace files destination directory.
421 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
424 const char *dir_name
;
425 struct consumer_output
*consumer
;
427 LTTNG_ASSERT(session
);
428 LTTNG_ASSERT(session
->consumer
);
431 case LTTNG_DOMAIN_KERNEL
:
432 DBG3("Copying tracing session consumer output in kernel session");
434 * XXX: We should audit the session creation and what this function
435 * does "extra" in order to avoid a destroy since this function is used
436 * in the domain session creation (kernel and ust) only. Same for UST
439 if (session
->kernel_session
->consumer
) {
440 consumer_output_put(session
->kernel_session
->consumer
);
442 session
->kernel_session
->consumer
=
443 consumer_copy_output(session
->consumer
);
444 /* Ease our life a bit for the next part */
445 consumer
= session
->kernel_session
->consumer
;
446 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
448 case LTTNG_DOMAIN_JUL
:
449 case LTTNG_DOMAIN_LOG4J
:
450 case LTTNG_DOMAIN_PYTHON
:
451 case LTTNG_DOMAIN_UST
:
452 DBG3("Copying tracing session consumer output in UST session");
453 if (session
->ust_session
->consumer
) {
454 consumer_output_put(session
->ust_session
->consumer
);
456 session
->ust_session
->consumer
=
457 consumer_copy_output(session
->consumer
);
458 /* Ease our life a bit for the next part */
459 consumer
= session
->ust_session
->consumer
;
460 dir_name
= DEFAULT_UST_TRACE_DIR
;
463 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
467 /* Append correct directory to subdir */
468 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
,
469 sizeof(consumer
->domain_subdir
));
474 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
482 * Create an UST session and add it to the session ust list.
484 static int create_ust_session(struct ltt_session
*session
,
485 const struct lttng_domain
*domain
)
488 struct ltt_ust_session
*lus
= NULL
;
490 LTTNG_ASSERT(session
);
491 LTTNG_ASSERT(domain
);
492 LTTNG_ASSERT(session
->consumer
);
494 switch (domain
->type
) {
495 case LTTNG_DOMAIN_JUL
:
496 case LTTNG_DOMAIN_LOG4J
:
497 case LTTNG_DOMAIN_PYTHON
:
498 case LTTNG_DOMAIN_UST
:
501 ERR("Unknown UST domain on create session %d", domain
->type
);
502 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
506 DBG("Creating UST session");
508 lus
= trace_ust_create_session(session
->id
);
510 ret
= LTTNG_ERR_UST_SESS_FAIL
;
514 lus
->uid
= session
->uid
;
515 lus
->gid
= session
->gid
;
516 lus
->output_traces
= session
->output_traces
;
517 lus
->snapshot_mode
= session
->snapshot_mode
;
518 lus
->live_timer_interval
= session
->live_timer
;
519 session
->ust_session
= lus
;
520 if (session
->shm_path
[0]) {
521 strncpy(lus
->root_shm_path
, session
->shm_path
,
522 sizeof(lus
->root_shm_path
));
523 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
524 strncpy(lus
->shm_path
, session
->shm_path
,
525 sizeof(lus
->shm_path
));
526 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
527 strncat(lus
->shm_path
, "/ust",
528 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
530 /* Copy session output to the newly created UST session */
531 ret
= copy_session_consumer(domain
->type
, session
);
532 if (ret
!= LTTNG_OK
) {
540 session
->ust_session
= NULL
;
545 * Create a kernel tracer session then create the default channel.
547 static int create_kernel_session(struct ltt_session
*session
)
551 DBG("Creating kernel session");
553 ret
= kernel_create_session(session
);
555 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
559 /* Code flow safety */
560 LTTNG_ASSERT(session
->kernel_session
);
562 /* Copy session output to the newly created Kernel session */
563 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
564 if (ret
!= LTTNG_OK
) {
568 session
->kernel_session
->uid
= session
->uid
;
569 session
->kernel_session
->gid
= session
->gid
;
570 session
->kernel_session
->output_traces
= session
->output_traces
;
571 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
572 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
577 trace_kernel_destroy_session(session
->kernel_session
);
578 session
->kernel_session
= NULL
;
584 * Count number of session permitted by uid/gid.
586 static unsigned int lttng_sessions_count(uid_t uid
,
587 gid_t gid
__attribute__((unused
)))
590 struct ltt_session
*session
;
591 const struct ltt_session_list
*session_list
= session_get_list();
593 DBG("Counting number of available session for UID %d", uid
);
594 cds_list_for_each_entry(session
, &session_list
->head
, list
) {
595 if (!session_get(session
)) {
598 session_lock(session
);
599 /* Only count the sessions the user can control. */
600 if (session_access_ok(session
, uid
) &&
601 !session
->destroyed
) {
604 session_unlock(session
);
605 session_put(session
);
610 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
613 struct lttng_trigger
**_trigger
)
617 ssize_t sock_recv_len
;
618 enum lttng_error_code ret_code
;
619 struct lttng_payload trigger_payload
;
620 struct lttng_trigger
*trigger
= NULL
;
622 lttng_payload_init(&trigger_payload
);
623 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
624 ret
= lttng_dynamic_buffer_set_size(
625 &trigger_payload
.buffer
, trigger_len
);
627 ret_code
= LTTNG_ERR_NOMEM
;
631 sock_recv_len
= lttcomm_recv_unix_sock(
632 sock
, trigger_payload
.buffer
.data
, trigger_len
);
633 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
634 ERR("Failed to receive trigger in command payload");
636 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
640 /* Receive fds, if any. */
641 if (cmd_ctx
->lsm
.fd_count
> 0) {
642 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
643 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
644 if (sock_recv_len
> 0 &&
645 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
646 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
647 cmd_ctx
->lsm
.fd_count
, (int) ret
);
648 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
651 } else if (sock_recv_len
<= 0) {
652 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
653 cmd_ctx
->lsm
.fd_count
, (int) ret
);
654 ret_code
= LTTNG_ERR_FATAL
;
660 /* Deserialize trigger. */
662 struct lttng_payload_view view
=
663 lttng_payload_view_from_payload(
664 &trigger_payload
, 0, -1);
666 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
668 ERR("Invalid trigger received as part of command payload");
669 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
670 lttng_trigger_put(trigger
);
679 lttng_payload_reset(&trigger_payload
);
683 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
686 struct lttng_error_query
**_query
)
690 ssize_t sock_recv_len
;
691 enum lttng_error_code ret_code
;
692 struct lttng_payload query_payload
;
693 struct lttng_error_query
*query
= NULL
;
695 lttng_payload_init(&query_payload
);
696 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
697 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
699 ret_code
= LTTNG_ERR_NOMEM
;
703 sock_recv_len
= lttcomm_recv_unix_sock(
704 sock
, query_payload
.buffer
.data
, query_len
);
705 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
706 ERR("Failed to receive error query in command payload");
708 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
712 /* Receive fds, if any. */
713 if (cmd_ctx
->lsm
.fd_count
> 0) {
714 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
715 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
716 if (sock_recv_len
> 0 &&
717 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
718 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
719 cmd_ctx
->lsm
.fd_count
, (int) ret
);
720 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
723 } else if (sock_recv_len
<= 0) {
724 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
725 cmd_ctx
->lsm
.fd_count
, (int) ret
);
726 ret_code
= LTTNG_ERR_FATAL
;
732 /* Deserialize error query. */
734 struct lttng_payload_view view
=
735 lttng_payload_view_from_payload(
736 &query_payload
, 0, -1);
738 if (lttng_error_query_create_from_payload(&view
, &query
) !=
740 ERR("Invalid error query received as part of command payload");
741 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
750 lttng_payload_reset(&query_payload
);
754 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
757 struct lttng_event
**out_event
,
758 char **out_filter_expression
,
759 struct lttng_bytecode
**out_bytecode
,
760 struct lttng_event_exclusion
**out_exclusion
)
764 ssize_t sock_recv_len
;
765 enum lttng_error_code ret_code
;
766 struct lttng_payload event_payload
;
767 struct lttng_event
*local_event
= NULL
;
768 char *local_filter_expression
= NULL
;
769 struct lttng_bytecode
*local_bytecode
= NULL
;
770 struct lttng_event_exclusion
*local_exclusion
= NULL
;
772 lttng_payload_init(&event_payload
);
773 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
) {
774 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
775 } else if (cmd_ctx
->lsm
.cmd_type
== LTTNG_DISABLE_EVENT
) {
776 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
781 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
783 ret_code
= LTTNG_ERR_NOMEM
;
787 sock_recv_len
= lttcomm_recv_unix_sock(
788 sock
, event_payload
.buffer
.data
, event_len
);
789 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
790 ERR("Failed to receive event in command payload");
792 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
796 /* Receive fds, if any. */
797 if (cmd_ctx
->lsm
.fd_count
> 0) {
798 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
799 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
800 if (sock_recv_len
> 0 &&
801 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
802 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
803 cmd_ctx
->lsm
.fd_count
, (int) ret
);
804 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
807 } else if (sock_recv_len
<= 0) {
808 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
809 cmd_ctx
->lsm
.fd_count
, (int) ret
);
810 ret_code
= LTTNG_ERR_FATAL
;
816 /* Deserialize event. */
819 struct lttng_payload_view event_view
=
820 lttng_payload_view_from_payload(
821 &event_payload
, 0, -1);
823 len
= lttng_event_create_from_payload(&event_view
, &local_event
,
824 &local_exclusion
, &local_filter_expression
,
828 ERR("Failed to create an event from the received buffer");
829 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
833 if (len
!= event_len
) {
834 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
", payload length = %zd", event_len
, len
);
835 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
840 *out_event
= local_event
;
841 *out_exclusion
= local_exclusion
;
842 *out_filter_expression
= local_filter_expression
;
843 *out_bytecode
= local_bytecode
;
845 local_exclusion
= NULL
;
846 local_filter_expression
= NULL
;
847 local_bytecode
= NULL
;
852 lttng_payload_reset(&event_payload
);
853 lttng_event_destroy(local_event
);
854 free(local_filter_expression
);
855 free(local_bytecode
);
856 free(local_exclusion
);
860 static enum lttng_error_code
receive_lttng_event_context(
861 const struct command_ctx
*cmd_ctx
,
864 struct lttng_event_context
**out_event_context
)
867 const size_t event_context_len
=
868 (size_t) cmd_ctx
->lsm
.u
.context
.length
;
869 ssize_t sock_recv_len
;
870 enum lttng_error_code ret_code
;
871 struct lttng_payload event_context_payload
;
872 struct lttng_event_context
*context
= NULL
;
874 lttng_payload_init(&event_context_payload
);
876 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
,
879 ret_code
= LTTNG_ERR_NOMEM
;
883 sock_recv_len
= lttcomm_recv_unix_sock(
884 sock
, event_context_payload
.buffer
.data
,
886 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
887 ERR("Failed to receive event context in command payload");
889 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
893 /* Deserialize event. */
896 struct lttng_payload_view event_context_view
=
897 lttng_payload_view_from_payload(
898 &event_context_payload
, 0, -1);
900 len
= lttng_event_context_create_from_payload(
901 &event_context_view
, &context
);
904 ERR("Failed to create a event context from the received buffer");
905 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
909 if (len
!= event_context_len
) {
910 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd", event_context_len
, len
);
911 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
916 *out_event_context
= context
;
921 lttng_event_context_destroy(context
);
922 lttng_payload_reset(&event_context_payload
);
927 * Version of setup_lttng_msg() without command header.
929 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
930 void *payload_buf
, size_t payload_len
)
932 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
936 * Check if the current kernel tracer supports the session rotation feature.
937 * Return 1 if it does, 0 otherwise.
939 static int check_rotate_compatible(void)
943 if (the_kernel_tracer_version
.major
!= 2 ||
944 the_kernel_tracer_version
.minor
< 11) {
945 DBG("Kernel tracer version is not compatible with the rotation feature");
953 * Send data on a unix socket using the liblttsessiondcomm API.
955 * Return lttcomm error code.
957 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
960 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
962 /* Check valid length */
963 if (view
->buffer
.size
== 0) {
968 ret
= lttcomm_send_unix_sock(
969 sock
, view
->buffer
.data
, view
->buffer
.size
);
975 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
986 * Process the command requested by the lttng client within the command
987 * context structure. This function make sure that the return structure (llm)
988 * is set and ready for transmission before returning.
990 * Return any error encountered or 0 for success.
992 * "sock" is only used for special-case var. len data.
993 * A command may assume the ownership of the socket, in which case its value
994 * should be set to -1.
996 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
1000 bool need_tracing_session
= true;
1002 bool need_consumerd
;
1004 DBG("Processing client command '%s\' (%d)",
1005 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
1006 cmd_ctx
->lsm
.cmd_type
);
1010 switch (cmd_ctx
->lsm
.cmd_type
) {
1011 case LTTNG_CREATE_SESSION_EXT
:
1012 case LTTNG_DESTROY_SESSION
:
1013 case LTTNG_LIST_SESSIONS
:
1014 case LTTNG_LIST_DOMAINS
:
1015 case LTTNG_START_TRACE
:
1016 case LTTNG_STOP_TRACE
:
1017 case LTTNG_DATA_PENDING
:
1018 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1019 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1020 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1021 case LTTNG_SNAPSHOT_RECORD
:
1022 case LTTNG_SAVE_SESSION
:
1023 case LTTNG_SET_SESSION_SHM_PATH
:
1024 case LTTNG_REGENERATE_METADATA
:
1025 case LTTNG_REGENERATE_STATEDUMP
:
1026 case LTTNG_ROTATE_SESSION
:
1027 case LTTNG_ROTATION_GET_INFO
:
1028 case LTTNG_ROTATION_SET_SCHEDULE
:
1029 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1030 case LTTNG_CLEAR_SESSION
:
1031 case LTTNG_LIST_TRIGGERS
:
1032 case LTTNG_EXECUTE_ERROR_QUERY
:
1033 need_domain
= false;
1039 /* Needs a functioning consumerd? */
1040 switch (cmd_ctx
->lsm
.cmd_type
) {
1041 case LTTNG_REGISTER_TRIGGER
:
1042 case LTTNG_UNREGISTER_TRIGGER
:
1043 case LTTNG_EXECUTE_ERROR_QUERY
:
1044 need_consumerd
= false;
1047 need_consumerd
= true;
1051 if (the_config
.no_kernel
&& need_domain
&&
1052 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1054 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1056 ret
= LTTNG_ERR_KERN_NA
;
1061 /* Deny register consumer if we already have a spawned consumer. */
1062 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
1063 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1064 if (the_kconsumer_data
.pid
> 0) {
1065 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1066 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1069 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1073 * Check for command that don't needs to allocate a returned payload. We do
1074 * this here so we don't have to make the call for no payload at each
1077 switch(cmd_ctx
->lsm
.cmd_type
) {
1078 case LTTNG_LIST_SESSIONS
:
1079 case LTTNG_LIST_TRACEPOINTS
:
1080 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1081 case LTTNG_LIST_DOMAINS
:
1082 case LTTNG_LIST_CHANNELS
:
1083 case LTTNG_LIST_EVENTS
:
1084 case LTTNG_LIST_SYSCALLS
:
1085 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1086 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1087 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1088 case LTTNG_DATA_PENDING
:
1089 case LTTNG_ROTATE_SESSION
:
1090 case LTTNG_ROTATION_GET_INFO
:
1091 case LTTNG_REGISTER_TRIGGER
:
1092 case LTTNG_LIST_TRIGGERS
:
1093 case LTTNG_EXECUTE_ERROR_QUERY
:
1096 /* Setup lttng message with no payload */
1097 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1099 /* This label does not try to unlock the session */
1100 goto init_setup_error
;
1104 /* Commands that DO NOT need a session. */
1105 switch (cmd_ctx
->lsm
.cmd_type
) {
1106 case LTTNG_CREATE_SESSION_EXT
:
1107 case LTTNG_LIST_SESSIONS
:
1108 case LTTNG_LIST_TRACEPOINTS
:
1109 case LTTNG_LIST_SYSCALLS
:
1110 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1111 case LTTNG_SAVE_SESSION
:
1112 case LTTNG_REGISTER_TRIGGER
:
1113 case LTTNG_UNREGISTER_TRIGGER
:
1114 case LTTNG_LIST_TRIGGERS
:
1115 case LTTNG_EXECUTE_ERROR_QUERY
:
1116 need_tracing_session
= false;
1119 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1121 * We keep the session list lock across _all_ commands
1122 * for now, because the per-session lock does not
1123 * handle teardown properly.
1125 session_lock_list();
1126 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1127 if (cmd_ctx
->session
== NULL
) {
1128 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1131 /* Acquire lock for the session */
1132 session_lock(cmd_ctx
->session
);
1138 * Commands that need a valid session but should NOT create one if none
1139 * exists. Instead of creating one and destroying it when the command is
1140 * handled, process that right before so we save some round trip in useless
1143 switch (cmd_ctx
->lsm
.cmd_type
) {
1144 case LTTNG_DISABLE_CHANNEL
:
1145 case LTTNG_DISABLE_EVENT
:
1146 switch (cmd_ctx
->lsm
.domain
.type
) {
1147 case LTTNG_DOMAIN_KERNEL
:
1148 if (!cmd_ctx
->session
->kernel_session
) {
1149 ret
= LTTNG_ERR_NO_CHANNEL
;
1153 case LTTNG_DOMAIN_JUL
:
1154 case LTTNG_DOMAIN_LOG4J
:
1155 case LTTNG_DOMAIN_PYTHON
:
1156 case LTTNG_DOMAIN_UST
:
1157 if (!cmd_ctx
->session
->ust_session
) {
1158 ret
= LTTNG_ERR_NO_CHANNEL
;
1163 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1175 * Check domain type for specific "pre-action".
1177 switch (cmd_ctx
->lsm
.domain
.type
) {
1178 case LTTNG_DOMAIN_KERNEL
:
1180 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1184 /* Kernel tracer check */
1185 if (!kernel_tracer_is_initialized()) {
1186 /* Basically, load kernel tracer modules */
1187 ret
= init_kernel_tracer();
1193 /* Consumer is in an ERROR state. Report back to client */
1194 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1196 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1200 /* Need a session for kernel command */
1201 if (need_tracing_session
) {
1202 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1203 ret
= create_kernel_session(cmd_ctx
->session
);
1204 if (ret
!= LTTNG_OK
) {
1205 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1210 /* Start the kernel consumer daemon */
1211 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1212 if (the_kconsumer_data
.pid
== 0 &&
1213 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1214 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1215 ret
= start_consumerd(&the_kconsumer_data
);
1217 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1220 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1222 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1226 * The consumer was just spawned so we need to add the socket to
1227 * the consumer output of the session if exist.
1229 ret
= consumer_create_socket(&the_kconsumer_data
,
1230 cmd_ctx
->session
->kernel_session
->consumer
);
1237 case LTTNG_DOMAIN_JUL
:
1238 case LTTNG_DOMAIN_LOG4J
:
1239 case LTTNG_DOMAIN_PYTHON
:
1240 if (!agent_tracing_is_enabled()) {
1241 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1245 case LTTNG_DOMAIN_UST
:
1247 if (!ust_app_supported()) {
1248 ret
= LTTNG_ERR_NO_UST
;
1252 /* Consumer is in an ERROR state. Report back to client */
1253 if (need_consumerd
&&
1254 uatomic_read(&the_ust_consumerd_state
) ==
1256 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1260 if (need_tracing_session
) {
1261 /* Create UST session if none exist. */
1262 if (cmd_ctx
->session
->ust_session
== NULL
) {
1263 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1264 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1265 if (ret
!= LTTNG_OK
) {
1270 /* Start the UST consumer daemons */
1272 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1273 if (the_config
.consumerd64_bin_path
.value
&&
1274 the_ustconsumer64_data
.pid
== 0 &&
1275 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1276 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1277 ret
= start_consumerd(&the_ustconsumer64_data
);
1279 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1280 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1284 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1285 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1287 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1291 * Setup socket for consumer 64 bit. No need for atomic access
1292 * since it was set above and can ONLY be set in this thread.
1294 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1295 cmd_ctx
->session
->ust_session
->consumer
);
1301 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1302 if (the_config
.consumerd32_bin_path
.value
&&
1303 the_ustconsumer32_data
.pid
== 0 &&
1304 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1305 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1306 ret
= start_consumerd(&the_ustconsumer32_data
);
1308 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1309 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1313 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1314 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1316 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1320 * Setup socket for consumer 32 bit. No need for atomic access
1321 * since it was set above and can ONLY be set in this thread.
1323 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1324 cmd_ctx
->session
->ust_session
->consumer
);
1336 /* Validate consumer daemon state when start/stop trace command */
1337 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1338 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1339 switch (cmd_ctx
->lsm
.domain
.type
) {
1340 case LTTNG_DOMAIN_NONE
:
1342 case LTTNG_DOMAIN_JUL
:
1343 case LTTNG_DOMAIN_LOG4J
:
1344 case LTTNG_DOMAIN_PYTHON
:
1345 case LTTNG_DOMAIN_UST
:
1346 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1347 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1351 case LTTNG_DOMAIN_KERNEL
:
1352 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1353 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1358 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1364 * Check that the UID matches that of the tracing session.
1365 * The root user can interact with all sessions.
1367 if (need_tracing_session
) {
1368 if (!session_access_ok(cmd_ctx
->session
,
1369 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1370 cmd_ctx
->session
->destroyed
) {
1371 ret
= LTTNG_ERR_EPERM
;
1377 * Send relayd information to consumer as soon as we have a domain and a
1380 if (cmd_ctx
->session
&& need_domain
) {
1382 * Setup relayd if not done yet. If the relayd information was already
1383 * sent to the consumer, this call will gracefully return.
1385 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1386 if (ret
!= LTTNG_OK
) {
1391 /* Process by command type */
1392 switch (cmd_ctx
->lsm
.cmd_type
) {
1393 case LTTNG_ADD_CONTEXT
:
1395 struct lttng_event_context
*event_context
= NULL
;
1396 const enum lttng_error_code ret_code
=
1397 receive_lttng_event_context(
1398 cmd_ctx
, *sock
, sock_error
, &event_context
);
1400 if (ret_code
!= LTTNG_OK
) {
1401 ret
= (int) ret_code
;
1405 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1406 lttng_event_context_destroy(event_context
);
1409 case LTTNG_DISABLE_CHANNEL
:
1411 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1412 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1415 case LTTNG_ENABLE_CHANNEL
:
1417 ret
= cmd_enable_channel(
1418 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1421 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1422 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1424 struct lttng_dynamic_buffer payload
;
1425 struct lttng_buffer_view payload_view
;
1426 const bool add_value
=
1427 cmd_ctx
->lsm
.cmd_type
==
1428 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1429 const size_t name_len
=
1430 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1432 const enum lttng_domain_type domain_type
=
1433 (enum lttng_domain_type
)
1434 cmd_ctx
->lsm
.domain
.type
;
1435 const enum lttng_process_attr process_attr
=
1436 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1437 .process_attr_tracker_add_remove_include_value
1439 const enum lttng_process_attr_value_type value_type
=
1440 (enum lttng_process_attr_value_type
) cmd_ctx
1442 .process_attr_tracker_add_remove_include_value
1444 struct process_attr_value
*value
;
1445 enum lttng_error_code ret_code
;
1446 long login_name_max
;
1448 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1449 if (login_name_max
< 0) {
1450 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1451 ret
= LTTNG_ERR_INVALID
;
1455 /* Receive remaining variable length payload if applicable. */
1456 if (name_len
> login_name_max
) {
1458 * POSIX mandates user and group names that are at least
1459 * 8 characters long. Note that although shadow-utils
1460 * (useradd, groupaadd, etc.) use 32 chars as their
1461 * limit (from bits/utmp.h, UT_NAMESIZE),
1462 * LOGIN_NAME_MAX is defined to 256.
1464 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1465 add_value
? "addition" : "removal",
1466 name_len
, login_name_max
);
1467 ret
= LTTNG_ERR_INVALID
;
1471 lttng_dynamic_buffer_init(&payload
);
1472 if (name_len
!= 0) {
1474 * Receive variable payload for user/group name
1477 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1479 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1480 add_value
? "add" : "remove");
1481 ret
= LTTNG_ERR_NOMEM
;
1482 goto error_add_remove_tracker_value
;
1485 ret
= lttcomm_recv_unix_sock(
1486 *sock
, payload
.data
, name_len
);
1488 ERR("Failed to receive payload of %s process attribute tracker value argument",
1489 add_value
? "add" : "remove");
1491 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1492 goto error_add_remove_tracker_value
;
1496 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1497 &payload
, 0, name_len
);
1498 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1499 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1500 goto error_add_remove_tracker_value
;
1504 * Validate the value type and domains are legal for the process
1505 * attribute tracker that is specified and convert the value to
1506 * add/remove to the internal sessiond representation.
1508 ret_code
= process_attr_value_from_comm(domain_type
,
1509 process_attr
, value_type
,
1510 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1512 &payload_view
, &value
);
1513 if (ret_code
!= LTTNG_OK
) {
1515 goto error_add_remove_tracker_value
;
1519 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1520 cmd_ctx
->session
, domain_type
,
1521 process_attr
, value
);
1523 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1524 cmd_ctx
->session
, domain_type
,
1525 process_attr
, value
);
1527 process_attr_value_destroy(value
);
1528 error_add_remove_tracker_value
:
1529 lttng_dynamic_buffer_reset(&payload
);
1532 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1534 enum lttng_tracking_policy tracking_policy
;
1535 const enum lttng_domain_type domain_type
=
1536 (enum lttng_domain_type
)
1537 cmd_ctx
->lsm
.domain
.type
;
1538 const enum lttng_process_attr process_attr
=
1539 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1540 .process_attr_tracker_get_tracking_policy
1543 ret
= cmd_process_attr_tracker_get_tracking_policy(
1544 cmd_ctx
->session
, domain_type
, process_attr
,
1546 if (ret
!= LTTNG_OK
) {
1550 uint32_t tracking_policy_u32
= tracking_policy
;
1551 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1552 &tracking_policy_u32
, sizeof(uint32_t));
1554 ret
= LTTNG_ERR_NOMEM
;
1560 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1562 const enum lttng_tracking_policy tracking_policy
=
1563 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1564 .process_attr_tracker_set_tracking_policy
1566 const enum lttng_domain_type domain_type
=
1567 (enum lttng_domain_type
)
1568 cmd_ctx
->lsm
.domain
.type
;
1569 const enum lttng_process_attr process_attr
=
1570 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1571 .process_attr_tracker_set_tracking_policy
1574 ret
= cmd_process_attr_tracker_set_tracking_policy(
1575 cmd_ctx
->session
, domain_type
, process_attr
,
1577 if (ret
!= LTTNG_OK
) {
1582 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1584 struct lttng_process_attr_values
*values
;
1585 struct lttng_dynamic_buffer reply
;
1586 const enum lttng_domain_type domain_type
=
1587 (enum lttng_domain_type
)
1588 cmd_ctx
->lsm
.domain
.type
;
1589 const enum lttng_process_attr process_attr
=
1590 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1591 .process_attr_tracker_get_inclusion_set
1594 ret
= cmd_process_attr_tracker_get_inclusion_set(
1595 cmd_ctx
->session
, domain_type
, process_attr
,
1597 if (ret
!= LTTNG_OK
) {
1601 lttng_dynamic_buffer_init(&reply
);
1602 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1604 goto error_tracker_get_inclusion_set
;
1607 ret
= setup_lttng_msg_no_cmd_header(
1608 cmd_ctx
, reply
.data
, reply
.size
);
1610 ret
= LTTNG_ERR_NOMEM
;
1611 goto error_tracker_get_inclusion_set
;
1615 error_tracker_get_inclusion_set
:
1616 lttng_process_attr_values_destroy(values
);
1617 lttng_dynamic_buffer_reset(&reply
);
1620 case LTTNG_ENABLE_EVENT
:
1621 case LTTNG_DISABLE_EVENT
:
1623 struct lttng_event
*event
;
1624 char *filter_expression
;
1625 struct lttng_event_exclusion
*exclusions
;
1626 struct lttng_bytecode
*bytecode
;
1627 const enum lttng_error_code ret_code
= receive_lttng_event(
1628 cmd_ctx
, *sock
, sock_error
, &event
,
1629 &filter_expression
, &bytecode
, &exclusions
);
1631 if (ret_code
!= LTTNG_OK
) {
1632 ret
= (int) ret_code
;
1637 * Ownership of filter_expression, exclusions, and bytecode is
1638 * always transferred.
1640 ret
= cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
?
1641 cmd_enable_event(cmd_ctx
, event
,
1642 filter_expression
, exclusions
,
1644 the_kernel_poll_pipe
[1]) :
1645 cmd_disable_event(cmd_ctx
, event
,
1646 filter_expression
, bytecode
,
1648 lttng_event_destroy(event
);
1651 case LTTNG_LIST_TRACEPOINTS
:
1653 enum lttng_error_code ret_code
;
1654 size_t original_payload_size
;
1655 size_t payload_size
;
1656 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1658 ret
= setup_empty_lttng_msg(cmd_ctx
);
1660 ret
= LTTNG_ERR_NOMEM
;
1664 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1666 session_lock_list();
1667 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1668 &cmd_ctx
->reply_payload
);
1669 session_unlock_list();
1670 if (ret_code
!= LTTNG_OK
) {
1671 ret
= (int) ret_code
;
1675 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1676 command_header_size
- original_payload_size
;
1677 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1682 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1684 enum lttng_error_code ret_code
;
1685 size_t original_payload_size
;
1686 size_t payload_size
;
1687 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1689 ret
= setup_empty_lttng_msg(cmd_ctx
);
1691 ret
= LTTNG_ERR_NOMEM
;
1695 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1697 session_lock_list();
1698 ret_code
= cmd_list_tracepoint_fields(
1699 cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1700 session_unlock_list();
1701 if (ret_code
!= LTTNG_OK
) {
1702 ret
= (int) ret_code
;
1706 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1707 command_header_size
- original_payload_size
;
1708 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1713 case LTTNG_LIST_SYSCALLS
:
1715 enum lttng_error_code ret_code
;
1716 size_t original_payload_size
;
1717 size_t payload_size
;
1718 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1720 ret
= setup_empty_lttng_msg(cmd_ctx
);
1722 ret
= LTTNG_ERR_NOMEM
;
1726 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1728 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1729 if (ret_code
!= LTTNG_OK
) {
1730 ret
= (int) ret_code
;
1734 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1735 command_header_size
- original_payload_size
;
1736 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1741 case LTTNG_SET_CONSUMER_URI
:
1744 struct lttng_uri
*uris
;
1746 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1747 len
= nb_uri
* sizeof(struct lttng_uri
);
1750 ret
= LTTNG_ERR_INVALID
;
1754 uris
= calloc
<lttng_uri
>(nb_uri
);
1756 ret
= LTTNG_ERR_FATAL
;
1760 /* Receive variable len data */
1761 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1762 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1764 DBG("No URIs received from client... continuing");
1766 ret
= LTTNG_ERR_SESSION_FAIL
;
1771 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1773 if (ret
!= LTTNG_OK
) {
1780 case LTTNG_START_TRACE
:
1783 * On the first start, if we have a kernel session and we have
1784 * enabled time or size-based rotations, we have to make sure
1785 * the kernel tracer supports it.
1787 if (!cmd_ctx
->session
->has_been_started
&& \
1788 cmd_ctx
->session
->kernel_session
&& \
1789 (cmd_ctx
->session
->rotate_timer_period
|| \
1790 cmd_ctx
->session
->rotate_size
) && \
1791 !check_rotate_compatible()) {
1792 DBG("Kernel tracer version is not compatible with the rotation feature");
1793 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1796 ret
= cmd_start_trace(cmd_ctx
->session
);
1799 case LTTNG_STOP_TRACE
:
1801 ret
= cmd_stop_trace(cmd_ctx
->session
);
1804 case LTTNG_DESTROY_SESSION
:
1806 ret
= cmd_destroy_session(cmd_ctx
->session
,
1807 the_notification_thread_handle
, sock
);
1810 case LTTNG_LIST_DOMAINS
:
1813 struct lttng_domain
*domains
= NULL
;
1815 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1817 /* Return value is a negative lttng_error_code. */
1822 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1823 nb_dom
* sizeof(struct lttng_domain
));
1833 case LTTNG_LIST_CHANNELS
:
1835 enum lttng_error_code ret_code
;
1836 size_t original_payload_size
;
1837 size_t payload_size
;
1838 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1840 ret
= setup_empty_lttng_msg(cmd_ctx
);
1842 ret
= LTTNG_ERR_NOMEM
;
1846 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1848 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1849 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1850 if (ret_code
!= LTTNG_OK
) {
1851 ret
= (int) ret_code
;
1855 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1856 command_header_size
- original_payload_size
;
1857 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1862 case LTTNG_LIST_EVENTS
:
1864 enum lttng_error_code ret_code
;
1865 size_t original_payload_size
;
1866 size_t payload_size
;
1867 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1869 ret
= setup_empty_lttng_msg(cmd_ctx
);
1871 ret
= LTTNG_ERR_NOMEM
;
1875 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1877 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1879 cmd_ctx
->lsm
.u
.list
.channel_name
, &cmd_ctx
->reply_payload
);
1880 if (ret_code
!= LTTNG_OK
) {
1881 ret
= (int) ret_code
;
1885 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1886 command_header_size
- original_payload_size
;
1887 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1892 case LTTNG_LIST_SESSIONS
:
1894 unsigned int nr_sessions
;
1895 lttng_session
*sessions_payload
= nullptr;
1896 size_t payload_len
= 0;
1898 session_lock_list();
1899 nr_sessions
= lttng_sessions_count(
1900 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1901 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1903 if (nr_sessions
> 0) {
1904 payload_len
= (sizeof(struct lttng_session
) *
1906 (sizeof(struct lttng_session_extended
) *
1908 sessions_payload
= zmalloc
<lttng_session
>(payload_len
);
1909 if (!sessions_payload
) {
1910 session_unlock_list();
1915 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1916 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1917 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1920 session_unlock_list();
1922 ret
= setup_lttng_msg_no_cmd_header(
1923 cmd_ctx
, sessions_payload
, payload_len
);
1924 free(sessions_payload
);
1933 case LTTNG_REGISTER_CONSUMER
:
1935 struct consumer_data
*cdata
;
1937 switch (cmd_ctx
->lsm
.domain
.type
) {
1938 case LTTNG_DOMAIN_KERNEL
:
1939 cdata
= &the_kconsumer_data
;
1942 ret
= LTTNG_ERR_UND
;
1946 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1947 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1950 case LTTNG_DATA_PENDING
:
1953 uint8_t pending_ret_byte
;
1955 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1960 * This function may returns 0 or 1 to indicate whether or not
1961 * there is data pending. In case of error, it should return an
1962 * LTTNG_ERR code. However, some code paths may still return
1963 * a nondescript error code, which we handle by returning an
1966 if (pending_ret
== 0 || pending_ret
== 1) {
1968 * ret will be set to LTTNG_OK at the end of
1971 } else if (pending_ret
< 0) {
1972 ret
= LTTNG_ERR_UNK
;
1979 pending_ret_byte
= (uint8_t) pending_ret
;
1981 /* 1 byte to return whether or not data is pending */
1982 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1983 &pending_ret_byte
, 1);
1992 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1994 uint32_t snapshot_id
;
1995 struct lttcomm_lttng_output_id reply
;
1996 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1998 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
2001 if (ret
!= LTTNG_OK
) {
2004 reply
.id
= snapshot_id
;
2006 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2012 /* Copy output list into message payload */
2016 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2018 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
2019 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
2022 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2025 struct lttng_snapshot_output
*outputs
= NULL
;
2027 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2028 if (nb_output
< 0) {
2033 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2034 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2035 nb_output
* sizeof(struct lttng_snapshot_output
));
2045 case LTTNG_SNAPSHOT_RECORD
:
2047 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2048 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2049 &output
, 0); // RFC: set to zero since it's ignored by cmd_snapshot_record
2052 case LTTNG_CREATE_SESSION_EXT
:
2054 struct lttng_dynamic_buffer payload
;
2055 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2057 lttng_dynamic_buffer_init(&payload
);
2058 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2059 if (ret
!= LTTNG_OK
) {
2063 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2066 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2067 lttng_session_descriptor_destroy(return_descriptor
);
2068 ret
= LTTNG_ERR_NOMEM
;
2071 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2074 lttng_session_descriptor_destroy(return_descriptor
);
2075 ret
= LTTNG_ERR_NOMEM
;
2078 lttng_dynamic_buffer_reset(&payload
);
2079 lttng_session_descriptor_destroy(return_descriptor
);
2083 case LTTNG_SAVE_SESSION
:
2085 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2089 case LTTNG_SET_SESSION_SHM_PATH
:
2091 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2092 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2095 case LTTNG_REGENERATE_METADATA
:
2097 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2100 case LTTNG_REGENERATE_STATEDUMP
:
2102 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2105 case LTTNG_REGISTER_TRIGGER
:
2107 struct lttng_trigger
*payload_trigger
;
2108 struct lttng_trigger
*return_trigger
;
2109 size_t original_reply_payload_size
;
2110 size_t reply_payload_size
;
2111 const struct lttng_credentials cmd_creds
= {
2112 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2113 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2116 ret
= setup_empty_lttng_msg(cmd_ctx
);
2118 ret
= LTTNG_ERR_NOMEM
;
2122 ret
= receive_lttng_trigger(
2123 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2124 if (ret
!= LTTNG_OK
) {
2128 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2130 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2131 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2132 the_notification_thread_handle
,
2134 if (ret
!= LTTNG_OK
) {
2135 lttng_trigger_put(payload_trigger
);
2139 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2140 lttng_trigger_put(payload_trigger
);
2141 lttng_trigger_put(return_trigger
);
2143 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2144 ret
= LTTNG_ERR_NOMEM
;
2148 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2149 original_reply_payload_size
;
2151 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2156 case LTTNG_UNREGISTER_TRIGGER
:
2158 struct lttng_trigger
*payload_trigger
;
2159 const struct lttng_credentials cmd_creds
= {
2160 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2161 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2164 ret
= receive_lttng_trigger(
2165 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2166 if (ret
!= LTTNG_OK
) {
2170 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2171 the_notification_thread_handle
);
2172 lttng_trigger_put(payload_trigger
);
2175 case LTTNG_ROTATE_SESSION
:
2177 struct lttng_rotate_session_return rotate_return
;
2179 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2181 memset(&rotate_return
, 0, sizeof(rotate_return
));
2182 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2183 DBG("Kernel tracer version is not compatible with the rotation feature");
2184 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2188 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2190 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2196 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2197 sizeof(rotate_return
));
2206 case LTTNG_ROTATION_GET_INFO
:
2208 struct lttng_rotation_get_info_return get_info_return
;
2210 memset(&get_info_return
, 0, sizeof(get_info_return
));
2211 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2212 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2218 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2219 sizeof(get_info_return
));
2228 case LTTNG_ROTATION_SET_SCHEDULE
:
2231 enum lttng_rotation_schedule_type schedule_type
;
2234 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2235 DBG("Kernel tracer version does not support session rotations");
2236 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2240 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2241 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2242 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2244 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2245 schedule_type
, value
,
2246 the_notification_thread_handle
);
2247 if (ret
!= LTTNG_OK
) {
2253 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2255 lttng_session_list_schedules_return schedules
;
2257 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2258 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2259 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2260 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2262 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2272 case LTTNG_CLEAR_SESSION
:
2274 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2277 case LTTNG_LIST_TRIGGERS
:
2279 struct lttng_triggers
*return_triggers
= NULL
;
2280 size_t original_payload_size
;
2281 size_t payload_size
;
2283 ret
= setup_empty_lttng_msg(cmd_ctx
);
2285 ret
= LTTNG_ERR_NOMEM
;
2289 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2291 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2293 if (ret
!= LTTNG_OK
) {
2297 LTTNG_ASSERT(return_triggers
);
2298 ret
= lttng_triggers_serialize(
2299 return_triggers
, &cmd_ctx
->reply_payload
);
2300 lttng_triggers_destroy(return_triggers
);
2302 ERR("Failed to serialize triggers in reply to `list triggers` command");
2303 ret
= LTTNG_ERR_NOMEM
;
2307 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2308 original_payload_size
;
2310 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2315 case LTTNG_EXECUTE_ERROR_QUERY
:
2317 struct lttng_error_query
*query
;
2318 const struct lttng_credentials cmd_creds
= {
2319 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2320 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2322 struct lttng_error_query_results
*results
= NULL
;
2323 size_t original_payload_size
;
2324 size_t payload_size
;
2326 ret
= setup_empty_lttng_msg(cmd_ctx
);
2328 ret
= LTTNG_ERR_NOMEM
;
2332 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2334 ret
= receive_lttng_error_query(
2335 cmd_ctx
, *sock
, sock_error
, &query
);
2336 if (ret
!= LTTNG_OK
) {
2340 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2341 the_notification_thread_handle
);
2342 lttng_error_query_destroy(query
);
2343 if (ret
!= LTTNG_OK
) {
2347 LTTNG_ASSERT(results
);
2348 ret
= lttng_error_query_results_serialize(
2349 results
, &cmd_ctx
->reply_payload
);
2350 lttng_error_query_results_destroy(results
);
2352 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2353 ret
= LTTNG_ERR_NOMEM
;
2357 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2358 original_payload_size
;
2360 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2367 ret
= LTTNG_ERR_UND
;
2372 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2373 DBG("Missing llm header, creating one.");
2374 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2378 /* Set return code */
2379 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2381 if (cmd_ctx
->session
) {
2382 session_unlock(cmd_ctx
->session
);
2383 session_put(cmd_ctx
->session
);
2384 cmd_ctx
->session
= NULL
;
2386 if (need_tracing_session
) {
2387 session_unlock_list();
2390 LTTNG_ASSERT(!rcu_read_ongoing());
2394 static int create_client_sock(void)
2396 int ret
, client_sock
;
2397 const mode_t old_umask
= umask(0);
2399 /* Create client tool unix socket */
2400 client_sock
= lttcomm_create_unix_sock(
2401 the_config
.client_unix_sock_path
.value
);
2402 if (client_sock
< 0) {
2403 ERR("Create unix sock failed: %s",
2404 the_config
.client_unix_sock_path
.value
);
2409 /* Set the cloexec flag */
2410 ret
= utils_set_fd_cloexec(client_sock
);
2412 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2413 "Continuing but note that the consumer daemon will have a "
2414 "reference to this socket on exec()", client_sock
);
2417 /* File permission MUST be 660 */
2418 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2419 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2421 ERR("Set file permissions failed: %s",
2422 the_config
.client_unix_sock_path
.value
);
2424 (void) lttcomm_close_unix_sock(client_sock
);
2428 DBG("Created client socket (fd = %i)", client_sock
);
2435 static void cleanup_client_thread(void *data
)
2437 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2439 lttng_pipe_destroy(quit_pipe
);
2442 static void thread_init_cleanup(void *data
__attribute__((unused
)))
2444 set_thread_status(false);
2448 * This thread manage all clients request using the unix client socket for
2451 static void *thread_manage_clients(void *data
)
2453 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2455 uint32_t revents
, nb_fd
;
2456 struct lttng_poll_event events
;
2457 const int client_sock
= thread_state
.client_sock
;
2458 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2459 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2460 struct command_ctx cmd_ctx
= {};
2462 DBG("[thread] Manage client started");
2464 lttng_payload_init(&cmd_ctx
.reply_payload
);
2466 is_root
= (getuid() == 0);
2468 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2470 rcu_register_thread();
2472 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2474 health_code_update();
2476 ret
= lttcomm_listen_unix_sock(client_sock
);
2482 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2483 * more will be added to this poll set.
2485 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2487 goto error_create_poll
;
2490 /* Add the application registration socket */
2491 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2496 /* Add thread quit pipe */
2497 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2502 /* Set state as running. */
2503 set_thread_status(true);
2504 pthread_cleanup_pop(0);
2506 /* This testpoint is after we signal readiness to the parent. */
2507 if (testpoint(sessiond_thread_manage_clients
)) {
2511 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2515 health_code_update();
2518 const struct cmd_completion_handler
*cmd_completion_handler
;
2520 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2521 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2522 cmd_ctx
.creds
.pid
= 0;
2523 cmd_ctx
.session
= NULL
;
2524 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2525 cmd_ctx
.lttng_msg_size
= 0;
2527 DBG("Accepting client command ...");
2529 /* Inifinite blocking call, waiting for transmission */
2531 health_poll_entry();
2532 ret
= lttng_poll_wait(&events
, -1);
2536 * Restart interrupted system call.
2538 if (errno
== EINTR
) {
2546 for (i
= 0; i
< nb_fd
; i
++) {
2547 revents
= LTTNG_POLL_GETEV(&events
, i
);
2548 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2550 health_code_update();
2552 if (pollfd
== thread_quit_pipe_fd
) {
2556 /* Event on the registration socket */
2557 if (revents
& LPOLLIN
) {
2559 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2560 ERR("Client socket poll error");
2563 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2569 DBG("Wait for client response");
2571 health_code_update();
2573 sock
= lttcomm_accept_unix_sock(client_sock
);
2579 * Set the CLOEXEC flag. Return code is useless because either way, the
2582 (void) utils_set_fd_cloexec(sock
);
2584 /* Set socket option for credentials retrieval */
2585 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2590 health_code_update();
2593 * Data is received from the lttng client. The struct
2594 * lttcomm_session_msg (lsm) contains the command and data request of
2597 DBG("Receiving data from client ...");
2598 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2599 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2600 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2601 DBG("Incomplete recv() from client... continuing");
2610 health_code_update();
2612 // TODO: Validate cmd_ctx including sanity check for
2613 // security purpose.
2615 rcu_thread_online();
2617 * This function dispatch the work to the kernel or userspace tracer
2618 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2619 * informations for the client. The command context struct contains
2620 * everything this function may needs.
2622 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2623 rcu_thread_offline();
2633 * TODO: Inform client somehow of the fatal error. At
2634 * this point, ret < 0 means that a zmalloc failed
2635 * (ENOMEM). Error detected but still accept
2636 * command, unless a socket error has been
2642 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2643 WARN("Command returned an invalid status code, returning unknown error: "
2644 "command type = %s (%d), ret = %d",
2645 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2646 cmd_ctx
.lsm
.cmd_type
, ret
);
2647 ret
= LTTNG_ERR_UNK
;
2650 cmd_completion_handler
= cmd_pop_completion_handler();
2651 if (cmd_completion_handler
) {
2652 enum lttng_error_code completion_code
;
2654 completion_code
= cmd_completion_handler
->run(
2655 cmd_completion_handler
->data
);
2656 if (completion_code
!= LTTNG_OK
) {
2661 health_code_update();
2664 struct lttng_payload_view view
=
2665 lttng_payload_view_from_payload(
2666 &cmd_ctx
.reply_payload
,
2668 struct lttcomm_lttng_msg
*llm
= (typeof(
2669 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2671 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2672 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2674 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2676 DBG("Sending response (size: %d, retcode: %s (%d))",
2677 cmd_ctx
.lttng_msg_size
,
2678 lttng_strerror(-llm
->ret_code
),
2680 ret
= send_unix_sock(sock
, &view
);
2682 ERR("Failed to send data back to client");
2685 /* End of transmission */
2693 health_code_update();
2705 lttng_poll_clean(&events
);
2709 unlink(the_config
.client_unix_sock_path
.value
);
2710 ret
= close(client_sock
);
2717 ERR("Health error occurred in %s", __func__
);
2720 health_unregister(the_health_sessiond
);
2722 DBG("Client thread dying");
2723 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2724 rcu_unregister_thread();
2729 bool shutdown_client_thread(void *thread_data
)
2731 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2732 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2734 return notify_thread_pipe(write_fd
) == 1;
2737 struct lttng_thread
*launch_client_thread(void)
2739 bool thread_running
;
2740 struct lttng_pipe
*client_quit_pipe
;
2741 struct lttng_thread
*thread
= NULL
;
2742 int client_sock_fd
= -1;
2744 sem_init(&thread_state
.ready
, 0, 0);
2745 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2746 if (!client_quit_pipe
) {
2750 client_sock_fd
= create_client_sock();
2751 if (client_sock_fd
< 0) {
2755 thread_state
.client_sock
= client_sock_fd
;
2756 thread
= lttng_thread_create("Client management",
2757 thread_manage_clients
,
2758 shutdown_client_thread
,
2759 cleanup_client_thread
,
2764 /* The client thread now owns the client sock fd and the quit pipe. */
2765 client_sock_fd
= -1;
2766 client_quit_pipe
= NULL
;
2769 * This thread is part of the threads that need to be fully
2770 * initialized before the session daemon is marked as "ready".
2772 thread_running
= wait_thread_status();
2773 if (!thread_running
) {
2778 if (client_sock_fd
>= 0) {
2779 if (close(client_sock_fd
)) {
2780 PERROR("Failed to close client socket");
2783 lttng_thread_put(thread
);
2784 cleanup_client_thread(client_quit_pipe
);