2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
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-buffer.h"
13 #include "common/dynamic-array.h"
14 #include "common/payload.h"
15 #include "common/payload-view.h"
16 #include "common/fd-handle.h"
17 #include "common/sessiond-comm/sessiond-comm.h"
18 #include "common/payload.h"
19 #include "common/payload-view.h"
20 #include "lttng/lttng-error.h"
21 #include "lttng/tracker.h"
22 #include <common/compat/getenv.h>
23 #include <common/tracker.h>
24 #include <common/unix.h>
25 #include <common/utils.h>
26 #include <lttng/event-internal.h>
27 #include <lttng/session-descriptor-internal.h>
28 #include <lttng/session-internal.h>
29 #include <lttng/userspace-probe-internal.h>
37 #include "lttng-sessiond.h"
41 #include "health-sessiond.h"
42 #include "testpoint.h"
44 #include "manage-consumer.h"
46 #include "agent-thread.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 (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", config
.consumerd64_bin_path
.value
? : "NULL");
228 DBG3(" 2) %s/%s", INSTALL_BIN_PATH
, DEFAULT_CONSUMERD_FILE
);
229 DBG3(" 3) %s", config
.consumerd32_bin_path
.value
? : "NULL");
230 if (stat(config
.consumerd64_bin_path
.value
, &st
) == 0) {
231 DBG3("Found location #1");
232 consumer_to_use
= 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 (config
.consumerd32_bin_path
.value
&&
237 stat(config
.consumerd32_bin_path
.value
, &st
) == 0) {
238 DBG3("Found location #3");
239 consumer_to_use
= 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
,
247 "lttng-consumerd", verbosity
, "-k",
248 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
249 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
250 "--group", config
.tracing_group_name
.value
,
253 case LTTNG_CONSUMER64_UST
:
255 if (config
.consumerd64_lib_dir
.value
) {
260 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
264 tmplen
= strlen(config
.consumerd64_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
265 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
270 strcat(tmpnew
, config
.consumerd64_lib_dir
.value
);
271 if (tmp
[0] != '\0') {
275 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
282 DBG("Using 64-bit UST consumer at: %s", config
.consumerd64_bin_path
.value
);
283 (void) execl(config
.consumerd64_bin_path
.value
, "lttng-consumerd", verbosity
, "-u",
284 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
285 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
286 "--group", config
.tracing_group_name
.value
,
290 case LTTNG_CONSUMER32_UST
:
292 if (config
.consumerd32_lib_dir
.value
) {
297 tmp
= lttng_secure_getenv("LD_LIBRARY_PATH");
301 tmplen
= strlen(config
.consumerd32_lib_dir
.value
) + 1 /* : */ + strlen(tmp
);
302 tmpnew
= zmalloc(tmplen
+ 1 /* \0 */);
307 strcat(tmpnew
, config
.consumerd32_lib_dir
.value
);
308 if (tmp
[0] != '\0') {
312 ret
= setenv("LD_LIBRARY_PATH", tmpnew
, 1);
319 DBG("Using 32-bit UST consumer at: %s", config
.consumerd32_bin_path
.value
);
320 (void) execl(config
.consumerd32_bin_path
.value
, "lttng-consumerd", verbosity
, "-u",
321 "--consumerd-cmd-sock", consumer_data
->cmd_unix_sock_path
,
322 "--consumerd-err-sock", consumer_data
->err_unix_sock_path
,
323 "--group", config
.tracing_group_name
.value
,
328 ERR("unknown consumer type");
332 PERROR("Consumer execl()");
334 /* Reaching this point, we got a failure on our execl(). */
336 } else if (pid
> 0) {
339 PERROR("start consumer fork");
347 * Spawn the consumerd daemon and session daemon thread.
349 static int start_consumerd(struct consumer_data
*consumer_data
)
354 * Set the listen() state on the socket since there is a possible race
355 * between the exec() of the consumer daemon and this call if place in the
356 * consumer thread. See bug #366 for more details.
358 ret
= lttcomm_listen_unix_sock(consumer_data
->err_sock
);
363 pthread_mutex_lock(&consumer_data
->pid_mutex
);
364 if (consumer_data
->pid
!= 0) {
365 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
369 ret
= spawn_consumerd(consumer_data
);
371 ERR("Spawning consumerd failed");
372 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
376 /* Setting up the consumer_data pid */
377 consumer_data
->pid
= ret
;
378 DBG2("Consumer pid %d", consumer_data
->pid
);
379 pthread_mutex_unlock(&consumer_data
->pid_mutex
);
381 DBG2("Spawning consumer control thread");
382 ret
= spawn_consumer_thread(consumer_data
);
384 ERR("Fatal error spawning consumer control thread");
392 /* Cleanup already created sockets on error. */
393 if (consumer_data
->err_sock
>= 0) {
396 err
= close(consumer_data
->err_sock
);
398 PERROR("close consumer data error socket");
405 * Copy consumer output from the tracing session to the domain session. The
406 * function also applies the right modification on a per domain basis for the
407 * trace files destination directory.
409 * Should *NOT* be called with RCU read-side lock held.
411 static int copy_session_consumer(int domain
, struct ltt_session
*session
)
414 const char *dir_name
;
415 struct consumer_output
*consumer
;
418 assert(session
->consumer
);
421 case LTTNG_DOMAIN_KERNEL
:
422 DBG3("Copying tracing session consumer output in kernel session");
424 * XXX: We should audit the session creation and what this function
425 * does "extra" in order to avoid a destroy since this function is used
426 * in the domain session creation (kernel and ust) only. Same for UST
429 if (session
->kernel_session
->consumer
) {
430 consumer_output_put(session
->kernel_session
->consumer
);
432 session
->kernel_session
->consumer
=
433 consumer_copy_output(session
->consumer
);
434 /* Ease our life a bit for the next part */
435 consumer
= session
->kernel_session
->consumer
;
436 dir_name
= DEFAULT_KERNEL_TRACE_DIR
;
438 case LTTNG_DOMAIN_JUL
:
439 case LTTNG_DOMAIN_LOG4J
:
440 case LTTNG_DOMAIN_PYTHON
:
441 case LTTNG_DOMAIN_UST
:
442 DBG3("Copying tracing session consumer output in UST session");
443 if (session
->ust_session
->consumer
) {
444 consumer_output_put(session
->ust_session
->consumer
);
446 session
->ust_session
->consumer
=
447 consumer_copy_output(session
->consumer
);
448 /* Ease our life a bit for the next part */
449 consumer
= session
->ust_session
->consumer
;
450 dir_name
= DEFAULT_UST_TRACE_DIR
;
453 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
457 /* Append correct directory to subdir */
458 ret
= lttng_strncpy(consumer
->domain_subdir
, dir_name
,
459 sizeof(consumer
->domain_subdir
));
464 DBG3("Copy session consumer subdir %s", consumer
->domain_subdir
);
472 * Create an UST session and add it to the session ust list.
474 * Should *NOT* be called with RCU read-side lock held.
476 static int create_ust_session(struct ltt_session
*session
,
477 const struct lttng_domain
*domain
)
480 struct ltt_ust_session
*lus
= NULL
;
484 assert(session
->consumer
);
486 switch (domain
->type
) {
487 case LTTNG_DOMAIN_JUL
:
488 case LTTNG_DOMAIN_LOG4J
:
489 case LTTNG_DOMAIN_PYTHON
:
490 case LTTNG_DOMAIN_UST
:
493 ERR("Unknown UST domain on create session %d", domain
->type
);
494 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
498 DBG("Creating UST session");
500 lus
= trace_ust_create_session(session
->id
);
502 ret
= LTTNG_ERR_UST_SESS_FAIL
;
506 lus
->uid
= session
->uid
;
507 lus
->gid
= session
->gid
;
508 lus
->output_traces
= session
->output_traces
;
509 lus
->snapshot_mode
= session
->snapshot_mode
;
510 lus
->live_timer_interval
= session
->live_timer
;
511 session
->ust_session
= lus
;
512 if (session
->shm_path
[0]) {
513 strncpy(lus
->root_shm_path
, session
->shm_path
,
514 sizeof(lus
->root_shm_path
));
515 lus
->root_shm_path
[sizeof(lus
->root_shm_path
) - 1] = '\0';
516 strncpy(lus
->shm_path
, session
->shm_path
,
517 sizeof(lus
->shm_path
));
518 lus
->shm_path
[sizeof(lus
->shm_path
) - 1] = '\0';
519 strncat(lus
->shm_path
, "/ust",
520 sizeof(lus
->shm_path
) - strlen(lus
->shm_path
) - 1);
522 /* Copy session output to the newly created UST session */
523 ret
= copy_session_consumer(domain
->type
, session
);
524 if (ret
!= LTTNG_OK
) {
532 session
->ust_session
= NULL
;
537 * Create a kernel tracer session then create the default channel.
539 static int create_kernel_session(struct ltt_session
*session
)
543 DBG("Creating kernel session");
545 ret
= kernel_create_session(session
);
547 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
551 /* Code flow safety */
552 assert(session
->kernel_session
);
554 /* Copy session output to the newly created Kernel session */
555 ret
= copy_session_consumer(LTTNG_DOMAIN_KERNEL
, session
);
556 if (ret
!= LTTNG_OK
) {
560 session
->kernel_session
->uid
= session
->uid
;
561 session
->kernel_session
->gid
= session
->gid
;
562 session
->kernel_session
->output_traces
= session
->output_traces
;
563 session
->kernel_session
->snapshot_mode
= session
->snapshot_mode
;
564 session
->kernel_session
->is_live_session
= session
->live_timer
!= 0;
569 trace_kernel_destroy_session(session
->kernel_session
);
570 session
->kernel_session
= NULL
;
576 * Count number of session permitted by uid/gid.
578 static unsigned int lttng_sessions_count(uid_t uid
, gid_t gid
)
581 struct ltt_session
*session
;
582 const struct ltt_session_list
*session_list
= session_get_list();
584 DBG("Counting number of available session for UID %d", uid
);
585 cds_list_for_each_entry(session
, &session_list
->head
, list
) {
586 if (!session_get(session
)) {
589 session_lock(session
);
590 /* Only count the sessions the user can control. */
591 if (session_access_ok(session
, uid
) &&
592 !session
->destroyed
) {
595 session_unlock(session
);
596 session_put(session
);
601 static int receive_userspace_probe(struct command_ctx
*cmd_ctx
, int sock
,
602 int *sock_error
, struct lttng_event
*event
)
605 struct lttng_userspace_probe_location
*probe_location
;
606 struct lttng_payload probe_location_payload
;
607 struct fd_handle
*handle
= NULL
;
610 * Create a payload to store the serialized version of the probe
613 lttng_payload_init(&probe_location_payload
);
615 ret
= lttng_dynamic_buffer_set_size(&probe_location_payload
.buffer
,
616 cmd_ctx
->lsm
.u
.enable
.userspace_probe_location_len
);
618 ret
= LTTNG_ERR_NOMEM
;
623 * Receive the probe location.
625 ret
= lttcomm_recv_unix_sock(sock
, probe_location_payload
.buffer
.data
,
626 probe_location_payload
.buffer
.size
);
628 DBG("Nothing recv() from client var len data... continuing");
630 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
635 * Receive the file descriptor to the target binary from the client.
637 DBG("Receiving userspace probe target FD from client ...");
638 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
640 DBG("Nothing recv() from client userspace probe fd... continuing");
642 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
646 handle
= fd_handle_create(fd
);
648 ret
= LTTNG_ERR_NOMEM
;
652 /* Transferred to the handle. */
655 ret
= lttng_payload_push_fd_handle(&probe_location_payload
, handle
);
657 ERR("Failed to add userspace probe file descriptor to payload");
658 ret
= LTTNG_ERR_NOMEM
;
662 fd_handle_put(handle
);
666 struct lttng_payload_view view
= lttng_payload_view_from_payload(
667 &probe_location_payload
, 0, -1);
669 /* Extract the probe location from the serialized version. */
670 ret
= lttng_userspace_probe_location_create_from_payload(
671 &view
, &probe_location
);
674 WARN("Failed to create a userspace probe location from the received buffer");
675 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
679 /* Attach the probe location to the event. */
680 ret
= lttng_event_set_userspace_probe_location(event
, probe_location
);
682 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
689 PERROR("Failed to close userspace probe location binary fd");
693 fd_handle_put(handle
);
694 lttng_payload_reset(&probe_location_payload
);
698 static enum lttng_error_code
receive_lttng_trigger(struct command_ctx
*cmd_ctx
,
701 struct lttng_trigger
**_trigger
)
705 ssize_t sock_recv_len
;
706 enum lttng_error_code ret_code
;
707 struct lttng_payload trigger_payload
;
708 struct lttng_trigger
*trigger
;
710 lttng_payload_init(&trigger_payload
);
711 trigger_len
= (size_t) cmd_ctx
->lsm
.u
.trigger
.length
;
712 ret
= lttng_dynamic_buffer_set_size(
713 &trigger_payload
.buffer
, trigger_len
);
715 ret_code
= LTTNG_ERR_NOMEM
;
719 sock_recv_len
= lttcomm_recv_unix_sock(
720 sock
, trigger_payload
.buffer
.data
, trigger_len
);
721 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
722 ERR("Failed to receive trigger in command payload");
724 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
728 /* Receive fds, if any. */
729 if (cmd_ctx
->lsm
.fd_count
> 0) {
730 sock_recv_len
= lttcomm_recv_payload_fds_unix_sock(
731 sock
, cmd_ctx
->lsm
.fd_count
, &trigger_payload
);
732 if (sock_recv_len
> 0 &&
733 sock_recv_len
!= cmd_ctx
->lsm
.fd_count
* sizeof(int)) {
734 ERR("Failed to receive all file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
735 cmd_ctx
->lsm
.fd_count
, (int) ret
);
736 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
739 } else if (sock_recv_len
<= 0) {
740 ERR("Failed to receive file descriptors for trigger in command payload: expected fd count = %u, ret = %d",
741 cmd_ctx
->lsm
.fd_count
, (int) ret
);
742 ret_code
= LTTNG_ERR_FATAL
;
748 /* Deserialize trigger. */
750 struct lttng_payload_view view
=
751 lttng_payload_view_from_payload(
752 &trigger_payload
, 0, -1);
754 if (lttng_trigger_create_from_payload(&view
, &trigger
) !=
756 ERR("Invalid trigger received as part of command payload");
757 ret_code
= LTTNG_ERR_INVALID_TRIGGER
;
770 * Version of setup_lttng_msg() without command header.
772 static int setup_lttng_msg_no_cmd_header(struct command_ctx
*cmd_ctx
,
773 void *payload_buf
, size_t payload_len
)
775 return setup_lttng_msg(cmd_ctx
, payload_buf
, payload_len
, NULL
, 0);
779 * Check if the current kernel tracer supports the session rotation feature.
780 * Return 1 if it does, 0 otherwise.
782 static int check_rotate_compatible(void)
786 if (kernel_tracer_version
.major
!= 2 || kernel_tracer_version
.minor
< 11) {
787 DBG("Kernel tracer version is not compatible with the rotation feature");
795 * Send data on a unix socket using the liblttsessiondcomm API.
797 * Return lttcomm error code.
799 static int send_unix_sock(int sock
, struct lttng_payload_view
*view
)
802 const int fd_count
= lttng_payload_view_get_fd_handle_count(view
);
804 /* Check valid length */
805 if (view
->buffer
.size
== 0) {
810 ret
= lttcomm_send_unix_sock(
811 sock
, view
->buffer
.data
, view
->buffer
.size
);
817 ret
= lttcomm_send_payload_view_fds_unix_sock(sock
, view
);
828 * Process the command requested by the lttng client within the command
829 * context structure. This function make sure that the return structure (llm)
830 * is set and ready for transmission before returning.
832 * Return any error encountered or 0 for success.
834 * "sock" is only used for special-case var. len data.
835 * A command may assume the ownership of the socket, in which case its value
836 * should be set to -1.
838 * Should *NOT* be called with RCU read-side lock held.
840 static int process_client_msg(struct command_ctx
*cmd_ctx
, int *sock
,
844 bool need_tracing_session
= true;
848 DBG("Processing client command '%s\' (%d)",
849 lttcomm_sessiond_command_str(cmd_ctx
->lsm
.cmd_type
),
850 cmd_ctx
->lsm
.cmd_type
);
852 assert(!rcu_read_ongoing());
856 switch (cmd_ctx
->lsm
.cmd_type
) {
857 case LTTNG_CREATE_SESSION_EXT
:
858 case LTTNG_DESTROY_SESSION
:
859 case LTTNG_LIST_SESSIONS
:
860 case LTTNG_LIST_DOMAINS
:
861 case LTTNG_START_TRACE
:
862 case LTTNG_STOP_TRACE
:
863 case LTTNG_DATA_PENDING
:
864 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
865 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
866 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
867 case LTTNG_SNAPSHOT_RECORD
:
868 case LTTNG_SAVE_SESSION
:
869 case LTTNG_SET_SESSION_SHM_PATH
:
870 case LTTNG_REGENERATE_METADATA
:
871 case LTTNG_REGENERATE_STATEDUMP
:
872 case LTTNG_ROTATE_SESSION
:
873 case LTTNG_ROTATION_GET_INFO
:
874 case LTTNG_ROTATION_SET_SCHEDULE
:
875 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
876 case LTTNG_CLEAR_SESSION
:
877 case LTTNG_LIST_TRIGGERS
:
884 /* Needs a functioning consumerd? */
885 switch (cmd_ctx
->lsm
.cmd_type
) {
886 case LTTNG_REGISTER_TRIGGER
:
887 case LTTNG_UNREGISTER_TRIGGER
:
888 need_consumerd
= false;
891 need_consumerd
= true;
895 if (config
.no_kernel
&& need_domain
896 && cmd_ctx
->lsm
.domain
.type
== LTTNG_DOMAIN_KERNEL
) {
898 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
900 ret
= LTTNG_ERR_KERN_NA
;
905 /* Deny register consumer if we already have a spawned consumer. */
906 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_REGISTER_CONSUMER
) {
907 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
908 if (kconsumer_data
.pid
> 0) {
909 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
910 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
913 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
917 * Check for command that don't needs to allocate a returned payload. We do
918 * this here so we don't have to make the call for no payload at each
921 switch(cmd_ctx
->lsm
.cmd_type
) {
922 case LTTNG_LIST_SESSIONS
:
923 case LTTNG_LIST_TRACEPOINTS
:
924 case LTTNG_LIST_TRACEPOINT_FIELDS
:
925 case LTTNG_LIST_DOMAINS
:
926 case LTTNG_LIST_CHANNELS
:
927 case LTTNG_LIST_EVENTS
:
928 case LTTNG_LIST_SYSCALLS
:
929 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
930 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
931 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
932 case LTTNG_DATA_PENDING
:
933 case LTTNG_ROTATE_SESSION
:
934 case LTTNG_ROTATION_GET_INFO
:
935 case LTTNG_REGISTER_TRIGGER
:
936 case LTTNG_LIST_TRIGGERS
:
939 /* Setup lttng message with no payload */
940 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0);
942 /* This label does not try to unlock the session */
943 goto init_setup_error
;
947 /* Commands that DO NOT need a session. */
948 switch (cmd_ctx
->lsm
.cmd_type
) {
949 case LTTNG_CREATE_SESSION_EXT
:
950 case LTTNG_LIST_SESSIONS
:
951 case LTTNG_LIST_TRACEPOINTS
:
952 case LTTNG_LIST_SYSCALLS
:
953 case LTTNG_LIST_TRACEPOINT_FIELDS
:
954 case LTTNG_SAVE_SESSION
:
955 case LTTNG_REGISTER_TRIGGER
:
956 case LTTNG_UNREGISTER_TRIGGER
:
957 case LTTNG_LIST_TRIGGERS
:
958 need_tracing_session
= false;
961 DBG("Getting session %s by name", cmd_ctx
->lsm
.session
.name
);
963 * We keep the session list lock across _all_ commands
964 * for now, because the per-session lock does not
965 * handle teardown properly.
968 cmd_ctx
->session
= session_find_by_name(cmd_ctx
->lsm
.session
.name
);
969 if (cmd_ctx
->session
== NULL
) {
970 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
973 /* Acquire lock for the session */
974 session_lock(cmd_ctx
->session
);
980 * Commands that need a valid session but should NOT create one if none
981 * exists. Instead of creating one and destroying it when the command is
982 * handled, process that right before so we save some round trip in useless
985 switch (cmd_ctx
->lsm
.cmd_type
) {
986 case LTTNG_DISABLE_CHANNEL
:
987 case LTTNG_DISABLE_EVENT
:
988 switch (cmd_ctx
->lsm
.domain
.type
) {
989 case LTTNG_DOMAIN_KERNEL
:
990 if (!cmd_ctx
->session
->kernel_session
) {
991 ret
= LTTNG_ERR_NO_CHANNEL
;
995 case LTTNG_DOMAIN_JUL
:
996 case LTTNG_DOMAIN_LOG4J
:
997 case LTTNG_DOMAIN_PYTHON
:
998 case LTTNG_DOMAIN_UST
:
999 if (!cmd_ctx
->session
->ust_session
) {
1000 ret
= LTTNG_ERR_NO_CHANNEL
;
1005 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1017 * Check domain type for specific "pre-action".
1019 switch (cmd_ctx
->lsm
.domain
.type
) {
1020 case LTTNG_DOMAIN_KERNEL
:
1022 ret
= LTTNG_ERR_NEED_ROOT_SESSIOND
;
1026 /* Kernel tracer check */
1027 if (!kernel_tracer_is_initialized()) {
1028 /* Basically, load kernel tracer modules */
1029 ret
= init_kernel_tracer();
1035 /* Consumer is in an ERROR state. Report back to client */
1036 if (need_consumerd
&& uatomic_read(&kernel_consumerd_state
) ==
1038 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1042 /* Need a session for kernel command */
1043 if (need_tracing_session
) {
1044 if (cmd_ctx
->session
->kernel_session
== NULL
) {
1045 ret
= create_kernel_session(cmd_ctx
->session
);
1046 if (ret
!= LTTNG_OK
) {
1047 ret
= LTTNG_ERR_KERN_SESS_FAIL
;
1052 /* Start the kernel consumer daemon */
1053 pthread_mutex_lock(&kconsumer_data
.pid_mutex
);
1054 if (kconsumer_data
.pid
== 0 &&
1055 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1056 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
1057 ret
= start_consumerd(&kconsumer_data
);
1059 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
1062 uatomic_set(&kernel_consumerd_state
, CONSUMER_STARTED
);
1064 pthread_mutex_unlock(&kconsumer_data
.pid_mutex
);
1068 * The consumer was just spawned so we need to add the socket to
1069 * the consumer output of the session if exist.
1071 ret
= consumer_create_socket(&kconsumer_data
,
1072 cmd_ctx
->session
->kernel_session
->consumer
);
1079 case LTTNG_DOMAIN_JUL
:
1080 case LTTNG_DOMAIN_LOG4J
:
1081 case LTTNG_DOMAIN_PYTHON
:
1082 if (!agent_tracing_is_enabled()) {
1083 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1087 case LTTNG_DOMAIN_UST
:
1089 if (!ust_app_supported()) {
1090 ret
= LTTNG_ERR_NO_UST
;
1094 /* Consumer is in an ERROR state. Report back to client */
1095 if (need_consumerd
&& uatomic_read(&ust_consumerd_state
) ==
1097 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1101 if (need_tracing_session
) {
1102 /* Create UST session if none exist. */
1103 if (cmd_ctx
->session
->ust_session
== NULL
) {
1104 ret
= create_ust_session(cmd_ctx
->session
,
1105 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
));
1106 if (ret
!= LTTNG_OK
) {
1111 /* Start the UST consumer daemons */
1113 pthread_mutex_lock(&ustconsumer64_data
.pid_mutex
);
1114 if (config
.consumerd64_bin_path
.value
&&
1115 ustconsumer64_data
.pid
== 0 &&
1116 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1117 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
1118 ret
= start_consumerd(&ustconsumer64_data
);
1120 ret
= LTTNG_ERR_UST_CONSUMER64_FAIL
;
1121 uatomic_set(&ust_consumerd64_fd
, -EINVAL
);
1125 uatomic_set(&ust_consumerd64_fd
, ustconsumer64_data
.cmd_sock
);
1126 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
1128 pthread_mutex_unlock(&ustconsumer64_data
.pid_mutex
);
1132 * Setup socket for consumer 64 bit. No need for atomic access
1133 * since it was set above and can ONLY be set in this thread.
1135 ret
= consumer_create_socket(&ustconsumer64_data
,
1136 cmd_ctx
->session
->ust_session
->consumer
);
1142 pthread_mutex_lock(&ustconsumer32_data
.pid_mutex
);
1143 if (config
.consumerd32_bin_path
.value
&&
1144 ustconsumer32_data
.pid
== 0 &&
1145 cmd_ctx
->lsm
.cmd_type
!= LTTNG_REGISTER_CONSUMER
) {
1146 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
1147 ret
= start_consumerd(&ustconsumer32_data
);
1149 ret
= LTTNG_ERR_UST_CONSUMER32_FAIL
;
1150 uatomic_set(&ust_consumerd32_fd
, -EINVAL
);
1154 uatomic_set(&ust_consumerd32_fd
, ustconsumer32_data
.cmd_sock
);
1155 uatomic_set(&ust_consumerd_state
, CONSUMER_STARTED
);
1157 pthread_mutex_unlock(&ustconsumer32_data
.pid_mutex
);
1161 * Setup socket for consumer 32 bit. No need for atomic access
1162 * since it was set above and can ONLY be set in this thread.
1164 ret
= consumer_create_socket(&ustconsumer32_data
,
1165 cmd_ctx
->session
->ust_session
->consumer
);
1177 /* Validate consumer daemon state when start/stop trace command */
1178 if (cmd_ctx
->lsm
.cmd_type
== LTTNG_START_TRACE
||
1179 cmd_ctx
->lsm
.cmd_type
== LTTNG_STOP_TRACE
) {
1180 switch (cmd_ctx
->lsm
.domain
.type
) {
1181 case LTTNG_DOMAIN_NONE
:
1183 case LTTNG_DOMAIN_JUL
:
1184 case LTTNG_DOMAIN_LOG4J
:
1185 case LTTNG_DOMAIN_PYTHON
:
1186 case LTTNG_DOMAIN_UST
:
1187 if (uatomic_read(&ust_consumerd_state
) != CONSUMER_STARTED
) {
1188 ret
= LTTNG_ERR_NO_USTCONSUMERD
;
1192 case LTTNG_DOMAIN_KERNEL
:
1193 if (uatomic_read(&kernel_consumerd_state
) != CONSUMER_STARTED
) {
1194 ret
= LTTNG_ERR_NO_KERNCONSUMERD
;
1199 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1205 * Check that the UID matches that of the tracing session.
1206 * The root user can interact with all sessions.
1208 if (need_tracing_session
) {
1209 if (!session_access_ok(cmd_ctx
->session
,
1210 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
)) ||
1211 cmd_ctx
->session
->destroyed
) {
1212 ret
= LTTNG_ERR_EPERM
;
1218 * Send relayd information to consumer as soon as we have a domain and a
1221 if (cmd_ctx
->session
&& need_domain
) {
1223 * Setup relayd if not done yet. If the relayd information was already
1224 * sent to the consumer, this call will gracefully return.
1226 ret
= cmd_setup_relayd(cmd_ctx
->session
);
1227 if (ret
!= LTTNG_OK
) {
1232 /* Process by command type */
1233 switch (cmd_ctx
->lsm
.cmd_type
) {
1234 case LTTNG_ADD_CONTEXT
:
1237 * An LTTNG_ADD_CONTEXT command might have a supplementary
1238 * payload if the context being added is an application context.
1240 if (cmd_ctx
->lsm
.u
.context
.ctx
.ctx
==
1241 LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1242 char *provider_name
= NULL
, *context_name
= NULL
;
1243 size_t provider_name_len
=
1244 cmd_ctx
->lsm
.u
.context
.provider_name_len
;
1245 size_t context_name_len
=
1246 cmd_ctx
->lsm
.u
.context
.context_name_len
;
1248 if (provider_name_len
== 0 || context_name_len
== 0) {
1250 * Application provider and context names MUST
1253 ret
= -LTTNG_ERR_INVALID
;
1257 provider_name
= zmalloc(provider_name_len
+ 1);
1258 if (!provider_name
) {
1259 ret
= -LTTNG_ERR_NOMEM
;
1262 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
=
1265 context_name
= zmalloc(context_name_len
+ 1);
1266 if (!context_name
) {
1267 ret
= -LTTNG_ERR_NOMEM
;
1268 goto error_add_context
;
1270 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
=
1273 ret
= lttcomm_recv_unix_sock(*sock
, provider_name
,
1276 goto error_add_context
;
1279 ret
= lttcomm_recv_unix_sock(*sock
, context_name
,
1282 goto error_add_context
;
1287 * cmd_add_context assumes ownership of the provider and context
1290 ret
= cmd_add_context(cmd_ctx
->session
,
1291 cmd_ctx
->lsm
.domain
.type
,
1292 cmd_ctx
->lsm
.u
.context
.channel_name
,
1293 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.context
.ctx
),
1294 kernel_poll_pipe
[1]);
1296 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
1297 cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
1299 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
);
1300 free(cmd_ctx
->lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
);
1306 case LTTNG_DISABLE_CHANNEL
:
1308 ret
= cmd_disable_channel(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1309 cmd_ctx
->lsm
.u
.disable
.channel_name
);
1312 case LTTNG_DISABLE_EVENT
:
1316 * FIXME: handle filter; for now we just receive the filter's
1317 * bytecode along with the filter expression which are sent by
1318 * liblttng-ctl and discard them.
1320 * This fixes an issue where the client may block while sending
1321 * the filter payload and encounter an error because the session
1322 * daemon closes the socket without ever handling this data.
1324 size_t count
= cmd_ctx
->lsm
.u
.disable
.expression_len
+
1325 cmd_ctx
->lsm
.u
.disable
.bytecode_len
;
1328 char data
[LTTNG_FILTER_MAX_LEN
];
1330 DBG("Discarding disable event command payload of size %zu", count
);
1332 ret
= lttcomm_recv_unix_sock(*sock
, data
,
1333 count
> sizeof(data
) ? sizeof(data
) : count
);
1338 count
-= (size_t) ret
;
1341 ret
= cmd_disable_event(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1342 cmd_ctx
->lsm
.u
.disable
.channel_name
,
1343 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.disable
.event
));
1346 case LTTNG_ENABLE_CHANNEL
:
1348 cmd_ctx
->lsm
.u
.channel
.chan
.attr
.extended
.ptr
=
1349 (struct lttng_channel_extended
*) &cmd_ctx
->lsm
.u
.channel
.extended
;
1350 ret
= cmd_enable_channel(cmd_ctx
->session
,
1351 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
),
1352 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.channel
.chan
),
1353 kernel_poll_pipe
[1]);
1356 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
1357 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
1359 struct lttng_dynamic_buffer payload
;
1360 struct lttng_buffer_view payload_view
;
1361 const bool add_value
=
1362 cmd_ctx
->lsm
.cmd_type
==
1363 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
;
1364 const size_t name_len
=
1365 cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1367 const enum lttng_domain_type domain_type
=
1368 (enum lttng_domain_type
)
1369 cmd_ctx
->lsm
.domain
.type
;
1370 const enum lttng_process_attr process_attr
=
1371 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1372 .process_attr_tracker_add_remove_include_value
1374 const enum lttng_process_attr_value_type value_type
=
1375 (enum lttng_process_attr_value_type
) cmd_ctx
1377 .process_attr_tracker_add_remove_include_value
1379 struct process_attr_value
*value
;
1380 enum lttng_error_code ret_code
;
1381 long login_name_max
;
1383 login_name_max
= sysconf(_SC_LOGIN_NAME_MAX
);
1384 if (login_name_max
< 0) {
1385 PERROR("Failed to get _SC_LOGIN_NAME_MAX system configuration");
1386 ret
= LTTNG_ERR_INVALID
;
1390 /* Receive remaining variable length payload if applicable. */
1391 if (name_len
> login_name_max
) {
1393 * POSIX mandates user and group names that are at least
1394 * 8 characters long. Note that although shadow-utils
1395 * (useradd, groupaadd, etc.) use 32 chars as their
1396 * limit (from bits/utmp.h, UT_NAMESIZE),
1397 * LOGIN_NAME_MAX is defined to 256.
1399 ERR("Rejecting process attribute tracker value %s as the provided exceeds the maximal allowed length: argument length = %zu, maximal length = %ld",
1400 add_value
? "addition" : "removal",
1401 name_len
, login_name_max
);
1402 ret
= LTTNG_ERR_INVALID
;
1406 lttng_dynamic_buffer_init(&payload
);
1407 if (name_len
!= 0) {
1409 * Receive variable payload for user/group name
1412 ret
= lttng_dynamic_buffer_set_size(&payload
, name_len
);
1414 ERR("Failed to allocate buffer to receive payload of %s process attribute tracker value argument",
1415 add_value
? "add" : "remove");
1416 ret
= LTTNG_ERR_NOMEM
;
1417 goto error_add_remove_tracker_value
;
1420 ret
= lttcomm_recv_unix_sock(
1421 *sock
, payload
.data
, name_len
);
1423 ERR("Failed to receive payload of %s process attribute tracker value argument",
1424 add_value
? "add" : "remove");
1426 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1427 goto error_add_remove_tracker_value
;
1431 payload_view
= lttng_buffer_view_from_dynamic_buffer(
1432 &payload
, 0, name_len
);
1433 if (name_len
> 0 && !lttng_buffer_view_is_valid(&payload_view
)) {
1434 ret
= LTTNG_ERR_INVALID_PROTOCOL
;
1435 goto error_add_remove_tracker_value
;
1439 * Validate the value type and domains are legal for the process
1440 * attribute tracker that is specified and convert the value to
1441 * add/remove to the internal sessiond representation.
1443 ret_code
= process_attr_value_from_comm(domain_type
,
1444 process_attr
, value_type
,
1445 &cmd_ctx
->lsm
.u
.process_attr_tracker_add_remove_include_value
1447 &payload_view
, &value
);
1448 if (ret_code
!= LTTNG_OK
) {
1450 goto error_add_remove_tracker_value
;
1454 ret
= cmd_process_attr_tracker_inclusion_set_add_value(
1455 cmd_ctx
->session
, domain_type
,
1456 process_attr
, value
);
1458 ret
= cmd_process_attr_tracker_inclusion_set_remove_value(
1459 cmd_ctx
->session
, domain_type
,
1460 process_attr
, value
);
1462 process_attr_value_destroy(value
);
1463 error_add_remove_tracker_value
:
1464 lttng_dynamic_buffer_reset(&payload
);
1467 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
1469 enum lttng_tracking_policy tracking_policy
;
1470 const enum lttng_domain_type domain_type
=
1471 (enum lttng_domain_type
)
1472 cmd_ctx
->lsm
.domain
.type
;
1473 const enum lttng_process_attr process_attr
=
1474 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1475 .process_attr_tracker_get_tracking_policy
1478 ret
= cmd_process_attr_tracker_get_tracking_policy(
1479 cmd_ctx
->session
, domain_type
, process_attr
,
1481 if (ret
!= LTTNG_OK
) {
1485 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
1486 &(uint32_t){tracking_policy
}, sizeof(uint32_t));
1488 ret
= LTTNG_ERR_NOMEM
;
1494 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
1496 const enum lttng_tracking_policy tracking_policy
=
1497 (enum lttng_tracking_policy
) cmd_ctx
->lsm
.u
1498 .process_attr_tracker_set_tracking_policy
1500 const enum lttng_domain_type domain_type
=
1501 (enum lttng_domain_type
)
1502 cmd_ctx
->lsm
.domain
.type
;
1503 const enum lttng_process_attr process_attr
=
1504 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1505 .process_attr_tracker_set_tracking_policy
1508 ret
= cmd_process_attr_tracker_set_tracking_policy(
1509 cmd_ctx
->session
, domain_type
, process_attr
,
1511 if (ret
!= LTTNG_OK
) {
1516 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
1518 struct lttng_process_attr_values
*values
;
1519 struct lttng_dynamic_buffer reply
;
1520 const enum lttng_domain_type domain_type
=
1521 (enum lttng_domain_type
)
1522 cmd_ctx
->lsm
.domain
.type
;
1523 const enum lttng_process_attr process_attr
=
1524 (enum lttng_process_attr
) cmd_ctx
->lsm
.u
1525 .process_attr_tracker_get_inclusion_set
1528 ret
= cmd_process_attr_tracker_get_inclusion_set(
1529 cmd_ctx
->session
, domain_type
, process_attr
,
1531 if (ret
!= LTTNG_OK
) {
1535 lttng_dynamic_buffer_init(&reply
);
1536 ret
= lttng_process_attr_values_serialize(values
, &reply
);
1538 goto error_tracker_get_inclusion_set
;
1541 ret
= setup_lttng_msg_no_cmd_header(
1542 cmd_ctx
, reply
.data
, reply
.size
);
1544 ret
= LTTNG_ERR_NOMEM
;
1545 goto error_tracker_get_inclusion_set
;
1549 error_tracker_get_inclusion_set
:
1550 lttng_process_attr_values_destroy(values
);
1551 lttng_dynamic_buffer_reset(&reply
);
1554 case LTTNG_ENABLE_EVENT
:
1556 struct lttng_event
*ev
= NULL
;
1557 struct lttng_event_exclusion
*exclusion
= NULL
;
1558 struct lttng_filter_bytecode
*bytecode
= NULL
;
1559 char *filter_expression
= NULL
;
1561 /* Handle exclusion events and receive it from the client. */
1562 if (cmd_ctx
->lsm
.u
.enable
.exclusion_count
> 0) {
1563 size_t count
= cmd_ctx
->lsm
.u
.enable
.exclusion_count
;
1565 exclusion
= zmalloc(sizeof(struct lttng_event_exclusion
) +
1566 (count
* LTTNG_SYMBOL_NAME_LEN
));
1568 ret
= LTTNG_ERR_EXCLUSION_NOMEM
;
1572 DBG("Receiving var len exclusion event list from client ...");
1573 exclusion
->count
= count
;
1574 ret
= lttcomm_recv_unix_sock(*sock
, exclusion
->names
,
1575 count
* LTTNG_SYMBOL_NAME_LEN
);
1577 DBG("Nothing recv() from client var len data... continuing");
1580 ret
= LTTNG_ERR_EXCLUSION_INVAL
;
1585 /* Get filter expression from client. */
1586 if (cmd_ctx
->lsm
.u
.enable
.expression_len
> 0) {
1587 size_t expression_len
=
1588 cmd_ctx
->lsm
.u
.enable
.expression_len
;
1590 if (expression_len
> LTTNG_FILTER_MAX_LEN
) {
1591 ret
= LTTNG_ERR_FILTER_INVAL
;
1596 filter_expression
= zmalloc(expression_len
);
1597 if (!filter_expression
) {
1599 ret
= LTTNG_ERR_FILTER_NOMEM
;
1603 /* Receive var. len. data */
1604 DBG("Receiving var len filter's expression from client ...");
1605 ret
= lttcomm_recv_unix_sock(*sock
, filter_expression
,
1608 DBG("Nothing recv() from client var len data... continuing");
1610 free(filter_expression
);
1612 ret
= LTTNG_ERR_FILTER_INVAL
;
1617 /* Handle filter and get bytecode from client. */
1618 if (cmd_ctx
->lsm
.u
.enable
.bytecode_len
> 0) {
1619 size_t bytecode_len
= cmd_ctx
->lsm
.u
.enable
.bytecode_len
;
1621 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
1622 ret
= LTTNG_ERR_FILTER_INVAL
;
1623 free(filter_expression
);
1628 bytecode
= zmalloc(bytecode_len
);
1630 free(filter_expression
);
1632 ret
= LTTNG_ERR_FILTER_NOMEM
;
1636 /* Receive var. len. data */
1637 DBG("Receiving var len filter's bytecode from client ...");
1638 ret
= lttcomm_recv_unix_sock(*sock
, bytecode
, bytecode_len
);
1640 DBG("Nothing recv() from client var len data... continuing");
1642 free(filter_expression
);
1645 ret
= LTTNG_ERR_FILTER_INVAL
;
1649 if ((bytecode
->len
+ sizeof(*bytecode
)) != bytecode_len
) {
1650 free(filter_expression
);
1653 ret
= LTTNG_ERR_FILTER_INVAL
;
1658 ev
= lttng_event_copy(ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.enable
.event
));
1660 DBG("Failed to copy event: %s",
1661 cmd_ctx
->lsm
.u
.enable
.event
.name
);
1662 free(filter_expression
);
1665 ret
= LTTNG_ERR_NOMEM
;
1670 if (cmd_ctx
->lsm
.u
.enable
.userspace_probe_location_len
> 0) {
1671 /* Expect a userspace probe description. */
1672 ret
= receive_userspace_probe(cmd_ctx
, *sock
, sock_error
, ev
);
1674 free(filter_expression
);
1677 lttng_event_destroy(ev
);
1682 ret
= cmd_enable_event(cmd_ctx
->session
,
1683 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.domain
),
1684 cmd_ctx
->lsm
.u
.enable
.channel_name
,
1686 filter_expression
, bytecode
, exclusion
,
1687 kernel_poll_pipe
[1]);
1688 lttng_event_destroy(ev
);
1691 case LTTNG_LIST_TRACEPOINTS
:
1693 struct lttng_event
*events
;
1696 session_lock_list();
1697 nb_events
= cmd_list_tracepoints(cmd_ctx
->lsm
.domain
.type
, &events
);
1698 session_unlock_list();
1699 if (nb_events
< 0) {
1700 /* Return value is a negative lttng_error_code. */
1706 * Setup lttng message with payload size set to the event list size in
1707 * bytes and then copy list into the llm payload.
1709 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1710 sizeof(struct lttng_event
) * nb_events
);
1720 case LTTNG_LIST_TRACEPOINT_FIELDS
:
1722 struct lttng_event_field
*fields
;
1725 session_lock_list();
1726 nb_fields
= cmd_list_tracepoint_fields(cmd_ctx
->lsm
.domain
.type
,
1728 session_unlock_list();
1729 if (nb_fields
< 0) {
1730 /* Return value is a negative lttng_error_code. */
1736 * Setup lttng message with payload size set to the event list size in
1737 * bytes and then copy list into the llm payload.
1739 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, fields
,
1740 sizeof(struct lttng_event_field
) * nb_fields
);
1750 case LTTNG_LIST_SYSCALLS
:
1752 struct lttng_event
*events
;
1755 nb_events
= cmd_list_syscalls(&events
);
1756 if (nb_events
< 0) {
1757 /* Return value is a negative lttng_error_code. */
1763 * Setup lttng message with payload size set to the event list size in
1764 * bytes and then copy list into the llm payload.
1766 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, events
,
1767 sizeof(struct lttng_event
) * nb_events
);
1777 case LTTNG_SET_CONSUMER_URI
:
1780 struct lttng_uri
*uris
;
1782 nb_uri
= cmd_ctx
->lsm
.u
.uri
.size
;
1783 len
= nb_uri
* sizeof(struct lttng_uri
);
1786 ret
= LTTNG_ERR_INVALID
;
1790 uris
= zmalloc(len
);
1792 ret
= LTTNG_ERR_FATAL
;
1796 /* Receive variable len data */
1797 DBG("Receiving %zu URI(s) from client ...", nb_uri
);
1798 ret
= lttcomm_recv_unix_sock(*sock
, uris
, len
);
1800 DBG("No URIs received from client... continuing");
1802 ret
= LTTNG_ERR_SESSION_FAIL
;
1807 ret
= cmd_set_consumer_uri(cmd_ctx
->session
, nb_uri
, uris
);
1809 if (ret
!= LTTNG_OK
) {
1816 case LTTNG_START_TRACE
:
1819 * On the first start, if we have a kernel session and we have
1820 * enabled time or size-based rotations, we have to make sure
1821 * the kernel tracer supports it.
1823 if (!cmd_ctx
->session
->has_been_started
&& \
1824 cmd_ctx
->session
->kernel_session
&& \
1825 (cmd_ctx
->session
->rotate_timer_period
|| \
1826 cmd_ctx
->session
->rotate_size
) && \
1827 !check_rotate_compatible()) {
1828 DBG("Kernel tracer version is not compatible with the rotation feature");
1829 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
1832 ret
= cmd_start_trace(cmd_ctx
->session
);
1835 case LTTNG_STOP_TRACE
:
1837 ret
= cmd_stop_trace(cmd_ctx
->session
);
1840 case LTTNG_DESTROY_SESSION
:
1842 ret
= cmd_destroy_session(cmd_ctx
->session
,
1843 notification_thread_handle
,
1847 case LTTNG_LIST_DOMAINS
:
1850 struct lttng_domain
*domains
= NULL
;
1852 nb_dom
= cmd_list_domains(cmd_ctx
->session
, &domains
);
1854 /* Return value is a negative lttng_error_code. */
1859 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, domains
,
1860 nb_dom
* sizeof(struct lttng_domain
));
1870 case LTTNG_LIST_CHANNELS
:
1872 ssize_t payload_size
;
1873 struct lttng_channel
*channels
= NULL
;
1875 payload_size
= cmd_list_channels(cmd_ctx
->lsm
.domain
.type
,
1876 cmd_ctx
->session
, &channels
);
1877 if (payload_size
< 0) {
1878 /* Return value is a negative lttng_error_code. */
1879 ret
= -payload_size
;
1883 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, channels
,
1894 case LTTNG_LIST_EVENTS
:
1897 struct lttcomm_event_command_header cmd_header
= {};
1898 size_t original_payload_size
;
1899 size_t payload_size
;
1901 ret
= setup_empty_lttng_msg(cmd_ctx
);
1903 ret
= LTTNG_ERR_NOMEM
;
1907 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
1909 /* Extended infos are included at the end of the payload. */
1910 list_ret
= cmd_list_events(cmd_ctx
->lsm
.domain
.type
,
1912 cmd_ctx
->lsm
.u
.list
.channel_name
,
1913 &cmd_ctx
->reply_payload
);
1915 /* Return value is a negative lttng_error_code. */
1920 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
1921 sizeof(cmd_header
) - original_payload_size
;
1922 update_lttng_msg(cmd_ctx
, sizeof(cmd_header
), payload_size
);
1927 case LTTNG_LIST_SESSIONS
:
1929 unsigned int nr_sessions
;
1930 void *sessions_payload
;
1933 session_lock_list();
1934 nr_sessions
= lttng_sessions_count(
1935 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1936 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1938 payload_len
= (sizeof(struct lttng_session
) * nr_sessions
) +
1939 (sizeof(struct lttng_session_extended
) * nr_sessions
);
1940 sessions_payload
= zmalloc(payload_len
);
1942 if (!sessions_payload
) {
1943 session_unlock_list();
1948 cmd_list_lttng_sessions(sessions_payload
, nr_sessions
,
1949 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx
->creds
),
1950 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx
->creds
));
1951 session_unlock_list();
1953 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, sessions_payload
,
1955 free(sessions_payload
);
1964 case LTTNG_REGISTER_CONSUMER
:
1966 struct consumer_data
*cdata
;
1968 switch (cmd_ctx
->lsm
.domain
.type
) {
1969 case LTTNG_DOMAIN_KERNEL
:
1970 cdata
= &kconsumer_data
;
1973 ret
= LTTNG_ERR_UND
;
1977 ret
= cmd_register_consumer(cmd_ctx
->session
, cmd_ctx
->lsm
.domain
.type
,
1978 cmd_ctx
->lsm
.u
.reg
.path
, cdata
);
1981 case LTTNG_DATA_PENDING
:
1984 uint8_t pending_ret_byte
;
1986 pending_ret
= cmd_data_pending(cmd_ctx
->session
);
1991 * This function may returns 0 or 1 to indicate whether or not
1992 * there is data pending. In case of error, it should return an
1993 * LTTNG_ERR code. However, some code paths may still return
1994 * a nondescript error code, which we handle by returning an
1997 if (pending_ret
== 0 || pending_ret
== 1) {
1999 * ret will be set to LTTNG_OK at the end of
2002 } else if (pending_ret
< 0) {
2003 ret
= LTTNG_ERR_UNK
;
2010 pending_ret_byte
= (uint8_t) pending_ret
;
2012 /* 1 byte to return whether or not data is pending */
2013 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
,
2014 &pending_ret_byte
, 1);
2023 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
2025 uint32_t snapshot_id
;
2026 struct lttcomm_lttng_output_id reply
;
2028 ret
= cmd_snapshot_add_output(cmd_ctx
->session
,
2029 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
),
2031 if (ret
!= LTTNG_OK
) {
2034 reply
.id
= snapshot_id
;
2036 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &reply
,
2042 /* Copy output list into message payload */
2046 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
2048 ret
= cmd_snapshot_del_output(cmd_ctx
->session
,
2049 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_output
.output
));
2052 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
2055 struct lttng_snapshot_output
*outputs
= NULL
;
2057 nb_output
= cmd_snapshot_list_outputs(cmd_ctx
->session
, &outputs
);
2058 if (nb_output
< 0) {
2063 assert((nb_output
> 0 && outputs
) || nb_output
== 0);
2064 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, outputs
,
2065 nb_output
* sizeof(struct lttng_snapshot_output
));
2075 case LTTNG_SNAPSHOT_RECORD
:
2077 ret
= cmd_snapshot_record(cmd_ctx
->session
,
2078 ALIGNED_CONST_PTR(cmd_ctx
->lsm
.u
.snapshot_record
.output
),
2079 cmd_ctx
->lsm
.u
.snapshot_record
.wait
);
2082 case LTTNG_CREATE_SESSION_EXT
:
2084 struct lttng_dynamic_buffer payload
;
2085 struct lttng_session_descriptor
*return_descriptor
= NULL
;
2087 lttng_dynamic_buffer_init(&payload
);
2088 ret
= cmd_create_session(cmd_ctx
, *sock
, &return_descriptor
);
2089 if (ret
!= LTTNG_OK
) {
2093 ret
= lttng_session_descriptor_serialize(return_descriptor
,
2096 ERR("Failed to serialize session descriptor in reply to \"create session\" command");
2097 lttng_session_descriptor_destroy(return_descriptor
);
2098 ret
= LTTNG_ERR_NOMEM
;
2101 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, payload
.data
,
2104 lttng_session_descriptor_destroy(return_descriptor
);
2105 ret
= LTTNG_ERR_NOMEM
;
2108 lttng_dynamic_buffer_reset(&payload
);
2109 lttng_session_descriptor_destroy(return_descriptor
);
2113 case LTTNG_SAVE_SESSION
:
2115 ret
= cmd_save_sessions(&cmd_ctx
->lsm
.u
.save_session
.attr
,
2119 case LTTNG_SET_SESSION_SHM_PATH
:
2121 ret
= cmd_set_session_shm_path(cmd_ctx
->session
,
2122 cmd_ctx
->lsm
.u
.set_shm_path
.shm_path
);
2125 case LTTNG_REGENERATE_METADATA
:
2127 ret
= cmd_regenerate_metadata(cmd_ctx
->session
);
2130 case LTTNG_REGENERATE_STATEDUMP
:
2132 ret
= cmd_regenerate_statedump(cmd_ctx
->session
);
2135 case LTTNG_REGISTER_TRIGGER
:
2137 struct lttng_trigger
*payload_trigger
;
2138 struct lttng_trigger
*return_trigger
;
2139 size_t original_reply_payload_size
;
2140 size_t reply_payload_size
;
2141 const struct lttng_credentials cmd_creds
= {
2142 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2143 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2146 ret
= setup_empty_lttng_msg(cmd_ctx
);
2148 ret
= LTTNG_ERR_NOMEM
;
2152 ret
= receive_lttng_trigger(
2153 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2154 if (ret
!= LTTNG_OK
) {
2158 original_reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2160 ret
= cmd_register_trigger(&cmd_creds
, payload_trigger
,
2161 notification_thread_handle
, &return_trigger
);
2162 if (ret
!= LTTNG_OK
) {
2163 lttng_trigger_put(payload_trigger
);
2167 ret
= lttng_trigger_serialize(return_trigger
, &cmd_ctx
->reply_payload
);
2168 lttng_trigger_put(payload_trigger
);
2169 lttng_trigger_put(return_trigger
);
2171 ERR("Failed to serialize trigger in reply to \"register trigger\" command");
2172 ret
= LTTNG_ERR_NOMEM
;
2176 reply_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2177 original_reply_payload_size
;
2179 update_lttng_msg(cmd_ctx
, 0, reply_payload_size
);
2184 case LTTNG_UNREGISTER_TRIGGER
:
2186 struct lttng_trigger
*payload_trigger
;
2187 const struct lttng_credentials cmd_creds
= {
2188 .uid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.uid
),
2189 .gid
= LTTNG_OPTIONAL_INIT_VALUE(cmd_ctx
->creds
.gid
),
2192 ret
= receive_lttng_trigger(
2193 cmd_ctx
, *sock
, sock_error
, &payload_trigger
);
2194 if (ret
!= LTTNG_OK
) {
2198 ret
= cmd_unregister_trigger(&cmd_creds
, payload_trigger
,
2199 notification_thread_handle
);
2200 lttng_trigger_put(payload_trigger
);
2203 case LTTNG_ROTATE_SESSION
:
2205 struct lttng_rotate_session_return rotate_return
;
2207 DBG("Client rotate session \"%s\"", cmd_ctx
->session
->name
);
2209 memset(&rotate_return
, 0, sizeof(rotate_return
));
2210 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2211 DBG("Kernel tracer version is not compatible with the rotation feature");
2212 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2216 ret
= cmd_rotate_session(cmd_ctx
->session
, &rotate_return
,
2218 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
2224 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &rotate_return
,
2225 sizeof(rotate_return
));
2234 case LTTNG_ROTATION_GET_INFO
:
2236 struct lttng_rotation_get_info_return get_info_return
;
2238 memset(&get_info_return
, 0, sizeof(get_info_return
));
2239 ret
= cmd_rotate_get_info(cmd_ctx
->session
, &get_info_return
,
2240 cmd_ctx
->lsm
.u
.get_rotation_info
.rotation_id
);
2246 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &get_info_return
,
2247 sizeof(get_info_return
));
2256 case LTTNG_ROTATION_SET_SCHEDULE
:
2259 enum lttng_rotation_schedule_type schedule_type
;
2262 if (cmd_ctx
->session
->kernel_session
&& !check_rotate_compatible()) {
2263 DBG("Kernel tracer version does not support session rotations");
2264 ret
= LTTNG_ERR_ROTATION_WRONG_VERSION
;
2268 set_schedule
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.set
== 1;
2269 schedule_type
= (enum lttng_rotation_schedule_type
) cmd_ctx
->lsm
.u
.rotation_set_schedule
.type
;
2270 value
= cmd_ctx
->lsm
.u
.rotation_set_schedule
.value
;
2272 ret
= cmd_rotation_set_schedule(cmd_ctx
->session
,
2276 notification_thread_handle
);
2277 if (ret
!= LTTNG_OK
) {
2283 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
2285 struct lttng_session_list_schedules_return schedules
= {
2286 .periodic
.set
= !!cmd_ctx
->session
->rotate_timer_period
,
2287 .periodic
.value
= cmd_ctx
->session
->rotate_timer_period
,
2288 .size
.set
= !!cmd_ctx
->session
->rotate_size
,
2289 .size
.value
= cmd_ctx
->session
->rotate_size
,
2292 ret
= setup_lttng_msg_no_cmd_header(cmd_ctx
, &schedules
,
2302 case LTTNG_CLEAR_SESSION
:
2304 ret
= cmd_clear_session(cmd_ctx
->session
, sock
);
2307 case LTTNG_LIST_TRIGGERS
:
2309 struct lttng_triggers
*return_triggers
= NULL
;
2310 size_t original_payload_size
;
2311 size_t payload_size
;
2313 ret
= setup_empty_lttng_msg(cmd_ctx
);
2315 ret
= LTTNG_ERR_NOMEM
;
2319 original_payload_size
= cmd_ctx
->reply_payload
.buffer
.size
;
2321 ret
= cmd_list_triggers(cmd_ctx
,
2322 notification_thread_handle
, &return_triggers
);
2323 if (ret
!= LTTNG_OK
) {
2327 assert(return_triggers
);
2328 ret
= lttng_triggers_serialize(
2329 return_triggers
, &cmd_ctx
->reply_payload
);
2330 lttng_triggers_destroy(return_triggers
);
2332 ERR("Failed to serialize triggers in reply to `list triggers` command");
2333 ret
= LTTNG_ERR_NOMEM
;
2337 payload_size
= cmd_ctx
->reply_payload
.buffer
.size
-
2338 original_payload_size
;
2340 update_lttng_msg(cmd_ctx
, 0, payload_size
);
2346 ret
= LTTNG_ERR_UND
;
2351 if (cmd_ctx
->reply_payload
.buffer
.size
== 0) {
2352 DBG("Missing llm header, creating one.");
2353 if (setup_lttng_msg_no_cmd_header(cmd_ctx
, NULL
, 0) < 0) {
2357 /* Set return code */
2358 ((struct lttcomm_lttng_msg
*) (cmd_ctx
->reply_payload
.buffer
.data
))->ret_code
= ret
;
2360 if (cmd_ctx
->session
) {
2361 session_unlock(cmd_ctx
->session
);
2362 session_put(cmd_ctx
->session
);
2363 cmd_ctx
->session
= NULL
;
2365 if (need_tracing_session
) {
2366 session_unlock_list();
2369 assert(!rcu_read_ongoing());
2373 static int create_client_sock(void)
2375 int ret
, client_sock
;
2376 const mode_t old_umask
= umask(0);
2378 /* Create client tool unix socket */
2379 client_sock
= lttcomm_create_unix_sock(config
.client_unix_sock_path
.value
);
2380 if (client_sock
< 0) {
2381 ERR("Create unix sock failed: %s", config
.client_unix_sock_path
.value
);
2386 /* Set the cloexec flag */
2387 ret
= utils_set_fd_cloexec(client_sock
);
2389 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
2390 "Continuing but note that the consumer daemon will have a "
2391 "reference to this socket on exec()", client_sock
);
2394 /* File permission MUST be 660 */
2395 ret
= chmod(config
.client_unix_sock_path
.value
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
2397 ERR("Set file permissions failed: %s",
2398 config
.client_unix_sock_path
.value
);
2400 (void) lttcomm_close_unix_sock(client_sock
);
2404 DBG("Created client socket (fd = %i)", client_sock
);
2411 static void cleanup_client_thread(void *data
)
2413 struct lttng_pipe
*quit_pipe
= data
;
2415 lttng_pipe_destroy(quit_pipe
);
2418 static void thread_init_cleanup(void *data
)
2420 set_thread_status(false);
2424 * This thread manage all clients request using the unix client socket for
2427 static void *thread_manage_clients(void *data
)
2429 int sock
= -1, ret
, i
, pollfd
, err
= -1;
2431 uint32_t revents
, nb_fd
;
2432 struct lttng_poll_event events
;
2433 const int client_sock
= thread_state
.client_sock
;
2434 struct lttng_pipe
*quit_pipe
= data
;
2435 const int thread_quit_pipe_fd
= lttng_pipe_get_readfd(quit_pipe
);
2436 struct command_ctx cmd_ctx
= {};
2438 DBG("[thread] Manage client started");
2440 lttng_payload_init(&cmd_ctx
.reply_payload
);
2442 is_root
= (getuid() == 0);
2444 pthread_cleanup_push(thread_init_cleanup
, NULL
);
2446 rcu_register_thread();
2448 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_CMD
);
2450 health_code_update();
2452 ret
= lttcomm_listen_unix_sock(client_sock
);
2458 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2459 * more will be added to this poll set.
2461 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2463 goto error_create_poll
;
2466 /* Add the application registration socket */
2467 ret
= lttng_poll_add(&events
, client_sock
, LPOLLIN
| LPOLLPRI
);
2472 /* Add thread quit pipe */
2473 ret
= lttng_poll_add(&events
, thread_quit_pipe_fd
, LPOLLIN
| LPOLLERR
);
2478 /* Set state as running. */
2479 set_thread_status(true);
2480 pthread_cleanup_pop(0);
2482 /* This testpoint is after we signal readiness to the parent. */
2483 if (testpoint(sessiond_thread_manage_clients
)) {
2487 if (testpoint(sessiond_thread_manage_clients_before_loop
)) {
2491 health_code_update();
2494 const struct cmd_completion_handler
*cmd_completion_handler
;
2496 cmd_ctx
.creds
= (lttng_sock_cred
) {
2500 cmd_ctx
.session
= NULL
;
2501 lttng_payload_clear(&cmd_ctx
.reply_payload
);
2502 cmd_ctx
.lttng_msg_size
= 0;
2504 DBG("Accepting client command ...");
2506 /* Inifinite blocking call, waiting for transmission */
2508 health_poll_entry();
2509 ret
= lttng_poll_wait(&events
, -1);
2513 * Restart interrupted system call.
2515 if (errno
== EINTR
) {
2523 for (i
= 0; i
< nb_fd
; i
++) {
2524 revents
= LTTNG_POLL_GETEV(&events
, i
);
2525 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2527 health_code_update();
2529 if (pollfd
== thread_quit_pipe_fd
) {
2533 /* Event on the registration socket */
2534 if (revents
& LPOLLIN
) {
2536 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
2537 ERR("Client socket poll error");
2540 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2546 DBG("Wait for client response");
2548 health_code_update();
2550 sock
= lttcomm_accept_unix_sock(client_sock
);
2556 * Set the CLOEXEC flag. Return code is useless because either way, the
2559 (void) utils_set_fd_cloexec(sock
);
2561 /* Set socket option for credentials retrieval */
2562 ret
= lttcomm_setsockopt_creds_unix_sock(sock
);
2567 health_code_update();
2570 * Data is received from the lttng client. The struct
2571 * lttcomm_session_msg (lsm) contains the command and data request of
2574 DBG("Receiving data from client ...");
2575 ret
= lttcomm_recv_creds_unix_sock(sock
, &cmd_ctx
.lsm
,
2576 sizeof(struct lttcomm_session_msg
), &cmd_ctx
.creds
);
2577 if (ret
!= sizeof(struct lttcomm_session_msg
)) {
2578 DBG("Incomplete recv() from client... continuing");
2587 health_code_update();
2589 // TODO: Validate cmd_ctx including sanity check for
2590 // security purpose.
2592 rcu_thread_online();
2594 * This function dispatch the work to the kernel or userspace tracer
2595 * libs and fill the lttcomm_lttng_msg data structure of all the needed
2596 * informations for the client. The command context struct contains
2597 * everything this function may needs.
2599 ret
= process_client_msg(&cmd_ctx
, &sock
, &sock_error
);
2600 rcu_thread_offline();
2610 * TODO: Inform client somehow of the fatal error. At
2611 * this point, ret < 0 means that a zmalloc failed
2612 * (ENOMEM). Error detected but still accept
2613 * command, unless a socket error has been
2619 if (ret
< LTTNG_OK
|| ret
>= LTTNG_ERR_NR
) {
2620 WARN("Command returned an invalid status code, returning unknown error: command type = %d, ret = %d", cmd_ctx
.lsm
.cmd_type
, ret
);
2621 ret
= LTTNG_ERR_UNK
;
2624 cmd_completion_handler
= cmd_pop_completion_handler();
2625 if (cmd_completion_handler
) {
2626 enum lttng_error_code completion_code
;
2628 completion_code
= cmd_completion_handler
->run(
2629 cmd_completion_handler
->data
);
2630 if (completion_code
!= LTTNG_OK
) {
2635 health_code_update();
2638 struct lttng_payload_view view
=
2639 lttng_payload_view_from_payload(
2640 &cmd_ctx
.reply_payload
,
2642 struct lttcomm_lttng_msg
*llm
= (typeof(
2643 llm
)) cmd_ctx
.reply_payload
.buffer
.data
;
2645 assert(cmd_ctx
.reply_payload
.buffer
.size
>= sizeof(*llm
));
2646 assert(cmd_ctx
.lttng_msg_size
== cmd_ctx
.reply_payload
.buffer
.size
);
2648 llm
->fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
2650 DBG("Sending response (size: %d, retcode: %s (%d))",
2651 cmd_ctx
.lttng_msg_size
,
2652 lttng_strerror(-llm
->ret_code
),
2654 ret
= send_unix_sock(sock
, &view
);
2656 ERR("Failed to send data back to client");
2659 /* End of transmission */
2667 health_code_update();
2679 lttng_poll_clean(&events
);
2683 unlink(config
.client_unix_sock_path
.value
);
2684 ret
= close(client_sock
);
2691 ERR("Health error occurred in %s", __func__
);
2694 health_unregister(health_sessiond
);
2696 DBG("Client thread dying");
2697 lttng_payload_reset(&cmd_ctx
.reply_payload
);
2698 rcu_unregister_thread();
2703 bool shutdown_client_thread(void *thread_data
)
2705 struct lttng_pipe
*client_quit_pipe
= thread_data
;
2706 const int write_fd
= lttng_pipe_get_writefd(client_quit_pipe
);
2708 return notify_thread_pipe(write_fd
) == 1;
2711 struct lttng_thread
*launch_client_thread(void)
2713 bool thread_running
;
2714 struct lttng_pipe
*client_quit_pipe
;
2715 struct lttng_thread
*thread
= NULL
;
2716 int client_sock_fd
= -1;
2718 sem_init(&thread_state
.ready
, 0, 0);
2719 client_quit_pipe
= lttng_pipe_open(FD_CLOEXEC
);
2720 if (!client_quit_pipe
) {
2724 client_sock_fd
= create_client_sock();
2725 if (client_sock_fd
< 0) {
2729 thread_state
.client_sock
= client_sock_fd
;
2730 thread
= lttng_thread_create("Client management",
2731 thread_manage_clients
,
2732 shutdown_client_thread
,
2733 cleanup_client_thread
,
2738 /* The client thread now owns the client sock fd and the quit pipe. */
2739 client_sock_fd
= -1;
2740 client_quit_pipe
= NULL
;
2743 * This thread is part of the threads that need to be fully
2744 * initialized before the session daemon is marked as "ready".
2746 thread_running
= wait_thread_status();
2747 if (!thread_running
) {
2752 if (client_sock_fd
>= 0) {
2753 if (close(client_sock_fd
)) {
2754 PERROR("Failed to close client socket");
2757 lttng_thread_put(thread
);
2758 cleanup_client_thread(client_quit_pipe
);