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>
35 #include "agent-thread.h"
39 #include "health-sessiond.h"
41 #include "lttng-sessiond.h"
42 #include "manage-consumer.h"
44 #include "testpoint.h"
49 static struct thread_state
{
55 static void set_thread_status(bool running
)
57 DBG("Marking client thread's state as %s", running
? "running" : "error");
58 thread_state
.running
= running
;
59 sem_post(&thread_state
.ready
);
62 static bool wait_thread_status(void)
64 DBG("Waiting for client thread to be ready");
65 sem_wait(&thread_state
.ready
);
66 if (thread_state
.running
) {
67 DBG("Client thread is ready");
69 ERR("Initialization of client thread failed");
72 return thread_state
.running
;
76 * Setup the outgoing data buffer for the response (llm) by allocating the
77 * right amount of memory and copying the original information from the lsm
80 * Return 0 on success, negative value on error.
82 static int setup_lttng_msg(struct command_ctx
*cmd_ctx
,
83 const void *payload_buf
, size_t payload_len
,
84 const void *cmd_header_buf
, size_t cmd_header_len
)
87 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
88 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
89 lttcomm_lttng_msg llm
{};
91 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
92 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
93 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
94 llm
.data_size
= (uint32_t) payload_len
;
96 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
101 lttng_dynamic_pointer_array_clear(&cmd_ctx
->reply_payload
._fd_handles
);
103 cmd_ctx
->lttng_msg_size
= total_msg_size
;
105 /* Append reply header. */
106 ret
= lttng_dynamic_buffer_append(
107 &cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
112 /* Append command header. */
113 if (cmd_header_len
) {
114 ret
= lttng_dynamic_buffer_append(
115 &cmd_ctx
->reply_payload
.buffer
, cmd_header_buf
,
122 /* Append payload. */
124 ret
= lttng_dynamic_buffer_append(
125 &cmd_ctx
->reply_payload
.buffer
, payload_buf
,
136 static int setup_empty_lttng_msg(struct command_ctx
*cmd_ctx
)
139 const struct lttcomm_lttng_msg llm
= {};
141 ret
= lttng_dynamic_buffer_set_size(&cmd_ctx
->reply_payload
.buffer
, 0);
146 /* Append place-holder reply header. */
147 ret
= lttng_dynamic_buffer_append(
148 &cmd_ctx
->reply_payload
.buffer
, &llm
, sizeof(llm
));
153 cmd_ctx
->lttng_msg_size
= sizeof(llm
);
158 static void update_lttng_msg(struct command_ctx
*cmd_ctx
, size_t cmd_header_len
,
161 const size_t header_len
= sizeof(struct lttcomm_lttng_msg
);
162 const size_t total_msg_size
= header_len
+ cmd_header_len
+ payload_len
;
163 struct lttcomm_lttng_msg
*p_llm
;
164 lttcomm_lttng_msg llm
{};
166 llm
.cmd_type
= cmd_ctx
->lsm
.cmd_type
;
167 llm
.pid
= (uint32_t) cmd_ctx
->lsm
.domain
.attr
.pid
;
168 llm
.cmd_header_size
= (uint32_t) cmd_header_len
;
169 llm
.data_size
= (uint32_t) payload_len
;
171 LTTNG_ASSERT(cmd_ctx
->reply_payload
.buffer
.size
>= sizeof(llm
));
173 p_llm
= (typeof(p_llm
)) cmd_ctx
->reply_payload
.buffer
.data
;
175 /* Update existing header. */
176 memcpy(p_llm
, &llm
, sizeof(llm
));
178 cmd_ctx
->lttng_msg_size
= total_msg_size
;
182 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
183 * exec or it will fail.
185 static int spawn_consumer_thread(struct consumer_data
*consumer_data
)
187 return launch_consumer_management_thread(consumer_data
) ? 0 : -1;
191 * Fork and exec a consumer daemon (consumerd).
193 * Return pid if successful else -1.
195 static pid_t
spawn_consumerd(struct consumer_data
*consumer_data
)
199 const char *consumer_to_use
;
200 const char *verbosity
;
203 DBG("Spawning consumerd");
210 if (the_config
.verbose_consumer
) {
211 verbosity
= "--verbose";
212 } else if (lttng_opt_quiet
) {
213 verbosity
= "--quiet";
218 switch (consumer_data
->type
) {
219 case LTTNG_CONSUMER_KERNEL
:
221 * Find out which consumerd to execute. We will first try the
222 * 64-bit path, then the sessiond's installation directory, and
223 * fallback on the 32-bit one,
225 DBG3("Looking for a kernel consumer at these locations:");
226 DBG3(" 1) %s", the_config
.consumerd64_bin_path
.value
? : "NULL");
227 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
228 DBG3(" 3) %s", the_config
.consumerd32_bin_path
.value
? : "NULL");
229 if (stat(the_config
.consumerd64_bin_path
.value
, &st
) == 0) {
230 DBG3("Found location #1");
231 consumer_to_use
= the_config
.consumerd64_bin_path
.value
;
232 } else if (stat(INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
, &st
) == 0) {
233 DBG3("Found location #2");
234 consumer_to_use
= INSTALL_BIN_PATH
"/" DEFAULT_CONSUMERD_FILE
;
235 } else if (the_config
.consumerd32_bin_path
.value
&&
236 stat(the_config
.consumerd32_bin_path
.value
, &st
) == 0) {
237 DBG3("Found location #3");
238 consumer_to_use
= the_config
.consumerd32_bin_path
.value
;
240 DBG("Could not find any valid consumerd executable");
244 DBG("Using kernel consumer at: %s", consumer_to_use
);
245 (void) execl(consumer_to_use
, "lttng-consumerd",
246 verbosity
, "-k", "--consumerd-cmd-sock",
247 consumer_data
->cmd_unix_sock_path
,
248 "--consumerd-err-sock",
249 consumer_data
->err_unix_sock_path
,
251 the_config
.tracing_group_name
.value
,
254 case LTTNG_CONSUMER64_UST
:
256 if (the_config
.consumerd64_lib_dir
.value
) {
261 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
265 tmplen
= strlen(the_config
.consumerd64_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
266 tmpnew
= (char *) zmalloc(tmplen
+ 1 /* \0 */);
271 strcat(tmpnew
, the_config
.consumerd64_lib_dir
.value
);
272 if (tmp
[0] != '\0') {
276 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
283 DBG("Using 64-bit UST consumer at: %s",
284 the_config
.consumerd64_bin_path
.value
);
285 (void) execl(the_config
.consumerd64_bin_path
.value
,
286 "lttng-consumerd", verbosity
, "-u",
287 "--consumerd-cmd-sock",
288 consumer_data
->cmd_unix_sock_path
,
289 "--consumerd-err-sock",
290 consumer_data
->err_unix_sock_path
,
292 the_config
.tracing_group_name
.value
,
296 case LTTNG_CONSUMER32_UST
:
298 if (the_config
.consumerd32_lib_dir
.value
) {
303 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
307 tmplen
= strlen(the_config
.consumerd32_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
308 tmpnew
= (char *) zmalloc(tmplen
+ 1 /* \0 */);
313 strcat(tmpnew
, the_config
.consumerd32_lib_dir
.value
);
314 if (tmp
[0] != '\0') {
318 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
325 DBG("Using 32-bit UST consumer at: %s",
326 the_config
.consumerd32_bin_path
.value
);
327 (void) execl(the_config
.consumerd32_bin_path
.value
,
328 "lttng-consumerd", verbosity
, "-u",
329 "--consumerd-cmd-sock",
330 consumer_data
->cmd_unix_sock_path
,
331 "--consumerd-err-sock",
332 consumer_data
->err_unix_sock_path
,
334 the_config
.tracing_group_name
.value
,
339 ERR("unknown consumer type");
343 PERROR("Consumer execl()");
345 /* Reaching this point, we got a failure on our execl(). */
347 } else if (pid
> 0) {
350 PERROR("start consumer fork");
358 * Spawn the consumerd daemon and session daemon thread.
360 static int start_consumerd(struct consumer_data
*consumer_data
)
365 * Set the listen() state on the socket since there is a possible race
366 * between the exec() of the consumer daemon and this call if place in the
367 * consumer thread. See bug #366 for more details.
369 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
374 pthread_mutex_lock(&consumer_data
->pid_mutex
);
375 if (consumer_data
->pid
!= 0) {
376 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
380 ret
= spawn_consumerd(consumer_data
);
382 ERR("Spawning consumerd failed");
383 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
387 /* Setting up the consumer_data pid */
388 consumer_data
->pid
= ret
;
389 DBG2("Consumer pid %d", consumer_data
->pid
);
390 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
392 DBG2("Spawning consumer control thread");
393 ret
= spawn_consumer_thread(consumer_data
);
395 ERR("Fatal error spawning consumer control thread");
403 /* Cleanup already created sockets on error. */
404 if (consumer_data
->err_sock
>= 0) {
407 err
= close(consumer_data
->err_sock
);
409 PERROR("close consumer data error socket");
416 * Copy consumer output from the tracing session to the domain session. The
417 * function also applies the right modification on a per domain basis for the
418 * trace files destination directory.
420 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
423 const char *dir_name
;
424 struct consumer_output
*consumer
;
426 LTTNG_ASSERT(session
);
427 LTTNG_ASSERT(session
->consumer
);
430 case LTTNG_DOMAIN_KERNEL
:
431 DBG3("Copying tracing session consumer output in kernel session");
433 * XXX: We should audit the session creation and what this function
434 * does "extra" in order to avoid a destroy since this function is used
435 * in the domain session creation (kernel and ust) only. Same for UST
438 if (session
->kernel_session
->consumer
) {
439 consumer_output_put(session
->kernel_session
->consumer
);
441 session
->kernel_session
->consumer
=
442 consumer_copy_output(session
->consumer
);
443 /* Ease our life a bit for the next part */
444 consumer
= session
->kernel_session
->consumer
;
445 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
447 case LTTNG_DOMAIN_JUL
:
448 case LTTNG_DOMAIN_LOG4J
:
449 case LTTNG_DOMAIN_PYTHON
:
450 case LTTNG_DOMAIN_UST
:
451 DBG3("Copying tracing session consumer output in UST session");
452 if (session
->ust_session
->consumer
) {
453 consumer_output_put(session
->ust_session
->consumer
);
455 session
->ust_session
->consumer
=
456 consumer_copy_output(session
->consumer
);
457 /* Ease our life a bit for the next part */
458 consumer
= session
->ust_session
->consumer
;
459 dir_name
= DEFAULT_UST_TRACE_DIR
;
462 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
466 /* Append correct directory to subdir */
467 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
,
468 sizeof(consumer
->domain_subdir
));
473 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
481 * Create an UST session and add it to the session ust list.
483 static int create_ust_session(struct ltt_session
*session
,
484 const struct lttng_domain
*domain
)
487 struct ltt_ust_session
*lus
= NULL
;
489 LTTNG_ASSERT(session
);
490 LTTNG_ASSERT(domain
);
491 LTTNG_ASSERT(session
->consumer
);
493 switch (domain
->type
) {
494 case LTTNG_DOMAIN_JUL
:
495 case LTTNG_DOMAIN_LOG4J
:
496 case LTTNG_DOMAIN_PYTHON
:
497 case LTTNG_DOMAIN_UST
:
500 ERR("Unknown UST domain on create session %d", domain
->type
);
501 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
505 DBG("Creating UST session");
507 lus
= trace_ust_create_session(session
->id
);
509 ret
= LTTNG_ERR_UST_SESS_FAIL
;
513 lus
->uid
= session
->uid
;
514 lus
->gid
= session
->gid
;
515 lus
->output_traces
= session
->output_traces
;
516 lus
->snapshot_mode
= session
->snapshot_mode
;
517 lus
->live_timer_interval
= session
->live_timer
;
518 session
->ust_session
= lus
;
519 if (session
->shm_path
[0]) {
520 strncpy(lus
->root_shm_path
, session
->shm_path
,
521 sizeof(lus
->root_shm_path
));
522 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
523 strncpy(lus
->shm_path
, session
->shm_path
,
524 sizeof(lus
->shm_path
));
525 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
526 strncat(lus
->shm_path
, "/ust",
527 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
529 /* Copy session output to the newly created UST session */
530 ret
= copy_session_consumer(domain
->type
, session
);
531 if (ret
!= LTTNG_OK
) {
539 session
->ust_session
= NULL
;
544 * Create a kernel tracer session then create the default channel.
546 static int create_kernel_session(struct ltt_session
*session
)
550 DBG("Creating kernel session");
552 ret
= kernel_create_session(session
);
554 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
558 /* Code flow safety */
559 LTTNG_ASSERT(session
->kernel_session
);
561 /* Copy session output to the newly created Kernel session */
562 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
563 if (ret
!= LTTNG_OK
) {
567 session
->kernel_session
->uid
= session
->uid
;
568 session
->kernel_session
->gid
= session
->gid
;
569 session
->kernel_session
->output_traces
= session
->output_traces
;
570 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
571 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
576 trace_kernel_destroy_session(session
->kernel_session
);
577 session
->kernel_session
= NULL
;
583 * Count number of session permitted by uid/gid.
585 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
588 struct ltt_session
*session
;
589 const struct ltt_session_list
*session_list
= session_get_list();
591 DBG("Counting number of available session for UID %d", uid
);
592 cds_list_for_each_entry(session
, &session_list
->head
, list
) {
593 if (!session_get(session
)) {
596 session_lock(session
);
597 /* Only count the sessions the user can control. */
598 if (session_access_ok(session
, uid
) &&
599 !session
->destroyed
) {
602 session_unlock(session
);
603 session_put(session
);
608 static int receive_userspace_probe(struct command_ctx
*cmd_ctx
, int sock
,
609 int *sock_error
, struct lttng_event
*event
)
612 struct lttng_userspace_probe_location
*probe_location
;
613 struct lttng_payload probe_location_payload
;
614 struct fd_handle
*handle
= NULL
;
617 * Create a payload to store the serialized version of the probe
620 lttng_payload_init(&probe_location_payload
);
622 ret
= lttng_dynamic_buffer_set_size(&probe_location_payload
.buffer
,
623 cmd_ctx
->lsm
.u
.enable
.userspace_probe_location_len
);
625 ret
= LTTNG_ERR_NOMEM
;
630 * Receive the probe location.
632 ret
= lttcomm_recv_unix_sock(sock
, probe_location_payload
.buffer
.data
,
633 probe_location_payload
.buffer
.size
);
635 DBG("Nothing recv() from client var len data... continuing");
637 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
642 * Receive the file descriptor to the target binary from the client.
644 DBG("Receiving userspace probe target FD from client ...");
645 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
647 DBG("Nothing recv() from client userspace probe fd... continuing");
649 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
653 handle
= fd_handle_create(fd
);
655 ret
= LTTNG_ERR_NOMEM
;
659 /* Transferred to the handle. */
662 ret
= lttng_payload_push_fd_handle(&probe_location_payload
, handle
);
664 ERR("Failed to add userspace probe file descriptor to payload");
665 ret
= LTTNG_ERR_NOMEM
;
669 fd_handle_put(handle
);
673 struct lttng_payload_view view
= lttng_payload_view_from_payload(
674 &probe_location_payload
, 0, -1);
676 /* Extract the probe location from the serialized version. */
677 ret
= lttng_userspace_probe_location_create_from_payload(
678 &view
, &probe_location
);
681 WARN("Failed to create a userspace probe location from the received buffer");
682 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
686 /* Attach the probe location to the event. */
687 ret
= lttng_event_set_userspace_probe_location(event
, probe_location
);
689 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
696 PERROR("Failed to close userspace probe location binary fd");
700 fd_handle_put(handle
);
701 lttng_payload_reset(&probe_location_payload
);
705 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
708 struct lttng_trigger
**_trigger
)
712 ssize_t sock_recv_len
;
713 enum lttng_error_code ret_code
;
714 struct lttng_payload trigger_payload
;
715 struct lttng_trigger
*trigger
= NULL
;
717 lttng_payload_init(&trigger_payload
);
718 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
719 ret
= lttng_dynamic_buffer_set_size(
720 &trigger_payload
.buffer
, trigger_len
);
722 ret_code
= LTTNG_ERR_NOMEM
;
726 sock_recv_len
= lttcomm_recv_unix_sock(
727 sock
, trigger_payload
.buffer
.data
, trigger_len
);
728 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
729 ERR("Failed to receive trigger in command payload");
731 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
735 /* Receive fds, if any. */
736 if (cmd_ctx
->lsm
.fd_count
> 0) {
737 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
738 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
739 if (sock_recv_len
> 0 &&
740 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
741 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
742 cmd_ctx
->lsm
.fd_count
, (int) ret
);
743 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
746 } else if (sock_recv_len
<= 0) {
747 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
748 cmd_ctx
->lsm
.fd_count
, (int) ret
);
749 ret_code
= LTTNG_ERR_FATAL
;
755 /* Deserialize trigger. */
757 struct lttng_payload_view view
=
758 lttng_payload_view_from_payload(
759 &trigger_payload
, 0, -1);
761 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
763 ERR("Invalid trigger received as part of command payload");
764 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
765 lttng_trigger_put(trigger
);
774 lttng_payload_reset(&trigger_payload
);
778 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
781 struct lttng_error_query
**_query
)
785 ssize_t sock_recv_len
;
786 enum lttng_error_code ret_code
;
787 struct lttng_payload query_payload
;
788 struct lttng_error_query
*query
= NULL
;
790 lttng_payload_init(&query_payload
);
791 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
792 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
794 ret_code
= LTTNG_ERR_NOMEM
;
798 sock_recv_len
= lttcomm_recv_unix_sock(
799 sock
, query_payload
.buffer
.data
, query_len
);
800 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
801 ERR("Failed to receive error query in command payload");
803 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
807 /* Receive fds, if any. */
808 if (cmd_ctx
->lsm
.fd_count
> 0) {
809 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
810 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
811 if (sock_recv_len
> 0 &&
812 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
813 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
814 cmd_ctx
->lsm
.fd_count
, (int) ret
);
815 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
818 } else if (sock_recv_len
<= 0) {
819 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
820 cmd_ctx
->lsm
.fd_count
, (int) ret
);
821 ret_code
= LTTNG_ERR_FATAL
;
827 /* Deserialize error query. */
829 struct lttng_payload_view view
=
830 lttng_payload_view_from_payload(
831 &query_payload
, 0, -1);
833 if (lttng_error_query_create_from_payload(&view
, &query
) !=
835 ERR("Invalid error query received as part of command payload");
836 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
845 lttng_payload_reset(&query_payload
);
850 * Version of setup_lttng_msg() without command header.
852 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
853 void *payload_buf
, size_t payload_len
)
855 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
859 * Check if the current kernel tracer supports the session rotation feature.
860 * Return 1 if it does, 0 otherwise.
862 static int check_rotate_compatible(void)
866 if (the_kernel_tracer_version
.major
!= 2 ||
867 the_kernel_tracer_version
.minor
< 11) {
868 DBG("Kernel tracer version is not compatible with the rotation feature");
876 * Send data on a unix socket using the liblttsessiondcomm API.
878 * Return lttcomm error code.
880 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
883 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
885 /* Check valid length */
886 if (view
->buffer
.size
== 0) {
891 ret
= lttcomm_send_unix_sock(
892 sock
, view
->buffer
.data
, view
->buffer
.size
);
898 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
909 * Process the command requested by the lttng client within the command
910 * context structure. This function make sure that the return structure (llm)
911 * is set and ready for transmission before returning.
913 * Return any error encountered or 0 for success.
915 * "sock" is only used for special-case var. len data.
916 * A command may assume the ownership of the socket, in which case its value
917 * should be set to -1.
919 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
923 bool need_tracing_session
= true;
927 DBG("Processing client command '%s\' (%d)",
928 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
->lsm
.cmd_type
),
929 cmd_ctx
->lsm
.cmd_type
);
933 switch (cmd_ctx
->lsm
.cmd_type
) {
934 case LTTNG_CREATE_SESSION_EXT
:
935 case LTTNG_DESTROY_SESSION
:
936 case LTTNG_LIST_SESSIONS
:
937 case LTTNG_LIST_DOMAINS
:
938 case LTTNG_START_TRACE
:
939 case LTTNG_STOP_TRACE
:
940 case LTTNG_DATA_PENDING
:
941 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
942 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
943 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
944 case LTTNG_SNAPSHOT_RECORD
:
945 case LTTNG_SAVE_SESSION
:
946 case LTTNG_SET_SESSION_SHM_PATH
:
947 case LTTNG_REGENERATE_METADATA
:
948 case LTTNG_REGENERATE_STATEDUMP
:
949 case LTTNG_ROTATE_SESSION
:
950 case LTTNG_ROTATION_GET_INFO
:
951 case LTTNG_ROTATION_SET_SCHEDULE
:
952 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
953 case LTTNG_CLEAR_SESSION
:
954 case LTTNG_LIST_TRIGGERS
:
955 case LTTNG_EXECUTE_ERROR_QUERY
:
962 /* Needs a functioning consumerd? */
963 switch (cmd_ctx
->lsm
.cmd_type
) {
964 case LTTNG_REGISTER_TRIGGER
:
965 case LTTNG_UNREGISTER_TRIGGER
:
966 case LTTNG_EXECUTE_ERROR_QUERY
:
967 need_consumerd
= false;
970 need_consumerd
= true;
974 if (the_config
.no_kernel
&& need_domain
&&
975 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
977 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
979 ret
= LTTNG_ERR_KERN_NA
;
984 /* Deny register consumer if we already have a spawned consumer. */
985 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
986 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
987 if (the_kconsumer_data
.pid
> 0) {
988 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
989 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
992 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
996 * Check for command that don't needs to allocate a returned payload. We do
997 * this here so we don't have to make the call for no payload at each
1000 switch(cmd_ctx
->lsm
.cmd_type
) {
1001 case LTTNG_LIST_SESSIONS
:
1002 case LTTNG_LIST_TRACEPOINTS
:
1003 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1004 case LTTNG_LIST_DOMAINS
:
1005 case LTTNG_LIST_CHANNELS
:
1006 case LTTNG_LIST_EVENTS
:
1007 case LTTNG_LIST_SYSCALLS
:
1008 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1009 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1010 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1011 case LTTNG_DATA_PENDING
:
1012 case LTTNG_ROTATE_SESSION
:
1013 case LTTNG_ROTATION_GET_INFO
:
1014 case LTTNG_REGISTER_TRIGGER
:
1015 case LTTNG_LIST_TRIGGERS
:
1016 case LTTNG_EXECUTE_ERROR_QUERY
:
1019 /* Setup lttng message with no payload */
1020 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1022 /* This label does not try to unlock the session */
1023 goto init_setup_error
;
1027 /* Commands that DO NOT need a session. */
1028 switch (cmd_ctx
->lsm
.cmd_type
) {
1029 case LTTNG_CREATE_SESSION_EXT
:
1030 case LTTNG_LIST_SESSIONS
:
1031 case LTTNG_LIST_TRACEPOINTS
:
1032 case LTTNG_LIST_SYSCALLS
:
1033 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1034 case LTTNG_SAVE_SESSION
:
1035 case LTTNG_REGISTER_TRIGGER
:
1036 case LTTNG_UNREGISTER_TRIGGER
:
1037 case LTTNG_LIST_TRIGGERS
:
1038 case LTTNG_EXECUTE_ERROR_QUERY
:
1039 need_tracing_session
= false;
1042 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1044 * We keep the session list lock across _all_ commands
1045 * for now, because the per-session lock does not
1046 * handle teardown properly.
1048 session_lock_list();
1049 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1050 if (cmd_ctx
->session
== NULL
) {
1051 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1054 /* Acquire lock for the session */
1055 session_lock(cmd_ctx
->session
);
1061 * Commands that need a valid session but should NOT create one if none
1062 * exists. Instead of creating one and destroying it when the command is
1063 * handled, process that right before so we save some round trip in useless
1066 switch (cmd_ctx
->lsm
.cmd_type
) {
1067 case LTTNG_DISABLE_CHANNEL
:
1068 case LTTNG_DISABLE_EVENT
:
1069 switch (cmd_ctx
->lsm
.domain
.type
) {
1070 case LTTNG_DOMAIN_KERNEL
:
1071 if (!cmd_ctx
->session
->kernel_session
) {
1072 ret
= LTTNG_ERR_NO_CHANNEL
;
1076 case LTTNG_DOMAIN_JUL
:
1077 case LTTNG_DOMAIN_LOG4J
:
1078 case LTTNG_DOMAIN_PYTHON
:
1079 case LTTNG_DOMAIN_UST
:
1080 if (!cmd_ctx
->session
->ust_session
) {
1081 ret
= LTTNG_ERR_NO_CHANNEL
;
1086 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1098 * Check domain type for specific "pre-action".
1100 switch (cmd_ctx
->lsm
.domain
.type
) {
1101 case LTTNG_DOMAIN_KERNEL
:
1103 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1107 /* Kernel tracer check */
1108 if (!kernel_tracer_is_initialized()) {
1109 /* Basically, load kernel tracer modules */
1110 ret
= init_kernel_tracer();
1116 /* Consumer is in an ERROR state. Report back to client */
1117 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1119 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1123 /* Need a session for kernel command */
1124 if (need_tracing_session
) {
1125 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1126 ret
= create_kernel_session(cmd_ctx
->session
);
1127 if (ret
!= LTTNG_OK
) {
1128 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1133 /* Start the kernel consumer daemon */
1134 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1135 if (the_kconsumer_data
.pid
== 0 &&
1136 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1137 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1138 ret
= start_consumerd(&the_kconsumer_data
);
1140 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1143 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1145 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1149 * The consumer was just spawned so we need to add the socket to
1150 * the consumer output of the session if exist.
1152 ret
= consumer_create_socket(&the_kconsumer_data
,
1153 cmd_ctx
->session
->kernel_session
->consumer
);
1160 case LTTNG_DOMAIN_JUL
:
1161 case LTTNG_DOMAIN_LOG4J
:
1162 case LTTNG_DOMAIN_PYTHON
:
1163 if (!agent_tracing_is_enabled()) {
1164 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1168 case LTTNG_DOMAIN_UST
:
1170 if (!ust_app_supported()) {
1171 ret
= LTTNG_ERR_NO_UST
;
1175 /* Consumer is in an ERROR state. Report back to client */
1176 if (need_consumerd
&&
1177 uatomic_read(&the_ust_consumerd_state
) ==
1179 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1183 if (need_tracing_session
) {
1184 /* Create UST session if none exist. */
1185 if (cmd_ctx
->session
->ust_session
== NULL
) {
1186 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1187 ret
= create_ust_session(cmd_ctx
->session
, &domain
);
1188 if (ret
!= LTTNG_OK
) {
1193 /* Start the UST consumer daemons */
1195 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1196 if (the_config
.consumerd64_bin_path
.value
&&
1197 the_ustconsumer64_data
.pid
== 0 &&
1198 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1199 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1200 ret
= start_consumerd(&the_ustconsumer64_data
);
1202 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1203 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1207 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1208 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1210 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1214 * Setup socket for consumer 64 bit. No need for atomic access
1215 * since it was set above and can ONLY be set in this thread.
1217 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1218 cmd_ctx
->session
->ust_session
->consumer
);
1224 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1225 if (the_config
.consumerd32_bin_path
.value
&&
1226 the_ustconsumer32_data
.pid
== 0 &&
1227 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1228 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1229 ret
= start_consumerd(&the_ustconsumer32_data
);
1231 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1232 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1236 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1237 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1239 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1243 * Setup socket for consumer 32 bit. No need for atomic access
1244 * since it was set above and can ONLY be set in this thread.
1246 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1247 cmd_ctx
->session
->ust_session
->consumer
);
1259 /* Validate consumer daemon state when start/stop trace command */
1260 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1261 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1262 switch (cmd_ctx
->lsm
.domain
.type
) {
1263 case LTTNG_DOMAIN_NONE
:
1265 case LTTNG_DOMAIN_JUL
:
1266 case LTTNG_DOMAIN_LOG4J
:
1267 case LTTNG_DOMAIN_PYTHON
:
1268 case LTTNG_DOMAIN_UST
:
1269 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1270 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1274 case LTTNG_DOMAIN_KERNEL
:
1275 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1276 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1281 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1287 * Check that the UID matches that of the tracing session.
1288 * The root user can interact with all sessions.
1290 if (need_tracing_session
) {
1291 if (!session_access_ok(cmd_ctx
->session
,
1292 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1293 cmd_ctx
->session
->destroyed
) {
1294 ret
= LTTNG_ERR_EPERM
;
1300 * Send relayd information to consumer as soon as we have a domain and a
1303 if (cmd_ctx
->session
&& need_domain
) {
1305 * Setup relayd if not done yet. If the relayd information was already
1306 * sent to the consumer, this call will gracefully return.
1308 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1309 if (ret
!= LTTNG_OK
) {
1314 /* Process by command type */
1315 switch (cmd_ctx
->lsm
.cmd_type
) {
1316 case LTTNG_ADD_CONTEXT
:
1318 lttng_event_context ctx
;
1321 * An LTTNG_ADD_CONTEXT command might have a supplementary
1322 * payload if the context being added is an application context.
1324 if (cmd_ctx
->lsm
.u
.context
.ctx
.ctx
==
1325 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1326 char *provider_name
= NULL
, *context_name
= NULL
;
1327 size_t provider_name_len
=
1328 cmd_ctx
->lsm
.u
.context
.provider_name_len
;
1329 size_t context_name_len
=
1330 cmd_ctx
->lsm
.u
.context
.context_name_len
;
1332 if (provider_name_len
== 0 || context_name_len
== 0) {
1334 * Application provider and context names MUST
1337 ret
= -LTTNG_ERR_INVALID
;
1341 provider_name
= (char *) zmalloc(provider_name_len
+ 1);
1342 if (!provider_name
) {
1343 ret
= -LTTNG_ERR_NOMEM
;
1346 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
=
1349 context_name
= (char *) zmalloc(context_name_len
+ 1);
1350 if (!context_name
) {
1351 ret
= -LTTNG_ERR_NOMEM
;
1352 goto error_add_context
;
1354 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
=
1357 ret
= lttcomm_recv_unix_sock(*sock
, provider_name
,
1360 goto error_add_context
;
1363 ret
= lttcomm_recv_unix_sock(*sock
, context_name
,
1366 goto error_add_context
;
1371 * cmd_add_context assumes ownership of the provider and context
1374 ctx
= cmd_ctx
->lsm
.u
.context
.ctx
;
1375 ret
= cmd_add_context(cmd_ctx
->session
,
1376 cmd_ctx
->lsm
.domain
.type
,
1377 cmd_ctx
->lsm
.u
.context
.channel_name
,
1379 the_kernel_poll_pipe
[1]);
1381 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
1382 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
1384 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
);
1385 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
);
1391 case LTTNG_DISABLE_CHANNEL
:
1393 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1394 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1397 case LTTNG_DISABLE_EVENT
:
1402 * FIXME: handle filter; for now we just receive the filter's
1403 * bytecode along with the filter expression which are sent by
1404 * liblttng-ctl and discard them.
1406 * This fixes an issue where the client may block while sending
1407 * the filter payload and encounter an error because the session
1408 * daemon closes the socket without ever handling this data.
1410 size_t count
= cmd_ctx
->lsm
.u
.disable
.expression_len
+
1411 cmd_ctx
->lsm
.u
.disable
.bytecode_len
;
1414 char data
[LTTNG_FILTER_MAX_LEN
];
1416 DBG("Discarding disable event command payload of size %zu", count
);
1418 ret
= lttcomm_recv_unix_sock(*sock
, data
,
1419 count
> sizeof(data
) ? sizeof(data
) : count
);
1424 count
-= (size_t) ret
;
1427 event
= cmd_ctx
->lsm
.u
.disable
.event
;
1428 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1429 cmd_ctx
->lsm
.u
.disable
.channel_name
,
1433 case LTTNG_ENABLE_CHANNEL
:
1435 cmd_ctx
->lsm
.u
.channel
.chan
.attr
.extended
.ptr
=
1436 (struct lttng_channel_extended
*) &cmd_ctx
->lsm
.u
.channel
.extended
;
1437 lttng_domain domain
= cmd_ctx
->lsm
.domain
;
1438 lttng_channel chan
= cmd_ctx
->lsm
.u
.channel
.chan
;
1439 ret
= cmd_enable_channel(cmd_ctx
->session
,
1442 the_kernel_poll_pipe
[1]);
1445 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1446 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1448 struct lttng_dynamic_buffer payload
;
1449 struct lttng_buffer_view payload_view
;
1450 const bool add_value
=
1451 cmd_ctx
->lsm
.cmd_type
==
1452 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1453 const size_t name_len
=
1454 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1456 const enum lttng_domain_type domain_type
=
1457 (enum lttng_domain_type
)
1458 cmd_ctx
->lsm
.domain
.type
;
1459 const enum lttng_process_attr process_attr
=
1460 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1461 .process_attr_tracker_add_remove_include_value
1463 const enum lttng_process_attr_value_type value_type
=
1464 (enum lttng_process_attr_value_type
) cmd_ctx
1466 .process_attr_tracker_add_remove_include_value
1468 struct process_attr_value
*value
;
1469 enum lttng_error_code ret_code
;
1470 long login_name_max
;
1472 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1473 if (login_name_max
< 0) {
1474 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1475 ret
= LTTNG_ERR_INVALID
;
1479 /* Receive remaining variable length payload if applicable. */
1480 if (name_len
> login_name_max
) {
1482 * POSIX mandates user and group names that are at least
1483 * 8 characters long. Note that although shadow-utils
1484 * (useradd, groupaadd, etc.) use 32 chars as their
1485 * limit (from bits/utmp.h, UT_NAMESIZE),
1486 * LOGIN_NAME_MAX is defined to 256.
1488 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1489 add_value
? "addition" : "removal",
1490 name_len
, login_name_max
);
1491 ret
= LTTNG_ERR_INVALID
;
1495 lttng_dynamic_buffer_init(&payload
);
1496 if (name_len
!= 0) {
1498 * Receive variable payload for user/group name
1501 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1503 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1504 add_value
? "add" : "remove");
1505 ret
= LTTNG_ERR_NOMEM
;
1506 goto error_add_remove_tracker_value
;
1509 ret
= lttcomm_recv_unix_sock(
1510 *sock
, payload
.data
, name_len
);
1512 ERR("Failed to receive payload of %s process attribute tracker value argument",
1513 add_value
? "add" : "remove");
1515 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1516 goto error_add_remove_tracker_value
;
1520 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1521 &payload
, 0, name_len
);
1522 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1523 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1524 goto error_add_remove_tracker_value
;
1528 * Validate the value type and domains are legal for the process
1529 * attribute tracker that is specified and convert the value to
1530 * add/remove to the internal sessiond representation.
1532 ret_code
= process_attr_value_from_comm(domain_type
,
1533 process_attr
, value_type
,
1534 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1536 &payload_view
, &value
);
1537 if (ret_code
!= LTTNG_OK
) {
1539 goto error_add_remove_tracker_value
;
1543 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1544 cmd_ctx
->session
, domain_type
,
1545 process_attr
, value
);
1547 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1548 cmd_ctx
->session
, domain_type
,
1549 process_attr
, value
);
1551 process_attr_value_destroy(value
);
1552 error_add_remove_tracker_value
:
1553 lttng_dynamic_buffer_reset(&payload
);
1556 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1558 enum lttng_tracking_policy tracking_policy
;
1559 const enum lttng_domain_type domain_type
=
1560 (enum lttng_domain_type
)
1561 cmd_ctx
->lsm
.domain
.type
;
1562 const enum lttng_process_attr process_attr
=
1563 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1564 .process_attr_tracker_get_tracking_policy
1567 ret
= cmd_process_attr_tracker_get_tracking_policy(
1568 cmd_ctx
->session
, domain_type
, process_attr
,
1570 if (ret
!= LTTNG_OK
) {
1574 uint32_t tracking_policy_u32
= tracking_policy
;
1575 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1576 &tracking_policy_u32
, sizeof(uint32_t));
1578 ret
= LTTNG_ERR_NOMEM
;
1584 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1586 const enum lttng_tracking_policy tracking_policy
=
1587 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1588 .process_attr_tracker_set_tracking_policy
1590 const enum lttng_domain_type domain_type
=
1591 (enum lttng_domain_type
)
1592 cmd_ctx
->lsm
.domain
.type
;
1593 const enum lttng_process_attr process_attr
=
1594 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1595 .process_attr_tracker_set_tracking_policy
1598 ret
= cmd_process_attr_tracker_set_tracking_policy(
1599 cmd_ctx
->session
, domain_type
, process_attr
,
1601 if (ret
!= LTTNG_OK
) {
1606 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1608 struct lttng_process_attr_values
*values
;
1609 struct lttng_dynamic_buffer reply
;
1610 const enum lttng_domain_type domain_type
=
1611 (enum lttng_domain_type
)
1612 cmd_ctx
->lsm
.domain
.type
;
1613 const enum lttng_process_attr process_attr
=
1614 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1615 .process_attr_tracker_get_inclusion_set
1618 ret
= cmd_process_attr_tracker_get_inclusion_set(
1619 cmd_ctx
->session
, domain_type
, process_attr
,
1621 if (ret
!= LTTNG_OK
) {
1625 lttng_dynamic_buffer_init(&reply
);
1626 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1628 goto error_tracker_get_inclusion_set
;
1631 ret
= setup_lttng_msg_no_cmd_header(
1632 cmd_ctx
, reply
.data
, reply
.size
);
1634 ret
= LTTNG_ERR_NOMEM
;
1635 goto error_tracker_get_inclusion_set
;
1639 error_tracker_get_inclusion_set
:
1640 lttng_process_attr_values_destroy(values
);
1641 lttng_dynamic_buffer_reset(&reply
);
1644 case LTTNG_ENABLE_EVENT
:
1646 struct lttng_event
*ev
= NULL
;
1647 struct lttng_event_exclusion
*exclusion
= NULL
;
1648 struct lttng_bytecode
*bytecode
= NULL
;
1649 char *filter_expression
= NULL
;
1651 lttng_domain domain
;
1653 /* Handle exclusion events and receive it from the client. */
1654 if (cmd_ctx
->lsm
.u
.enable
.exclusion_count
> 0) {
1655 size_t count
= cmd_ctx
->lsm
.u
.enable
.exclusion_count
;
1657 exclusion
= (lttng_event_exclusion
*) zmalloc(sizeof(struct lttng_event_exclusion
) +
1658 (count
* LTTNG_SYMBOL_NAME_LEN
));
1660 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
1664 DBG("Receiving var len exclusion event list from client ...");
1665 exclusion
->count
= count
;
1666 ret
= lttcomm_recv_unix_sock(*sock
, exclusion
->names
,
1667 count
* LTTNG_SYMBOL_NAME_LEN
);
1669 DBG("Nothing recv() from client var len data... continuing");
1672 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
1677 /* Get filter expression from client. */
1678 if (cmd_ctx
->lsm
.u
.enable
.expression_len
> 0) {
1679 size_t expression_len
=
1680 cmd_ctx
->lsm
.u
.enable
.expression_len
;
1682 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
1683 ret
= LTTNG_ERR_FILTER_INVAL
;
1688 filter_expression
= (char *) zmalloc(expression_len
);
1689 if (!filter_expression
) {
1691 ret
= LTTNG_ERR_FILTER_NOMEM
;
1695 /* Receive var. len. data */
1696 DBG("Receiving var len filter's expression from client ...");
1697 ret
= lttcomm_recv_unix_sock(*sock
, filter_expression
,
1700 DBG("Nothing recv() from client var len data... continuing");
1702 free(filter_expression
);
1704 ret
= LTTNG_ERR_FILTER_INVAL
;
1709 /* Handle filter and get bytecode from client. */
1710 if (cmd_ctx
->lsm
.u
.enable
.bytecode_len
> 0) {
1711 size_t bytecode_len
= cmd_ctx
->lsm
.u
.enable
.bytecode_len
;
1713 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
1714 ret
= LTTNG_ERR_FILTER_INVAL
;
1715 free(filter_expression
);
1720 bytecode
= (lttng_bytecode
*) zmalloc(bytecode_len
);
1722 free(filter_expression
);
1724 ret
= LTTNG_ERR_FILTER_NOMEM
;
1728 /* Receive var. len. data */
1729 DBG("Receiving var len filter's bytecode from client ...");
1730 ret
= lttcomm_recv_unix_sock(*sock
, bytecode
, bytecode_len
);
1732 DBG("Nothing recv() from client var len data... continuing");
1734 free(filter_expression
);
1737 ret
= LTTNG_ERR_FILTER_INVAL
;
1741 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
1742 free(filter_expression
);
1745 ret
= LTTNG_ERR_FILTER_INVAL
;
1750 event
= cmd_ctx
->lsm
.u
.enable
.event
;
1751 ev
= lttng_event_copy(&event
);
1753 DBG("Failed to copy event: %s",
1754 cmd_ctx
->lsm
.u
.enable
.event
.name
);
1755 free(filter_expression
);
1758 ret
= LTTNG_ERR_NOMEM
;
1763 if (cmd_ctx
->lsm
.u
.enable
.userspace_probe_location_len
> 0) {
1764 /* Expect a userspace probe description. */
1765 ret
= receive_userspace_probe(cmd_ctx
, *sock
, sock_error
, ev
);
1767 free(filter_expression
);
1770 lttng_event_destroy(ev
);
1775 domain
= cmd_ctx
->lsm
.domain
;
1776 ret
= cmd_enable_event(cmd_ctx
->session
,
1778 cmd_ctx
->lsm
.u
.enable
.channel_name
,
1780 filter_expression
, bytecode
, exclusion
,
1781 the_kernel_poll_pipe
[1]);
1782 lttng_event_destroy(ev
);
1785 case LTTNG_LIST_TRACEPOINTS
:
1787 struct lttng_event
*events
;
1790 session_lock_list();
1791 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
, &events
);
1792 session_unlock_list();
1793 if (nb_events
< 0) {
1794 /* Return value is a negative lttng_error_code. */
1800 * Setup lttng message with payload size set to the event list size in
1801 * bytes and then copy list into the llm payload.
1803 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1804 sizeof(struct lttng_event
) * nb_events
);
1814 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1816 struct lttng_event_field
*fields
;
1819 session_lock_list();
1820 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1822 session_unlock_list();
1823 if (nb_fields
< 0) {
1824 /* Return value is a negative lttng_error_code. */
1830 * Setup lttng message with payload size set to the event list size in
1831 * bytes and then copy list into the llm payload.
1833 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
1834 sizeof(struct lttng_event_field
) * nb_fields
);
1844 case LTTNG_LIST_SYSCALLS
:
1846 struct lttng_event
*events
;
1849 nb_events
= cmd_list_syscalls(&events
);
1850 if (nb_events
< 0) {
1851 /* Return value is a negative lttng_error_code. */
1857 * Setup lttng message with payload size set to the event list size in
1858 * bytes and then copy list into the llm payload.
1860 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1861 sizeof(struct lttng_event
) * nb_events
);
1871 case LTTNG_SET_CONSUMER_URI
:
1874 struct lttng_uri
*uris
;
1876 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1877 len
= nb_uri
* sizeof(struct lttng_uri
);
1880 ret
= LTTNG_ERR_INVALID
;
1884 uris
= (lttng_uri
*) zmalloc(len
);
1886 ret
= LTTNG_ERR_FATAL
;
1890 /* Receive variable len data */
1891 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1892 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1894 DBG("No URIs received from client... continuing");
1896 ret
= LTTNG_ERR_SESSION_FAIL
;
1901 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1903 if (ret
!= LTTNG_OK
) {
1910 case LTTNG_START_TRACE
:
1913 * On the first start, if we have a kernel session and we have
1914 * enabled time or size-based rotations, we have to make sure
1915 * the kernel tracer supports it.
1917 if (!cmd_ctx
->session
->has_been_started
&& \
1918 cmd_ctx
->session
->kernel_session
&& \
1919 (cmd_ctx
->session
->rotate_timer_period
|| \
1920 cmd_ctx
->session
->rotate_size
) && \
1921 !check_rotate_compatible()) {
1922 DBG("Kernel tracer version is not compatible with the rotation feature");
1923 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1926 ret
= cmd_start_trace(cmd_ctx
->session
);
1929 case LTTNG_STOP_TRACE
:
1931 ret
= cmd_stop_trace(cmd_ctx
->session
);
1934 case LTTNG_DESTROY_SESSION
:
1936 ret
= cmd_destroy_session(cmd_ctx
->session
,
1937 the_notification_thread_handle
, sock
);
1940 case LTTNG_LIST_DOMAINS
:
1943 struct lttng_domain
*domains
= NULL
;
1945 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1947 /* Return value is a negative lttng_error_code. */
1952 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1953 nb_dom
* sizeof(struct lttng_domain
));
1963 case LTTNG_LIST_CHANNELS
:
1965 ssize_t payload_size
;
1966 struct lttng_channel
*channels
= NULL
;
1968 payload_size
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1969 cmd_ctx
->session
, &channels
);
1970 if (payload_size
< 0) {
1971 /* Return value is a negative lttng_error_code. */
1972 ret
= -payload_size
;
1976 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, channels
,
1987 case LTTNG_LIST_EVENTS
:
1990 struct lttcomm_event_command_header cmd_header
= {};
1991 size_t original_payload_size
;
1992 size_t payload_size
;
1994 ret
= setup_empty_lttng_msg(cmd_ctx
);
1996 ret
= LTTNG_ERR_NOMEM
;
2000 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2002 /* Extended infos are included at the end of the payload. */
2003 list_ret
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
2005 cmd_ctx
->lsm
.u
.list
.channel_name
,
2006 &cmd_ctx
->reply_payload
);
2008 /* Return value is a negative lttng_error_code. */
2013 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2014 sizeof(cmd_header
) - original_payload_size
;
2015 update_lttng_msg(cmd_ctx
, sizeof(cmd_header
), payload_size
);
2020 case LTTNG_LIST_SESSIONS
:
2022 unsigned int nr_sessions
;
2023 lttng_session
*sessions_payload
;
2026 session_lock_list();
2027 nr_sessions
= lttng_sessions_count(
2028 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2029 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
2031 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
2032 (sizeof(struct lttng_session_extended
) * nr_sessions
);
2033 sessions_payload
= (lttng_session
*) zmalloc(payload_len
);
2035 if (!sessions_payload
) {
2036 session_unlock_list();
2041 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
2042 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2043 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
2044 session_unlock_list();
2046 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
2048 free(sessions_payload
);
2057 case LTTNG_REGISTER_CONSUMER
:
2059 struct consumer_data
*cdata
;
2061 switch (cmd_ctx
->lsm
.domain
.type
) {
2062 case LTTNG_DOMAIN_KERNEL
:
2063 cdata
= &the_kconsumer_data
;
2066 ret
= LTTNG_ERR_UND
;
2070 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
2071 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
2074 case LTTNG_DATA_PENDING
:
2077 uint8_t pending_ret_byte
;
2079 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
2084 * This function may returns 0 or 1 to indicate whether or not
2085 * there is data pending. In case of error, it should return an
2086 * LTTNG_ERR code. However, some code paths may still return
2087 * a nondescript error code, which we handle by returning an
2090 if (pending_ret
== 0 || pending_ret
== 1) {
2092 * ret will be set to LTTNG_OK at the end of
2095 } else if (pending_ret
< 0) {
2096 ret
= LTTNG_ERR_UNK
;
2103 pending_ret_byte
= (uint8_t) pending_ret
;
2105 /* 1 byte to return whether or not data is pending */
2106 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
2107 &pending_ret_byte
, 1);
2116 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2118 uint32_t snapshot_id
;
2119 struct lttcomm_lttng_output_id reply
;
2120 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
2122 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
2125 if (ret
!= LTTNG_OK
) {
2128 reply
.id
= snapshot_id
;
2130 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2136 /* Copy output list into message payload */
2140 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2142 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_output
.output
;
2143 ret
= cmd_snapshot_del_output(cmd_ctx
->session
, &output
);
2146 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2149 struct lttng_snapshot_output
*outputs
= NULL
;
2151 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2152 if (nb_output
< 0) {
2157 LTTNG_ASSERT((nb_output
> 0 && outputs
) || nb_output
== 0);
2158 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2159 nb_output
* sizeof(struct lttng_snapshot_output
));
2169 case LTTNG_SNAPSHOT_RECORD
:
2171 lttng_snapshot_output output
= cmd_ctx
->lsm
.u
.snapshot_record
.output
;
2172 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2174 cmd_ctx
->lsm
.u
.snapshot_record
.wait
);
2177 case LTTNG_CREATE_SESSION_EXT
:
2179 struct lttng_dynamic_buffer payload
;
2180 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2182 lttng_dynamic_buffer_init(&payload
);
2183 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2184 if (ret
!= LTTNG_OK
) {
2188 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2191 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2192 lttng_session_descriptor_destroy(return_descriptor
);
2193 ret
= LTTNG_ERR_NOMEM
;
2196 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2199 lttng_session_descriptor_destroy(return_descriptor
);
2200 ret
= LTTNG_ERR_NOMEM
;
2203 lttng_dynamic_buffer_reset(&payload
);
2204 lttng_session_descriptor_destroy(return_descriptor
);
2208 case LTTNG_SAVE_SESSION
:
2210 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2214 case LTTNG_SET_SESSION_SHM_PATH
:
2216 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2217 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2220 case LTTNG_REGENERATE_METADATA
:
2222 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2225 case LTTNG_REGENERATE_STATEDUMP
:
2227 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2230 case LTTNG_REGISTER_TRIGGER
:
2232 struct lttng_trigger
*payload_trigger
;
2233 struct lttng_trigger
*return_trigger
;
2234 size_t original_reply_payload_size
;
2235 size_t reply_payload_size
;
2236 const struct lttng_credentials cmd_creds
= {
2237 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2238 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2241 ret
= setup_empty_lttng_msg(cmd_ctx
);
2243 ret
= LTTNG_ERR_NOMEM
;
2247 ret
= receive_lttng_trigger(
2248 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2249 if (ret
!= LTTNG_OK
) {
2253 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2255 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2256 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2257 the_notification_thread_handle
,
2259 if (ret
!= LTTNG_OK
) {
2260 lttng_trigger_put(payload_trigger
);
2264 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2265 lttng_trigger_put(payload_trigger
);
2266 lttng_trigger_put(return_trigger
);
2268 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2269 ret
= LTTNG_ERR_NOMEM
;
2273 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2274 original_reply_payload_size
;
2276 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2281 case LTTNG_UNREGISTER_TRIGGER
:
2283 struct lttng_trigger
*payload_trigger
;
2284 const struct lttng_credentials cmd_creds
= {
2285 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2286 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2289 ret
= receive_lttng_trigger(
2290 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2291 if (ret
!= LTTNG_OK
) {
2295 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2296 the_notification_thread_handle
);
2297 lttng_trigger_put(payload_trigger
);
2300 case LTTNG_ROTATE_SESSION
:
2302 struct lttng_rotate_session_return rotate_return
;
2304 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2306 memset(&rotate_return
, 0, sizeof(rotate_return
));
2307 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2308 DBG("Kernel tracer version is not compatible with the rotation feature");
2309 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2313 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2315 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2321 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2322 sizeof(rotate_return
));
2331 case LTTNG_ROTATION_GET_INFO
:
2333 struct lttng_rotation_get_info_return get_info_return
;
2335 memset(&get_info_return
, 0, sizeof(get_info_return
));
2336 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2337 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2343 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2344 sizeof(get_info_return
));
2353 case LTTNG_ROTATION_SET_SCHEDULE
:
2356 enum lttng_rotation_schedule_type schedule_type
;
2359 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2360 DBG("Kernel tracer version does not support session rotations");
2361 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2365 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2366 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2367 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2369 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2370 schedule_type
, value
,
2371 the_notification_thread_handle
);
2372 if (ret
!= LTTNG_OK
) {
2378 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2380 lttng_session_list_schedules_return schedules
;
2382 schedules
.periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
;
2383 schedules
.periodic
.value
= cmd_ctx
->session
->rotate_timer_period
;
2384 schedules
.size
.set
= !!cmd_ctx
->session
->rotate_size
;
2385 schedules
.size
.value
= cmd_ctx
->session
->rotate_size
;
2387 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2397 case LTTNG_CLEAR_SESSION
:
2399 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2402 case LTTNG_LIST_TRIGGERS
:
2404 struct lttng_triggers
*return_triggers
= NULL
;
2405 size_t original_payload_size
;
2406 size_t payload_size
;
2408 ret
= setup_empty_lttng_msg(cmd_ctx
);
2410 ret
= LTTNG_ERR_NOMEM
;
2414 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2416 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2418 if (ret
!= LTTNG_OK
) {
2422 LTTNG_ASSERT(return_triggers
);
2423 ret
= lttng_triggers_serialize(
2424 return_triggers
, &cmd_ctx
->reply_payload
);
2425 lttng_triggers_destroy(return_triggers
);
2427 ERR("Failed to serialize triggers in reply to `list triggers` command");
2428 ret
= LTTNG_ERR_NOMEM
;
2432 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2433 original_payload_size
;
2435 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2440 case LTTNG_EXECUTE_ERROR_QUERY
:
2442 struct lttng_error_query
*query
;
2443 const struct lttng_credentials cmd_creds
= {
2444 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2445 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2447 struct lttng_error_query_results
*results
= NULL
;
2448 size_t original_payload_size
;
2449 size_t payload_size
;
2451 ret
= setup_empty_lttng_msg(cmd_ctx
);
2453 ret
= LTTNG_ERR_NOMEM
;
2457 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2459 ret
= receive_lttng_error_query(
2460 cmd_ctx
, *sock
, sock_error
, &query
);
2461 if (ret
!= LTTNG_OK
) {
2465 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2466 the_notification_thread_handle
);
2467 lttng_error_query_destroy(query
);
2468 if (ret
!= LTTNG_OK
) {
2472 LTTNG_ASSERT(results
);
2473 ret
= lttng_error_query_results_serialize(
2474 results
, &cmd_ctx
->reply_payload
);
2475 lttng_error_query_results_destroy(results
);
2477 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2478 ret
= LTTNG_ERR_NOMEM
;
2482 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2483 original_payload_size
;
2485 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2492 ret
= LTTNG_ERR_UND
;
2497 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2498 DBG("Missing llm header, creating one.");
2499 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2503 /* Set return code */
2504 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2506 if (cmd_ctx
->session
) {
2507 session_unlock(cmd_ctx
->session
);
2508 session_put(cmd_ctx
->session
);
2509 cmd_ctx
->session
= NULL
;
2511 if (need_tracing_session
) {
2512 session_unlock_list();
2515 LTTNG_ASSERT(!rcu_read_ongoing());
2519 static int create_client_sock(void)
2521 int ret
, client_sock
;
2522 const mode_t old_umask
= umask(0);
2524 /* Create client tool unix socket */
2525 client_sock
= lttcomm_create_unix_sock(
2526 the_config
.client_unix_sock_path
.value
);
2527 if (client_sock
< 0) {
2528 ERR("Create unix sock failed: %s",
2529 the_config
.client_unix_sock_path
.value
);
2534 /* Set the cloexec flag */
2535 ret
= utils_set_fd_cloexec(client_sock
);
2537 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2538 "Continuing but note that the consumer daemon will have a "
2539 "reference to this socket on exec()", client_sock
);
2542 /* File permission MUST be 660 */
2543 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2544 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2546 ERR("Set file permissions failed: %s",
2547 the_config
.client_unix_sock_path
.value
);
2549 (void) lttcomm_close_unix_sock(client_sock
);
2553 DBG("Created client socket (fd = %i)", client_sock
);
2560 static void cleanup_client_thread(void *data
)
2562 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2564 lttng_pipe_destroy(quit_pipe
);
2567 static void thread_init_cleanup(void *data
)
2569 set_thread_status(false);
2573 * This thread manage all clients request using the unix client socket for
2576 static void *thread_manage_clients(void *data
)
2578 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2580 uint32_t revents
, nb_fd
;
2581 struct lttng_poll_event events
;
2582 const int client_sock
= thread_state
.client_sock
;
2583 struct lttng_pipe
*quit_pipe
= (lttng_pipe
*) data
;
2584 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2585 struct command_ctx cmd_ctx
= {};
2587 DBG("[thread] Manage client started");
2589 lttng_payload_init(&cmd_ctx
.reply_payload
);
2591 is_root
= (getuid() == 0);
2593 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2595 rcu_register_thread();
2597 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2599 health_code_update();
2601 ret
= lttcomm_listen_unix_sock(client_sock
);
2607 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2608 * more will be added to this poll set.
2610 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2612 goto error_create_poll
;
2615 /* Add the application registration socket */
2616 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2621 /* Add thread quit pipe */
2622 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2627 /* Set state as running. */
2628 set_thread_status(true);
2629 pthread_cleanup_pop(0);
2631 /* This testpoint is after we signal readiness to the parent. */
2632 if (testpoint(sessiond_thread_manage_clients
)) {
2636 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2640 health_code_update();
2643 const struct cmd_completion_handler
*cmd_completion_handler
;
2645 cmd_ctx
.creds
.uid
= UINT32_MAX
;
2646 cmd_ctx
.creds
.gid
= UINT32_MAX
;
2647 cmd_ctx
.creds
.pid
= 0;
2648 cmd_ctx
.session
= NULL
;
2649 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2650 cmd_ctx
.lttng_msg_size
= 0;
2652 DBG("Accepting client command ...");
2654 /* Inifinite blocking call, waiting for transmission */
2656 health_poll_entry();
2657 ret
= lttng_poll_wait(&events
, -1);
2661 * Restart interrupted system call.
2663 if (errno
== EINTR
) {
2671 for (i
= 0; i
< nb_fd
; i
++) {
2672 revents
= LTTNG_POLL_GETEV(&events
, i
);
2673 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2675 health_code_update();
2677 if (pollfd
== thread_quit_pipe_fd
) {
2681 /* Event on the registration socket */
2682 if (revents
& LPOLLIN
) {
2684 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2685 ERR("Client socket poll error");
2688 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2694 DBG("Wait for client response");
2696 health_code_update();
2698 sock
= lttcomm_accept_unix_sock(client_sock
);
2704 * Set the CLOEXEC flag. Return code is useless because either way, the
2707 (void) utils_set_fd_cloexec(sock
);
2709 /* Set socket option for credentials retrieval */
2710 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2715 health_code_update();
2718 * Data is received from the lttng client. The struct
2719 * lttcomm_session_msg (lsm) contains the command and data request of
2722 DBG("Receiving data from client ...");
2723 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2724 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2725 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2726 DBG("Incomplete recv() from client... continuing");
2735 health_code_update();
2737 // TODO: Validate cmd_ctx including sanity check for
2738 // security purpose.
2740 rcu_thread_online();
2742 * This function dispatch the work to the kernel or userspace tracer
2743 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2744 * informations for the client. The command context struct contains
2745 * everything this function may needs.
2747 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2748 rcu_thread_offline();
2758 * TODO: Inform client somehow of the fatal error. At
2759 * this point, ret < 0 means that a zmalloc failed
2760 * (ENOMEM). Error detected but still accept
2761 * command, unless a socket error has been
2767 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2768 WARN("Command returned an invalid status code, returning unknown error: "
2769 "command type = %s (%d), ret = %d",
2770 lttcomm_sessiond_command_str((lttcomm_sessiond_command
) cmd_ctx
.lsm
.cmd_type
),
2771 cmd_ctx
.lsm
.cmd_type
, ret
);
2772 ret
= LTTNG_ERR_UNK
;
2775 cmd_completion_handler
= cmd_pop_completion_handler();
2776 if (cmd_completion_handler
) {
2777 enum lttng_error_code completion_code
;
2779 completion_code
= cmd_completion_handler
->run(
2780 cmd_completion_handler
->data
);
2781 if (completion_code
!= LTTNG_OK
) {
2786 health_code_update();
2789 struct lttng_payload_view view
=
2790 lttng_payload_view_from_payload(
2791 &cmd_ctx
.reply_payload
,
2793 struct lttcomm_lttng_msg
*llm
= (typeof(
2794 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2796 LTTNG_ASSERT(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2797 LTTNG_ASSERT(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2799 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2801 DBG("Sending response (size: %d, retcode: %s (%d))",
2802 cmd_ctx
.lttng_msg_size
,
2803 lttng_strerror(-llm
->ret_code
),
2805 ret
= send_unix_sock(sock
, &view
);
2807 ERR("Failed to send data back to client");
2810 /* End of transmission */
2818 health_code_update();
2830 lttng_poll_clean(&events
);
2834 unlink(the_config
.client_unix_sock_path
.value
);
2835 ret
= close(client_sock
);
2842 ERR("Health error occurred in %s", __func__
);
2845 health_unregister(the_health_sessiond
);
2847 DBG("Client thread dying");
2848 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2849 rcu_unregister_thread();
2854 bool shutdown_client_thread(void *thread_data
)
2856 struct lttng_pipe
*client_quit_pipe
= (lttng_pipe
*) thread_data
;
2857 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2859 return notify_thread_pipe(write_fd
) == 1;
2862 struct lttng_thread
*launch_client_thread(void)
2864 bool thread_running
;
2865 struct lttng_pipe
*client_quit_pipe
;
2866 struct lttng_thread
*thread
= NULL
;
2867 int client_sock_fd
= -1;
2869 sem_init(&thread_state
.ready
, 0, 0);
2870 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2871 if (!client_quit_pipe
) {
2875 client_sock_fd
= create_client_sock();
2876 if (client_sock_fd
< 0) {
2880 thread_state
.client_sock
= client_sock_fd
;
2881 thread
= lttng_thread_create("Client management",
2882 thread_manage_clients
,
2883 shutdown_client_thread
,
2884 cleanup_client_thread
,
2889 /* The client thread now owns the client sock fd and the quit pipe. */
2890 client_sock_fd
= -1;
2891 client_quit_pipe
= NULL
;
2894 * This thread is part of the threads that need to be fully
2895 * initialized before the session daemon is marked as "ready".
2897 thread_running
= wait_thread_status();
2898 if (!thread_running
) {
2903 if (client_sock_fd
>= 0) {
2904 if (close(client_sock_fd
)) {
2905 PERROR("Failed to close client socket");
2908 lttng_thread_put(thread
);
2909 cleanup_client_thread(client_quit_pipe
);