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 const struct lttcomm_lttng_msg llm
= {
91 .cmd_type
= cmd_ctx
->lsm
.cmd_type
,
92 .pid
= cmd_ctx
->lsm
.domain
.attr
.pid
,
93 .cmd_header_size
= cmd_header_len
,
94 .data_size
= 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 const struct lttcomm_lttng_msg llm
= {
165 .cmd_type
= cmd_ctx
->lsm
.cmd_type
,
166 .pid
= cmd_ctx
->lsm
.domain
.attr
.pid
,
167 .cmd_header_size
= cmd_header_len
,
168 .data_size
= payload_len
,
170 struct lttcomm_lttng_msg
*p_llm
;
172 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(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(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 * Should *NOT* be called with RCU read-side lock held.
423 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
426 const char *dir_name
;
427 struct consumer_output
*consumer
;
430 assert(session
->consumer
);
433 case LTTNG_DOMAIN_KERNEL
:
434 DBG3("Copying tracing session consumer output in kernel session");
436 * XXX: We should audit the session creation and what this function
437 * does "extra" in order to avoid a destroy since this function is used
438 * in the domain session creation (kernel and ust) only. Same for UST
441 if (session
->kernel_session
->consumer
) {
442 consumer_output_put(session
->kernel_session
->consumer
);
444 session
->kernel_session
->consumer
=
445 consumer_copy_output(session
->consumer
);
446 /* Ease our life a bit for the next part */
447 consumer
= session
->kernel_session
->consumer
;
448 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
450 case LTTNG_DOMAIN_JUL
:
451 case LTTNG_DOMAIN_LOG4J
:
452 case LTTNG_DOMAIN_PYTHON
:
453 case LTTNG_DOMAIN_UST
:
454 DBG3("Copying tracing session consumer output in UST session");
455 if (session
->ust_session
->consumer
) {
456 consumer_output_put(session
->ust_session
->consumer
);
458 session
->ust_session
->consumer
=
459 consumer_copy_output(session
->consumer
);
460 /* Ease our life a bit for the next part */
461 consumer
= session
->ust_session
->consumer
;
462 dir_name
= DEFAULT_UST_TRACE_DIR
;
465 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
469 /* Append correct directory to subdir */
470 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
,
471 sizeof(consumer
->domain_subdir
));
476 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
484 * Create an UST session and add it to the session ust list.
486 * Should *NOT* be called with RCU read-side lock held.
488 static int create_ust_session(struct ltt_session
*session
,
489 const struct lttng_domain
*domain
)
492 struct ltt_ust_session
*lus
= NULL
;
496 assert(session
->consumer
);
498 switch (domain
->type
) {
499 case LTTNG_DOMAIN_JUL
:
500 case LTTNG_DOMAIN_LOG4J
:
501 case LTTNG_DOMAIN_PYTHON
:
502 case LTTNG_DOMAIN_UST
:
505 ERR("Unknown UST domain on create session %d", domain
->type
);
506 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
510 DBG("Creating UST session");
512 lus
= trace_ust_create_session(session
->id
);
514 ret
= LTTNG_ERR_UST_SESS_FAIL
;
518 lus
->uid
= session
->uid
;
519 lus
->gid
= session
->gid
;
520 lus
->output_traces
= session
->output_traces
;
521 lus
->snapshot_mode
= session
->snapshot_mode
;
522 lus
->live_timer_interval
= session
->live_timer
;
523 session
->ust_session
= lus
;
524 if (session
->shm_path
[0]) {
525 strncpy(lus
->root_shm_path
, session
->shm_path
,
526 sizeof(lus
->root_shm_path
));
527 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
528 strncpy(lus
->shm_path
, session
->shm_path
,
529 sizeof(lus
->shm_path
));
530 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
531 strncat(lus
->shm_path
, "/ust",
532 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
534 /* Copy session output to the newly created UST session */
535 ret
= copy_session_consumer(domain
->type
, session
);
536 if (ret
!= LTTNG_OK
) {
544 session
->ust_session
= NULL
;
549 * Create a kernel tracer session then create the default channel.
551 static int create_kernel_session(struct ltt_session
*session
)
555 DBG("Creating kernel session");
557 ret
= kernel_create_session(session
);
559 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
563 /* Code flow safety */
564 assert(session
->kernel_session
);
566 /* Copy session output to the newly created Kernel session */
567 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
568 if (ret
!= LTTNG_OK
) {
572 session
->kernel_session
->uid
= session
->uid
;
573 session
->kernel_session
->gid
= session
->gid
;
574 session
->kernel_session
->output_traces
= session
->output_traces
;
575 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
576 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
581 trace_kernel_destroy_session(session
->kernel_session
);
582 session
->kernel_session
= NULL
;
588 * Count number of session permitted by uid/gid.
590 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
593 struct ltt_session
*session
;
594 const struct ltt_session_list
*session_list
= session_get_list();
596 DBG("Counting number of available session for UID %d", uid
);
597 cds_list_for_each_entry(session
, &session_list
->head
, list
) {
598 if (!session_get(session
)) {
601 session_lock(session
);
602 /* Only count the sessions the user can control. */
603 if (session_access_ok(session
, uid
) &&
604 !session
->destroyed
) {
607 session_unlock(session
);
608 session_put(session
);
613 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
616 struct lttng_trigger
**_trigger
)
620 ssize_t sock_recv_len
;
621 enum lttng_error_code ret_code
;
622 struct lttng_payload trigger_payload
;
623 struct lttng_trigger
*trigger
= NULL
;
625 lttng_payload_init(&trigger_payload
);
626 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
627 ret
= lttng_dynamic_buffer_set_size(
628 &trigger_payload
.buffer
, trigger_len
);
630 ret_code
= LTTNG_ERR_NOMEM
;
634 sock_recv_len
= lttcomm_recv_unix_sock(
635 sock
, trigger_payload
.buffer
.data
, trigger_len
);
636 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
637 ERR("Failed to receive trigger in command payload");
639 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
643 /* Receive fds, if any. */
644 if (cmd_ctx
->lsm
.fd_count
> 0) {
645 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
646 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
647 if (sock_recv_len
> 0 &&
648 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
649 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
650 cmd_ctx
->lsm
.fd_count
, (int) ret
);
651 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
654 } else if (sock_recv_len
<= 0) {
655 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
656 cmd_ctx
->lsm
.fd_count
, (int) ret
);
657 ret_code
= LTTNG_ERR_FATAL
;
663 /* Deserialize trigger. */
665 struct lttng_payload_view view
=
666 lttng_payload_view_from_payload(
667 &trigger_payload
, 0, -1);
669 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
671 ERR("Invalid trigger received as part of command payload");
672 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
673 lttng_trigger_put(trigger
);
682 lttng_payload_reset(&trigger_payload
);
686 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
689 struct lttng_error_query
**_query
)
693 ssize_t sock_recv_len
;
694 enum lttng_error_code ret_code
;
695 struct lttng_payload query_payload
;
696 struct lttng_error_query
*query
= NULL
;
698 lttng_payload_init(&query_payload
);
699 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
700 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
702 ret_code
= LTTNG_ERR_NOMEM
;
706 sock_recv_len
= lttcomm_recv_unix_sock(
707 sock
, query_payload
.buffer
.data
, query_len
);
708 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
709 ERR("Failed to receive error query in command payload");
711 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
715 /* Receive fds, if any. */
716 if (cmd_ctx
->lsm
.fd_count
> 0) {
717 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
718 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
719 if (sock_recv_len
> 0 &&
720 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
721 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
722 cmd_ctx
->lsm
.fd_count
, (int) ret
);
723 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
726 } else if (sock_recv_len
<= 0) {
727 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
728 cmd_ctx
->lsm
.fd_count
, (int) ret
);
729 ret_code
= LTTNG_ERR_FATAL
;
735 /* Deserialize error query. */
737 struct lttng_payload_view view
=
738 lttng_payload_view_from_payload(
739 &query_payload
, 0, -1);
741 if (lttng_error_query_create_from_payload(&view
, &query
) !=
743 ERR("Invalid error query received as part of command payload");
744 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
753 lttng_payload_reset(&query_payload
);
757 static enum lttng_error_code
receive_lttng_event(struct command_ctx
*cmd_ctx
,
760 struct lttng_event
**out_event
,
761 char **out_filter_expression
,
762 struct lttng_bytecode
**out_bytecode
,
763 struct lttng_event_exclusion
**out_exclusion
)
767 ssize_t sock_recv_len
;
768 enum lttng_error_code ret_code
;
769 struct lttng_payload event_payload
;
770 struct lttng_event
*local_event
= NULL
;
771 char *local_filter_expression
= NULL
;
772 struct lttng_bytecode
*local_bytecode
= NULL
;
773 struct lttng_event_exclusion
*local_exclusion
= NULL
;
775 lttng_payload_init(&event_payload
);
776 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
) {
777 event_len
= (size_t) cmd_ctx
->lsm
.u
.enable
.length
;
778 } else if (cmd_ctx
->lsm
.cmd_type
== LTTNG_DISABLE_EVENT
) {
779 event_len
= (size_t) cmd_ctx
->lsm
.u
.disable
.length
;
784 ret
= lttng_dynamic_buffer_set_size(&event_payload
.buffer
, event_len
);
786 ret_code
= LTTNG_ERR_NOMEM
;
790 sock_recv_len
= lttcomm_recv_unix_sock(
791 sock
, event_payload
.buffer
.data
, event_len
);
792 if (sock_recv_len
< 0 || sock_recv_len
!= event_len
) {
793 ERR("Failed to receive event in command payload");
795 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
799 /* Receive fds, if any. */
800 if (cmd_ctx
->lsm
.fd_count
> 0) {
801 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
802 sock
, cmd_ctx
->lsm
.fd_count
, &event_payload
);
803 if (sock_recv_len
> 0 &&
804 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
805 ERR("Failed to receive all file descriptors for event in command payload: expected fd count = %u, ret = %d",
806 cmd_ctx
->lsm
.fd_count
, (int) ret
);
807 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
810 } else if (sock_recv_len
<= 0) {
811 ERR("Failed to receive file descriptors for event in command payload: expected fd count = %u, ret = %d",
812 cmd_ctx
->lsm
.fd_count
, (int) ret
);
813 ret_code
= LTTNG_ERR_FATAL
;
819 /* Deserialize event. */
822 struct lttng_payload_view event_view
=
823 lttng_payload_view_from_payload(
824 &event_payload
, 0, -1);
826 len
= lttng_event_create_from_payload(&event_view
, &local_event
,
827 &local_exclusion
, &local_filter_expression
,
831 ERR("Failed to create an event from the received buffer");
832 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
836 if (len
!= event_len
) {
837 ERR("Userspace probe location from the received buffer is not the advertised length: header length = %zu" PRIu32
", payload length = %zd", event_len
, len
);
838 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
843 *out_event
= local_event
;
844 *out_exclusion
= local_exclusion
;
845 *out_filter_expression
= local_filter_expression
;
846 *out_bytecode
= local_bytecode
;
848 local_exclusion
= NULL
;
849 local_filter_expression
= NULL
;
850 local_bytecode
= NULL
;
855 lttng_payload_reset(&event_payload
);
856 lttng_event_destroy(local_event
);
857 free(local_filter_expression
);
858 free(local_bytecode
);
859 free(local_exclusion
);
863 static enum lttng_error_code
receive_lttng_event_context(
864 const struct command_ctx
*cmd_ctx
,
867 struct lttng_event_context
**out_event_context
)
870 const size_t event_context_len
=
871 (size_t) cmd_ctx
->lsm
.u
.context
.length
;
872 ssize_t sock_recv_len
;
873 enum lttng_error_code ret_code
;
874 struct lttng_payload event_context_payload
;
875 struct lttng_event_context
*context
= NULL
;
877 lttng_payload_init(&event_context_payload
);
879 ret
= lttng_dynamic_buffer_set_size(&event_context_payload
.buffer
,
882 ret_code
= LTTNG_ERR_NOMEM
;
886 sock_recv_len
= lttcomm_recv_unix_sock(
887 sock
, event_context_payload
.buffer
.data
,
889 if (sock_recv_len
< 0 || sock_recv_len
!= event_context_len
) {
890 ERR("Failed to receive event context in command payload");
892 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
896 /* Deserialize event. */
899 struct lttng_payload_view event_context_view
=
900 lttng_payload_view_from_payload(
901 &event_context_payload
, 0, -1);
903 len
= lttng_event_context_create_from_payload(
904 &event_context_view
, &context
);
907 ERR("Failed to create a event context from the received buffer");
908 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
912 if (len
!= event_context_len
) {
913 ERR("Event context from the received buffer is not the advertised length: expected length = %zu, payload length = %zd", event_context_len
, len
);
914 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
919 *out_event_context
= context
;
924 lttng_event_context_destroy(context
);
925 lttng_payload_reset(&event_context_payload
);
930 * Version of setup_lttng_msg() without command header.
932 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
933 void *payload_buf
, size_t payload_len
)
935 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
939 * Check if the current kernel tracer supports the session rotation feature.
940 * Return 1 if it does, 0 otherwise.
942 static int check_rotate_compatible(void)
946 if (the_kernel_tracer_version
.major
!= 2 ||
947 the_kernel_tracer_version
.minor
< 11) {
948 DBG("Kernel tracer version is not compatible with the rotation feature");
956 * Send data on a unix socket using the liblttsessiondcomm API.
958 * Return lttcomm error code.
960 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
963 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
965 /* Check valid length */
966 if (view
->buffer
.size
== 0) {
971 ret
= lttcomm_send_unix_sock(
972 sock
, view
->buffer
.data
, view
->buffer
.size
);
978 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
989 * Process the command requested by the lttng client within the command
990 * context structure. This function make sure that the return structure (llm)
991 * is set and ready for transmission before returning.
993 * Return any error encountered or 0 for success.
995 * "sock" is only used for special-case var. len data.
996 * A command may assume the ownership of the socket, in which case its value
997 * should be set to -1.
999 * Should *NOT* be called with RCU read-side lock held.
1001 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
1005 bool need_tracing_session
= true;
1007 bool need_consumerd
;
1009 DBG("Processing client command '%s\' (%d)",
1010 lttcomm_sessiond_command_str(cmd_ctx
->lsm
.cmd_type
),
1011 cmd_ctx
->lsm
.cmd_type
);
1013 assert(!rcu_read_ongoing());
1017 switch (cmd_ctx
->lsm
.cmd_type
) {
1018 case LTTNG_CREATE_SESSION_EXT
:
1019 case LTTNG_DESTROY_SESSION
:
1020 case LTTNG_LIST_SESSIONS
:
1021 case LTTNG_LIST_DOMAINS
:
1022 case LTTNG_START_TRACE
:
1023 case LTTNG_STOP_TRACE
:
1024 case LTTNG_DATA_PENDING
:
1025 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1026 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1027 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1028 case LTTNG_SNAPSHOT_RECORD
:
1029 case LTTNG_SAVE_SESSION
:
1030 case LTTNG_SET_SESSION_SHM_PATH
:
1031 case LTTNG_REGENERATE_METADATA
:
1032 case LTTNG_REGENERATE_STATEDUMP
:
1033 case LTTNG_ROTATE_SESSION
:
1034 case LTTNG_ROTATION_GET_INFO
:
1035 case LTTNG_ROTATION_SET_SCHEDULE
:
1036 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1037 case LTTNG_CLEAR_SESSION
:
1038 case LTTNG_LIST_TRIGGERS
:
1039 case LTTNG_EXECUTE_ERROR_QUERY
:
1040 need_domain
= false;
1046 /* Needs a functioning consumerd? */
1047 switch (cmd_ctx
->lsm
.cmd_type
) {
1048 case LTTNG_REGISTER_TRIGGER
:
1049 case LTTNG_UNREGISTER_TRIGGER
:
1050 case LTTNG_EXECUTE_ERROR_QUERY
:
1051 need_consumerd
= false;
1054 need_consumerd
= true;
1058 if (the_config
.no_kernel
&& need_domain
&&
1059 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
1061 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1063 ret
= LTTNG_ERR_KERN_NA
;
1068 /* Deny register consumer if we already have a spawned consumer. */
1069 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
1070 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1071 if (the_kconsumer_data
.pid
> 0) {
1072 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1073 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1076 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1080 * Check for command that don't needs to allocate a returned payload. We do
1081 * this here so we don't have to make the call for no payload at each
1084 switch(cmd_ctx
->lsm
.cmd_type
) {
1085 case LTTNG_LIST_SESSIONS
:
1086 case LTTNG_LIST_TRACEPOINTS
:
1087 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1088 case LTTNG_LIST_DOMAINS
:
1089 case LTTNG_LIST_CHANNELS
:
1090 case LTTNG_LIST_EVENTS
:
1091 case LTTNG_LIST_SYSCALLS
:
1092 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1093 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1094 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1095 case LTTNG_DATA_PENDING
:
1096 case LTTNG_ROTATE_SESSION
:
1097 case LTTNG_ROTATION_GET_INFO
:
1098 case LTTNG_REGISTER_TRIGGER
:
1099 case LTTNG_LIST_TRIGGERS
:
1100 case LTTNG_EXECUTE_ERROR_QUERY
:
1103 /* Setup lttng message with no payload */
1104 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1106 /* This label does not try to unlock the session */
1107 goto init_setup_error
;
1111 /* Commands that DO NOT need a session. */
1112 switch (cmd_ctx
->lsm
.cmd_type
) {
1113 case LTTNG_CREATE_SESSION_EXT
:
1114 case LTTNG_LIST_SESSIONS
:
1115 case LTTNG_LIST_TRACEPOINTS
:
1116 case LTTNG_LIST_SYSCALLS
:
1117 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1118 case LTTNG_SAVE_SESSION
:
1119 case LTTNG_REGISTER_TRIGGER
:
1120 case LTTNG_UNREGISTER_TRIGGER
:
1121 case LTTNG_LIST_TRIGGERS
:
1122 case LTTNG_EXECUTE_ERROR_QUERY
:
1123 need_tracing_session
= false;
1126 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1128 * We keep the session list lock across _all_ commands
1129 * for now, because the per-session lock does not
1130 * handle teardown properly.
1132 session_lock_list();
1133 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1134 if (cmd_ctx
->session
== NULL
) {
1135 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1138 /* Acquire lock for the session */
1139 session_lock(cmd_ctx
->session
);
1145 * Commands that need a valid session but should NOT create one if none
1146 * exists. Instead of creating one and destroying it when the command is
1147 * handled, process that right before so we save some round trip in useless
1150 switch (cmd_ctx
->lsm
.cmd_type
) {
1151 case LTTNG_DISABLE_CHANNEL
:
1152 case LTTNG_DISABLE_EVENT
:
1153 switch (cmd_ctx
->lsm
.domain
.type
) {
1154 case LTTNG_DOMAIN_KERNEL
:
1155 if (!cmd_ctx
->session
->kernel_session
) {
1156 ret
= LTTNG_ERR_NO_CHANNEL
;
1160 case LTTNG_DOMAIN_JUL
:
1161 case LTTNG_DOMAIN_LOG4J
:
1162 case LTTNG_DOMAIN_PYTHON
:
1163 case LTTNG_DOMAIN_UST
:
1164 if (!cmd_ctx
->session
->ust_session
) {
1165 ret
= LTTNG_ERR_NO_CHANNEL
;
1170 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1182 * Check domain type for specific "pre-action".
1184 switch (cmd_ctx
->lsm
.domain
.type
) {
1185 case LTTNG_DOMAIN_KERNEL
:
1187 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1191 /* Kernel tracer check */
1192 if (!kernel_tracer_is_initialized()) {
1193 /* Basically, load kernel tracer modules */
1194 ret
= init_kernel_tracer();
1200 /* Consumer is in an ERROR state. Report back to client */
1201 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1203 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1207 /* Need a session for kernel command */
1208 if (need_tracing_session
) {
1209 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1210 ret
= create_kernel_session(cmd_ctx
->session
);
1211 if (ret
!= LTTNG_OK
) {
1212 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1217 /* Start the kernel consumer daemon */
1218 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1219 if (the_kconsumer_data
.pid
== 0 &&
1220 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1221 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1222 ret
= start_consumerd(&the_kconsumer_data
);
1224 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1227 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1229 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1233 * The consumer was just spawned so we need to add the socket to
1234 * the consumer output of the session if exist.
1236 ret
= consumer_create_socket(&the_kconsumer_data
,
1237 cmd_ctx
->session
->kernel_session
->consumer
);
1244 case LTTNG_DOMAIN_JUL
:
1245 case LTTNG_DOMAIN_LOG4J
:
1246 case LTTNG_DOMAIN_PYTHON
:
1247 if (!agent_tracing_is_enabled()) {
1248 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1252 case LTTNG_DOMAIN_UST
:
1254 if (!ust_app_supported()) {
1255 ret
= LTTNG_ERR_NO_UST
;
1259 /* Consumer is in an ERROR state. Report back to client */
1260 if (need_consumerd
&&
1261 uatomic_read(&the_ust_consumerd_state
) ==
1263 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1267 if (need_tracing_session
) {
1268 /* Create UST session if none exist. */
1269 if (cmd_ctx
->session
->ust_session
== NULL
) {
1270 ret
= create_ust_session(cmd_ctx
->session
,
1271 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
));
1272 if (ret
!= LTTNG_OK
) {
1277 /* Start the UST consumer daemons */
1279 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1280 if (the_config
.consumerd64_bin_path
.value
&&
1281 the_ustconsumer64_data
.pid
== 0 &&
1282 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1283 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1284 ret
= start_consumerd(&the_ustconsumer64_data
);
1286 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1287 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1291 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1292 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1294 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1298 * Setup socket for consumer 64 bit. No need for atomic access
1299 * since it was set above and can ONLY be set in this thread.
1301 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1302 cmd_ctx
->session
->ust_session
->consumer
);
1308 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1309 if (the_config
.consumerd32_bin_path
.value
&&
1310 the_ustconsumer32_data
.pid
== 0 &&
1311 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1312 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1313 ret
= start_consumerd(&the_ustconsumer32_data
);
1315 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1316 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1320 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1321 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1323 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1327 * Setup socket for consumer 32 bit. No need for atomic access
1328 * since it was set above and can ONLY be set in this thread.
1330 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1331 cmd_ctx
->session
->ust_session
->consumer
);
1343 /* Validate consumer daemon state when start/stop trace command */
1344 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1345 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1346 switch (cmd_ctx
->lsm
.domain
.type
) {
1347 case LTTNG_DOMAIN_NONE
:
1349 case LTTNG_DOMAIN_JUL
:
1350 case LTTNG_DOMAIN_LOG4J
:
1351 case LTTNG_DOMAIN_PYTHON
:
1352 case LTTNG_DOMAIN_UST
:
1353 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1354 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1358 case LTTNG_DOMAIN_KERNEL
:
1359 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1360 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1365 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1371 * Check that the UID matches that of the tracing session.
1372 * The root user can interact with all sessions.
1374 if (need_tracing_session
) {
1375 if (!session_access_ok(cmd_ctx
->session
,
1376 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1377 cmd_ctx
->session
->destroyed
) {
1378 ret
= LTTNG_ERR_EPERM
;
1384 * Send relayd information to consumer as soon as we have a domain and a
1387 if (cmd_ctx
->session
&& need_domain
) {
1389 * Setup relayd if not done yet. If the relayd information was already
1390 * sent to the consumer, this call will gracefully return.
1392 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1393 if (ret
!= LTTNG_OK
) {
1398 /* Process by command type */
1399 switch (cmd_ctx
->lsm
.cmd_type
) {
1400 case LTTNG_ADD_CONTEXT
:
1402 struct lttng_event_context
*event_context
= NULL
;
1403 const enum lttng_error_code ret_code
=
1404 receive_lttng_event_context(
1405 cmd_ctx
, *sock
, sock_error
, &event_context
);
1407 if (ret_code
!= LTTNG_OK
) {
1408 ret
= (int) ret_code
;
1412 ret
= cmd_add_context(cmd_ctx
, event_context
, the_kernel_poll_pipe
[1]);
1413 lttng_event_context_destroy(event_context
);
1416 case LTTNG_DISABLE_CHANNEL
:
1418 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1419 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1422 case LTTNG_ENABLE_CHANNEL
:
1424 ret
= cmd_enable_channel(
1425 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1428 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1429 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1431 struct lttng_dynamic_buffer payload
;
1432 struct lttng_buffer_view payload_view
;
1433 const bool add_value
=
1434 cmd_ctx
->lsm
.cmd_type
==
1435 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1436 const size_t name_len
=
1437 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1439 const enum lttng_domain_type domain_type
=
1440 (enum lttng_domain_type
)
1441 cmd_ctx
->lsm
.domain
.type
;
1442 const enum lttng_process_attr process_attr
=
1443 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1444 .process_attr_tracker_add_remove_include_value
1446 const enum lttng_process_attr_value_type value_type
=
1447 (enum lttng_process_attr_value_type
) cmd_ctx
1449 .process_attr_tracker_add_remove_include_value
1451 struct process_attr_value
*value
;
1452 enum lttng_error_code ret_code
;
1453 long login_name_max
;
1455 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1456 if (login_name_max
< 0) {
1457 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1458 ret
= LTTNG_ERR_INVALID
;
1462 /* Receive remaining variable length payload if applicable. */
1463 if (name_len
> login_name_max
) {
1465 * POSIX mandates user and group names that are at least
1466 * 8 characters long. Note that although shadow-utils
1467 * (useradd, groupaadd, etc.) use 32 chars as their
1468 * limit (from bits/utmp.h, UT_NAMESIZE),
1469 * LOGIN_NAME_MAX is defined to 256.
1471 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1472 add_value
? "addition" : "removal",
1473 name_len
, login_name_max
);
1474 ret
= LTTNG_ERR_INVALID
;
1478 lttng_dynamic_buffer_init(&payload
);
1479 if (name_len
!= 0) {
1481 * Receive variable payload for user/group name
1484 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1486 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1487 add_value
? "add" : "remove");
1488 ret
= LTTNG_ERR_NOMEM
;
1489 goto error_add_remove_tracker_value
;
1492 ret
= lttcomm_recv_unix_sock(
1493 *sock
, payload
.data
, name_len
);
1495 ERR("Failed to receive payload of %s process attribute tracker value argument",
1496 add_value
? "add" : "remove");
1498 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1499 goto error_add_remove_tracker_value
;
1503 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1504 &payload
, 0, name_len
);
1505 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1506 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1507 goto error_add_remove_tracker_value
;
1511 * Validate the value type and domains are legal for the process
1512 * attribute tracker that is specified and convert the value to
1513 * add/remove to the internal sessiond representation.
1515 ret_code
= process_attr_value_from_comm(domain_type
,
1516 process_attr
, value_type
,
1517 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1519 &payload_view
, &value
);
1520 if (ret_code
!= LTTNG_OK
) {
1522 goto error_add_remove_tracker_value
;
1526 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1527 cmd_ctx
->session
, domain_type
,
1528 process_attr
, value
);
1530 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1531 cmd_ctx
->session
, domain_type
,
1532 process_attr
, value
);
1534 process_attr_value_destroy(value
);
1535 error_add_remove_tracker_value
:
1536 lttng_dynamic_buffer_reset(&payload
);
1539 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1541 enum lttng_tracking_policy tracking_policy
;
1542 const enum lttng_domain_type domain_type
=
1543 (enum lttng_domain_type
)
1544 cmd_ctx
->lsm
.domain
.type
;
1545 const enum lttng_process_attr process_attr
=
1546 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1547 .process_attr_tracker_get_tracking_policy
1550 ret
= cmd_process_attr_tracker_get_tracking_policy(
1551 cmd_ctx
->session
, domain_type
, process_attr
,
1553 if (ret
!= LTTNG_OK
) {
1557 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1558 &(uint32_t){tracking_policy
}, sizeof(uint32_t));
1560 ret
= LTTNG_ERR_NOMEM
;
1566 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1568 const enum lttng_tracking_policy tracking_policy
=
1569 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1570 .process_attr_tracker_set_tracking_policy
1572 const enum lttng_domain_type domain_type
=
1573 (enum lttng_domain_type
)
1574 cmd_ctx
->lsm
.domain
.type
;
1575 const enum lttng_process_attr process_attr
=
1576 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1577 .process_attr_tracker_set_tracking_policy
1580 ret
= cmd_process_attr_tracker_set_tracking_policy(
1581 cmd_ctx
->session
, domain_type
, process_attr
,
1583 if (ret
!= LTTNG_OK
) {
1588 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1590 struct lttng_process_attr_values
*values
;
1591 struct lttng_dynamic_buffer reply
;
1592 const enum lttng_domain_type domain_type
=
1593 (enum lttng_domain_type
)
1594 cmd_ctx
->lsm
.domain
.type
;
1595 const enum lttng_process_attr process_attr
=
1596 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1597 .process_attr_tracker_get_inclusion_set
1600 ret
= cmd_process_attr_tracker_get_inclusion_set(
1601 cmd_ctx
->session
, domain_type
, process_attr
,
1603 if (ret
!= LTTNG_OK
) {
1607 lttng_dynamic_buffer_init(&reply
);
1608 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1610 goto error_tracker_get_inclusion_set
;
1613 ret
= setup_lttng_msg_no_cmd_header(
1614 cmd_ctx
, reply
.data
, reply
.size
);
1616 ret
= LTTNG_ERR_NOMEM
;
1617 goto error_tracker_get_inclusion_set
;
1621 error_tracker_get_inclusion_set
:
1622 lttng_process_attr_values_destroy(values
);
1623 lttng_dynamic_buffer_reset(&reply
);
1626 case LTTNG_ENABLE_EVENT
:
1627 case LTTNG_DISABLE_EVENT
:
1629 struct lttng_event
*event
;
1630 char *filter_expression
;
1631 struct lttng_event_exclusion
*exclusions
;
1632 struct lttng_bytecode
*bytecode
;
1633 const enum lttng_error_code ret_code
= receive_lttng_event(
1634 cmd_ctx
, *sock
, sock_error
, &event
,
1635 &filter_expression
, &bytecode
, &exclusions
);
1637 if (ret_code
!= LTTNG_OK
) {
1638 ret
= (int) ret_code
;
1643 * Ownership of filter_expression, exclusions, and bytecode is
1644 * always transferred.
1646 ret
= cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
?
1647 cmd_enable_event(cmd_ctx
, event
,
1648 filter_expression
, exclusions
,
1650 the_kernel_poll_pipe
[1]) :
1651 cmd_disable_event(cmd_ctx
, event
,
1652 filter_expression
, bytecode
,
1654 lttng_event_destroy(event
);
1657 case LTTNG_LIST_TRACEPOINTS
:
1659 enum lttng_error_code ret_code
;
1660 size_t original_payload_size
;
1661 size_t payload_size
;
1662 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1664 ret
= setup_empty_lttng_msg(cmd_ctx
);
1666 ret
= LTTNG_ERR_NOMEM
;
1670 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1672 session_lock_list();
1673 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1674 &cmd_ctx
->reply_payload
);
1675 session_unlock_list();
1676 if (ret_code
!= LTTNG_OK
) {
1677 ret
= (int) ret_code
;
1681 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1682 command_header_size
- original_payload_size
;
1683 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1688 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1690 enum lttng_error_code ret_code
;
1691 size_t original_payload_size
;
1692 size_t payload_size
;
1693 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1695 ret
= setup_empty_lttng_msg(cmd_ctx
);
1697 ret
= LTTNG_ERR_NOMEM
;
1701 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1703 session_lock_list();
1704 ret_code
= cmd_list_tracepoint_fields(
1705 cmd_ctx
->lsm
.domain
.type
, &cmd_ctx
->reply_payload
);
1706 session_unlock_list();
1707 if (ret_code
!= LTTNG_OK
) {
1708 ret
= (int) ret_code
;
1712 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1713 command_header_size
- original_payload_size
;
1714 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1719 case LTTNG_LIST_SYSCALLS
:
1721 enum lttng_error_code ret_code
;
1722 size_t original_payload_size
;
1723 size_t payload_size
;
1724 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1726 ret
= setup_empty_lttng_msg(cmd_ctx
);
1728 ret
= LTTNG_ERR_NOMEM
;
1732 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1734 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1735 if (ret_code
!= LTTNG_OK
) {
1736 ret
= (int) ret_code
;
1740 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1741 command_header_size
- original_payload_size
;
1742 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1747 case LTTNG_SET_CONSUMER_URI
:
1750 struct lttng_uri
*uris
;
1752 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1753 len
= nb_uri
* sizeof(struct lttng_uri
);
1756 ret
= LTTNG_ERR_INVALID
;
1760 uris
= zmalloc(len
);
1762 ret
= LTTNG_ERR_FATAL
;
1766 /* Receive variable len data */
1767 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1768 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1770 DBG("No URIs received from client... continuing");
1772 ret
= LTTNG_ERR_SESSION_FAIL
;
1777 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1779 if (ret
!= LTTNG_OK
) {
1786 case LTTNG_START_TRACE
:
1789 * On the first start, if we have a kernel session and we have
1790 * enabled time or size-based rotations, we have to make sure
1791 * the kernel tracer supports it.
1793 if (!cmd_ctx
->session
->has_been_started
&& \
1794 cmd_ctx
->session
->kernel_session
&& \
1795 (cmd_ctx
->session
->rotate_timer_period
|| \
1796 cmd_ctx
->session
->rotate_size
) && \
1797 !check_rotate_compatible()) {
1798 DBG("Kernel tracer version is not compatible with the rotation feature");
1799 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1802 ret
= cmd_start_trace(cmd_ctx
->session
);
1805 case LTTNG_STOP_TRACE
:
1807 ret
= cmd_stop_trace(cmd_ctx
->session
);
1810 case LTTNG_DESTROY_SESSION
:
1812 ret
= cmd_destroy_session(cmd_ctx
->session
,
1813 the_notification_thread_handle
, sock
);
1816 case LTTNG_LIST_DOMAINS
:
1819 struct lttng_domain
*domains
= NULL
;
1821 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1823 /* Return value is a negative lttng_error_code. */
1828 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1829 nb_dom
* sizeof(struct lttng_domain
));
1839 case LTTNG_LIST_CHANNELS
:
1841 enum lttng_error_code ret_code
;
1842 size_t original_payload_size
;
1843 size_t payload_size
;
1844 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1846 ret
= setup_empty_lttng_msg(cmd_ctx
);
1848 ret
= LTTNG_ERR_NOMEM
;
1852 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1854 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1855 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1856 if (ret_code
!= LTTNG_OK
) {
1857 ret
= (int) ret_code
;
1861 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1862 command_header_size
- original_payload_size
;
1863 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1868 case LTTNG_LIST_EVENTS
:
1870 enum lttng_error_code ret_code
;
1871 size_t original_payload_size
;
1872 size_t payload_size
;
1873 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1875 ret
= setup_empty_lttng_msg(cmd_ctx
);
1877 ret
= LTTNG_ERR_NOMEM
;
1881 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1883 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1885 cmd_ctx
->lsm
.u
.list
.channel_name
, &cmd_ctx
->reply_payload
);
1886 if (ret_code
!= LTTNG_OK
) {
1887 ret
= (int) ret_code
;
1891 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1892 command_header_size
- original_payload_size
;
1893 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1898 case LTTNG_LIST_SESSIONS
:
1900 unsigned int nr_sessions
;
1901 void *sessions_payload
;
1904 session_lock_list();
1905 nr_sessions
= lttng_sessions_count(
1906 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1907 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1909 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1910 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1911 sessions_payload
= zmalloc(payload_len
);
1913 if (!sessions_payload
) {
1914 session_unlock_list();
1919 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1920 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1921 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1922 session_unlock_list();
1924 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
1926 free(sessions_payload
);
1935 case LTTNG_REGISTER_CONSUMER
:
1937 struct consumer_data
*cdata
;
1939 switch (cmd_ctx
->lsm
.domain
.type
) {
1940 case LTTNG_DOMAIN_KERNEL
:
1941 cdata
= &the_kconsumer_data
;
1944 ret
= LTTNG_ERR_UND
;
1948 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1949 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1952 case LTTNG_DATA_PENDING
:
1955 uint8_t pending_ret_byte
;
1957 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1962 * This function may returns 0 or 1 to indicate whether or not
1963 * there is data pending. In case of error, it should return an
1964 * LTTNG_ERR code. However, some code paths may still return
1965 * a nondescript error code, which we handle by returning an
1968 if (pending_ret
== 0 || pending_ret
== 1) {
1970 * ret will be set to LTTNG_OK at the end of
1973 } else if (pending_ret
< 0) {
1974 ret
= LTTNG_ERR_UNK
;
1981 pending_ret_byte
= (uint8_t) pending_ret
;
1983 /* 1 byte to return whether or not data is pending */
1984 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1985 &pending_ret_byte
, 1);
1994 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1996 uint32_t snapshot_id
;
1997 struct lttcomm_lttng_output_id reply
;
1999 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
2000 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
),
2002 if (ret
!= LTTNG_OK
) {
2005 reply
.id
= snapshot_id
;
2007 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2013 /* Copy output list into message payload */
2017 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2019 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
2020 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
));
2023 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2026 struct lttng_snapshot_output
*outputs
= NULL
;
2028 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2029 if (nb_output
< 0) {
2034 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
2035 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2036 nb_output
* sizeof(struct lttng_snapshot_output
));
2046 case LTTNG_SNAPSHOT_RECORD
:
2048 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2049 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_record
.output
),
2050 cmd_ctx
->lsm
.u
.snapshot_record
.wait
);
2053 case LTTNG_CREATE_SESSION_EXT
:
2055 struct lttng_dynamic_buffer payload
;
2056 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2058 lttng_dynamic_buffer_init(&payload
);
2059 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2060 if (ret
!= LTTNG_OK
) {
2064 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2067 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2068 lttng_session_descriptor_destroy(return_descriptor
);
2069 ret
= LTTNG_ERR_NOMEM
;
2072 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2075 lttng_session_descriptor_destroy(return_descriptor
);
2076 ret
= LTTNG_ERR_NOMEM
;
2079 lttng_dynamic_buffer_reset(&payload
);
2080 lttng_session_descriptor_destroy(return_descriptor
);
2084 case LTTNG_SAVE_SESSION
:
2086 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2090 case LTTNG_SET_SESSION_SHM_PATH
:
2092 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2093 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2096 case LTTNG_REGENERATE_METADATA
:
2098 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2101 case LTTNG_REGENERATE_STATEDUMP
:
2103 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2106 case LTTNG_REGISTER_TRIGGER
:
2108 struct lttng_trigger
*payload_trigger
;
2109 struct lttng_trigger
*return_trigger
;
2110 size_t original_reply_payload_size
;
2111 size_t reply_payload_size
;
2112 const struct lttng_credentials cmd_creds
= {
2113 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2114 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2117 ret
= setup_empty_lttng_msg(cmd_ctx
);
2119 ret
= LTTNG_ERR_NOMEM
;
2123 ret
= receive_lttng_trigger(
2124 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2125 if (ret
!= LTTNG_OK
) {
2129 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2131 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2132 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2133 the_notification_thread_handle
,
2135 if (ret
!= LTTNG_OK
) {
2136 lttng_trigger_put(payload_trigger
);
2140 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2141 lttng_trigger_put(payload_trigger
);
2142 lttng_trigger_put(return_trigger
);
2144 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2145 ret
= LTTNG_ERR_NOMEM
;
2149 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2150 original_reply_payload_size
;
2152 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2157 case LTTNG_UNREGISTER_TRIGGER
:
2159 struct lttng_trigger
*payload_trigger
;
2160 const struct lttng_credentials cmd_creds
= {
2161 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2162 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2165 ret
= receive_lttng_trigger(
2166 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2167 if (ret
!= LTTNG_OK
) {
2171 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2172 the_notification_thread_handle
);
2173 lttng_trigger_put(payload_trigger
);
2176 case LTTNG_ROTATE_SESSION
:
2178 struct lttng_rotate_session_return rotate_return
;
2180 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2182 memset(&rotate_return
, 0, sizeof(rotate_return
));
2183 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2184 DBG("Kernel tracer version is not compatible with the rotation feature");
2185 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2189 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2191 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2197 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2198 sizeof(rotate_return
));
2207 case LTTNG_ROTATION_GET_INFO
:
2209 struct lttng_rotation_get_info_return get_info_return
;
2211 memset(&get_info_return
, 0, sizeof(get_info_return
));
2212 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2213 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2219 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2220 sizeof(get_info_return
));
2229 case LTTNG_ROTATION_SET_SCHEDULE
:
2232 enum lttng_rotation_schedule_type schedule_type
;
2235 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2236 DBG("Kernel tracer version does not support session rotations");
2237 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2241 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2242 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2243 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2245 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2246 schedule_type
, value
,
2247 the_notification_thread_handle
);
2248 if (ret
!= LTTNG_OK
) {
2254 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2256 struct lttng_session_list_schedules_return schedules
= {
2257 .periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
,
2258 .periodic
.value
= cmd_ctx
->session
->rotate_timer_period
,
2259 .size
.set
= !!cmd_ctx
->session
->rotate_size
,
2260 .size
.value
= cmd_ctx
->session
->rotate_size
,
2263 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2273 case LTTNG_CLEAR_SESSION
:
2275 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2278 case LTTNG_LIST_TRIGGERS
:
2280 struct lttng_triggers
*return_triggers
= NULL
;
2281 size_t original_payload_size
;
2282 size_t payload_size
;
2284 ret
= setup_empty_lttng_msg(cmd_ctx
);
2286 ret
= LTTNG_ERR_NOMEM
;
2290 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2292 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2294 if (ret
!= LTTNG_OK
) {
2298 assert(return_triggers
);
2299 ret
= lttng_triggers_serialize(
2300 return_triggers
, &cmd_ctx
->reply_payload
);
2301 lttng_triggers_destroy(return_triggers
);
2303 ERR("Failed to serialize triggers in reply to `list triggers` command");
2304 ret
= LTTNG_ERR_NOMEM
;
2308 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2309 original_payload_size
;
2311 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2316 case LTTNG_EXECUTE_ERROR_QUERY
:
2318 struct lttng_error_query
*query
;
2319 const struct lttng_credentials cmd_creds
= {
2320 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2321 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2323 struct lttng_error_query_results
*results
= NULL
;
2324 size_t original_payload_size
;
2325 size_t payload_size
;
2327 ret
= setup_empty_lttng_msg(cmd_ctx
);
2329 ret
= LTTNG_ERR_NOMEM
;
2333 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2335 ret
= receive_lttng_error_query(
2336 cmd_ctx
, *sock
, sock_error
, &query
);
2337 if (ret
!= LTTNG_OK
) {
2341 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2342 the_notification_thread_handle
);
2343 lttng_error_query_destroy(query
);
2344 if (ret
!= LTTNG_OK
) {
2349 ret
= lttng_error_query_results_serialize(
2350 results
, &cmd_ctx
->reply_payload
);
2351 lttng_error_query_results_destroy(results
);
2353 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2354 ret
= LTTNG_ERR_NOMEM
;
2358 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2359 original_payload_size
;
2361 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2368 ret
= LTTNG_ERR_UND
;
2373 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2374 DBG("Missing llm header, creating one.");
2375 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2379 /* Set return code */
2380 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2382 if (cmd_ctx
->session
) {
2383 session_unlock(cmd_ctx
->session
);
2384 session_put(cmd_ctx
->session
);
2385 cmd_ctx
->session
= NULL
;
2387 if (need_tracing_session
) {
2388 session_unlock_list();
2391 assert(!rcu_read_ongoing());
2395 static int create_client_sock(void)
2397 int ret
, client_sock
;
2398 const mode_t old_umask
= umask(0);
2400 /* Create client tool unix socket */
2401 client_sock
= lttcomm_create_unix_sock(
2402 the_config
.client_unix_sock_path
.value
);
2403 if (client_sock
< 0) {
2404 ERR("Create unix sock failed: %s",
2405 the_config
.client_unix_sock_path
.value
);
2410 /* Set the cloexec flag */
2411 ret
= utils_set_fd_cloexec(client_sock
);
2413 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2414 "Continuing but note that the consumer daemon will have a "
2415 "reference to this socket on exec()", client_sock
);
2418 /* File permission MUST be 660 */
2419 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2420 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2422 ERR("Set file permissions failed: %s",
2423 the_config
.client_unix_sock_path
.value
);
2425 (void) lttcomm_close_unix_sock(client_sock
);
2429 DBG("Created client socket (fd = %i)", client_sock
);
2436 static void cleanup_client_thread(void *data
)
2438 struct lttng_pipe
*quit_pipe
= data
;
2440 lttng_pipe_destroy(quit_pipe
);
2443 static void thread_init_cleanup(void *data
)
2445 set_thread_status(false);
2449 * This thread manage all clients request using the unix client socket for
2452 static void *thread_manage_clients(void *data
)
2454 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2456 uint32_t revents
, nb_fd
;
2457 struct lttng_poll_event events
;
2458 const int client_sock
= thread_state
.client_sock
;
2459 struct lttng_pipe
*quit_pipe
= data
;
2460 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2461 struct command_ctx cmd_ctx
= {};
2463 DBG("[thread] Manage client started");
2465 lttng_payload_init(&cmd_ctx
.reply_payload
);
2467 is_root
= (getuid() == 0);
2469 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2471 rcu_register_thread();
2473 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2475 health_code_update();
2477 ret
= lttcomm_listen_unix_sock(client_sock
);
2483 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2484 * more will be added to this poll set.
2486 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2488 goto error_create_poll
;
2491 /* Add the application registration socket */
2492 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2497 /* Add thread quit pipe */
2498 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2503 /* Set state as running. */
2504 set_thread_status(true);
2505 pthread_cleanup_pop(0);
2507 /* This testpoint is after we signal readiness to the parent. */
2508 if (testpoint(sessiond_thread_manage_clients
)) {
2512 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2516 health_code_update();
2519 const struct cmd_completion_handler
*cmd_completion_handler
;
2521 cmd_ctx
.creds
= (lttng_sock_cred
) {
2525 cmd_ctx
.session
= NULL
;
2526 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2527 cmd_ctx
.lttng_msg_size
= 0;
2529 DBG("Accepting client command ...");
2531 /* Inifinite blocking call, waiting for transmission */
2533 health_poll_entry();
2534 ret
= lttng_poll_wait(&events
, -1);
2538 * Restart interrupted system call.
2540 if (errno
== EINTR
) {
2548 for (i
= 0; i
< nb_fd
; i
++) {
2549 revents
= LTTNG_POLL_GETEV(&events
, i
);
2550 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2552 health_code_update();
2554 if (pollfd
== thread_quit_pipe_fd
) {
2558 /* Event on the registration socket */
2559 if (revents
& LPOLLIN
) {
2561 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2562 ERR("Client socket poll error");
2565 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2571 DBG("Wait for client response");
2573 health_code_update();
2575 sock
= lttcomm_accept_unix_sock(client_sock
);
2581 * Set the CLOEXEC flag. Return code is useless because either way, the
2584 (void) utils_set_fd_cloexec(sock
);
2586 /* Set socket option for credentials retrieval */
2587 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2592 health_code_update();
2595 * Data is received from the lttng client. The struct
2596 * lttcomm_session_msg (lsm) contains the command and data request of
2599 DBG("Receiving data from client ...");
2600 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2601 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2602 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2603 DBG("Incomplete recv() from client... continuing");
2612 health_code_update();
2614 // TODO: Validate cmd_ctx including sanity check for
2615 // security purpose.
2617 rcu_thread_online();
2619 * This function dispatch the work to the kernel or userspace tracer
2620 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2621 * informations for the client. The command context struct contains
2622 * everything this function may needs.
2624 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2625 rcu_thread_offline();
2635 * TODO: Inform client somehow of the fatal error. At
2636 * this point, ret < 0 means that a zmalloc failed
2637 * (ENOMEM). Error detected but still accept
2638 * command, unless a socket error has been
2644 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2645 WARN("Command returned an invalid status code, returning unknown error: "
2646 "command type = %s (%d), ret = %d",
2647 lttcomm_sessiond_command_str(cmd_ctx
.lsm
.cmd_type
),
2648 cmd_ctx
.lsm
.cmd_type
, ret
);
2649 ret
= LTTNG_ERR_UNK
;
2652 cmd_completion_handler
= cmd_pop_completion_handler();
2653 if (cmd_completion_handler
) {
2654 enum lttng_error_code completion_code
;
2656 completion_code
= cmd_completion_handler
->run(
2657 cmd_completion_handler
->data
);
2658 if (completion_code
!= LTTNG_OK
) {
2663 health_code_update();
2666 struct lttng_payload_view view
=
2667 lttng_payload_view_from_payload(
2668 &cmd_ctx
.reply_payload
,
2670 struct lttcomm_lttng_msg
*llm
= (typeof(
2671 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2673 assert(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2674 assert(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2676 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2678 DBG("Sending response (size: %d, retcode: %s (%d))",
2679 cmd_ctx
.lttng_msg_size
,
2680 lttng_strerror(-llm
->ret_code
),
2682 ret
= send_unix_sock(sock
, &view
);
2684 ERR("Failed to send data back to client");
2687 /* End of transmission */
2695 health_code_update();
2707 lttng_poll_clean(&events
);
2711 unlink(the_config
.client_unix_sock_path
.value
);
2712 ret
= close(client_sock
);
2719 ERR("Health error occurred in %s", __func__
);
2722 health_unregister(the_health_sessiond
);
2724 DBG("Client thread dying");
2725 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2726 rcu_unregister_thread();
2731 bool shutdown_client_thread(void *thread_data
)
2733 struct lttng_pipe
*client_quit_pipe
= thread_data
;
2734 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2736 return notify_thread_pipe(write_fd
) == 1;
2739 struct lttng_thread
*launch_client_thread(void)
2741 bool thread_running
;
2742 struct lttng_pipe
*client_quit_pipe
;
2743 struct lttng_thread
*thread
= NULL
;
2744 int client_sock_fd
= -1;
2746 sem_init(&thread_state
.ready
, 0, 0);
2747 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2748 if (!client_quit_pipe
) {
2752 client_sock_fd
= create_client_sock();
2753 if (client_sock_fd
< 0) {
2757 thread_state
.client_sock
= client_sock_fd
;
2758 thread
= lttng_thread_create("Client management",
2759 thread_manage_clients
,
2760 shutdown_client_thread
,
2761 cleanup_client_thread
,
2766 /* The client thread now owns the client sock fd and the quit pipe. */
2767 client_sock_fd
= -1;
2768 client_quit_pipe
= NULL
;
2771 * This thread is part of the threads that need to be fully
2772 * initialized before the session daemon is marked as "ready".
2774 thread_running
= wait_thread_status();
2775 if (!thread_running
) {
2780 if (client_sock_fd
>= 0) {
2781 if (close(client_sock_fd
)) {
2782 PERROR("Failed to close client socket");
2785 lttng_thread_put(thread
);
2786 cleanup_client_thread(client_quit_pipe
);