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 int receive_userspace_probe(struct command_ctx
*cmd_ctx
, int sock
,
614 int *sock_error
, struct lttng_event
*event
)
617 struct lttng_userspace_probe_location
*probe_location
;
618 struct lttng_payload probe_location_payload
;
619 struct fd_handle
*handle
= NULL
;
622 * Create a payload to store the serialized version of the probe
625 lttng_payload_init(&probe_location_payload
);
627 ret
= lttng_dynamic_buffer_set_size(&probe_location_payload
.buffer
,
628 cmd_ctx
->lsm
.u
.enable
.userspace_probe_location_len
);
630 ret
= LTTNG_ERR_NOMEM
;
635 * Receive the probe location.
637 ret
= lttcomm_recv_unix_sock(sock
, probe_location_payload
.buffer
.data
,
638 probe_location_payload
.buffer
.size
);
640 DBG("Nothing recv() from client var len data... continuing");
642 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
647 * Receive the file descriptor to the target binary from the client.
649 DBG("Receiving userspace probe target FD from client ...");
650 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
652 DBG("Nothing recv() from client userspace probe fd... continuing");
654 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
658 handle
= fd_handle_create(fd
);
660 ret
= LTTNG_ERR_NOMEM
;
664 /* Transferred to the handle. */
667 ret
= lttng_payload_push_fd_handle(&probe_location_payload
, handle
);
669 ERR("Failed to add userspace probe file descriptor to payload");
670 ret
= LTTNG_ERR_NOMEM
;
674 fd_handle_put(handle
);
678 struct lttng_payload_view view
= lttng_payload_view_from_payload(
679 &probe_location_payload
, 0, -1);
681 /* Extract the probe location from the serialized version. */
682 ret
= lttng_userspace_probe_location_create_from_payload(
683 &view
, &probe_location
);
686 WARN("Failed to create a userspace probe location from the received buffer");
687 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
691 /* Attach the probe location to the event. */
692 ret
= lttng_event_set_userspace_probe_location(event
, probe_location
);
694 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
701 PERROR("Failed to close userspace probe location binary fd");
705 fd_handle_put(handle
);
706 lttng_payload_reset(&probe_location_payload
);
710 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
713 struct lttng_trigger
**_trigger
)
717 ssize_t sock_recv_len
;
718 enum lttng_error_code ret_code
;
719 struct lttng_payload trigger_payload
;
720 struct lttng_trigger
*trigger
= NULL
;
722 lttng_payload_init(&trigger_payload
);
723 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
724 ret
= lttng_dynamic_buffer_set_size(
725 &trigger_payload
.buffer
, trigger_len
);
727 ret_code
= LTTNG_ERR_NOMEM
;
731 sock_recv_len
= lttcomm_recv_unix_sock(
732 sock
, trigger_payload
.buffer
.data
, trigger_len
);
733 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
734 ERR("Failed to receive trigger in command payload");
736 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
740 /* Receive fds, if any. */
741 if (cmd_ctx
->lsm
.fd_count
> 0) {
742 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
743 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
744 if (sock_recv_len
> 0 &&
745 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
746 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
747 cmd_ctx
->lsm
.fd_count
, (int) ret
);
748 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
751 } else if (sock_recv_len
<= 0) {
752 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
753 cmd_ctx
->lsm
.fd_count
, (int) ret
);
754 ret_code
= LTTNG_ERR_FATAL
;
760 /* Deserialize trigger. */
762 struct lttng_payload_view view
=
763 lttng_payload_view_from_payload(
764 &trigger_payload
, 0, -1);
766 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
768 ERR("Invalid trigger received as part of command payload");
769 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
770 lttng_trigger_put(trigger
);
779 lttng_payload_reset(&trigger_payload
);
783 static enum lttng_error_code
receive_lttng_error_query(struct command_ctx
*cmd_ctx
,
786 struct lttng_error_query
**_query
)
790 ssize_t sock_recv_len
;
791 enum lttng_error_code ret_code
;
792 struct lttng_payload query_payload
;
793 struct lttng_error_query
*query
= NULL
;
795 lttng_payload_init(&query_payload
);
796 query_len
= (size_t) cmd_ctx
->lsm
.u
.error_query
.length
;
797 ret
= lttng_dynamic_buffer_set_size(&query_payload
.buffer
, query_len
);
799 ret_code
= LTTNG_ERR_NOMEM
;
803 sock_recv_len
= lttcomm_recv_unix_sock(
804 sock
, query_payload
.buffer
.data
, query_len
);
805 if (sock_recv_len
< 0 || sock_recv_len
!= query_len
) {
806 ERR("Failed to receive error query in command payload");
808 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
812 /* Receive fds, if any. */
813 if (cmd_ctx
->lsm
.fd_count
> 0) {
814 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
815 sock
, cmd_ctx
->lsm
.fd_count
, &query_payload
);
816 if (sock_recv_len
> 0 &&
817 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
818 ERR("Failed to receive all file descriptors for error query in command payload: expected fd count = %u, ret = %d",
819 cmd_ctx
->lsm
.fd_count
, (int) ret
);
820 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
823 } else if (sock_recv_len
<= 0) {
824 ERR("Failed to receive file descriptors for error query in command payload: expected fd count = %u, ret = %d",
825 cmd_ctx
->lsm
.fd_count
, (int) ret
);
826 ret_code
= LTTNG_ERR_FATAL
;
832 /* Deserialize error query. */
834 struct lttng_payload_view view
=
835 lttng_payload_view_from_payload(
836 &query_payload
, 0, -1);
838 if (lttng_error_query_create_from_payload(&view
, &query
) !=
840 ERR("Invalid error query received as part of command payload");
841 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
850 lttng_payload_reset(&query_payload
);
855 * Version of setup_lttng_msg() without command header.
857 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
858 void *payload_buf
, size_t payload_len
)
860 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
864 * Check if the current kernel tracer supports the session rotation feature.
865 * Return 1 if it does, 0 otherwise.
867 static int check_rotate_compatible(void)
871 if (the_kernel_tracer_version
.major
!= 2 ||
872 the_kernel_tracer_version
.minor
< 11) {
873 DBG("Kernel tracer version is not compatible with the rotation feature");
881 * Send data on a unix socket using the liblttsessiondcomm API.
883 * Return lttcomm error code.
885 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
888 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
890 /* Check valid length */
891 if (view
->buffer
.size
== 0) {
896 ret
= lttcomm_send_unix_sock(
897 sock
, view
->buffer
.data
, view
->buffer
.size
);
903 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
914 * Process the command requested by the lttng client within the command
915 * context structure. This function make sure that the return structure (llm)
916 * is set and ready for transmission before returning.
918 * Return any error encountered or 0 for success.
920 * "sock" is only used for special-case var. len data.
921 * A command may assume the ownership of the socket, in which case its value
922 * should be set to -1.
924 * Should *NOT* be called with RCU read-side lock held.
926 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
930 bool need_tracing_session
= true;
934 DBG("Processing client command '%s\' (%d)",
935 lttcomm_sessiond_command_str(cmd_ctx
->lsm
.cmd_type
),
936 cmd_ctx
->lsm
.cmd_type
);
938 assert(!rcu_read_ongoing());
942 switch (cmd_ctx
->lsm
.cmd_type
) {
943 case LTTNG_CREATE_SESSION_EXT
:
944 case LTTNG_DESTROY_SESSION
:
945 case LTTNG_LIST_SESSIONS
:
946 case LTTNG_LIST_DOMAINS
:
947 case LTTNG_START_TRACE
:
948 case LTTNG_STOP_TRACE
:
949 case LTTNG_DATA_PENDING
:
950 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
951 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
952 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
953 case LTTNG_SNAPSHOT_RECORD
:
954 case LTTNG_SAVE_SESSION
:
955 case LTTNG_SET_SESSION_SHM_PATH
:
956 case LTTNG_REGENERATE_METADATA
:
957 case LTTNG_REGENERATE_STATEDUMP
:
958 case LTTNG_ROTATE_SESSION
:
959 case LTTNG_ROTATION_GET_INFO
:
960 case LTTNG_ROTATION_SET_SCHEDULE
:
961 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
962 case LTTNG_CLEAR_SESSION
:
963 case LTTNG_LIST_TRIGGERS
:
964 case LTTNG_EXECUTE_ERROR_QUERY
:
971 /* Needs a functioning consumerd? */
972 switch (cmd_ctx
->lsm
.cmd_type
) {
973 case LTTNG_REGISTER_TRIGGER
:
974 case LTTNG_UNREGISTER_TRIGGER
:
975 case LTTNG_EXECUTE_ERROR_QUERY
:
976 need_consumerd
= false;
979 need_consumerd
= true;
983 if (the_config
.no_kernel
&& need_domain
&&
984 cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
986 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
988 ret
= LTTNG_ERR_KERN_NA
;
993 /* Deny register consumer if we already have a spawned consumer. */
994 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
995 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
996 if (the_kconsumer_data
.pid
> 0) {
997 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
998 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1001 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1005 * Check for command that don't needs to allocate a returned payload. We do
1006 * this here so we don't have to make the call for no payload at each
1009 switch(cmd_ctx
->lsm
.cmd_type
) {
1010 case LTTNG_LIST_SESSIONS
:
1011 case LTTNG_LIST_TRACEPOINTS
:
1012 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1013 case LTTNG_LIST_DOMAINS
:
1014 case LTTNG_LIST_CHANNELS
:
1015 case LTTNG_LIST_EVENTS
:
1016 case LTTNG_LIST_SYSCALLS
:
1017 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
1018 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1019 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1020 case LTTNG_DATA_PENDING
:
1021 case LTTNG_ROTATE_SESSION
:
1022 case LTTNG_ROTATION_GET_INFO
:
1023 case LTTNG_REGISTER_TRIGGER
:
1024 case LTTNG_LIST_TRIGGERS
:
1025 case LTTNG_EXECUTE_ERROR_QUERY
:
1028 /* Setup lttng message with no payload */
1029 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
1031 /* This label does not try to unlock the session */
1032 goto init_setup_error
;
1036 /* Commands that DO NOT need a session. */
1037 switch (cmd_ctx
->lsm
.cmd_type
) {
1038 case LTTNG_CREATE_SESSION_EXT
:
1039 case LTTNG_LIST_SESSIONS
:
1040 case LTTNG_LIST_TRACEPOINTS
:
1041 case LTTNG_LIST_SYSCALLS
:
1042 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1043 case LTTNG_SAVE_SESSION
:
1044 case LTTNG_REGISTER_TRIGGER
:
1045 case LTTNG_UNREGISTER_TRIGGER
:
1046 case LTTNG_LIST_TRIGGERS
:
1047 case LTTNG_EXECUTE_ERROR_QUERY
:
1048 need_tracing_session
= false;
1051 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
1053 * We keep the session list lock across _all_ commands
1054 * for now, because the per-session lock does not
1055 * handle teardown properly.
1057 session_lock_list();
1058 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
1059 if (cmd_ctx
->session
== NULL
) {
1060 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1063 /* Acquire lock for the session */
1064 session_lock(cmd_ctx
->session
);
1070 * Commands that need a valid session but should NOT create one if none
1071 * exists. Instead of creating one and destroying it when the command is
1072 * handled, process that right before so we save some round trip in useless
1075 switch (cmd_ctx
->lsm
.cmd_type
) {
1076 case LTTNG_DISABLE_CHANNEL
:
1077 case LTTNG_DISABLE_EVENT
:
1078 switch (cmd_ctx
->lsm
.domain
.type
) {
1079 case LTTNG_DOMAIN_KERNEL
:
1080 if (!cmd_ctx
->session
->kernel_session
) {
1081 ret
= LTTNG_ERR_NO_CHANNEL
;
1085 case LTTNG_DOMAIN_JUL
:
1086 case LTTNG_DOMAIN_LOG4J
:
1087 case LTTNG_DOMAIN_PYTHON
:
1088 case LTTNG_DOMAIN_UST
:
1089 if (!cmd_ctx
->session
->ust_session
) {
1090 ret
= LTTNG_ERR_NO_CHANNEL
;
1095 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1107 * Check domain type for specific "pre-action".
1109 switch (cmd_ctx
->lsm
.domain
.type
) {
1110 case LTTNG_DOMAIN_KERNEL
:
1112 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1116 /* Kernel tracer check */
1117 if (!kernel_tracer_is_initialized()) {
1118 /* Basically, load kernel tracer modules */
1119 ret
= init_kernel_tracer();
1125 /* Consumer is in an ERROR state. Report back to client */
1126 if (need_consumerd
&& uatomic_read(&the_kernel_consumerd_state
) ==
1128 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1132 /* Need a session for kernel command */
1133 if (need_tracing_session
) {
1134 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1135 ret
= create_kernel_session(cmd_ctx
->session
);
1136 if (ret
!= LTTNG_OK
) {
1137 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1142 /* Start the kernel consumer daemon */
1143 pthread_mutex_lock(&the_kconsumer_data
.pid_mutex
);
1144 if (the_kconsumer_data
.pid
== 0 &&
1145 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1146 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1147 ret
= start_consumerd(&the_kconsumer_data
);
1149 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1152 uatomic_set(&the_kernel_consumerd_state
, CONSUMER_STARTED
);
1154 pthread_mutex_unlock(&the_kconsumer_data
.pid_mutex
);
1158 * The consumer was just spawned so we need to add the socket to
1159 * the consumer output of the session if exist.
1161 ret
= consumer_create_socket(&the_kconsumer_data
,
1162 cmd_ctx
->session
->kernel_session
->consumer
);
1169 case LTTNG_DOMAIN_JUL
:
1170 case LTTNG_DOMAIN_LOG4J
:
1171 case LTTNG_DOMAIN_PYTHON
:
1172 if (!agent_tracing_is_enabled()) {
1173 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1177 case LTTNG_DOMAIN_UST
:
1179 if (!ust_app_supported()) {
1180 ret
= LTTNG_ERR_NO_UST
;
1184 /* Consumer is in an ERROR state. Report back to client */
1185 if (need_consumerd
&&
1186 uatomic_read(&the_ust_consumerd_state
) ==
1188 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1192 if (need_tracing_session
) {
1193 /* Create UST session if none exist. */
1194 if (cmd_ctx
->session
->ust_session
== NULL
) {
1195 ret
= create_ust_session(cmd_ctx
->session
,
1196 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
));
1197 if (ret
!= LTTNG_OK
) {
1202 /* Start the UST consumer daemons */
1204 pthread_mutex_lock(&the_ustconsumer64_data
.pid_mutex
);
1205 if (the_config
.consumerd64_bin_path
.value
&&
1206 the_ustconsumer64_data
.pid
== 0 &&
1207 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1208 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1209 ret
= start_consumerd(&the_ustconsumer64_data
);
1211 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1212 uatomic_set(&the_ust_consumerd64_fd
, -EINVAL
);
1216 uatomic_set(&the_ust_consumerd64_fd
, the_ustconsumer64_data
.cmd_sock
);
1217 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1219 pthread_mutex_unlock(&the_ustconsumer64_data
.pid_mutex
);
1223 * Setup socket for consumer 64 bit. No need for atomic access
1224 * since it was set above and can ONLY be set in this thread.
1226 ret
= consumer_create_socket(&the_ustconsumer64_data
,
1227 cmd_ctx
->session
->ust_session
->consumer
);
1233 pthread_mutex_lock(&the_ustconsumer32_data
.pid_mutex
);
1234 if (the_config
.consumerd32_bin_path
.value
&&
1235 the_ustconsumer32_data
.pid
== 0 &&
1236 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1237 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1238 ret
= start_consumerd(&the_ustconsumer32_data
);
1240 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1241 uatomic_set(&the_ust_consumerd32_fd
, -EINVAL
);
1245 uatomic_set(&the_ust_consumerd32_fd
, the_ustconsumer32_data
.cmd_sock
);
1246 uatomic_set(&the_ust_consumerd_state
, CONSUMER_STARTED
);
1248 pthread_mutex_unlock(&the_ustconsumer32_data
.pid_mutex
);
1252 * Setup socket for consumer 32 bit. No need for atomic access
1253 * since it was set above and can ONLY be set in this thread.
1255 ret
= consumer_create_socket(&the_ustconsumer32_data
,
1256 cmd_ctx
->session
->ust_session
->consumer
);
1268 /* Validate consumer daemon state when start/stop trace command */
1269 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1270 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1271 switch (cmd_ctx
->lsm
.domain
.type
) {
1272 case LTTNG_DOMAIN_NONE
:
1274 case LTTNG_DOMAIN_JUL
:
1275 case LTTNG_DOMAIN_LOG4J
:
1276 case LTTNG_DOMAIN_PYTHON
:
1277 case LTTNG_DOMAIN_UST
:
1278 if (uatomic_read(&the_ust_consumerd_state
) != CONSUMER_STARTED
) {
1279 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1283 case LTTNG_DOMAIN_KERNEL
:
1284 if (uatomic_read(&the_kernel_consumerd_state
) != CONSUMER_STARTED
) {
1285 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1290 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1296 * Check that the UID matches that of the tracing session.
1297 * The root user can interact with all sessions.
1299 if (need_tracing_session
) {
1300 if (!session_access_ok(cmd_ctx
->session
,
1301 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1302 cmd_ctx
->session
->destroyed
) {
1303 ret
= LTTNG_ERR_EPERM
;
1309 * Send relayd information to consumer as soon as we have a domain and a
1312 if (cmd_ctx
->session
&& need_domain
) {
1314 * Setup relayd if not done yet. If the relayd information was already
1315 * sent to the consumer, this call will gracefully return.
1317 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1318 if (ret
!= LTTNG_OK
) {
1323 /* Process by command type */
1324 switch (cmd_ctx
->lsm
.cmd_type
) {
1325 case LTTNG_ADD_CONTEXT
:
1328 * An LTTNG_ADD_CONTEXT command might have a supplementary
1329 * payload if the context being added is an application context.
1331 if (cmd_ctx
->lsm
.u
.context
.ctx
.ctx
==
1332 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1333 char *provider_name
= NULL
, *context_name
= NULL
;
1334 size_t provider_name_len
=
1335 cmd_ctx
->lsm
.u
.context
.provider_name_len
;
1336 size_t context_name_len
=
1337 cmd_ctx
->lsm
.u
.context
.context_name_len
;
1339 if (provider_name_len
== 0 || context_name_len
== 0) {
1341 * Application provider and context names MUST
1344 ret
= -LTTNG_ERR_INVALID
;
1348 provider_name
= zmalloc(provider_name_len
+ 1);
1349 if (!provider_name
) {
1350 ret
= -LTTNG_ERR_NOMEM
;
1353 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
=
1356 context_name
= zmalloc(context_name_len
+ 1);
1357 if (!context_name
) {
1358 ret
= -LTTNG_ERR_NOMEM
;
1359 goto error_add_context
;
1361 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
=
1364 ret
= lttcomm_recv_unix_sock(*sock
, provider_name
,
1367 goto error_add_context
;
1370 ret
= lttcomm_recv_unix_sock(*sock
, context_name
,
1373 goto error_add_context
;
1378 * cmd_add_context assumes ownership of the provider and context
1381 ret
= cmd_add_context(cmd_ctx
->session
,
1382 cmd_ctx
->lsm
.domain
.type
,
1383 cmd_ctx
->lsm
.u
.context
.channel_name
,
1384 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.context
.ctx
),
1385 the_kernel_poll_pipe
[1]);
1387 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
1388 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
1390 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
);
1391 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
);
1397 case LTTNG_DISABLE_CHANNEL
:
1399 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1400 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1403 case LTTNG_DISABLE_EVENT
:
1407 * FIXME: handle filter; for now we just receive the filter's
1408 * bytecode along with the filter expression which are sent by
1409 * liblttng-ctl and discard them.
1411 * This fixes an issue where the client may block while sending
1412 * the filter payload and encounter an error because the session
1413 * daemon closes the socket without ever handling this data.
1415 size_t count
= cmd_ctx
->lsm
.u
.disable
.expression_len
+
1416 cmd_ctx
->lsm
.u
.disable
.bytecode_len
;
1419 char data
[LTTNG_FILTER_MAX_LEN
];
1421 DBG("Discarding disable event command payload of size %zu", count
);
1423 ret
= lttcomm_recv_unix_sock(*sock
, data
,
1424 count
> sizeof(data
) ? sizeof(data
) : count
);
1429 count
-= (size_t) ret
;
1432 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1433 cmd_ctx
->lsm
.u
.disable
.channel_name
,
1434 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.disable
.event
));
1437 case LTTNG_ENABLE_CHANNEL
:
1439 ret
= cmd_enable_channel(
1440 cmd_ctx
, *sock
, the_kernel_poll_pipe
[1]);
1443 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1444 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1446 struct lttng_dynamic_buffer payload
;
1447 struct lttng_buffer_view payload_view
;
1448 const bool add_value
=
1449 cmd_ctx
->lsm
.cmd_type
==
1450 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1451 const size_t name_len
=
1452 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1454 const enum lttng_domain_type domain_type
=
1455 (enum lttng_domain_type
)
1456 cmd_ctx
->lsm
.domain
.type
;
1457 const enum lttng_process_attr process_attr
=
1458 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1459 .process_attr_tracker_add_remove_include_value
1461 const enum lttng_process_attr_value_type value_type
=
1462 (enum lttng_process_attr_value_type
) cmd_ctx
1464 .process_attr_tracker_add_remove_include_value
1466 struct process_attr_value
*value
;
1467 enum lttng_error_code ret_code
;
1468 long login_name_max
;
1470 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1471 if (login_name_max
< 0) {
1472 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1473 ret
= LTTNG_ERR_INVALID
;
1477 /* Receive remaining variable length payload if applicable. */
1478 if (name_len
> login_name_max
) {
1480 * POSIX mandates user and group names that are at least
1481 * 8 characters long. Note that although shadow-utils
1482 * (useradd, groupaadd, etc.) use 32 chars as their
1483 * limit (from bits/utmp.h, UT_NAMESIZE),
1484 * LOGIN_NAME_MAX is defined to 256.
1486 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1487 add_value
? "addition" : "removal",
1488 name_len
, login_name_max
);
1489 ret
= LTTNG_ERR_INVALID
;
1493 lttng_dynamic_buffer_init(&payload
);
1494 if (name_len
!= 0) {
1496 * Receive variable payload for user/group name
1499 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1501 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1502 add_value
? "add" : "remove");
1503 ret
= LTTNG_ERR_NOMEM
;
1504 goto error_add_remove_tracker_value
;
1507 ret
= lttcomm_recv_unix_sock(
1508 *sock
, payload
.data
, name_len
);
1510 ERR("Failed to receive payload of %s process attribute tracker value argument",
1511 add_value
? "add" : "remove");
1513 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1514 goto error_add_remove_tracker_value
;
1518 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1519 &payload
, 0, name_len
);
1520 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1521 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1522 goto error_add_remove_tracker_value
;
1526 * Validate the value type and domains are legal for the process
1527 * attribute tracker that is specified and convert the value to
1528 * add/remove to the internal sessiond representation.
1530 ret_code
= process_attr_value_from_comm(domain_type
,
1531 process_attr
, value_type
,
1532 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1534 &payload_view
, &value
);
1535 if (ret_code
!= LTTNG_OK
) {
1537 goto error_add_remove_tracker_value
;
1541 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1542 cmd_ctx
->session
, domain_type
,
1543 process_attr
, value
);
1545 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1546 cmd_ctx
->session
, domain_type
,
1547 process_attr
, value
);
1549 process_attr_value_destroy(value
);
1550 error_add_remove_tracker_value
:
1551 lttng_dynamic_buffer_reset(&payload
);
1554 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1556 enum lttng_tracking_policy tracking_policy
;
1557 const enum lttng_domain_type domain_type
=
1558 (enum lttng_domain_type
)
1559 cmd_ctx
->lsm
.domain
.type
;
1560 const enum lttng_process_attr process_attr
=
1561 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1562 .process_attr_tracker_get_tracking_policy
1565 ret
= cmd_process_attr_tracker_get_tracking_policy(
1566 cmd_ctx
->session
, domain_type
, process_attr
,
1568 if (ret
!= LTTNG_OK
) {
1572 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1573 &(uint32_t){tracking_policy
}, sizeof(uint32_t));
1575 ret
= LTTNG_ERR_NOMEM
;
1581 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1583 const enum lttng_tracking_policy tracking_policy
=
1584 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1585 .process_attr_tracker_set_tracking_policy
1587 const enum lttng_domain_type domain_type
=
1588 (enum lttng_domain_type
)
1589 cmd_ctx
->lsm
.domain
.type
;
1590 const enum lttng_process_attr process_attr
=
1591 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1592 .process_attr_tracker_set_tracking_policy
1595 ret
= cmd_process_attr_tracker_set_tracking_policy(
1596 cmd_ctx
->session
, domain_type
, process_attr
,
1598 if (ret
!= LTTNG_OK
) {
1603 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1605 struct lttng_process_attr_values
*values
;
1606 struct lttng_dynamic_buffer reply
;
1607 const enum lttng_domain_type domain_type
=
1608 (enum lttng_domain_type
)
1609 cmd_ctx
->lsm
.domain
.type
;
1610 const enum lttng_process_attr process_attr
=
1611 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1612 .process_attr_tracker_get_inclusion_set
1615 ret
= cmd_process_attr_tracker_get_inclusion_set(
1616 cmd_ctx
->session
, domain_type
, process_attr
,
1618 if (ret
!= LTTNG_OK
) {
1622 lttng_dynamic_buffer_init(&reply
);
1623 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1625 goto error_tracker_get_inclusion_set
;
1628 ret
= setup_lttng_msg_no_cmd_header(
1629 cmd_ctx
, reply
.data
, reply
.size
);
1631 ret
= LTTNG_ERR_NOMEM
;
1632 goto error_tracker_get_inclusion_set
;
1636 error_tracker_get_inclusion_set
:
1637 lttng_process_attr_values_destroy(values
);
1638 lttng_dynamic_buffer_reset(&reply
);
1641 case LTTNG_ENABLE_EVENT
:
1643 struct lttng_event
*ev
= NULL
;
1644 struct lttng_event_exclusion
*exclusion
= NULL
;
1645 struct lttng_bytecode
*bytecode
= NULL
;
1646 char *filter_expression
= NULL
;
1648 /* Handle exclusion events and receive it from the client. */
1649 if (cmd_ctx
->lsm
.u
.enable
.exclusion_count
> 0) {
1650 size_t count
= cmd_ctx
->lsm
.u
.enable
.exclusion_count
;
1652 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
1653 (count
* LTTNG_SYMBOL_NAME_LEN
));
1655 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
1659 DBG("Receiving var len exclusion event list from client ...");
1660 exclusion
->count
= count
;
1661 ret
= lttcomm_recv_unix_sock(*sock
, exclusion
->names
,
1662 count
* LTTNG_SYMBOL_NAME_LEN
);
1664 DBG("Nothing recv() from client var len data... continuing");
1667 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
1672 /* Get filter expression from client. */
1673 if (cmd_ctx
->lsm
.u
.enable
.expression_len
> 0) {
1674 size_t expression_len
=
1675 cmd_ctx
->lsm
.u
.enable
.expression_len
;
1677 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
1678 ret
= LTTNG_ERR_FILTER_INVAL
;
1683 filter_expression
= zmalloc(expression_len
);
1684 if (!filter_expression
) {
1686 ret
= LTTNG_ERR_FILTER_NOMEM
;
1690 /* Receive var. len. data */
1691 DBG("Receiving var len filter's expression from client ...");
1692 ret
= lttcomm_recv_unix_sock(*sock
, filter_expression
,
1695 DBG("Nothing recv() from client var len data... continuing");
1697 free(filter_expression
);
1699 ret
= LTTNG_ERR_FILTER_INVAL
;
1704 /* Handle filter and get bytecode from client. */
1705 if (cmd_ctx
->lsm
.u
.enable
.bytecode_len
> 0) {
1706 size_t bytecode_len
= cmd_ctx
->lsm
.u
.enable
.bytecode_len
;
1708 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
1709 ret
= LTTNG_ERR_FILTER_INVAL
;
1710 free(filter_expression
);
1715 bytecode
= zmalloc(bytecode_len
);
1717 free(filter_expression
);
1719 ret
= LTTNG_ERR_FILTER_NOMEM
;
1723 /* Receive var. len. data */
1724 DBG("Receiving var len filter's bytecode from client ...");
1725 ret
= lttcomm_recv_unix_sock(*sock
, bytecode
, bytecode_len
);
1727 DBG("Nothing recv() from client var len data... continuing");
1729 free(filter_expression
);
1732 ret
= LTTNG_ERR_FILTER_INVAL
;
1736 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
1737 free(filter_expression
);
1740 ret
= LTTNG_ERR_FILTER_INVAL
;
1745 ev
= lttng_event_copy(ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.enable
.event
));
1747 DBG("Failed to copy event: %s",
1748 cmd_ctx
->lsm
.u
.enable
.event
.name
);
1749 free(filter_expression
);
1752 ret
= LTTNG_ERR_NOMEM
;
1757 if (cmd_ctx
->lsm
.u
.enable
.userspace_probe_location_len
> 0) {
1758 /* Expect a userspace probe description. */
1759 ret
= receive_userspace_probe(cmd_ctx
, *sock
, sock_error
, ev
);
1761 free(filter_expression
);
1764 lttng_event_destroy(ev
);
1769 ret
= cmd_enable_event(cmd_ctx
->session
,
1770 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
),
1771 cmd_ctx
->lsm
.u
.enable
.channel_name
,
1773 filter_expression
, bytecode
, exclusion
,
1774 the_kernel_poll_pipe
[1]);
1775 lttng_event_destroy(ev
);
1778 case LTTNG_LIST_TRACEPOINTS
:
1780 struct lttng_event
*events
;
1783 session_lock_list();
1784 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
, &events
);
1785 session_unlock_list();
1786 if (nb_events
< 0) {
1787 /* Return value is a negative lttng_error_code. */
1793 * Setup lttng message with payload size set to the event list size in
1794 * bytes and then copy list into the llm payload.
1796 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1797 sizeof(struct lttng_event
) * nb_events
);
1807 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1809 struct lttng_event_field
*fields
;
1812 session_lock_list();
1813 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1815 session_unlock_list();
1816 if (nb_fields
< 0) {
1817 /* Return value is a negative lttng_error_code. */
1823 * Setup lttng message with payload size set to the event list size in
1824 * bytes and then copy list into the llm payload.
1826 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
1827 sizeof(struct lttng_event_field
) * nb_fields
);
1837 case LTTNG_LIST_SYSCALLS
:
1839 struct lttng_event
*events
;
1842 nb_events
= cmd_list_syscalls(&events
);
1843 if (nb_events
< 0) {
1844 /* Return value is a negative lttng_error_code. */
1850 * Setup lttng message with payload size set to the event list size in
1851 * bytes and then copy list into the llm payload.
1853 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1854 sizeof(struct lttng_event
) * nb_events
);
1864 case LTTNG_SET_CONSUMER_URI
:
1867 struct lttng_uri
*uris
;
1869 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1870 len
= nb_uri
* sizeof(struct lttng_uri
);
1873 ret
= LTTNG_ERR_INVALID
;
1877 uris
= zmalloc(len
);
1879 ret
= LTTNG_ERR_FATAL
;
1883 /* Receive variable len data */
1884 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1885 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1887 DBG("No URIs received from client... continuing");
1889 ret
= LTTNG_ERR_SESSION_FAIL
;
1894 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1896 if (ret
!= LTTNG_OK
) {
1903 case LTTNG_START_TRACE
:
1906 * On the first start, if we have a kernel session and we have
1907 * enabled time or size-based rotations, we have to make sure
1908 * the kernel tracer supports it.
1910 if (!cmd_ctx
->session
->has_been_started
&& \
1911 cmd_ctx
->session
->kernel_session
&& \
1912 (cmd_ctx
->session
->rotate_timer_period
|| \
1913 cmd_ctx
->session
->rotate_size
) && \
1914 !check_rotate_compatible()) {
1915 DBG("Kernel tracer version is not compatible with the rotation feature");
1916 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1919 ret
= cmd_start_trace(cmd_ctx
->session
);
1922 case LTTNG_STOP_TRACE
:
1924 ret
= cmd_stop_trace(cmd_ctx
->session
);
1927 case LTTNG_DESTROY_SESSION
:
1929 ret
= cmd_destroy_session(cmd_ctx
->session
,
1930 the_notification_thread_handle
, sock
);
1933 case LTTNG_LIST_DOMAINS
:
1936 struct lttng_domain
*domains
= NULL
;
1938 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1940 /* Return value is a negative lttng_error_code. */
1945 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1946 nb_dom
* sizeof(struct lttng_domain
));
1956 case LTTNG_LIST_CHANNELS
:
1958 enum lttng_error_code ret_code
;
1959 size_t original_payload_size
;
1960 size_t payload_size
;
1961 const size_t command_header_size
= sizeof(struct lttcomm_list_command_header
);
1963 ret
= setup_empty_lttng_msg(cmd_ctx
);
1965 ret
= LTTNG_ERR_NOMEM
;
1969 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1971 ret_code
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1972 cmd_ctx
->session
, &cmd_ctx
->reply_payload
);
1973 if (ret_code
!= LTTNG_OK
) {
1974 ret
= (int) ret_code
;
1978 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1979 command_header_size
- original_payload_size
;
1980 update_lttng_msg(cmd_ctx
, command_header_size
, payload_size
);
1985 case LTTNG_LIST_EVENTS
:
1988 struct lttcomm_event_command_header cmd_header
= {};
1989 size_t original_payload_size
;
1990 size_t payload_size
;
1992 ret
= setup_empty_lttng_msg(cmd_ctx
);
1994 ret
= LTTNG_ERR_NOMEM
;
1998 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2000 /* Extended infos are included at the end of the payload. */
2001 list_ret
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
2003 cmd_ctx
->lsm
.u
.list
.channel_name
,
2004 &cmd_ctx
->reply_payload
);
2006 /* Return value is a negative lttng_error_code. */
2011 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2012 sizeof(cmd_header
) - original_payload_size
;
2013 update_lttng_msg(cmd_ctx
, sizeof(cmd_header
), payload_size
);
2018 case LTTNG_LIST_SESSIONS
:
2020 unsigned int nr_sessions
;
2021 void *sessions_payload
;
2024 session_lock_list();
2025 nr_sessions
= lttng_sessions_count(
2026 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2027 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
2029 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
2030 (sizeof(struct lttng_session_extended
) * nr_sessions
);
2031 sessions_payload
= zmalloc(payload_len
);
2033 if (!sessions_payload
) {
2034 session_unlock_list();
2039 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
2040 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
2041 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
2042 session_unlock_list();
2044 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
2046 free(sessions_payload
);
2055 case LTTNG_REGISTER_CONSUMER
:
2057 struct consumer_data
*cdata
;
2059 switch (cmd_ctx
->lsm
.domain
.type
) {
2060 case LTTNG_DOMAIN_KERNEL
:
2061 cdata
= &the_kconsumer_data
;
2064 ret
= LTTNG_ERR_UND
;
2068 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
2069 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
2072 case LTTNG_DATA_PENDING
:
2075 uint8_t pending_ret_byte
;
2077 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
2082 * This function may returns 0 or 1 to indicate whether or not
2083 * there is data pending. In case of error, it should return an
2084 * LTTNG_ERR code. However, some code paths may still return
2085 * a nondescript error code, which we handle by returning an
2088 if (pending_ret
== 0 || pending_ret
== 1) {
2090 * ret will be set to LTTNG_OK at the end of
2093 } else if (pending_ret
< 0) {
2094 ret
= LTTNG_ERR_UNK
;
2101 pending_ret_byte
= (uint8_t) pending_ret
;
2103 /* 1 byte to return whether or not data is pending */
2104 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
2105 &pending_ret_byte
, 1);
2114 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2116 uint32_t snapshot_id
;
2117 struct lttcomm_lttng_output_id reply
;
2119 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
2120 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
),
2122 if (ret
!= LTTNG_OK
) {
2125 reply
.id
= snapshot_id
;
2127 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2133 /* Copy output list into message payload */
2137 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2139 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
2140 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
));
2143 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2146 struct lttng_snapshot_output
*outputs
= NULL
;
2148 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2149 if (nb_output
< 0) {
2154 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
2155 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2156 nb_output
* sizeof(struct lttng_snapshot_output
));
2166 case LTTNG_SNAPSHOT_RECORD
:
2168 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2169 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_record
.output
),
2170 cmd_ctx
->lsm
.u
.snapshot_record
.wait
);
2173 case LTTNG_CREATE_SESSION_EXT
:
2175 struct lttng_dynamic_buffer payload
;
2176 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2178 lttng_dynamic_buffer_init(&payload
);
2179 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2180 if (ret
!= LTTNG_OK
) {
2184 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2187 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2188 lttng_session_descriptor_destroy(return_descriptor
);
2189 ret
= LTTNG_ERR_NOMEM
;
2192 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2195 lttng_session_descriptor_destroy(return_descriptor
);
2196 ret
= LTTNG_ERR_NOMEM
;
2199 lttng_dynamic_buffer_reset(&payload
);
2200 lttng_session_descriptor_destroy(return_descriptor
);
2204 case LTTNG_SAVE_SESSION
:
2206 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2210 case LTTNG_SET_SESSION_SHM_PATH
:
2212 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2213 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2216 case LTTNG_REGENERATE_METADATA
:
2218 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2221 case LTTNG_REGENERATE_STATEDUMP
:
2223 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2226 case LTTNG_REGISTER_TRIGGER
:
2228 struct lttng_trigger
*payload_trigger
;
2229 struct lttng_trigger
*return_trigger
;
2230 size_t original_reply_payload_size
;
2231 size_t reply_payload_size
;
2232 const struct lttng_credentials cmd_creds
= {
2233 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2234 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2237 ret
= setup_empty_lttng_msg(cmd_ctx
);
2239 ret
= LTTNG_ERR_NOMEM
;
2243 ret
= receive_lttng_trigger(
2244 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2245 if (ret
!= LTTNG_OK
) {
2249 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2251 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2252 cmd_ctx
->lsm
.u
.trigger
.is_trigger_anonymous
,
2253 the_notification_thread_handle
,
2255 if (ret
!= LTTNG_OK
) {
2256 lttng_trigger_put(payload_trigger
);
2260 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2261 lttng_trigger_put(payload_trigger
);
2262 lttng_trigger_put(return_trigger
);
2264 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2265 ret
= LTTNG_ERR_NOMEM
;
2269 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2270 original_reply_payload_size
;
2272 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2277 case LTTNG_UNREGISTER_TRIGGER
:
2279 struct lttng_trigger
*payload_trigger
;
2280 const struct lttng_credentials cmd_creds
= {
2281 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2282 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2285 ret
= receive_lttng_trigger(
2286 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2287 if (ret
!= LTTNG_OK
) {
2291 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2292 the_notification_thread_handle
);
2293 lttng_trigger_put(payload_trigger
);
2296 case LTTNG_ROTATE_SESSION
:
2298 struct lttng_rotate_session_return rotate_return
;
2300 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2302 memset(&rotate_return
, 0, sizeof(rotate_return
));
2303 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2304 DBG("Kernel tracer version is not compatible with the rotation feature");
2305 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2309 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2311 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2317 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2318 sizeof(rotate_return
));
2327 case LTTNG_ROTATION_GET_INFO
:
2329 struct lttng_rotation_get_info_return get_info_return
;
2331 memset(&get_info_return
, 0, sizeof(get_info_return
));
2332 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2333 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2339 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2340 sizeof(get_info_return
));
2349 case LTTNG_ROTATION_SET_SCHEDULE
:
2352 enum lttng_rotation_schedule_type schedule_type
;
2355 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2356 DBG("Kernel tracer version does not support session rotations");
2357 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2361 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2362 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2363 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2365 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
, set_schedule
,
2366 schedule_type
, value
,
2367 the_notification_thread_handle
);
2368 if (ret
!= LTTNG_OK
) {
2374 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2376 struct lttng_session_list_schedules_return schedules
= {
2377 .periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
,
2378 .periodic
.value
= cmd_ctx
->session
->rotate_timer_period
,
2379 .size
.set
= !!cmd_ctx
->session
->rotate_size
,
2380 .size
.value
= cmd_ctx
->session
->rotate_size
,
2383 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2393 case LTTNG_CLEAR_SESSION
:
2395 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2398 case LTTNG_LIST_TRIGGERS
:
2400 struct lttng_triggers
*return_triggers
= NULL
;
2401 size_t original_payload_size
;
2402 size_t payload_size
;
2404 ret
= setup_empty_lttng_msg(cmd_ctx
);
2406 ret
= LTTNG_ERR_NOMEM
;
2410 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2412 ret
= cmd_list_triggers(cmd_ctx
, the_notification_thread_handle
,
2414 if (ret
!= LTTNG_OK
) {
2418 assert(return_triggers
);
2419 ret
= lttng_triggers_serialize(
2420 return_triggers
, &cmd_ctx
->reply_payload
);
2421 lttng_triggers_destroy(return_triggers
);
2423 ERR("Failed to serialize triggers in reply to `list triggers` command");
2424 ret
= LTTNG_ERR_NOMEM
;
2428 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2429 original_payload_size
;
2431 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2436 case LTTNG_EXECUTE_ERROR_QUERY
:
2438 struct lttng_error_query
*query
;
2439 const struct lttng_credentials cmd_creds
= {
2440 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2441 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2443 struct lttng_error_query_results
*results
= NULL
;
2444 size_t original_payload_size
;
2445 size_t payload_size
;
2447 ret
= setup_empty_lttng_msg(cmd_ctx
);
2449 ret
= LTTNG_ERR_NOMEM
;
2453 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2455 ret
= receive_lttng_error_query(
2456 cmd_ctx
, *sock
, sock_error
, &query
);
2457 if (ret
!= LTTNG_OK
) {
2461 ret
= cmd_execute_error_query(&cmd_creds
, query
, &results
,
2462 the_notification_thread_handle
);
2463 lttng_error_query_destroy(query
);
2464 if (ret
!= LTTNG_OK
) {
2469 ret
= lttng_error_query_results_serialize(
2470 results
, &cmd_ctx
->reply_payload
);
2471 lttng_error_query_results_destroy(results
);
2473 ERR("Failed to serialize error query result set in reply to `execute error query` command");
2474 ret
= LTTNG_ERR_NOMEM
;
2478 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2479 original_payload_size
;
2481 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2488 ret
= LTTNG_ERR_UND
;
2493 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2494 DBG("Missing llm header, creating one.");
2495 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2499 /* Set return code */
2500 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2502 if (cmd_ctx
->session
) {
2503 session_unlock(cmd_ctx
->session
);
2504 session_put(cmd_ctx
->session
);
2505 cmd_ctx
->session
= NULL
;
2507 if (need_tracing_session
) {
2508 session_unlock_list();
2511 assert(!rcu_read_ongoing());
2515 static int create_client_sock(void)
2517 int ret
, client_sock
;
2518 const mode_t old_umask
= umask(0);
2520 /* Create client tool unix socket */
2521 client_sock
= lttcomm_create_unix_sock(
2522 the_config
.client_unix_sock_path
.value
);
2523 if (client_sock
< 0) {
2524 ERR("Create unix sock failed: %s",
2525 the_config
.client_unix_sock_path
.value
);
2530 /* Set the cloexec flag */
2531 ret
= utils_set_fd_cloexec(client_sock
);
2533 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2534 "Continuing but note that the consumer daemon will have a "
2535 "reference to this socket on exec()", client_sock
);
2538 /* File permission MUST be 660 */
2539 ret
= chmod(the_config
.client_unix_sock_path
.value
,
2540 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2542 ERR("Set file permissions failed: %s",
2543 the_config
.client_unix_sock_path
.value
);
2545 (void) lttcomm_close_unix_sock(client_sock
);
2549 DBG("Created client socket (fd = %i)", client_sock
);
2556 static void cleanup_client_thread(void *data
)
2558 struct lttng_pipe
*quit_pipe
= data
;
2560 lttng_pipe_destroy(quit_pipe
);
2563 static void thread_init_cleanup(void *data
)
2565 set_thread_status(false);
2569 * This thread manage all clients request using the unix client socket for
2572 static void *thread_manage_clients(void *data
)
2574 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2576 uint32_t revents
, nb_fd
;
2577 struct lttng_poll_event events
;
2578 const int client_sock
= thread_state
.client_sock
;
2579 struct lttng_pipe
*quit_pipe
= data
;
2580 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2581 struct command_ctx cmd_ctx
= {};
2583 DBG("[thread] Manage client started");
2585 lttng_payload_init(&cmd_ctx
.reply_payload
);
2587 is_root
= (getuid() == 0);
2589 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2591 rcu_register_thread();
2593 health_register(the_health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2595 health_code_update();
2597 ret
= lttcomm_listen_unix_sock(client_sock
);
2603 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2604 * more will be added to this poll set.
2606 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2608 goto error_create_poll
;
2611 /* Add the application registration socket */
2612 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2617 /* Add thread quit pipe */
2618 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2623 /* Set state as running. */
2624 set_thread_status(true);
2625 pthread_cleanup_pop(0);
2627 /* This testpoint is after we signal readiness to the parent. */
2628 if (testpoint(sessiond_thread_manage_clients
)) {
2632 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2636 health_code_update();
2639 const struct cmd_completion_handler
*cmd_completion_handler
;
2641 cmd_ctx
.creds
= (lttng_sock_cred
) {
2645 cmd_ctx
.session
= NULL
;
2646 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2647 cmd_ctx
.lttng_msg_size
= 0;
2649 DBG("Accepting client command ...");
2651 /* Inifinite blocking call, waiting for transmission */
2653 health_poll_entry();
2654 ret
= lttng_poll_wait(&events
, -1);
2658 * Restart interrupted system call.
2660 if (errno
== EINTR
) {
2668 for (i
= 0; i
< nb_fd
; i
++) {
2669 revents
= LTTNG_POLL_GETEV(&events
, i
);
2670 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2672 health_code_update();
2674 if (pollfd
== thread_quit_pipe_fd
) {
2678 /* Event on the registration socket */
2679 if (revents
& LPOLLIN
) {
2681 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2682 ERR("Client socket poll error");
2685 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2691 DBG("Wait for client response");
2693 health_code_update();
2695 sock
= lttcomm_accept_unix_sock(client_sock
);
2701 * Set the CLOEXEC flag. Return code is useless because either way, the
2704 (void) utils_set_fd_cloexec(sock
);
2706 /* Set socket option for credentials retrieval */
2707 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2712 health_code_update();
2715 * Data is received from the lttng client. The struct
2716 * lttcomm_session_msg (lsm) contains the command and data request of
2719 DBG("Receiving data from client ...");
2720 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2721 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2722 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2723 DBG("Incomplete recv() from client... continuing");
2732 health_code_update();
2734 // TODO: Validate cmd_ctx including sanity check for
2735 // security purpose.
2737 rcu_thread_online();
2739 * This function dispatch the work to the kernel or userspace tracer
2740 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2741 * informations for the client. The command context struct contains
2742 * everything this function may needs.
2744 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2745 rcu_thread_offline();
2755 * TODO: Inform client somehow of the fatal error. At
2756 * this point, ret < 0 means that a zmalloc failed
2757 * (ENOMEM). Error detected but still accept
2758 * command, unless a socket error has been
2764 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2765 WARN("Command returned an invalid status code, returning unknown error: "
2766 "command type = %s (%d), ret = %d",
2767 lttcomm_sessiond_command_str(cmd_ctx
.lsm
.cmd_type
),
2768 cmd_ctx
.lsm
.cmd_type
, ret
);
2769 ret
= LTTNG_ERR_UNK
;
2772 cmd_completion_handler
= cmd_pop_completion_handler();
2773 if (cmd_completion_handler
) {
2774 enum lttng_error_code completion_code
;
2776 completion_code
= cmd_completion_handler
->run(
2777 cmd_completion_handler
->data
);
2778 if (completion_code
!= LTTNG_OK
) {
2783 health_code_update();
2786 struct lttng_payload_view view
=
2787 lttng_payload_view_from_payload(
2788 &cmd_ctx
.reply_payload
,
2790 struct lttcomm_lttng_msg
*llm
= (typeof(
2791 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2793 assert(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2794 assert(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2796 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2798 DBG("Sending response (size: %d, retcode: %s (%d))",
2799 cmd_ctx
.lttng_msg_size
,
2800 lttng_strerror(-llm
->ret_code
),
2802 ret
= send_unix_sock(sock
, &view
);
2804 ERR("Failed to send data back to client");
2807 /* End of transmission */
2815 health_code_update();
2827 lttng_poll_clean(&events
);
2831 unlink(the_config
.client_unix_sock_path
.value
);
2832 ret
= close(client_sock
);
2839 ERR("Health error occurred in %s", __func__
);
2842 health_unregister(the_health_sessiond
);
2844 DBG("Client thread dying");
2845 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2846 rcu_unregister_thread();
2851 bool shutdown_client_thread(void *thread_data
)
2853 struct lttng_pipe
*client_quit_pipe
= thread_data
;
2854 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2856 return notify_thread_pipe(write_fd
) == 1;
2859 struct lttng_thread
*launch_client_thread(void)
2861 bool thread_running
;
2862 struct lttng_pipe
*client_quit_pipe
;
2863 struct lttng_thread
*thread
= NULL
;
2864 int client_sock_fd
= -1;
2866 sem_init(&thread_state
.ready
, 0, 0);
2867 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2868 if (!client_quit_pipe
) {
2872 client_sock_fd
= create_client_sock();
2873 if (client_sock_fd
< 0) {
2877 thread_state
.client_sock
= client_sock_fd
;
2878 thread
= lttng_thread_create("Client management",
2879 thread_manage_clients
,
2880 shutdown_client_thread
,
2881 cleanup_client_thread
,
2886 /* The client thread now owns the client sock fd and the quit pipe. */
2887 client_sock_fd
= -1;
2888 client_quit_pipe
= NULL
;
2891 * This thread is part of the threads that need to be fully
2892 * initialized before the session daemon is marked as "ready".
2894 thread_running
= wait_thread_status();
2895 if (!thread_running
) {
2900 if (client_sock_fd
>= 0) {
2901 if (close(client_sock_fd
)) {
2902 PERROR("Failed to close client socket");
2905 lttng_thread_put(thread
);
2906 cleanup_client_thread(client_quit_pipe
);