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.h"
11 #include "common/compat/socket.h"
12 #include "common/dynamic-array.h"
13 #include "common/dynamic-buffer.h"
14 #include "common/fd-handle.h"
15 #include "common/payload-view.h"
16 #include "common/payload.h"
17 #include "common/sessiond-comm/sessiond-comm.h"
18 #include "lttng/lttng-error.h"
19 #include "lttng/tracker.h"
20 #include <common/compat/getenv.h>
21 #include <common/tracker.h>
22 #include <common/unix.h>
23 #include <common/utils.h>
24 #include <lttng/error-query-internal.h>
25 #include <lttng/event-internal.h>
26 #include <lttng/session-descriptor-internal.h>
27 #include <lttng/session-internal.h>
28 #include <lttng/userspace-probe-internal.h>
36 #include "agent-thread.h"
40 #include "health-sessiond.h"
42 #include "lttng-sessiond.h"
43 #include "manage-consumer.h"
45 #include "testpoint.h"
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
= (char *) zmalloc(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
= (char *) zmalloc(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
, gid_t gid
)
589 struct ltt_session
*session
;
590 const struct ltt_session_list
*session_list
= session_get_list();
592 DBG("Counting number of available session for UID %d", uid
);
593 cds_list_for_each_entry(session
, &session_list
->head
, list
) {
594 if (!session_get(session
)) {
597 session_lock(session
);
598 /* Only count the sessions the user can control. */
599 if (session_access_ok(session
, uid
) &&
600 !session
->destroyed
) {
603 session_unlock(session
);
604 session_put(session
);
609 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
612 struct lttng_trigger
**_trigger
)
616 ssize_t sock_recv_len
;
617 enum lttng_error_code ret_code
;
618 struct lttng_payload trigger_payload
;
619 struct lttng_trigger
*trigger
= NULL
;
621 lttng_payload_init(&trigger_payload
);
622 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
623 ret
= lttng_dynamic_buffer_set_size(
624 &trigger_payload
.buffer
, trigger_len
);
626 ret_code
= LTTNG_ERR_NOMEM
;
630 sock_recv_len
= lttcomm_recv_unix_sock(
631 sock
, trigger_payload
.buffer
.data
, trigger_len
);
632 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
633 ERR("Failed to receive trigger in command payload");
635 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
639 /* Receive fds, if any. */
640 if (cmd_ctx
->lsm
.fd_count
> 0) {
641 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
642 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
643 if (sock_recv_len
> 0 &&
644 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
645 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
646 cmd_ctx
->lsm
.fd_count
, (int) ret
);
647 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
650 } else if (sock_recv_len
<= 0) {
651 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
652 cmd_ctx
->lsm
.fd_count
, (int) ret
);
653 ret_code
= LTTNG_ERR_FATAL
;
659 /* Deserialize trigger. */
661 struct lttng_payload_view view
=
662 lttng_payload_view_from_payload(
663 &trigger_payload
, 0, -1);
665 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
667 ERR("Invalid trigger received as part of command payload");
668 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
669 lttng_trigger_put(trigger
);
678 lttng_payload_reset(&trigger_payload
);
682 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
685 struct lttng_error_query
**_query
)
689 ssize_t sock_recv_len
;
690 enum lttng_error_code ret_code
;
691 struct lttng_payload query_payload
;
692 struct lttng_error_query
*query
= NULL
;
694 lttng_payload_init(&query_payload
);
695 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
696 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
698 ret_code
= LTTNG_ERR_NOMEM
;
702 sock_recv_len
= lttcomm_recv_unix_sock(
703 sock
, query_payload
.buffer
.data
, query_len
);
704 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
705 ERR("Failed to receive error query in command payload");
707 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
711 /* Receive fds, if any. */
712 if (cmd_ctx
->lsm
.fd_count
> 0) {
713 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
714 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
715 if (sock_recv_len
> 0 &&
716 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
717 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
718 cmd_ctx
->lsm
.fd_count
, (int) ret
);
719 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
722 } else if (sock_recv_len
<= 0) {
723 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
724 cmd_ctx
->lsm
.fd_count
, (int) ret
);
725 ret_code
= LTTNG_ERR_FATAL
;
731 /* Deserialize error query. */
733 struct lttng_payload_view view
=
734 lttng_payload_view_from_payload(
735 &query_payload
, 0, -1);
737 if (lttng_error_query_create_from_payload(&view
, &query
) !=
739 ERR("Invalid error query received as part of command payload");
740 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
749 lttng_payload_reset(&query_payload
);
753 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
756 struct lttng_event
**out_event
,
757 char **out_filter_expression
,
758 struct lttng_bytecode
**out_bytecode
,
759 struct lttng_event_exclusion
**out_exclusion
)
763 ssize_t sock_recv_len
;
764 enum lttng_error_code ret_code
;
765 struct lttng_payload event_payload
;
766 struct lttng_event
*local_event
= NULL
;
767 char *local_filter_expression
= NULL
;
768 struct lttng_bytecode
*local_bytecode
= NULL
;
769 struct lttng_event_exclusion
*local_exclusion
= NULL
;
771 lttng_payload_init(&event_payload
);
772 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
) {
773 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
774 } else if (cmd_ctx
->lsm
.cmd_type
== LTTNG_DISABLE_EVENT
) {
775 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
780 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
782 ret_code
= LTTNG_ERR_NOMEM
;
786 sock_recv_len
= lttcomm_recv_unix_sock(
787 sock
, event_payload
.buffer
.data
, event_len
);
788 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
789 ERR("Failed to receive event in command payload");
791 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
795 /* Receive fds, if any. */
796 if (cmd_ctx
->lsm
.fd_count
> 0) {
797 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
798 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
799 if (sock_recv_len
> 0 &&
800 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
801 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
802 cmd_ctx
->lsm
.fd_count
, (int) ret
);
803 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
806 } else if (sock_recv_len
<= 0) {
807 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
808 cmd_ctx
->lsm
.fd_count
, (int) ret
);
809 ret_code
= LTTNG_ERR_FATAL
;
815 /* Deserialize event. */
818 struct lttng_payload_view event_view
=
819 lttng_payload_view_from_payload(
820 &event_payload
, 0, -1);
822 len
= lttng_event_create_from_payload(&event_view
, &local_event
,
823 &local_exclusion
, &local_filter_expression
,
827 ERR("Failed to create an event from the received buffer");
828 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
832 if (len
!= event_len
) {
833 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
", payload length = %zd", event_len
, len
);
834 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
839 *out_event
= local_event
;
840 *out_exclusion
= local_exclusion
;
841 *out_filter_expression
= local_filter_expression
;
842 *out_bytecode
= local_bytecode
;
844 local_exclusion
= NULL
;
845 local_filter_expression
= NULL
;
846 local_bytecode
= NULL
;
851 lttng_payload_reset(&event_payload
);
852 lttng_event_destroy(local_event
);
853 free(local_filter_expression
);
854 free(local_bytecode
);
855 free(local_exclusion
);
859 static enum lttng_error_code
receive_lttng_event_context(
860 const struct command_ctx
*cmd_ctx
,
863 struct lttng_event_context
**out_event_context
)
866 const size_t event_context_len
=
867 (size_t) cmd_ctx
->lsm
.u
.context
.length
;
868 ssize_t sock_recv_len
;
869 enum lttng_error_code ret_code
;
870 struct lttng_payload event_context_payload
;
871 struct lttng_event_context
*context
= NULL
;
873 lttng_payload_init(&event_context_payload
);
875 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
,
878 ret_code
= LTTNG_ERR_NOMEM
;
882 sock_recv_len
= lttcomm_recv_unix_sock(
883 sock
, event_context_payload
.buffer
.data
,
885 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
886 ERR("Failed to receive event context in command payload");
888 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
892 /* Deserialize event. */
895 struct lttng_payload_view event_context_view
=
896 lttng_payload_view_from_payload(
897 &event_context_payload
, 0, -1);
899 len
= lttng_event_context_create_from_payload(
900 &event_context_view
, &context
);
903 ERR("Failed to create a event context from the received buffer");
904 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
908 if (len
!= event_context_len
) {
909 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd", event_context_len
, len
);
910 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
915 *out_event_context
= context
;
920 lttng_event_context_destroy(context
);
921 lttng_payload_reset(&event_context_payload
);
926 * Version of setup_lttng_msg() without command header.
928 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
929 void *payload_buf
, size_t payload_len
)
931 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
935 * Check if the current kernel tracer supports the session rotation feature.
936 * Return 1 if it does, 0 otherwise.
938 static int check_rotate_compatible(void)
942 if (the_kernel_tracer_version
.major
!= 2 ||
943 the_kernel_tracer_version
.minor
< 11) {
944 DBG("Kernel tracer version is not compatible with the rotation feature");
952 * Send data on a unix socket using the liblttsessiondcomm API.
954 * Return lttcomm error code.
956 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
959 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
961 /* Check valid length */
962 if (view
->buffer
.size
== 0) {
967 ret
= lttcomm_send_unix_sock(
968 sock
, view
->buffer
.data
, view
->buffer
.size
);
974 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
985 * Process the command requested by the lttng client within the command
986 * context structure. This function make sure that the return structure (llm)
987 * is set and ready for transmission before returning.
989 * Return any error encountered or 0 for success.
991 * "sock" is only used for special-case var. len data.
992 * A command may assume the ownership of the socket, in which case its value
993 * should be set to -1.
995 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
999 bool need_tracing_session
= true;
1001 bool need_consumerd
;
1003 DBG("Processing client command '%s\' (%d)",
1004 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
1005 cmd_ctx
->lsm
.cmd_type
);
1009 switch (cmd_ctx
->lsm
.cmd_type
) {
1010 case LTTNG_CREATE_SESSION_EXT
:
1011 case LTTNG_DESTROY_SESSION
:
1012 case LTTNG_LIST_SESSIONS
:
1013 case LTTNG_LIST_DOMAINS
:
1014 case LTTNG_START_TRACE
:
1015 case LTTNG_STOP_TRACE
:
1016 case LTTNG_DATA_PENDING
:
1017 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1018 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1019 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1020 case LTTNG_SNAPSHOT_RECORD
:
1021 case LTTNG_SAVE_SESSION
:
1022 case LTTNG_SET_SESSION_SHM_PATH
:
1023 case LTTNG_REGENERATE_METADATA
:
1024 case LTTNG_REGENERATE_STATEDUMP
:
1025 case LTTNG_ROTATE_SESSION
:
1026 case LTTNG_ROTATION_GET_INFO
:
1027 case LTTNG_ROTATION_SET_SCHEDULE
:
1028 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1029 case LTTNG_CLEAR_SESSION
:
1030 case LTTNG_LIST_TRIGGERS
:
1031 case LTTNG_EXECUTE_ERROR_QUERY
:
1032 need_domain
= false;
1038 /* Needs a functioning consumerd? */
1039 switch (cmd_ctx
->lsm
.cmd_type
) {
1040 case LTTNG_REGISTER_TRIGGER
:
1041 case LTTNG_UNREGISTER_TRIGGER
:
1042 case LTTNG_EXECUTE_ERROR_QUERY
:
1043 need_consumerd
= false;
1046 need_consumerd
= true;
1050 if (the_config
.no_kernel
&& need_domain
&&
1051 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1053 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1055 ret
= LTTNG_ERR_KERN_NA
;
1060 /* Deny register consumer if we already have a spawned consumer. */
1061 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
1062 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1063 if (the_kconsumer_data
.pid
> 0) {
1064 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1065 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1068 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1072 * Check for command that don't needs to allocate a returned payload. We do
1073 * this here so we don't have to make the call for no payload at each
1076 switch(cmd_ctx
->lsm
.cmd_type
) {
1077 case LTTNG_LIST_SESSIONS
:
1078 case LTTNG_LIST_TRACEPOINTS
:
1079 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1080 case LTTNG_LIST_DOMAINS
:
1081 case LTTNG_LIST_CHANNELS
:
1082 case LTTNG_LIST_EVENTS
:
1083 case LTTNG_LIST_SYSCALLS
:
1084 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1085 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1086 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1087 case LTTNG_DATA_PENDING
:
1088 case LTTNG_ROTATE_SESSION
:
1089 case LTTNG_ROTATION_GET_INFO
:
1090 case LTTNG_REGISTER_TRIGGER
:
1091 case LTTNG_LIST_TRIGGERS
:
1092 case LTTNG_EXECUTE_ERROR_QUERY
:
1095 /* Setup lttng message with no payload */
1096 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1098 /* This label does not try to unlock the session */
1099 goto init_setup_error
;
1103 /* Commands that DO NOT need a session. */
1104 switch (cmd_ctx
->lsm
.cmd_type
) {
1105 case LTTNG_CREATE_SESSION_EXT
:
1106 case LTTNG_LIST_SESSIONS
:
1107 case LTTNG_LIST_TRACEPOINTS
:
1108 case LTTNG_LIST_SYSCALLS
:
1109 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1110 case LTTNG_SAVE_SESSION
:
1111 case LTTNG_REGISTER_TRIGGER
:
1112 case LTTNG_UNREGISTER_TRIGGER
:
1113 case LTTNG_LIST_TRIGGERS
:
1114 case LTTNG_EXECUTE_ERROR_QUERY
:
1115 need_tracing_session
= false;
1118 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1120 * We keep the session list lock across _all_ commands
1121 * for now, because the per-session lock does not
1122 * handle teardown properly.
1124 session_lock_list();
1125 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1126 if (cmd_ctx
->session
== NULL
) {
1127 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1130 /* Acquire lock for the session */
1131 session_lock(cmd_ctx
->session
);
1137 * Commands that need a valid session but should NOT create one if none
1138 * exists. Instead of creating one and destroying it when the command is
1139 * handled, process that right before so we save some round trip in useless
1142 switch (cmd_ctx
->lsm
.cmd_type
) {
1143 case LTTNG_DISABLE_CHANNEL
:
1144 case LTTNG_DISABLE_EVENT
:
1145 switch (cmd_ctx
->lsm
.domain
.type
) {
1146 case LTTNG_DOMAIN_KERNEL
:
1147 if (!cmd_ctx
->session
->kernel_session
) {
1148 ret
= LTTNG_ERR_NO_CHANNEL
;
1152 case LTTNG_DOMAIN_JUL
:
1153 case LTTNG_DOMAIN_LOG4J
:
1154 case LTTNG_DOMAIN_PYTHON
:
1155 case LTTNG_DOMAIN_UST
:
1156 if (!cmd_ctx
->session
->ust_session
) {
1157 ret
= LTTNG_ERR_NO_CHANNEL
;
1162 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1174 * Check domain type for specific "pre-action".
1176 switch (cmd_ctx
->lsm
.domain
.type
) {
1177 case LTTNG_DOMAIN_KERNEL
:
1179 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1183 /* Kernel tracer check */
1184 if (!kernel_tracer_is_initialized()) {
1185 /* Basically, load kernel tracer modules */
1186 ret
= init_kernel_tracer();
1192 /* Consumer is in an ERROR state. Report back to client */
1193 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1195 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1199 /* Need a session for kernel command */
1200 if (need_tracing_session
) {
1201 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1202 ret
= create_kernel_session(cmd_ctx
->session
);
1203 if (ret
!= LTTNG_OK
) {
1204 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1209 /* Start the kernel consumer daemon */
1210 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1211 if (the_kconsumer_data
.pid
== 0 &&
1212 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1213 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1214 ret
= start_consumerd(&the_kconsumer_data
);
1216 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1219 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1221 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1225 * The consumer was just spawned so we need to add the socket to
1226 * the consumer output of the session if exist.
1228 ret
= consumer_create_socket(&the_kconsumer_data
,
1229 cmd_ctx
->session
->kernel_session
->consumer
);
1236 case LTTNG_DOMAIN_JUL
:
1237 case LTTNG_DOMAIN_LOG4J
:
1238 case LTTNG_DOMAIN_PYTHON
:
1239 if (!agent_tracing_is_enabled()) {
1240 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1244 case LTTNG_DOMAIN_UST
:
1246 if (!ust_app_supported()) {
1247 ret
= LTTNG_ERR_NO_UST
;
1251 /* Consumer is in an ERROR state. Report back to client */
1252 if (need_consumerd
&&
1253 uatomic_read(&the_ust_consumerd_state
) ==
1255 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1259 if (need_tracing_session
) {
1260 /* Create UST session if none exist. */
1261 if (cmd_ctx
->session
->ust_session
== NULL
) {
1262 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1263 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1264 if (ret
!= LTTNG_OK
) {
1269 /* Start the UST consumer daemons */
1271 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1272 if (the_config
.consumerd64_bin_path
.value
&&
1273 the_ustconsumer64_data
.pid
== 0 &&
1274 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1275 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1276 ret
= start_consumerd(&the_ustconsumer64_data
);
1278 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1279 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1283 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1284 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1286 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1290 * Setup socket for consumer 64 bit. No need for atomic access
1291 * since it was set above and can ONLY be set in this thread.
1293 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1294 cmd_ctx
->session
->ust_session
->consumer
);
1300 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1301 if (the_config
.consumerd32_bin_path
.value
&&
1302 the_ustconsumer32_data
.pid
== 0 &&
1303 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1304 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1305 ret
= start_consumerd(&the_ustconsumer32_data
);
1307 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1308 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1312 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1313 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1315 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1319 * Setup socket for consumer 32 bit. No need for atomic access
1320 * since it was set above and can ONLY be set in this thread.
1322 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1323 cmd_ctx
->session
->ust_session
->consumer
);
1335 /* Validate consumer daemon state when start/stop trace command */
1336 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1337 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1338 switch (cmd_ctx
->lsm
.domain
.type
) {
1339 case LTTNG_DOMAIN_NONE
:
1341 case LTTNG_DOMAIN_JUL
:
1342 case LTTNG_DOMAIN_LOG4J
:
1343 case LTTNG_DOMAIN_PYTHON
:
1344 case LTTNG_DOMAIN_UST
:
1345 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1346 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1350 case LTTNG_DOMAIN_KERNEL
:
1351 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1352 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1357 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1363 * Check that the UID matches that of the tracing session.
1364 * The root user can interact with all sessions.
1366 if (need_tracing_session
) {
1367 if (!session_access_ok(cmd_ctx
->session
,
1368 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1369 cmd_ctx
->session
->destroyed
) {
1370 ret
= LTTNG_ERR_EPERM
;
1376 * Send relayd information to consumer as soon as we have a domain and a
1379 if (cmd_ctx
->session
&& need_domain
) {
1381 * Setup relayd if not done yet. If the relayd information was already
1382 * sent to the consumer, this call will gracefully return.
1384 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1385 if (ret
!= LTTNG_OK
) {
1390 /* Process by command type */
1391 switch (cmd_ctx
->lsm
.cmd_type
) {
1392 case LTTNG_ADD_CONTEXT
:
1394 struct lttng_event_context
*event_context
= NULL
;
1395 const enum lttng_error_code ret_code
=
1396 receive_lttng_event_context(
1397 cmd_ctx
, *sock
, sock_error
, &event_context
);
1399 if (ret_code
!= LTTNG_OK
) {
1400 ret
= (int) ret_code
;
1404 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1405 lttng_event_context_destroy(event_context
);
1408 case LTTNG_DISABLE_CHANNEL
:
1410 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1411 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1414 case LTTNG_ENABLE_CHANNEL
:
1416 ret
= cmd_enable_channel(
1417 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1420 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1421 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1423 struct lttng_dynamic_buffer payload
;
1424 struct lttng_buffer_view payload_view
;
1425 const bool add_value
=
1426 cmd_ctx
->lsm
.cmd_type
==
1427 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1428 const size_t name_len
=
1429 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1431 const enum lttng_domain_type domain_type
=
1432 (enum lttng_domain_type
)
1433 cmd_ctx
->lsm
.domain
.type
;
1434 const enum lttng_process_attr process_attr
=
1435 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1436 .process_attr_tracker_add_remove_include_value
1438 const enum lttng_process_attr_value_type value_type
=
1439 (enum lttng_process_attr_value_type
) cmd_ctx
1441 .process_attr_tracker_add_remove_include_value
1443 struct process_attr_value
*value
;
1444 enum lttng_error_code ret_code
;
1445 long login_name_max
;
1447 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1448 if (login_name_max
< 0) {
1449 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1450 ret
= LTTNG_ERR_INVALID
;
1454 /* Receive remaining variable length payload if applicable. */
1455 if (name_len
> login_name_max
) {
1457 * POSIX mandates user and group names that are at least
1458 * 8 characters long. Note that although shadow-utils
1459 * (useradd, groupaadd, etc.) use 32 chars as their
1460 * limit (from bits/utmp.h, UT_NAMESIZE),
1461 * LOGIN_NAME_MAX is defined to 256.
1463 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1464 add_value
? "addition" : "removal",
1465 name_len
, login_name_max
);
1466 ret
= LTTNG_ERR_INVALID
;
1470 lttng_dynamic_buffer_init(&payload
);
1471 if (name_len
!= 0) {
1473 * Receive variable payload for user/group name
1476 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1478 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1479 add_value
? "add" : "remove");
1480 ret
= LTTNG_ERR_NOMEM
;
1481 goto error_add_remove_tracker_value
;
1484 ret
= lttcomm_recv_unix_sock(
1485 *sock
, payload
.data
, name_len
);
1487 ERR("Failed to receive payload of %s process attribute tracker value argument",
1488 add_value
? "add" : "remove");
1490 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1491 goto error_add_remove_tracker_value
;
1495 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1496 &payload
, 0, name_len
);
1497 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1498 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1499 goto error_add_remove_tracker_value
;
1503 * Validate the value type and domains are legal for the process
1504 * attribute tracker that is specified and convert the value to
1505 * add/remove to the internal sessiond representation.
1507 ret_code
= process_attr_value_from_comm(domain_type
,
1508 process_attr
, value_type
,
1509 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1511 &payload_view
, &value
);
1512 if (ret_code
!= LTTNG_OK
) {
1514 goto error_add_remove_tracker_value
;
1518 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1519 cmd_ctx
->session
, domain_type
,
1520 process_attr
, value
);
1522 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1523 cmd_ctx
->session
, domain_type
,
1524 process_attr
, value
);
1526 process_attr_value_destroy(value
);
1527 error_add_remove_tracker_value
:
1528 lttng_dynamic_buffer_reset(&payload
);
1531 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1533 enum lttng_tracking_policy tracking_policy
;
1534 const enum lttng_domain_type domain_type
=
1535 (enum lttng_domain_type
)
1536 cmd_ctx
->lsm
.domain
.type
;
1537 const enum lttng_process_attr process_attr
=
1538 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1539 .process_attr_tracker_get_tracking_policy
1542 ret
= cmd_process_attr_tracker_get_tracking_policy(
1543 cmd_ctx
->session
, domain_type
, process_attr
,
1545 if (ret
!= LTTNG_OK
) {
1549 uint32_t tracking_policy_u32
= tracking_policy
;
1550 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1551 &tracking_policy_u32
, sizeof(uint32_t));
1553 ret
= LTTNG_ERR_NOMEM
;
1559 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1561 const enum lttng_tracking_policy tracking_policy
=
1562 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1563 .process_attr_tracker_set_tracking_policy
1565 const enum lttng_domain_type domain_type
=
1566 (enum lttng_domain_type
)
1567 cmd_ctx
->lsm
.domain
.type
;
1568 const enum lttng_process_attr process_attr
=
1569 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1570 .process_attr_tracker_set_tracking_policy
1573 ret
= cmd_process_attr_tracker_set_tracking_policy(
1574 cmd_ctx
->session
, domain_type
, process_attr
,
1576 if (ret
!= LTTNG_OK
) {
1581 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1583 struct lttng_process_attr_values
*values
;
1584 struct lttng_dynamic_buffer reply
;
1585 const enum lttng_domain_type domain_type
=
1586 (enum lttng_domain_type
)
1587 cmd_ctx
->lsm
.domain
.type
;
1588 const enum lttng_process_attr process_attr
=
1589 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1590 .process_attr_tracker_get_inclusion_set
1593 ret
= cmd_process_attr_tracker_get_inclusion_set(
1594 cmd_ctx
->session
, domain_type
, process_attr
,
1596 if (ret
!= LTTNG_OK
) {
1600 lttng_dynamic_buffer_init(&reply
);
1601 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1603 goto error_tracker_get_inclusion_set
;
1606 ret
= setup_lttng_msg_no_cmd_header(
1607 cmd_ctx
, reply
.data
, reply
.size
);
1609 ret
= LTTNG_ERR_NOMEM
;
1610 goto error_tracker_get_inclusion_set
;
1614 error_tracker_get_inclusion_set
:
1615 lttng_process_attr_values_destroy(values
);
1616 lttng_dynamic_buffer_reset(&reply
);
1619 case LTTNG_ENABLE_EVENT
:
1620 case LTTNG_DISABLE_EVENT
:
1622 struct lttng_event
*event
;
1623 char *filter_expression
;
1624 struct lttng_event_exclusion
*exclusions
;
1625 struct lttng_bytecode
*bytecode
;
1626 const enum lttng_error_code ret_code
= receive_lttng_event(
1627 cmd_ctx
, *sock
, sock_error
, &event
,
1628 &filter_expression
, &bytecode
, &exclusions
);
1630 if (ret_code
!= LTTNG_OK
) {
1631 ret
= (int) ret_code
;
1636 * Ownership of filter_expression, exclusions, and bytecode is
1637 * always transferred.
1639 ret
= cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
?
1640 cmd_enable_event(cmd_ctx
, event
,
1641 filter_expression
, exclusions
,
1643 the_kernel_poll_pipe
[1]) :
1644 cmd_disable_event(cmd_ctx
, event
,
1645 filter_expression
, bytecode
,
1647 lttng_event_destroy(event
);
1650 case LTTNG_LIST_TRACEPOINTS
:
1652 enum lttng_error_code ret_code
;
1653 size_t original_payload_size
;
1654 size_t payload_size
;
1655 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1657 ret
= setup_empty_lttng_msg(cmd_ctx
);
1659 ret
= LTTNG_ERR_NOMEM
;
1663 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1665 session_lock_list();
1666 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1667 &cmd_ctx
->reply_payload
);
1668 session_unlock_list();
1669 if (ret_code
!= LTTNG_OK
) {
1670 ret
= (int) ret_code
;
1674 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1675 command_header_size
- original_payload_size
;
1676 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1681 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1683 enum lttng_error_code ret_code
;
1684 size_t original_payload_size
;
1685 size_t payload_size
;
1686 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1688 ret
= setup_empty_lttng_msg(cmd_ctx
);
1690 ret
= LTTNG_ERR_NOMEM
;
1694 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1696 session_lock_list();
1697 ret_code
= cmd_list_tracepoint_fields(
1698 cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1699 session_unlock_list();
1700 if (ret_code
!= LTTNG_OK
) {
1701 ret
= (int) ret_code
;
1705 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1706 command_header_size
- original_payload_size
;
1707 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1712 case LTTNG_LIST_SYSCALLS
:
1714 enum lttng_error_code ret_code
;
1715 size_t original_payload_size
;
1716 size_t payload_size
;
1717 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1719 ret
= setup_empty_lttng_msg(cmd_ctx
);
1721 ret
= LTTNG_ERR_NOMEM
;
1725 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1727 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1728 if (ret_code
!= LTTNG_OK
) {
1729 ret
= (int) ret_code
;
1733 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1734 command_header_size
- original_payload_size
;
1735 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1740 case LTTNG_SET_CONSUMER_URI
:
1743 struct lttng_uri
*uris
;
1745 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1746 len
= nb_uri
* sizeof(struct lttng_uri
);
1749 ret
= LTTNG_ERR_INVALID
;
1753 uris
= (lttng_uri
*) zmalloc(len
);
1755 ret
= LTTNG_ERR_FATAL
;
1759 /* Receive variable len data */
1760 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1761 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1763 DBG("No URIs received from client... continuing");
1765 ret
= LTTNG_ERR_SESSION_FAIL
;
1770 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1772 if (ret
!= LTTNG_OK
) {
1779 case LTTNG_START_TRACE
:
1782 * On the first start, if we have a kernel session and we have
1783 * enabled time or size-based rotations, we have to make sure
1784 * the kernel tracer supports it.
1786 if (!cmd_ctx
->session
->has_been_started
&& \
1787 cmd_ctx
->session
->kernel_session
&& \
1788 (cmd_ctx
->session
->rotate_timer_period
|| \
1789 cmd_ctx
->session
->rotate_size
) && \
1790 !check_rotate_compatible()) {
1791 DBG("Kernel tracer version is not compatible with the rotation feature");
1792 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1795 ret
= cmd_start_trace(cmd_ctx
->session
);
1798 case LTTNG_STOP_TRACE
:
1800 ret
= cmd_stop_trace(cmd_ctx
->session
);
1803 case LTTNG_DESTROY_SESSION
:
1805 ret
= cmd_destroy_session(cmd_ctx
->session
,
1806 the_notification_thread_handle
, sock
);
1809 case LTTNG_LIST_DOMAINS
:
1812 struct lttng_domain
*domains
= NULL
;
1814 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1816 /* Return value is a negative lttng_error_code. */
1821 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1822 nb_dom
* sizeof(struct lttng_domain
));
1832 case LTTNG_LIST_CHANNELS
:
1834 enum lttng_error_code ret_code
;
1835 size_t original_payload_size
;
1836 size_t payload_size
;
1837 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1839 ret
= setup_empty_lttng_msg(cmd_ctx
);
1841 ret
= LTTNG_ERR_NOMEM
;
1845 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1847 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1848 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1849 if (ret_code
!= LTTNG_OK
) {
1850 ret
= (int) ret_code
;
1854 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1855 command_header_size
- original_payload_size
;
1856 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1861 case LTTNG_LIST_EVENTS
:
1863 enum lttng_error_code ret_code
;
1864 size_t original_payload_size
;
1865 size_t payload_size
;
1866 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1868 ret
= setup_empty_lttng_msg(cmd_ctx
);
1870 ret
= LTTNG_ERR_NOMEM
;
1874 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1876 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1878 cmd_ctx
->lsm
.u
.list
.channel_name
, &cmd_ctx
->reply_payload
);
1879 if (ret_code
!= LTTNG_OK
) {
1880 ret
= (int) ret_code
;
1884 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1885 command_header_size
- original_payload_size
;
1886 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1891 case LTTNG_LIST_SESSIONS
:
1893 unsigned int nr_sessions
;
1894 lttng_session
*sessions_payload
;
1897 session_lock_list();
1898 nr_sessions
= lttng_sessions_count(
1899 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1900 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1902 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1903 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1904 sessions_payload
= (lttng_session
*) zmalloc(payload_len
);
1906 if (!sessions_payload
) {
1907 session_unlock_list();
1912 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1913 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1914 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1915 session_unlock_list();
1917 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
1919 free(sessions_payload
);
1928 case LTTNG_REGISTER_CONSUMER
:
1930 struct consumer_data
*cdata
;
1932 switch (cmd_ctx
->lsm
.domain
.type
) {
1933 case LTTNG_DOMAIN_KERNEL
:
1934 cdata
= &the_kconsumer_data
;
1937 ret
= LTTNG_ERR_UND
;
1941 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1942 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1945 case LTTNG_DATA_PENDING
:
1948 uint8_t pending_ret_byte
;
1950 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1955 * This function may returns 0 or 1 to indicate whether or not
1956 * there is data pending. In case of error, it should return an
1957 * LTTNG_ERR code. However, some code paths may still return
1958 * a nondescript error code, which we handle by returning an
1961 if (pending_ret
== 0 || pending_ret
== 1) {
1963 * ret will be set to LTTNG_OK at the end of
1966 } else if (pending_ret
< 0) {
1967 ret
= LTTNG_ERR_UNK
;
1974 pending_ret_byte
= (uint8_t) pending_ret
;
1976 /* 1 byte to return whether or not data is pending */
1977 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1978 &pending_ret_byte
, 1);
1987 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1989 uint32_t snapshot_id
;
1990 struct lttcomm_lttng_output_id reply
;
1991 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
1993 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
1996 if (ret
!= LTTNG_OK
) {
1999 reply
.id
= snapshot_id
;
2001 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2007 /* Copy output list into message payload */
2011 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2013 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
2014 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
2017 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2020 struct lttng_snapshot_output
*outputs
= NULL
;
2022 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2023 if (nb_output
< 0) {
2028 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2029 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2030 nb_output
* sizeof(struct lttng_snapshot_output
));
2040 case LTTNG_SNAPSHOT_RECORD
:
2042 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2043 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2045 cmd_ctx
->lsm
.u
.snapshot_record
.wait
);
2048 case LTTNG_CREATE_SESSION_EXT
:
2050 struct lttng_dynamic_buffer payload
;
2051 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2053 lttng_dynamic_buffer_init(&payload
);
2054 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2055 if (ret
!= LTTNG_OK
) {
2059 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2062 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2063 lttng_session_descriptor_destroy(return_descriptor
);
2064 ret
= LTTNG_ERR_NOMEM
;
2067 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2070 lttng_session_descriptor_destroy(return_descriptor
);
2071 ret
= LTTNG_ERR_NOMEM
;
2074 lttng_dynamic_buffer_reset(&payload
);
2075 lttng_session_descriptor_destroy(return_descriptor
);
2079 case LTTNG_SAVE_SESSION
:
2081 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2085 case LTTNG_SET_SESSION_SHM_PATH
:
2087 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2088 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2091 case LTTNG_REGENERATE_METADATA
:
2093 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2096 case LTTNG_REGENERATE_STATEDUMP
:
2098 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2101 case LTTNG_REGISTER_TRIGGER
:
2103 struct lttng_trigger
*payload_trigger
;
2104 struct lttng_trigger
*return_trigger
;
2105 size_t original_reply_payload_size
;
2106 size_t reply_payload_size
;
2107 const struct lttng_credentials cmd_creds
= {
2108 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2109 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2112 ret
= setup_empty_lttng_msg(cmd_ctx
);
2114 ret
= LTTNG_ERR_NOMEM
;
2118 ret
= receive_lttng_trigger(
2119 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2120 if (ret
!= LTTNG_OK
) {
2124 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2126 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2127 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2128 the_notification_thread_handle
,
2130 if (ret
!= LTTNG_OK
) {
2131 lttng_trigger_put(payload_trigger
);
2135 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2136 lttng_trigger_put(payload_trigger
);
2137 lttng_trigger_put(return_trigger
);
2139 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2140 ret
= LTTNG_ERR_NOMEM
;
2144 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2145 original_reply_payload_size
;
2147 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2152 case LTTNG_UNREGISTER_TRIGGER
:
2154 struct lttng_trigger
*payload_trigger
;
2155 const struct lttng_credentials cmd_creds
= {
2156 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2157 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2160 ret
= receive_lttng_trigger(
2161 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2162 if (ret
!= LTTNG_OK
) {
2166 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2167 the_notification_thread_handle
);
2168 lttng_trigger_put(payload_trigger
);
2171 case LTTNG_ROTATE_SESSION
:
2173 struct lttng_rotate_session_return rotate_return
;
2175 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2177 memset(&rotate_return
, 0, sizeof(rotate_return
));
2178 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2179 DBG("Kernel tracer version is not compatible with the rotation feature");
2180 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2184 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2186 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2192 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2193 sizeof(rotate_return
));
2202 case LTTNG_ROTATION_GET_INFO
:
2204 struct lttng_rotation_get_info_return get_info_return
;
2206 memset(&get_info_return
, 0, sizeof(get_info_return
));
2207 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2208 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2214 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2215 sizeof(get_info_return
));
2224 case LTTNG_ROTATION_SET_SCHEDULE
:
2227 enum lttng_rotation_schedule_type schedule_type
;
2230 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2231 DBG("Kernel tracer version does not support session rotations");
2232 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2236 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2237 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2238 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2240 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2241 schedule_type
, value
,
2242 the_notification_thread_handle
);
2243 if (ret
!= LTTNG_OK
) {
2249 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2251 lttng_session_list_schedules_return schedules
;
2253 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2254 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2255 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2256 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2258 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2268 case LTTNG_CLEAR_SESSION
:
2270 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2273 case LTTNG_LIST_TRIGGERS
:
2275 struct lttng_triggers
*return_triggers
= NULL
;
2276 size_t original_payload_size
;
2277 size_t payload_size
;
2279 ret
= setup_empty_lttng_msg(cmd_ctx
);
2281 ret
= LTTNG_ERR_NOMEM
;
2285 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2287 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2289 if (ret
!= LTTNG_OK
) {
2293 LTTNG_ASSERT(return_triggers
);
2294 ret
= lttng_triggers_serialize(
2295 return_triggers
, &cmd_ctx
->reply_payload
);
2296 lttng_triggers_destroy(return_triggers
);
2298 ERR("Failed to serialize triggers in reply to `list triggers` command");
2299 ret
= LTTNG_ERR_NOMEM
;
2303 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2304 original_payload_size
;
2306 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2311 case LTTNG_EXECUTE_ERROR_QUERY
:
2313 struct lttng_error_query
*query
;
2314 const struct lttng_credentials cmd_creds
= {
2315 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2316 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2318 struct lttng_error_query_results
*results
= NULL
;
2319 size_t original_payload_size
;
2320 size_t payload_size
;
2322 ret
= setup_empty_lttng_msg(cmd_ctx
);
2324 ret
= LTTNG_ERR_NOMEM
;
2328 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2330 ret
= receive_lttng_error_query(
2331 cmd_ctx
, *sock
, sock_error
, &query
);
2332 if (ret
!= LTTNG_OK
) {
2336 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2337 the_notification_thread_handle
);
2338 lttng_error_query_destroy(query
);
2339 if (ret
!= LTTNG_OK
) {
2343 LTTNG_ASSERT(results
);
2344 ret
= lttng_error_query_results_serialize(
2345 results
, &cmd_ctx
->reply_payload
);
2346 lttng_error_query_results_destroy(results
);
2348 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2349 ret
= LTTNG_ERR_NOMEM
;
2353 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2354 original_payload_size
;
2356 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2363 ret
= LTTNG_ERR_UND
;
2368 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2369 DBG("Missing llm header, creating one.");
2370 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2374 /* Set return code */
2375 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2377 if (cmd_ctx
->session
) {
2378 session_unlock(cmd_ctx
->session
);
2379 session_put(cmd_ctx
->session
);
2380 cmd_ctx
->session
= NULL
;
2382 if (need_tracing_session
) {
2383 session_unlock_list();
2386 LTTNG_ASSERT(!rcu_read_ongoing());
2390 static int create_client_sock(void)
2392 int ret
, client_sock
;
2393 const mode_t old_umask
= umask(0);
2395 /* Create client tool unix socket */
2396 client_sock
= lttcomm_create_unix_sock(
2397 the_config
.client_unix_sock_path
.value
);
2398 if (client_sock
< 0) {
2399 ERR("Create unix sock failed: %s",
2400 the_config
.client_unix_sock_path
.value
);
2405 /* Set the cloexec flag */
2406 ret
= utils_set_fd_cloexec(client_sock
);
2408 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2409 "Continuing but note that the consumer daemon will have a "
2410 "reference to this socket on exec()", client_sock
);
2413 /* File permission MUST be 660 */
2414 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2415 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2417 ERR("Set file permissions failed: %s",
2418 the_config
.client_unix_sock_path
.value
);
2420 (void) lttcomm_close_unix_sock(client_sock
);
2424 DBG("Created client socket (fd = %i)", client_sock
);
2431 static void cleanup_client_thread(void *data
)
2433 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2435 lttng_pipe_destroy(quit_pipe
);
2438 static void thread_init_cleanup(void *data
)
2440 set_thread_status(false);
2444 * This thread manage all clients request using the unix client socket for
2447 static void *thread_manage_clients(void *data
)
2449 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2451 uint32_t revents
, nb_fd
;
2452 struct lttng_poll_event events
;
2453 const int client_sock
= thread_state
.client_sock
;
2454 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2455 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2456 struct command_ctx cmd_ctx
= {};
2458 DBG("[thread] Manage client started");
2460 lttng_payload_init(&cmd_ctx
.reply_payload
);
2462 is_root
= (getuid() == 0);
2464 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2466 rcu_register_thread();
2468 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2470 health_code_update();
2472 ret
= lttcomm_listen_unix_sock(client_sock
);
2478 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2479 * more will be added to this poll set.
2481 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2483 goto error_create_poll
;
2486 /* Add the application registration socket */
2487 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2492 /* Add thread quit pipe */
2493 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2498 /* Set state as running. */
2499 set_thread_status(true);
2500 pthread_cleanup_pop(0);
2502 /* This testpoint is after we signal readiness to the parent. */
2503 if (testpoint(sessiond_thread_manage_clients
)) {
2507 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2511 health_code_update();
2514 const struct cmd_completion_handler
*cmd_completion_handler
;
2516 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2517 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2518 cmd_ctx
.creds
.pid
= 0;
2519 cmd_ctx
.session
= NULL
;
2520 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2521 cmd_ctx
.lttng_msg_size
= 0;
2523 DBG("Accepting client command ...");
2525 /* Inifinite blocking call, waiting for transmission */
2527 health_poll_entry();
2528 ret
= lttng_poll_wait(&events
, -1);
2532 * Restart interrupted system call.
2534 if (errno
== EINTR
) {
2542 for (i
= 0; i
< nb_fd
; i
++) {
2543 revents
= LTTNG_POLL_GETEV(&events
, i
);
2544 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2546 health_code_update();
2548 if (pollfd
== thread_quit_pipe_fd
) {
2552 /* Event on the registration socket */
2553 if (revents
& LPOLLIN
) {
2555 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2556 ERR("Client socket poll error");
2559 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2565 DBG("Wait for client response");
2567 health_code_update();
2569 sock
= lttcomm_accept_unix_sock(client_sock
);
2575 * Set the CLOEXEC flag. Return code is useless because either way, the
2578 (void) utils_set_fd_cloexec(sock
);
2580 /* Set socket option for credentials retrieval */
2581 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2586 health_code_update();
2589 * Data is received from the lttng client. The struct
2590 * lttcomm_session_msg (lsm) contains the command and data request of
2593 DBG("Receiving data from client ...");
2594 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2595 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2596 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2597 DBG("Incomplete recv() from client... continuing");
2606 health_code_update();
2608 // TODO: Validate cmd_ctx including sanity check for
2609 // security purpose.
2611 rcu_thread_online();
2613 * This function dispatch the work to the kernel or userspace tracer
2614 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2615 * informations for the client. The command context struct contains
2616 * everything this function may needs.
2618 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2619 rcu_thread_offline();
2629 * TODO: Inform client somehow of the fatal error. At
2630 * this point, ret < 0 means that a zmalloc failed
2631 * (ENOMEM). Error detected but still accept
2632 * command, unless a socket error has been
2638 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2639 WARN("Command returned an invalid status code, returning unknown error: "
2640 "command type = %s (%d), ret = %d",
2641 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2642 cmd_ctx
.lsm
.cmd_type
, ret
);
2643 ret
= LTTNG_ERR_UNK
;
2646 cmd_completion_handler
= cmd_pop_completion_handler();
2647 if (cmd_completion_handler
) {
2648 enum lttng_error_code completion_code
;
2650 completion_code
= cmd_completion_handler
->run(
2651 cmd_completion_handler
->data
);
2652 if (completion_code
!= LTTNG_OK
) {
2657 health_code_update();
2660 struct lttng_payload_view view
=
2661 lttng_payload_view_from_payload(
2662 &cmd_ctx
.reply_payload
,
2664 struct lttcomm_lttng_msg
*llm
= (typeof(
2665 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2667 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2668 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2670 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2672 DBG("Sending response (size: %d, retcode: %s (%d))",
2673 cmd_ctx
.lttng_msg_size
,
2674 lttng_strerror(-llm
->ret_code
),
2676 ret
= send_unix_sock(sock
, &view
);
2678 ERR("Failed to send data back to client");
2681 /* End of transmission */
2689 health_code_update();
2701 lttng_poll_clean(&events
);
2705 unlink(the_config
.client_unix_sock_path
.value
);
2706 ret
= close(client_sock
);
2713 ERR("Health error occurred in %s", __func__
);
2716 health_unregister(the_health_sessiond
);
2718 DBG("Client thread dying");
2719 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2720 rcu_unregister_thread();
2725 bool shutdown_client_thread(void *thread_data
)
2727 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2728 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2730 return notify_thread_pipe(write_fd
) == 1;
2733 struct lttng_thread
*launch_client_thread(void)
2735 bool thread_running
;
2736 struct lttng_pipe
*client_quit_pipe
;
2737 struct lttng_thread
*thread
= NULL
;
2738 int client_sock_fd
= -1;
2740 sem_init(&thread_state
.ready
, 0, 0);
2741 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2742 if (!client_quit_pipe
) {
2746 client_sock_fd
= create_client_sock();
2747 if (client_sock_fd
< 0) {
2751 thread_state
.client_sock
= client_sock_fd
;
2752 thread
= lttng_thread_create("Client management",
2753 thread_manage_clients
,
2754 shutdown_client_thread
,
2755 cleanup_client_thread
,
2760 /* The client thread now owns the client sock fd and the quit pipe. */
2761 client_sock_fd
= -1;
2762 client_quit_pipe
= NULL
;
2765 * This thread is part of the threads that need to be fully
2766 * initialized before the session daemon is marked as "ready".
2768 thread_running
= wait_thread_status();
2769 if (!thread_running
) {
2774 if (client_sock_fd
>= 0) {
2775 if (close(client_sock_fd
)) {
2776 PERROR("Failed to close client socket");
2779 lttng_thread_put(thread
);
2780 cleanup_client_thread(client_quit_pipe
);