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
;
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. */
817 struct lttng_payload_view event_view
=
818 lttng_payload_view_from_payload(
819 &event_payload
, 0, -1);
821 if (lttng_event_create_from_payload(&event_view
, out_event
,
822 out_exclusion
, out_filter_expression
,
823 out_bytecode
) != event_len
) {
824 ERR("Invalid event received as part of command payload");
825 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
833 lttng_payload_reset(&event_payload
);
838 * Version of setup_lttng_msg() without command header.
840 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
841 void *payload_buf
, size_t payload_len
)
843 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
847 * Check if the current kernel tracer supports the session rotation feature.
848 * Return 1 if it does, 0 otherwise.
850 static int check_rotate_compatible(void)
854 if (the_kernel_tracer_version
.major
!= 2 ||
855 the_kernel_tracer_version
.minor
< 11) {
856 DBG("Kernel tracer version is not compatible with the rotation feature");
864 * Send data on a unix socket using the liblttsessiondcomm API.
866 * Return lttcomm error code.
868 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
871 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
873 /* Check valid length */
874 if (view
->buffer
.size
== 0) {
879 ret
= lttcomm_send_unix_sock(
880 sock
, view
->buffer
.data
, view
->buffer
.size
);
886 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
897 * Process the command requested by the lttng client within the command
898 * context structure. This function make sure that the return structure (llm)
899 * is set and ready for transmission before returning.
901 * Return any error encountered or 0 for success.
903 * "sock" is only used for special-case var. len data.
904 * A command may assume the ownership of the socket, in which case its value
905 * should be set to -1.
907 * Should *NOT* be called with RCU read-side lock held.
909 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
913 bool need_tracing_session
= true;
917 DBG("Processing client command '%s\' (%d)",
918 lttcomm_sessiond_command_str(cmd_ctx
->lsm
.cmd_type
),
919 cmd_ctx
->lsm
.cmd_type
);
921 assert(!rcu_read_ongoing());
925 switch (cmd_ctx
->lsm
.cmd_type
) {
926 case LTTNG_CREATE_SESSION_EXT
:
927 case LTTNG_DESTROY_SESSION
:
928 case LTTNG_LIST_SESSIONS
:
929 case LTTNG_LIST_DOMAINS
:
930 case LTTNG_START_TRACE
:
931 case LTTNG_STOP_TRACE
:
932 case LTTNG_DATA_PENDING
:
933 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
934 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
935 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
936 case LTTNG_SNAPSHOT_RECORD
:
937 case LTTNG_SAVE_SESSION
:
938 case LTTNG_SET_SESSION_SHM_PATH
:
939 case LTTNG_REGENERATE_METADATA
:
940 case LTTNG_REGENERATE_STATEDUMP
:
941 case LTTNG_ROTATE_SESSION
:
942 case LTTNG_ROTATION_GET_INFO
:
943 case LTTNG_ROTATION_SET_SCHEDULE
:
944 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
945 case LTTNG_CLEAR_SESSION
:
946 case LTTNG_LIST_TRIGGERS
:
947 case LTTNG_EXECUTE_ERROR_QUERY
:
954 /* Needs a functioning consumerd? */
955 switch (cmd_ctx
->lsm
.cmd_type
) {
956 case LTTNG_REGISTER_TRIGGER
:
957 case LTTNG_UNREGISTER_TRIGGER
:
958 case LTTNG_EXECUTE_ERROR_QUERY
:
959 need_consumerd
= false;
962 need_consumerd
= true;
966 if (the_config
.no_kernel
&& need_domain
&&
967 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
969 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
971 ret
= LTTNG_ERR_KERN_NA
;
976 /* Deny register consumer if we already have a spawned consumer. */
977 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
978 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
979 if (the_kconsumer_data
.pid
> 0) {
980 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
981 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
984 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
988 * Check for command that don't needs to allocate a returned payload. We do
989 * this here so we don't have to make the call for no payload at each
992 switch(cmd_ctx
->lsm
.cmd_type
) {
993 case LTTNG_LIST_SESSIONS
:
994 case LTTNG_LIST_TRACEPOINTS
:
995 case LTTNG_LIST_TRACEPOINT_FIELDS
:
996 case LTTNG_LIST_DOMAINS
:
997 case LTTNG_LIST_CHANNELS
:
998 case LTTNG_LIST_EVENTS
:
999 case LTTNG_LIST_SYSCALLS
:
1000 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1001 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1002 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1003 case LTTNG_DATA_PENDING
:
1004 case LTTNG_ROTATE_SESSION
:
1005 case LTTNG_ROTATION_GET_INFO
:
1006 case LTTNG_REGISTER_TRIGGER
:
1007 case LTTNG_LIST_TRIGGERS
:
1008 case LTTNG_EXECUTE_ERROR_QUERY
:
1011 /* Setup lttng message with no payload */
1012 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1014 /* This label does not try to unlock the session */
1015 goto init_setup_error
;
1019 /* Commands that DO NOT need a session. */
1020 switch (cmd_ctx
->lsm
.cmd_type
) {
1021 case LTTNG_CREATE_SESSION_EXT
:
1022 case LTTNG_LIST_SESSIONS
:
1023 case LTTNG_LIST_TRACEPOINTS
:
1024 case LTTNG_LIST_SYSCALLS
:
1025 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1026 case LTTNG_SAVE_SESSION
:
1027 case LTTNG_REGISTER_TRIGGER
:
1028 case LTTNG_UNREGISTER_TRIGGER
:
1029 case LTTNG_LIST_TRIGGERS
:
1030 case LTTNG_EXECUTE_ERROR_QUERY
:
1031 need_tracing_session
= false;
1034 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1036 * We keep the session list lock across _all_ commands
1037 * for now, because the per-session lock does not
1038 * handle teardown properly.
1040 session_lock_list();
1041 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1042 if (cmd_ctx
->session
== NULL
) {
1043 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1046 /* Acquire lock for the session */
1047 session_lock(cmd_ctx
->session
);
1053 * Commands that need a valid session but should NOT create one if none
1054 * exists. Instead of creating one and destroying it when the command is
1055 * handled, process that right before so we save some round trip in useless
1058 switch (cmd_ctx
->lsm
.cmd_type
) {
1059 case LTTNG_DISABLE_CHANNEL
:
1060 case LTTNG_DISABLE_EVENT
:
1061 switch (cmd_ctx
->lsm
.domain
.type
) {
1062 case LTTNG_DOMAIN_KERNEL
:
1063 if (!cmd_ctx
->session
->kernel_session
) {
1064 ret
= LTTNG_ERR_NO_CHANNEL
;
1068 case LTTNG_DOMAIN_JUL
:
1069 case LTTNG_DOMAIN_LOG4J
:
1070 case LTTNG_DOMAIN_PYTHON
:
1071 case LTTNG_DOMAIN_UST
:
1072 if (!cmd_ctx
->session
->ust_session
) {
1073 ret
= LTTNG_ERR_NO_CHANNEL
;
1078 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1090 * Check domain type for specific "pre-action".
1092 switch (cmd_ctx
->lsm
.domain
.type
) {
1093 case LTTNG_DOMAIN_KERNEL
:
1095 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1099 /* Kernel tracer check */
1100 if (!kernel_tracer_is_initialized()) {
1101 /* Basically, load kernel tracer modules */
1102 ret
= init_kernel_tracer();
1108 /* Consumer is in an ERROR state. Report back to client */
1109 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1111 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1115 /* Need a session for kernel command */
1116 if (need_tracing_session
) {
1117 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1118 ret
= create_kernel_session(cmd_ctx
->session
);
1119 if (ret
!= LTTNG_OK
) {
1120 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1125 /* Start the kernel consumer daemon */
1126 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1127 if (the_kconsumer_data
.pid
== 0 &&
1128 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1129 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1130 ret
= start_consumerd(&the_kconsumer_data
);
1132 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1135 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1137 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1141 * The consumer was just spawned so we need to add the socket to
1142 * the consumer output of the session if exist.
1144 ret
= consumer_create_socket(&the_kconsumer_data
,
1145 cmd_ctx
->session
->kernel_session
->consumer
);
1152 case LTTNG_DOMAIN_JUL
:
1153 case LTTNG_DOMAIN_LOG4J
:
1154 case LTTNG_DOMAIN_PYTHON
:
1155 if (!agent_tracing_is_enabled()) {
1156 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1160 case LTTNG_DOMAIN_UST
:
1162 if (!ust_app_supported()) {
1163 ret
= LTTNG_ERR_NO_UST
;
1167 /* Consumer is in an ERROR state. Report back to client */
1168 if (need_consumerd
&&
1169 uatomic_read(&the_ust_consumerd_state
) ==
1171 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1175 if (need_tracing_session
) {
1176 /* Create UST session if none exist. */
1177 if (cmd_ctx
->session
->ust_session
== NULL
) {
1178 ret
= create_ust_session(cmd_ctx
->session
,
1179 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
));
1180 if (ret
!= LTTNG_OK
) {
1185 /* Start the UST consumer daemons */
1187 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1188 if (the_config
.consumerd64_bin_path
.value
&&
1189 the_ustconsumer64_data
.pid
== 0 &&
1190 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1191 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1192 ret
= start_consumerd(&the_ustconsumer64_data
);
1194 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1195 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1199 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1200 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1202 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1206 * Setup socket for consumer 64 bit. No need for atomic access
1207 * since it was set above and can ONLY be set in this thread.
1209 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1210 cmd_ctx
->session
->ust_session
->consumer
);
1216 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1217 if (the_config
.consumerd32_bin_path
.value
&&
1218 the_ustconsumer32_data
.pid
== 0 &&
1219 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1220 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1221 ret
= start_consumerd(&the_ustconsumer32_data
);
1223 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1224 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1228 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1229 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1231 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1235 * Setup socket for consumer 32 bit. No need for atomic access
1236 * since it was set above and can ONLY be set in this thread.
1238 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1239 cmd_ctx
->session
->ust_session
->consumer
);
1251 /* Validate consumer daemon state when start/stop trace command */
1252 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1253 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1254 switch (cmd_ctx
->lsm
.domain
.type
) {
1255 case LTTNG_DOMAIN_NONE
:
1257 case LTTNG_DOMAIN_JUL
:
1258 case LTTNG_DOMAIN_LOG4J
:
1259 case LTTNG_DOMAIN_PYTHON
:
1260 case LTTNG_DOMAIN_UST
:
1261 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1262 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1266 case LTTNG_DOMAIN_KERNEL
:
1267 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1268 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1273 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1279 * Check that the UID matches that of the tracing session.
1280 * The root user can interact with all sessions.
1282 if (need_tracing_session
) {
1283 if (!session_access_ok(cmd_ctx
->session
,
1284 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1285 cmd_ctx
->session
->destroyed
) {
1286 ret
= LTTNG_ERR_EPERM
;
1292 * Send relayd information to consumer as soon as we have a domain and a
1295 if (cmd_ctx
->session
&& need_domain
) {
1297 * Setup relayd if not done yet. If the relayd information was already
1298 * sent to the consumer, this call will gracefully return.
1300 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1301 if (ret
!= LTTNG_OK
) {
1306 /* Process by command type */
1307 switch (cmd_ctx
->lsm
.cmd_type
) {
1308 case LTTNG_ADD_CONTEXT
:
1311 * An LTTNG_ADD_CONTEXT command might have a supplementary
1312 * payload if the context being added is an application context.
1314 if (cmd_ctx
->lsm
.u
.context
.ctx
.ctx
==
1315 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1316 char *provider_name
= NULL
, *context_name
= NULL
;
1317 size_t provider_name_len
=
1318 cmd_ctx
->lsm
.u
.context
.provider_name_len
;
1319 size_t context_name_len
=
1320 cmd_ctx
->lsm
.u
.context
.context_name_len
;
1322 if (provider_name_len
== 0 || context_name_len
== 0) {
1324 * Application provider and context names MUST
1327 ret
= -LTTNG_ERR_INVALID
;
1331 provider_name
= zmalloc(provider_name_len
+ 1);
1332 if (!provider_name
) {
1333 ret
= -LTTNG_ERR_NOMEM
;
1336 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
=
1339 context_name
= zmalloc(context_name_len
+ 1);
1340 if (!context_name
) {
1341 ret
= -LTTNG_ERR_NOMEM
;
1342 goto error_add_context
;
1344 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
=
1347 ret
= lttcomm_recv_unix_sock(*sock
, provider_name
,
1350 goto error_add_context
;
1353 ret
= lttcomm_recv_unix_sock(*sock
, context_name
,
1356 goto error_add_context
;
1361 * cmd_add_context assumes ownership of the provider and context
1364 ret
= cmd_add_context(cmd_ctx
->session
,
1365 cmd_ctx
->lsm
.domain
.type
,
1366 cmd_ctx
->lsm
.u
.context
.channel_name
,
1367 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.context
.ctx
),
1368 the_kernel_poll_pipe
[1]);
1370 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
1371 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
1373 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
);
1374 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
);
1380 case LTTNG_DISABLE_CHANNEL
:
1382 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1383 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1386 case LTTNG_ENABLE_CHANNEL
:
1388 ret
= cmd_enable_channel(
1389 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1392 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1393 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1395 struct lttng_dynamic_buffer payload
;
1396 struct lttng_buffer_view payload_view
;
1397 const bool add_value
=
1398 cmd_ctx
->lsm
.cmd_type
==
1399 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1400 const size_t name_len
=
1401 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1403 const enum lttng_domain_type domain_type
=
1404 (enum lttng_domain_type
)
1405 cmd_ctx
->lsm
.domain
.type
;
1406 const enum lttng_process_attr process_attr
=
1407 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1408 .process_attr_tracker_add_remove_include_value
1410 const enum lttng_process_attr_value_type value_type
=
1411 (enum lttng_process_attr_value_type
) cmd_ctx
1413 .process_attr_tracker_add_remove_include_value
1415 struct process_attr_value
*value
;
1416 enum lttng_error_code ret_code
;
1417 long login_name_max
;
1419 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1420 if (login_name_max
< 0) {
1421 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1422 ret
= LTTNG_ERR_INVALID
;
1426 /* Receive remaining variable length payload if applicable. */
1427 if (name_len
> login_name_max
) {
1429 * POSIX mandates user and group names that are at least
1430 * 8 characters long. Note that although shadow-utils
1431 * (useradd, groupaadd, etc.) use 32 chars as their
1432 * limit (from bits/utmp.h, UT_NAMESIZE),
1433 * LOGIN_NAME_MAX is defined to 256.
1435 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1436 add_value
? "addition" : "removal",
1437 name_len
, login_name_max
);
1438 ret
= LTTNG_ERR_INVALID
;
1442 lttng_dynamic_buffer_init(&payload
);
1443 if (name_len
!= 0) {
1445 * Receive variable payload for user/group name
1448 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1450 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1451 add_value
? "add" : "remove");
1452 ret
= LTTNG_ERR_NOMEM
;
1453 goto error_add_remove_tracker_value
;
1456 ret
= lttcomm_recv_unix_sock(
1457 *sock
, payload
.data
, name_len
);
1459 ERR("Failed to receive payload of %s process attribute tracker value argument",
1460 add_value
? "add" : "remove");
1462 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1463 goto error_add_remove_tracker_value
;
1467 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1468 &payload
, 0, name_len
);
1469 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1470 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1471 goto error_add_remove_tracker_value
;
1475 * Validate the value type and domains are legal for the process
1476 * attribute tracker that is specified and convert the value to
1477 * add/remove to the internal sessiond representation.
1479 ret_code
= process_attr_value_from_comm(domain_type
,
1480 process_attr
, value_type
,
1481 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1483 &payload_view
, &value
);
1484 if (ret_code
!= LTTNG_OK
) {
1486 goto error_add_remove_tracker_value
;
1490 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1491 cmd_ctx
->session
, domain_type
,
1492 process_attr
, value
);
1494 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1495 cmd_ctx
->session
, domain_type
,
1496 process_attr
, value
);
1498 process_attr_value_destroy(value
);
1499 error_add_remove_tracker_value
:
1500 lttng_dynamic_buffer_reset(&payload
);
1503 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1505 enum lttng_tracking_policy tracking_policy
;
1506 const enum lttng_domain_type domain_type
=
1507 (enum lttng_domain_type
)
1508 cmd_ctx
->lsm
.domain
.type
;
1509 const enum lttng_process_attr process_attr
=
1510 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1511 .process_attr_tracker_get_tracking_policy
1514 ret
= cmd_process_attr_tracker_get_tracking_policy(
1515 cmd_ctx
->session
, domain_type
, process_attr
,
1517 if (ret
!= LTTNG_OK
) {
1521 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1522 &(uint32_t){tracking_policy
}, sizeof(uint32_t));
1524 ret
= LTTNG_ERR_NOMEM
;
1530 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1532 const enum lttng_tracking_policy tracking_policy
=
1533 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1534 .process_attr_tracker_set_tracking_policy
1536 const enum lttng_domain_type domain_type
=
1537 (enum lttng_domain_type
)
1538 cmd_ctx
->lsm
.domain
.type
;
1539 const enum lttng_process_attr process_attr
=
1540 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1541 .process_attr_tracker_set_tracking_policy
1544 ret
= cmd_process_attr_tracker_set_tracking_policy(
1545 cmd_ctx
->session
, domain_type
, process_attr
,
1547 if (ret
!= LTTNG_OK
) {
1552 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1554 struct lttng_process_attr_values
*values
;
1555 struct lttng_dynamic_buffer reply
;
1556 const enum lttng_domain_type domain_type
=
1557 (enum lttng_domain_type
)
1558 cmd_ctx
->lsm
.domain
.type
;
1559 const enum lttng_process_attr process_attr
=
1560 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1561 .process_attr_tracker_get_inclusion_set
1564 ret
= cmd_process_attr_tracker_get_inclusion_set(
1565 cmd_ctx
->session
, domain_type
, process_attr
,
1567 if (ret
!= LTTNG_OK
) {
1571 lttng_dynamic_buffer_init(&reply
);
1572 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1574 goto error_tracker_get_inclusion_set
;
1577 ret
= setup_lttng_msg_no_cmd_header(
1578 cmd_ctx
, reply
.data
, reply
.size
);
1580 ret
= LTTNG_ERR_NOMEM
;
1581 goto error_tracker_get_inclusion_set
;
1585 error_tracker_get_inclusion_set
:
1586 lttng_process_attr_values_destroy(values
);
1587 lttng_dynamic_buffer_reset(&reply
);
1590 case LTTNG_ENABLE_EVENT
:
1591 case LTTNG_DISABLE_EVENT
:
1593 struct lttng_event
*event
;
1594 char *filter_expression
;
1595 struct lttng_event_exclusion
*exclusions
;
1596 struct lttng_bytecode
*bytecode
;
1597 const enum lttng_error_code ret_code
= receive_lttng_event(
1598 cmd_ctx
, *sock
, sock_error
, &event
,
1599 &filter_expression
, &bytecode
, &exclusions
);
1601 if (ret_code
!= LTTNG_OK
) {
1602 ret
= (int) ret_code
;
1607 * Ownership of filter_expression, exclusions, and bytecode is
1608 * always transferred.
1610 ret
= cmd_ctx
->lsm
.cmd_type
== LTTNG_ENABLE_EVENT
?
1611 cmd_enable_event(cmd_ctx
, event
,
1612 filter_expression
, exclusions
,
1614 the_kernel_poll_pipe
[1]) :
1615 cmd_disable_event(cmd_ctx
, event
,
1616 filter_expression
, bytecode
,
1618 lttng_event_destroy(event
);
1621 case LTTNG_LIST_TRACEPOINTS
:
1623 enum lttng_error_code ret_code
;
1624 size_t original_payload_size
;
1625 size_t payload_size
;
1626 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1628 ret
= setup_empty_lttng_msg(cmd_ctx
);
1630 ret
= LTTNG_ERR_NOMEM
;
1634 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1636 session_lock_list();
1637 ret_code
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
,
1638 &cmd_ctx
->reply_payload
);
1639 session_unlock_list();
1640 if (ret_code
!= LTTNG_OK
) {
1641 ret
= (int) ret_code
;
1645 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1646 command_header_size
- original_payload_size
;
1647 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1652 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1654 struct lttng_event_field
*fields
;
1657 session_lock_list();
1658 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1660 session_unlock_list();
1661 if (nb_fields
< 0) {
1662 /* Return value is a negative lttng_error_code. */
1668 * Setup lttng message with payload size set to the event list size in
1669 * bytes and then copy list into the llm payload.
1671 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
1672 sizeof(struct lttng_event_field
) * nb_fields
);
1682 case LTTNG_LIST_SYSCALLS
:
1684 enum lttng_error_code ret_code
;
1685 size_t original_payload_size
;
1686 size_t payload_size
;
1687 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1689 ret
= setup_empty_lttng_msg(cmd_ctx
);
1691 ret
= LTTNG_ERR_NOMEM
;
1695 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1697 ret_code
= cmd_list_syscalls(&cmd_ctx
->reply_payload
);
1698 if (ret_code
!= LTTNG_OK
) {
1699 ret
= (int) ret_code
;
1703 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1704 command_header_size
- original_payload_size
;
1705 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1710 case LTTNG_SET_CONSUMER_URI
:
1713 struct lttng_uri
*uris
;
1715 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1716 len
= nb_uri
* sizeof(struct lttng_uri
);
1719 ret
= LTTNG_ERR_INVALID
;
1723 uris
= zmalloc(len
);
1725 ret
= LTTNG_ERR_FATAL
;
1729 /* Receive variable len data */
1730 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1731 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1733 DBG("No URIs received from client... continuing");
1735 ret
= LTTNG_ERR_SESSION_FAIL
;
1740 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1742 if (ret
!= LTTNG_OK
) {
1749 case LTTNG_START_TRACE
:
1752 * On the first start, if we have a kernel session and we have
1753 * enabled time or size-based rotations, we have to make sure
1754 * the kernel tracer supports it.
1756 if (!cmd_ctx
->session
->has_been_started
&& \
1757 cmd_ctx
->session
->kernel_session
&& \
1758 (cmd_ctx
->session
->rotate_timer_period
|| \
1759 cmd_ctx
->session
->rotate_size
) && \
1760 !check_rotate_compatible()) {
1761 DBG("Kernel tracer version is not compatible with the rotation feature");
1762 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1765 ret
= cmd_start_trace(cmd_ctx
->session
);
1768 case LTTNG_STOP_TRACE
:
1770 ret
= cmd_stop_trace(cmd_ctx
->session
);
1773 case LTTNG_DESTROY_SESSION
:
1775 ret
= cmd_destroy_session(cmd_ctx
->session
,
1776 the_notification_thread_handle
, sock
);
1779 case LTTNG_LIST_DOMAINS
:
1782 struct lttng_domain
*domains
= NULL
;
1784 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1786 /* Return value is a negative lttng_error_code. */
1791 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1792 nb_dom
* sizeof(struct lttng_domain
));
1802 case LTTNG_LIST_CHANNELS
:
1804 enum lttng_error_code ret_code
;
1805 size_t original_payload_size
;
1806 size_t payload_size
;
1807 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1809 ret
= setup_empty_lttng_msg(cmd_ctx
);
1811 ret
= LTTNG_ERR_NOMEM
;
1815 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1817 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1818 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1819 if (ret_code
!= LTTNG_OK
) {
1820 ret
= (int) ret_code
;
1824 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1825 command_header_size
- original_payload_size
;
1826 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1831 case LTTNG_LIST_EVENTS
:
1833 enum lttng_error_code ret_code
;
1834 size_t original_payload_size
;
1835 size_t payload_size
;
1836 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1838 ret
= setup_empty_lttng_msg(cmd_ctx
);
1840 ret
= LTTNG_ERR_NOMEM
;
1844 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1846 ret_code
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1848 cmd_ctx
->lsm
.u
.list
.channel_name
, &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_SESSIONS
:
1863 unsigned int nr_sessions
;
1864 void *sessions_payload
;
1867 session_lock_list();
1868 nr_sessions
= lttng_sessions_count(
1869 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1870 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1872 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1873 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1874 sessions_payload
= zmalloc(payload_len
);
1876 if (!sessions_payload
) {
1877 session_unlock_list();
1882 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1883 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1884 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1885 session_unlock_list();
1887 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
1889 free(sessions_payload
);
1898 case LTTNG_REGISTER_CONSUMER
:
1900 struct consumer_data
*cdata
;
1902 switch (cmd_ctx
->lsm
.domain
.type
) {
1903 case LTTNG_DOMAIN_KERNEL
:
1904 cdata
= &the_kconsumer_data
;
1907 ret
= LTTNG_ERR_UND
;
1911 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1912 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1915 case LTTNG_DATA_PENDING
:
1918 uint8_t pending_ret_byte
;
1920 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1925 * This function may returns 0 or 1 to indicate whether or not
1926 * there is data pending. In case of error, it should return an
1927 * LTTNG_ERR code. However, some code paths may still return
1928 * a nondescript error code, which we handle by returning an
1931 if (pending_ret
== 0 || pending_ret
== 1) {
1933 * ret will be set to LTTNG_OK at the end of
1936 } else if (pending_ret
< 0) {
1937 ret
= LTTNG_ERR_UNK
;
1944 pending_ret_byte
= (uint8_t) pending_ret
;
1946 /* 1 byte to return whether or not data is pending */
1947 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1948 &pending_ret_byte
, 1);
1957 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
1959 uint32_t snapshot_id
;
1960 struct lttcomm_lttng_output_id reply
;
1962 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
1963 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
),
1965 if (ret
!= LTTNG_OK
) {
1968 reply
.id
= snapshot_id
;
1970 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
1976 /* Copy output list into message payload */
1980 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
1982 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
1983 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
));
1986 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
1989 struct lttng_snapshot_output
*outputs
= NULL
;
1991 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
1992 if (nb_output
< 0) {
1997 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
1998 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
1999 nb_output
* sizeof(struct lttng_snapshot_output
));
2009 case LTTNG_SNAPSHOT_RECORD
:
2011 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2012 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_record
.output
),
2013 cmd_ctx
->lsm
.u
.snapshot_record
.wait
);
2016 case LTTNG_CREATE_SESSION_EXT
:
2018 struct lttng_dynamic_buffer payload
;
2019 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2021 lttng_dynamic_buffer_init(&payload
);
2022 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2023 if (ret
!= LTTNG_OK
) {
2027 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2030 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2031 lttng_session_descriptor_destroy(return_descriptor
);
2032 ret
= LTTNG_ERR_NOMEM
;
2035 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2038 lttng_session_descriptor_destroy(return_descriptor
);
2039 ret
= LTTNG_ERR_NOMEM
;
2042 lttng_dynamic_buffer_reset(&payload
);
2043 lttng_session_descriptor_destroy(return_descriptor
);
2047 case LTTNG_SAVE_SESSION
:
2049 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2053 case LTTNG_SET_SESSION_SHM_PATH
:
2055 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2056 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2059 case LTTNG_REGENERATE_METADATA
:
2061 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2064 case LTTNG_REGENERATE_STATEDUMP
:
2066 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2069 case LTTNG_REGISTER_TRIGGER
:
2071 struct lttng_trigger
*payload_trigger
;
2072 struct lttng_trigger
*return_trigger
;
2073 size_t original_reply_payload_size
;
2074 size_t reply_payload_size
;
2075 const struct lttng_credentials cmd_creds
= {
2076 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2077 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2080 ret
= setup_empty_lttng_msg(cmd_ctx
);
2082 ret
= LTTNG_ERR_NOMEM
;
2086 ret
= receive_lttng_trigger(
2087 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2088 if (ret
!= LTTNG_OK
) {
2092 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2094 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2095 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2096 the_notification_thread_handle
,
2098 if (ret
!= LTTNG_OK
) {
2099 lttng_trigger_put(payload_trigger
);
2103 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2104 lttng_trigger_put(payload_trigger
);
2105 lttng_trigger_put(return_trigger
);
2107 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2108 ret
= LTTNG_ERR_NOMEM
;
2112 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2113 original_reply_payload_size
;
2115 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2120 case LTTNG_UNREGISTER_TRIGGER
:
2122 struct lttng_trigger
*payload_trigger
;
2123 const struct lttng_credentials cmd_creds
= {
2124 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2125 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2128 ret
= receive_lttng_trigger(
2129 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2130 if (ret
!= LTTNG_OK
) {
2134 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2135 the_notification_thread_handle
);
2136 lttng_trigger_put(payload_trigger
);
2139 case LTTNG_ROTATE_SESSION
:
2141 struct lttng_rotate_session_return rotate_return
;
2143 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2145 memset(&rotate_return
, 0, sizeof(rotate_return
));
2146 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2147 DBG("Kernel tracer version is not compatible with the rotation feature");
2148 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2152 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2154 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2160 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2161 sizeof(rotate_return
));
2170 case LTTNG_ROTATION_GET_INFO
:
2172 struct lttng_rotation_get_info_return get_info_return
;
2174 memset(&get_info_return
, 0, sizeof(get_info_return
));
2175 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2176 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2182 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2183 sizeof(get_info_return
));
2192 case LTTNG_ROTATION_SET_SCHEDULE
:
2195 enum lttng_rotation_schedule_type schedule_type
;
2198 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2199 DBG("Kernel tracer version does not support session rotations");
2200 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2204 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2205 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2206 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2208 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2209 schedule_type
, value
,
2210 the_notification_thread_handle
);
2211 if (ret
!= LTTNG_OK
) {
2217 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2219 struct lttng_session_list_schedules_return schedules
= {
2220 .periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
,
2221 .periodic
.value
= cmd_ctx
->session
->rotate_timer_period
,
2222 .size
.set
= !!cmd_ctx
->session
->rotate_size
,
2223 .size
.value
= cmd_ctx
->session
->rotate_size
,
2226 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2236 case LTTNG_CLEAR_SESSION
:
2238 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2241 case LTTNG_LIST_TRIGGERS
:
2243 struct lttng_triggers
*return_triggers
= NULL
;
2244 size_t original_payload_size
;
2245 size_t payload_size
;
2247 ret
= setup_empty_lttng_msg(cmd_ctx
);
2249 ret
= LTTNG_ERR_NOMEM
;
2253 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2255 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2257 if (ret
!= LTTNG_OK
) {
2261 assert(return_triggers
);
2262 ret
= lttng_triggers_serialize(
2263 return_triggers
, &cmd_ctx
->reply_payload
);
2264 lttng_triggers_destroy(return_triggers
);
2266 ERR("Failed to serialize triggers in reply to `list triggers` command");
2267 ret
= LTTNG_ERR_NOMEM
;
2271 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2272 original_payload_size
;
2274 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2279 case LTTNG_EXECUTE_ERROR_QUERY
:
2281 struct lttng_error_query
*query
;
2282 const struct lttng_credentials cmd_creds
= {
2283 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2284 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2286 struct lttng_error_query_results
*results
= NULL
;
2287 size_t original_payload_size
;
2288 size_t payload_size
;
2290 ret
= setup_empty_lttng_msg(cmd_ctx
);
2292 ret
= LTTNG_ERR_NOMEM
;
2296 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2298 ret
= receive_lttng_error_query(
2299 cmd_ctx
, *sock
, sock_error
, &query
);
2300 if (ret
!= LTTNG_OK
) {
2304 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2305 the_notification_thread_handle
);
2306 lttng_error_query_destroy(query
);
2307 if (ret
!= LTTNG_OK
) {
2312 ret
= lttng_error_query_results_serialize(
2313 results
, &cmd_ctx
->reply_payload
);
2314 lttng_error_query_results_destroy(results
);
2316 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2317 ret
= LTTNG_ERR_NOMEM
;
2321 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2322 original_payload_size
;
2324 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2331 ret
= LTTNG_ERR_UND
;
2336 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2337 DBG("Missing llm header, creating one.");
2338 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2342 /* Set return code */
2343 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2345 if (cmd_ctx
->session
) {
2346 session_unlock(cmd_ctx
->session
);
2347 session_put(cmd_ctx
->session
);
2348 cmd_ctx
->session
= NULL
;
2350 if (need_tracing_session
) {
2351 session_unlock_list();
2354 assert(!rcu_read_ongoing());
2358 static int create_client_sock(void)
2360 int ret
, client_sock
;
2361 const mode_t old_umask
= umask(0);
2363 /* Create client tool unix socket */
2364 client_sock
= lttcomm_create_unix_sock(
2365 the_config
.client_unix_sock_path
.value
);
2366 if (client_sock
< 0) {
2367 ERR("Create unix sock failed: %s",
2368 the_config
.client_unix_sock_path
.value
);
2373 /* Set the cloexec flag */
2374 ret
= utils_set_fd_cloexec(client_sock
);
2376 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2377 "Continuing but note that the consumer daemon will have a "
2378 "reference to this socket on exec()", client_sock
);
2381 /* File permission MUST be 660 */
2382 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2383 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2385 ERR("Set file permissions failed: %s",
2386 the_config
.client_unix_sock_path
.value
);
2388 (void) lttcomm_close_unix_sock(client_sock
);
2392 DBG("Created client socket (fd = %i)", client_sock
);
2399 static void cleanup_client_thread(void *data
)
2401 struct lttng_pipe
*quit_pipe
= data
;
2403 lttng_pipe_destroy(quit_pipe
);
2406 static void thread_init_cleanup(void *data
)
2408 set_thread_status(false);
2412 * This thread manage all clients request using the unix client socket for
2415 static void *thread_manage_clients(void *data
)
2417 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2419 uint32_t revents
, nb_fd
;
2420 struct lttng_poll_event events
;
2421 const int client_sock
= thread_state
.client_sock
;
2422 struct lttng_pipe
*quit_pipe
= data
;
2423 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2424 struct command_ctx cmd_ctx
= {};
2426 DBG("[thread] Manage client started");
2428 lttng_payload_init(&cmd_ctx
.reply_payload
);
2430 is_root
= (getuid() == 0);
2432 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2434 rcu_register_thread();
2436 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2438 health_code_update();
2440 ret
= lttcomm_listen_unix_sock(client_sock
);
2446 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2447 * more will be added to this poll set.
2449 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2451 goto error_create_poll
;
2454 /* Add the application registration socket */
2455 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2460 /* Add thread quit pipe */
2461 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2466 /* Set state as running. */
2467 set_thread_status(true);
2468 pthread_cleanup_pop(0);
2470 /* This testpoint is after we signal readiness to the parent. */
2471 if (testpoint(sessiond_thread_manage_clients
)) {
2475 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2479 health_code_update();
2482 const struct cmd_completion_handler
*cmd_completion_handler
;
2484 cmd_ctx
.creds
= (lttng_sock_cred
) {
2488 cmd_ctx
.session
= NULL
;
2489 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2490 cmd_ctx
.lttng_msg_size
= 0;
2492 DBG("Accepting client command ...");
2494 /* Inifinite blocking call, waiting for transmission */
2496 health_poll_entry();
2497 ret
= lttng_poll_wait(&events
, -1);
2501 * Restart interrupted system call.
2503 if (errno
== EINTR
) {
2511 for (i
= 0; i
< nb_fd
; i
++) {
2512 revents
= LTTNG_POLL_GETEV(&events
, i
);
2513 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2515 health_code_update();
2517 if (pollfd
== thread_quit_pipe_fd
) {
2521 /* Event on the registration socket */
2522 if (revents
& LPOLLIN
) {
2524 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2525 ERR("Client socket poll error");
2528 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2534 DBG("Wait for client response");
2536 health_code_update();
2538 sock
= lttcomm_accept_unix_sock(client_sock
);
2544 * Set the CLOEXEC flag. Return code is useless because either way, the
2547 (void) utils_set_fd_cloexec(sock
);
2549 /* Set socket option for credentials retrieval */
2550 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2555 health_code_update();
2558 * Data is received from the lttng client. The struct
2559 * lttcomm_session_msg (lsm) contains the command and data request of
2562 DBG("Receiving data from client ...");
2563 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2564 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2565 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2566 DBG("Incomplete recv() from client... continuing");
2575 health_code_update();
2577 // TODO: Validate cmd_ctx including sanity check for
2578 // security purpose.
2580 rcu_thread_online();
2582 * This function dispatch the work to the kernel or userspace tracer
2583 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2584 * informations for the client. The command context struct contains
2585 * everything this function may needs.
2587 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2588 rcu_thread_offline();
2598 * TODO: Inform client somehow of the fatal error. At
2599 * this point, ret < 0 means that a zmalloc failed
2600 * (ENOMEM). Error detected but still accept
2601 * command, unless a socket error has been
2607 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2608 WARN("Command returned an invalid status code, returning unknown error: "
2609 "command type = %s (%d), ret = %d",
2610 lttcomm_sessiond_command_str(cmd_ctx
.lsm
.cmd_type
),
2611 cmd_ctx
.lsm
.cmd_type
, ret
);
2612 ret
= LTTNG_ERR_UNK
;
2615 cmd_completion_handler
= cmd_pop_completion_handler();
2616 if (cmd_completion_handler
) {
2617 enum lttng_error_code completion_code
;
2619 completion_code
= cmd_completion_handler
->run(
2620 cmd_completion_handler
->data
);
2621 if (completion_code
!= LTTNG_OK
) {
2626 health_code_update();
2629 struct lttng_payload_view view
=
2630 lttng_payload_view_from_payload(
2631 &cmd_ctx
.reply_payload
,
2633 struct lttcomm_lttng_msg
*llm
= (typeof(
2634 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2636 assert(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2637 assert(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2639 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2641 DBG("Sending response (size: %d, retcode: %s (%d))",
2642 cmd_ctx
.lttng_msg_size
,
2643 lttng_strerror(-llm
->ret_code
),
2645 ret
= send_unix_sock(sock
, &view
);
2647 ERR("Failed to send data back to client");
2650 /* End of transmission */
2658 health_code_update();
2670 lttng_poll_clean(&events
);
2674 unlink(the_config
.client_unix_sock_path
.value
);
2675 ret
= close(client_sock
);
2682 ERR("Health error occurred in %s", __func__
);
2685 health_unregister(the_health_sessiond
);
2687 DBG("Client thread dying");
2688 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2689 rcu_unregister_thread();
2694 bool shutdown_client_thread(void *thread_data
)
2696 struct lttng_pipe
*client_quit_pipe
= thread_data
;
2697 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2699 return notify_thread_pipe(write_fd
) == 1;
2702 struct lttng_thread
*launch_client_thread(void)
2704 bool thread_running
;
2705 struct lttng_pipe
*client_quit_pipe
;
2706 struct lttng_thread
*thread
= NULL
;
2707 int client_sock_fd
= -1;
2709 sem_init(&thread_state
.ready
, 0, 0);
2710 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2711 if (!client_quit_pipe
) {
2715 client_sock_fd
= create_client_sock();
2716 if (client_sock_fd
< 0) {
2720 thread_state
.client_sock
= client_sock_fd
;
2721 thread
= lttng_thread_create("Client management",
2722 thread_manage_clients
,
2723 shutdown_client_thread
,
2724 cleanup_client_thread
,
2729 /* The client thread now owns the client sock fd and the quit pipe. */
2730 client_sock_fd
= -1;
2731 client_quit_pipe
= NULL
;
2734 * This thread is part of the threads that need to be fully
2735 * initialized before the session daemon is marked as "ready".
2737 thread_running
= wait_thread_status();
2738 if (!thread_running
) {
2743 if (client_sock_fd
>= 0) {
2744 if (close(client_sock_fd
)) {
2745 PERROR("Failed to close client socket");
2748 lttng_thread_put(thread
);
2749 cleanup_client_thread(client_quit_pipe
);